diff --git a/.gitattributes b/.gitattributes index d643da3c..9320eaec 100644 --- a/.gitattributes +++ b/.gitattributes @@ -22,11 +22,20 @@ *.cpp text *.h text *.pl text -Makefile* text +*.py text +*.sh text *.txt text *.desktop text *.conf text *.rc text +*.spec text +*.bat text +*.1 text +*.md text +COPYING text +Makefile* text +README* text *.ico binary *.png binary + diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 00000000..341ccc8f --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,162 @@ +name: 'build direwolf' + +on: + # permit to manually trigger the CI + workflow_dispatch: + inputs: + cmake_flags: + description: 'Custom CMAKE flags' + required: false + push: + paths-ignore: + - '.github/**' + pull_request: + paths-ignore: + - '.github/**' + +jobs: + build: + name: ${{ matrix.config.name }} + runs-on: ${{ matrix.config.os }} + strategy: + fail-fast: false + matrix: + config: + - { + name: 'Windows Latest MinGW 64bit', + os: windows-latest, + cc: 'x86_64-w64-mingw32-gcc', + cxx: 'x86_64-w64-mingw32-g++', + ar: 'x86_64-w64-mingw32-ar', + windres: 'x86_64-w64-mingw32-windres', + arch: 'x86_64', + build_type: 'Release', + cmake_extra_flags: '-G "MinGW Makefiles"' + } + - { + name: 'Windows 2019 MinGW 32bit', + os: windows-2019, + cc: 'i686-w64-mingw32-gcc', + cxx: 'i686-w64-mingw32-g++', + ar: 'i686-w64-mingw32-ar', + windres: 'i686-w64-mingw32-windres', + arch: 'i686', + build_type: 'Release', + cmake_extra_flags: '-G "MinGW Makefiles"' + } + - { + name: 'macOS latest', + os: macos-latest, + cc: 'clang', + cxx: 'clang++', + arch: 'x86_64', + build_type: 'Release', + cmake_extra_flags: '' + } + - { + name: 'Ubuntu latest Debug', + os: ubuntu-latest, + cc: 'gcc', + cxx: 'g++', + arch: 'x86_64', + build_type: 'Debug', + cmake_extra_flags: '' + } + - { + name: 'Ubuntu 22.04', + os: ubuntu-22.04, + cc: 'gcc', + cxx: 'g++', + arch: 'x86_64', + build_type: 'Release', + cmake_extra_flags: '' + } + - { + name: 'Ubuntu 20.04', + os: ubuntu-20.04, + cc: 'gcc', + cxx: 'g++', + arch: 'x86_64', + build_type: 'Release', + cmake_extra_flags: '' + } + + steps: + - name: checkout + uses: actions/checkout@v2 + with: + fetch-depth: 8 + - name: dependency + shell: bash + run: | + # this is not perfect but enought for now + if [ "$RUNNER_OS" == "Linux" ]; then + sudo apt-get update + sudo apt-get install libasound2-dev libudev-dev libhamlib-dev gpsd + elif [ "$RUNNER_OS" == "macOS" ]; then + # just to simplify I use homebrew but + # we can use macports (latest direwolf is already available as port) + brew install portaudio hamlib gpsd + elif [ "$RUNNER_OS" == "Windows" ]; then + # add the folder to PATH + echo "C:\msys64\mingw32\bin" >> $GITHUB_PATH + fi + - name: create build environment + run: | + cmake -E make_directory ${{github.workspace}}/build + - name: configure + shell: bash + working-directory: ${{github.workspace}}/build + run: | + if [ "$RUNNER_OS" == "Windows" ]; then + export CC=${{ matrix.config.cc }} + export CXX=${{ matrix.config.cxx }} + export AR=${{ matrix.config.ar }} + export WINDRES=${{ matrix.config.windres }} + fi + cmake $GITHUB_WORKSPACE \ + -DCMAKE_BUILD_TYPE=${{ matrix.config.build_type }} \ + -DCMAKE_C_COMPILER=${{ matrix.config.cc }} \ + -DCMAKE_CXX_COMPILER=${{ matrix.config.cxx }} \ + -DCMAKE_CXX_FLAGS="-Werror" -DUNITTEST=1 \ + ${{ matrix.config.cmake_extra_flags }} \ + ${{ github.event.inputs.cmake_flags }} + - name: build + shell: bash + working-directory: ${{github.workspace}}/build + run: | + if [ "$RUNNER_OS" == "Windows" ]; then + export CC=${{ matrix.config.cc }} + export CXX=${{ matrix.config.cxx }} + export AR=${{ matrix.config.ar }} + export WINDRES=${{ matrix.config.windres }} + fi + cmake --build . --config ${{ matrix.config.build_type }} \ + ${{ github.event.inputs.cmake_flags }} + - name: test + continue-on-error: true + shell: bash + working-directory: ${{github.workspace}}/build + run: | + ctest -C ${{ matrix.config.build_type }} \ + --parallel 2 --output-on-failure \ + ${{ github.event.inputs.cmake_flags }} + - name: package + shell: bash + working-directory: ${{github.workspace}}/build + run: | + if [ "$RUNNER_OS" == "Windows" ] || [ "$RUNNER_OS" == "macOS" ]; then + make package + fi + - name: archive binary + uses: actions/upload-artifact@v4 + with: + name: direwolf_${{ matrix.config.os }}_${{ matrix.config.arch }}_${{ github.sha }} + path: | + ${{github.workspace}}/build/direwolf-*.zip + ${{github.workspace}}/build/direwolf.conf + ${{github.workspace}}/build/src/* + ${{github.workspace}}/build/CMakeCache.txt + !${{github.workspace}}/build/src/cmake_install.cmake + !${{github.workspace}}/build/src/CMakeFiles + !${{github.workspace}}/build/src/Makefile diff --git a/.github/workflows/codeql-analysis-python.yml b/.github/workflows/codeql-analysis-python.yml new file mode 100644 index 00000000..a47a8f8d --- /dev/null +++ b/.github/workflows/codeql-analysis-python.yml @@ -0,0 +1,64 @@ +# For most projects, this workflow file will not need changing; you simply need +# to commit it to your repository. +# +# You may wish to alter this file to override the set of languages analyzed, +# or to provide custom queries or build logic. +# +# ******** NOTE ******** +# We have attempted to detect the languages in your repository. Please check +# the `language` matrix defined below to confirm you have the correct set of +# supported CodeQL languages. +# +name: "CodeQL - Python" + +on: + push: + branches: [ dev ] + pull_request: + # The branches below must be a subset of the branches above + branches: [ dev ] + schedule: + - cron: '25 8 * * 4' + +jobs: + analyze: + name: Analyze + runs-on: ubuntu-latest + permissions: + actions: read + contents: read + security-events: write + + strategy: + fail-fast: false + matrix: + language: [ 'python' ] + # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ] + # Learn more about CodeQL language support at https://git.io/codeql-language-support + + steps: + - name: Checkout repository + uses: actions/checkout@v3 + + # Initializes the CodeQL tools for scanning. + - name: Initialize CodeQL + uses: github/codeql-action/init@v3 + with: + languages: ${{ matrix.language }} + setup-python-dependencies: true + # If you wish to specify custom queries, you can do so here or in a config file. + # By default, queries listed here will override any specified in a config file. + # Prefix the list here with "+" to use these queries and those in the config file. + # queries: ./path/to/local/query, your-org/your-repo/queries@main + + # Autobuild attempts to build any compiled languages (C/C++, C#, or Java). + # If this step fails, then you should remove it and run the build manually (see below) + - name: Autobuild + uses: github/codeql-action/autobuild@v3 + + # â„¹ï¸ Command-line programs to run using the OS shell. + # 📚 https://git.io/JvXDl + + + - name: Perform CodeQL Analysis + uses: github/codeql-action/analyze@v3 diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml new file mode 100644 index 00000000..a86300f3 --- /dev/null +++ b/.github/workflows/codeql-analysis.yml @@ -0,0 +1,74 @@ +# For most projects, this workflow file will not need changing; you simply need +# to commit it to your repository. +# +# You may wish to alter this file to override the set of languages analyzed, +# or to provide custom queries or build logic. +# +# ******** NOTE ******** +# We have attempted to detect the languages in your repository. Please check +# the `language` matrix defined below to confirm you have the correct set of +# supported CodeQL languages. +# +name: "CodeQL - CPP" + +on: + push: + branches: [ dev ] + pull_request: + # The branches below must be a subset of the branches above + branches: [ dev ] + schedule: + - cron: '25 8 * * 4' + +jobs: + analyze: + name: Analyze + runs-on: ubuntu-latest + permissions: + actions: read + contents: read + security-events: write + + strategy: + fail-fast: false + matrix: + language: [ 'cpp' ] + # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ] + # Learn more about CodeQL language support at https://git.io/codeql-language-support + + steps: + - name: Checkout repository + uses: actions/checkout@v3 + + # Initializes the CodeQL tools for scanning. + - name: Initialize CodeQL + uses: github/codeql-action/init@v3 + with: + languages: ${{ matrix.language }} + setup-python-dependencies: true + # If you wish to specify custom queries, you can do so here or in a config file. + # By default, queries listed here will override any specified in a config file. + # Prefix the list here with "+" to use these queries and those in the config file. + # queries: ./path/to/local/query, your-org/your-repo/queries@main + + # Autobuild attempts to build any compiled languages (C/C++, C#, or Java). + # If this step fails, then you should remove it and run the build manually (see below) + - name: Autobuild + uses: github/codeql-action/autobuild@v3 + + # â„¹ï¸ Command-line programs to run using the OS shell. + # 📚 https://git.io/JvXDl + + # âœï¸ If the Autobuild fails above, remove it and uncomment the following three lines + # and modify them (or add more) to build your code if your project + # uses a compiled language + + - run: | + mkdir build + cd build + cmake -DUNITTEST=1 .. + make + make test + + - name: Perform CodeQL Analysis + uses: github/codeql-action/analyze@v3 diff --git a/.gitignore b/.gitignore index 23228642..659c845b 100644 --- a/.gitignore +++ b/.gitignore @@ -6,6 +6,8 @@ z* *~ *.xlsx *.stackdump +*.wav + # Object files *.o @@ -37,6 +39,26 @@ z* *.x86_64 *.hex +# Binaries, other build results + +aclients +atest +decode_aprs +direwolf +gen_fff +gen_packets +ll2utm +log2gpx +text2tt +tt2text +ttcalc +utm2ll + +direwolf.conf +fsk_fast_filter.h +direwolf.desktop + + # ========================= # Operating System Files # ========================= @@ -83,3 +105,9 @@ $RECYCLE.BIN/ # Windows shortcuts *.lnk +/use_this_sdk +*.dSYM + +# cmake +build/ +tmp/ \ No newline at end of file diff --git a/APRStt-Implementation-Notes.pdf b/APRStt-Implementation-Notes.pdf deleted file mode 100644 index 31e50280..00000000 Binary files a/APRStt-Implementation-Notes.pdf and /dev/null differ diff --git a/CHANGES.md b/CHANGES.md new file mode 100644 index 00000000..4b78ca14 --- /dev/null +++ b/CHANGES.md @@ -0,0 +1,578 @@ + +# Revision History # + + +## Version 1.7 -- October 2023 ## + + +### New Documentation: ### + +Additional documentation location to slow down growth of main repository. [https://github.com/wb2osz/direwolf-doc](https://github.com/wb2osz/direwolf-doc) . These are more oriented toward achieving a goal and understanding, as opposed to the User Guide which describes the functionality. + +- ***APRS Digipeaters*** + +- ***Internal Packet Routing*** + +- ***Radio Interface Guide*** + +- ***Successful IGate Operation*** + +- ***Understanding APRS Packets*** + + +### New Features: ### + + + +- New ICHANNEL configuration option to map a KISS client application channel to APRS-IS. Packets from APRS-IS will be presented to client applications as the specified channel. Packets sent, by client applications, to that channel will go to APRS-IS rather than a radio channel. Details in ***Internal-Packet-Routing.pdf***. + +- New variable speed option for gen_packets. For example, "-v 5,0.1" would generate packets from 5% too slow to 5% too fast with increments of 0.1. Some implementations might have imprecise timing. Use this to test how well TNCs tolerate sloppy timing. + +- Improved Layer 2 Protocol [(IL2P)](https://en.wikipedia.org/wiki/FX.25_Forward_Error_Correction). Compatible with Nino TNC for 1200 and 9600 bps. Use "-I 1" on command line to enable transmit for first channel. For more general case, add to config file (simplified version, see User Guide for more details): + + > After: "CHANNEL 1" (or other channel) + > + > Add: "IL2PTX 1" + +- Limited support for CM108/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. You can specify a specific number of parity bytes (16, 32, 64) or 1 to choose automatically based on packet size. + + > After: "CHANNEL 1" (or other channel) + > + > Add: "FX25TX 1" (or 16 or 32 or 64) + + + +### Bugs Fixed: ### + +- The t/m packet filter incorrectly included bulletins. It now allows only "messages" to specific stations. Use of t/m is discouraged. i/180 is the preferred filter for messages to users recently heard locally. + +- Packet filtering now skips over any third party header before classifying packet types. + +- Fixed build for Alpine Linux. + +### Notes: ### + +The Windows binary distribution now uses gcc (MinGW) version 11.3.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. + +## 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. This was contributed by Davide Gerhard. + +- README.md has a quick summary of the process. More details in the ***User Guide***. + + +### New Features: ### + + +- "-X" option enables FX.25 transmission. FX.25 reception is always enabled so you don't need to do anything special. "What is FX.25?" you might ask. It is forward error correction (FEC) added in a way that is completely compatible with an ordinary AX.25 frame. See new document ***AX25\_plus\_FEC\_equals\_FX25.pdf*** for details. + +- Receive AIS location data from ships. Enable by using "-B AIS" command line option or "MODEM AIS" in the configuration file. AIS NMEA sentences are encapsulated in APRS user-defined data with a "{DA" prefix. This uses 9600 bps so you need to use wide band audio, not what comes out of the speaker. There is also a "-A" option to generate APRS Object Reports. + +- Receive Emergency Alert System (EAS) Specific Area Message Encoding (SAME). Enable by using "-B EAS" command line option or "MODEM EAS" in the configuration file. EAS SAME messages are encapsulated in APRS user-defined data with a "{DE" prefix. This uses low speed AFSK so speaker output is fine. + +- "-t" option now accepts more values to accommodate inconsistent handling of text color control codes by different terminal emulators. The default, 1, should work with most modern terminal types. If the colors are not right, try "-t 9" to see the result of the different choices and pick the best one. If none of them look right, file a bug report and specify: operating system version (e.g. Raspbian Buster), terminal emulator type and version (e.g. LXTerminal 0.3.2). Include a screen capture. + + +- "-g" option to force G3RUH mode for lower speeds where a different modem type may be the default. + +- 2400 bps compatibility with MFJ-2400. See ***2400-4800-PSK-for-APRS-Packet-Radio.pdf*** for details + +- "atest -h" will display the frame in hexadecimal for closer inspection. + +- Add support for Multi-GNSS NMEA sentences. + + + +### Bugs Fixed: ### + +- Proper counting of frames in transmit queue for AGW protocol 'Y' command. + + + +### New Documentation: ### + +- ***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 (HRoT) - IoT over Ham Radio***](https://github.com/wb2osz/hrot) + +- [***EAS SAME to APRS Message Converter***](https://github.com/wb2osz/eas2aprs) + +- [***Dire Wolf PowerPoint Slide Show***](https://github.com/wb2osz/direwolf-presentation) + +### Notes: ### + +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. + + + +## Version 1.5 -- September 2018 ## + + +### New Features: ### + +- PTT using GPIO pin of CM108/CM119 (e.g. DMK URI, RB-USB RIM), Linux only. + +- More efficient error recovery for AX.25 connected mode. Better generation and processing of REJ and SREJ to reduce unnecessary duplicate "**I**" frames. + +- New configuration option, "**V20**", for listing stations known to not understand AX.25 v2.2. This will speed up connection by going right to SABM and not trying SABME first and failing. + +- New "**NOXID**" configuration file option to avoid sending XID command to listed station(s). If other end is a partial v2.2 implementation, which recognizes SABME, but not XID, we would waste a lot of time resending XID many times before giving up. This is less drastic than the "**V20**" option which doesn't even attempt to use v2.2 with listed station(s). + +- New application "**kissutil**" for troubleshooting a KISS TNC or interfacing to an application via files. + +- KISS "Set Hardware" command to report transmit queue length. + +- TCP KISS can now handle multiple concurrent applications. + +- Linux can use serial port for KISS in addition to a pseudo terminal. + +- decode_aprs utility can now accept KISS frames and AX.25 frames as series of two digit hexadecimal numbers. + +- Full Duplex operation. (Put "FULLDUP ON" in channel section of configuration file.) + +- Time slots for beaconing. + +- Allow single log file with fixed name rather than starting a new one each day. + + + +### Bugs Fixed: ### + +- Possible crash when CDIGIPEAT did not include the optional alias. + +- PACLEN configuration item no longer restricts length of received frames. + +- Strange failures when trying to use multiple KISS client applications over TCP. Only Linux was affected. + +- Under certain conditions, outgoing connected mode data would get stuck in a queue and not be transmitted. This could happen if client application sends a burst of data larger than the "window" size (MAXFRAME or EMAXFRAME option). + + +- Little typographical / spelling errors in messages. + + +### Documentation: ### + + +- New document ***Bluetooth-KISS-TNC.pdf*** explaining how to use KISS over Bluetooth. + +- Updates describing cheap SDR frequency inaccuracy and how to compensate for it. + +### Notes: ### + +Windows binary distribution now uses gcc (MinGW) version 6.3.0. + +---------- + +## Version 1.4 -- April 2017 ## + + +### New Features: ### + +- AX.25 v2.2 connected mode. See chapter 10 of User Guide for details. + +- New client side packet filter to select "messages" only to stations that have been heard nearby recently. This is now the default if no IS to RF filter is specified. + +- New beacon type, IBEACON, for sending IGate statistics. + +- Expanded debug options so you can understand what is going on with packet filtering. + +- Added new document ***Successful-APRS-IGate-Operation.pdf*** with IGate background, configuration, and troubleshooting tips. +- 2400 & 4800 bps PSK modems. See ***2400-4800-PSK-for-APRS-Packet-Radio.pdf*** in the doc directory for discussion. + +- The top speed of 9600 bps has been increased to 38400. You will need a sound card capable of 96k or 192k samples per second for the higher rates. Radios must also have adequate bandwidth. See ***Going-beyond-9600-baud.pdf*** in the doc directory for more details. + +- Better decoder performance for 9600 and higher especially for low audio sample rate to baud ratios. + +- Generate waypoint sentences for use by AvMap G5 / G6 or other mapping devices or applications. Formats include + - $GPWPL - NMEA generic with only location and name. + - $PGRMW - Garmin, adds altitude, symbol, and comment to previously named waypoint. + - $PMGNWPL - Magellan, more complete for stationary objects. + - $PKWDWPL - Kenwood with APRS style symbol but missing comment. + + +- DTMF tones can be sent by putting "DTMF" in the destination address, similar to the way that Morse Code is sent. + +- Take advantage of new 'gpio' group and new /sys/class/gpio ownership in Raspbian Jessie. + +- Handle more complicated gpio naming for CubieBoard, etc. + +- More flexible dw-start.sh start up script for both GUI and CLI environments. + + + +### Bugs Fixed: ### + +- The transmitter (PTT control) was being turned off too soon when sending Morse Code. + +- The -qd (quiet decode) command line option now suppresses errors about improperly formed Telemetry packets. + +- Longer tocall.txt files can now be handled. + +- Sometimes kissattach would have an issue with the Dire Wolf pseudo terminal. This showed up most often on Raspbian but sometimes occurred with other versions of Linux. + + *kissattach: Error setting line discipline: TIOCSETD: Device or resource busy + Are you sure you have enabled MKISS support in the kernel + or, if you made it a module, that the module is loaded?* + + +- Sometimes writes to a pseudo terminal would block causing the received +frame processing thread to hang. The first thing you will notice is that +received frames are not being printed. After a while this message will appear: + + *Received frame queue is out of control. Length=... Reader thread is probably + frozen. This can be caused by using a pseudo terminal (direwolf -p) where + another application is not reading the frames from the other side.* + +- -p command line option caused segmentation fault with glibc >= 2.24. + + +- The Windows version 1.3 would crash when starting to transmit on Windows XP. There have also been some other reports of erratic behavior on Windows. The crashing problem was fixed in in the 1.3.1 patch release. Linux version was not affected. + +- IGate did not retain nul characters in the information part of a packet. This should never happen with a valid APRS packet but there are a couple cases where it has. If we encounter these malformed packets, pass them along as-is, rather than truncating. + +- Don't digipeat packets when the source is my call. + + + +---------- + +## Version 1.3 -- May 2016 ## + +### New Features: ### + +- Support for Mac OS X. + +- Many APRStt enhancements including: Morse code and speech responses to to APRStt tone sequences, new 5 digit callsign suffix abbreviation, +position ambiguity for latitude and longitude in object reports + +- APRS Telemetry Toolkit. + +- GPS Tracker beacons are now available for the Windows version. Previously this was only in the Linux version. + +- SATgate mode for IGate. Packets heard directly are delayed before being sent +to the Internet Server. This favors digipeated packets because the original +arrives later and gets dropped if there are duplicates. + +- Added support for hamlib. This provides more flexible options for PTT control. + +- Implemented AGW network protocol 'M' message for sending UNPROTO information without digipeater path. + + +- A list of all symbols available can be obtained with the -S +command line option. + +- Command line option "-a n" to print audio device statistics each n seconds. Previously this was always each 100 seconds on Linux and not available on Windows. + +### Bugs Fixed: ### + + + +- Fixed several cases where crashes were caused by unexpected packet contents: + + - When receiving packet with unexpected form of GPS NMEA sentence. + + - When receiving packet with comment of a few hundred characters. + + - Address in path, from Internet server, more than 9 characters. + +- "INTERNAL ERROR: dlq_append NULL packet pointer." when using PASSALL. + +- In Mac OSX version: Assertion failed: (adev[a].inbuf_size_in_bytes >= 100 && adev[a].inbuf_size_in_bytes <= 32768), function audio_get, file audio_portaudio.c, line 917. + +- Tracker beacons were not always updating the location properly. + +- AGW network protocol now works properly for big-endian processors +such as PowerPC or MIPS. + +- Packet filtering treated telemetry metadata as messages rather than telemetry. + +---------- + +## Version 1.2 -- June 2015 ## + +### New Features ### + +- Improved decoder performance. +Over 1000 error-free frames decoded from WA8LMF TNC Test CD. +See ***A-Better-APRS-Packet-Demodulator-Part-1-1200-baud.pdf*** for details. + +- Up to 3 soundcards and 6 radio channels can be handled at the same time. + +- New framework for applications which listen for Touch Tone commands +and respond with voice. A sample calculator application is included +as a starting point for building more interesting applications. +For example, if it hears the DTMF sequence "2*3*4#" it will respond +with the spoken words "Twenty Four." + +- Reduced latency for transfers to/from soundcards. + +- More accurate transmit PTT timing. + +- Packet filtering for digipeater and IGate. + +- New command line -q (quiet) option to suppress some types of output. + +- Attempted fixing of corrupted bits now works for 9600 baud. + +- Implemented AGW network protocol 'y' message so applications can +throttle generation of packets when sending a large file. + +- When using serial port RTS/DTR to activate transmitter, the two +control lines can now be driven with opposite polarity as required +by some interfaces. + +- Data Carrier Detect (DCD) can be sent to an output line (just +like PTT) to activate a carrier detect light. + +- Linux "man" pages for on-line documentation. + +- AGWPORT and KISSPORT can be set to 0 to disable the interfaces. + +- APRStt gateway enhancements: MGRS/USNG coordinates, new APRStt3 +format call, satellite grid squares. + + +### Bugs fixed ### + +- Fixed "gen_packets" so it now handles user-specified messages correctly. + +- Under some circumstances PTT would be held on long after the transmit +audio was finished. + + + +### Known problems ### + +- Sometimes writes to a pseudo terminal will block causing the received +frame processing thread to hang. The first thing you will notice is that +received frames are not being printed. After a while this message will appear: + + Received frame queue is out of control. Length=... Reader thread is probably + frozen. This can be caused by using a pseudo terminal (direwolf -p) where + another application is not reading the frames from the other side. + +----------- + +## Version 1.1 -- December 2014 ## + +### New Features ### + +- Logging of received packets and utility to convert log file +into GPX format. + +- AGW network port formerly allowed only one connection at a +time. It can now accept 3 client applications at the same time. +(Same has not yet been done for network KISS port.) + +- Frequency / offset / tone standard formats are now recognized. +Non-standard attempts, in the comment, are often detected and +a message suggests the correct format. + +- Telemetry is now recognized. Messages are printed for +usage that does not adhere to the published standard. + +- Tracker function transmits location from GPS position. +New configuration file options: TBEACON and SMARTBEACONING. +(For Linux only. Warning - has not been well tested.) + +- Experimental packet regeneration feature for HF use. +Will be documented later if proves to be useful... + +- Several enhancements for trying to fix incorrect CRC: +Additional types of attempts to fix a bad CRC. +Optimized code to reduce execution time. +Improved detection of duplicate packets from different fixup attempts. +Set limit on number of packets in fix up later queue. + +- Beacon positions can be specified in either latitude / longitude +or UTM coordinates. + +- It is still highly recommended, but no longer mandatory, that +beaconing be enabled for digipeating to work. + +* Bugs fixed: + +- For Windows version, maximum serial port was COM9. +It is now possible to use COM10 and higher. + +- Fixed issue with KISS protocol decoder state that showed up +only with "binary" data in packets (e.g. RMS Express). + +- An extra 00 byte was being appended to packets from AGW +network protocol 'K' messages. + +- Invalid data from an AGW client application could cause an +application crash. + +- OSS (audio interface for non-Linux versions of Unix) should +be better now. + +### Known problems ### + +- Sometimes kissattach fails to connect with "direwolf -p". +The User Guide and Raspberry Pi APRS document have a couple work-arounds. + +----------- + +## Version 1.0a -- May 2014 ## + +### Bug fixed ### + +- Beacons sent directly to IGate server had incorrect source address. + +----------- + +## Version 1.0 -- May 2014 ## + +### New Features ### + +- Received audio can be obtained with a UDP socket or stdin. +This can be used to take audio from software defined radios +such as rtl_fm or gqrx. + +- 9600 baud data rate. + +- New PBEACON and OBEACON configuration options. Previously +it was necessary to handcraft beacons. + +- Less CPU power required for 300 baud. This is important +if you want to run a bunch of decoders at the same time +to tolerate off-frequency HF SSB signals. + +- Improved support for UTF-8 character set. + +- Improved troubleshooting display for APRStt macros. + +- In earlier versions, the DTMF decoder was always active because it +took a negligible amount of CPU time. Unfortunately this sometimes +resulted in too many false positives from some other types of digital +transmissions heard on HF. Starting in version 1.0, the DTMF decoder +is enabled only when the APRStt gateway is configured. + + +----------- + +## Version 0.9 --November 2013 ## + +### New Features ### + +- Selection of non-default audio device for Linux ALSA. + +- Simplified audio device set up for Raspberry Pi. + +- GPIO lines can be used for PTT on suitable Linux systems. + +- Improved 1200 baud decoder. + +- Multiple decoders per channel to tolerate HF SSB signals off frequency. + +- Command line option "-t 0" to disable text colors. + +- APRStt macros which allow short numeric only touch tone +sequences to be processed as much longer predefined sequences. + + +### Bugs Fixed ### + +- Now works on 64 bit target. + +### New Restriction for Windows version ### + +- Minimum processor is now Pentium 3 or equivalent or later. +It's possible to run on something older but you will need +to rebuild it from source. + + +----------- + +## Version 0.8 -- August 2013 ## + +### New Features ### + +- Internet Gateway (IGate) including IPv6 support. + +- Compatibility with YAAC. + +- Preemptive digipeating option. + +- KISS TNC should now work with connected AX.25 protocols +(e.g. AX25 for Linux), not just APRS. + + +---------- + +## Version 0.7 -- March 2013 ## + +### New Features: ### + +- Added APRStt gateway capability. For details, see ***APRStt-Implementation-Notes.pdf*** + + +----------- + +## Version 0.6 -- February 2013 ## + +### New Features ### + +- Improved performance of AFSK demodulator. +Now decodes 965 frames from Track 2 of WA8LMF's TNC Test CD. + +- KISS protocol now available thru a TCP socket. +Default port is 8001. +Change it with KISSPORT option in configuration file. + +- Ability to salvage frames with bad FCS. +See section mentioning "bad apple" in the user guide. +Default of fixing 1 bit works well. +Fixing more bits not recommended because there is a high +probability of occasional corrupted data getting thru. + +- Added AGW "monitor" format messages. +Now compatible with APRS-TW for telemetry. + + +### Known Problem ### + +- The Linux (but not Cygwin) version eventually hangs if nothing is +reading from the KISS pseudo terminal. Some operating system +queue fills up, the application write blocks, and decoding stops. + + +### Workaround ### + +- If another application is not using the serial KISS interface, +run this in another window: + + tail -f /tmp/kisstnc + +----------- + +## Version 0.5 -- March 2012 ## + +- More error checking and messages for invalid APRS data. + +----------- + +## Version 0.4 -- September 2011 ## + +- First general availability. + diff --git a/CHANGES.txt b/CHANGES.txt deleted file mode 100644 index fa2fe310..00000000 --- a/CHANGES.txt +++ /dev/null @@ -1,246 +0,0 @@ ----------------- -Revision history ----------------- - - ------------ -Version 1.1 -- December 2014 ------------ - -* Changes since beta test version. - -It is still highly recommended, but no longer mandatory, that -beaconing be enabled for digipeating to work. - - -* Known problems. - -Sometimes kissattach fails to connect with "direwolf -p". -The User Guide and Raspberry Pi APRS document have a couple work-arounds. - - - ------------ -Version 1.1 -- Beta Test 1 -- November 2014 ------------ - -* New Features: - -Logging of received packets and utility to convert log file -into GPX format. - -AGW network port formerly allowed only one connection at a -time. It can now accept 3 client applications at the same time. -(Same has not yet been done for network KISS port.) - -Frequency / offset / tone standard formats are now recognized. -Non-standard attempts, in the comment, are often detected and -a message suggests the correct format. - -Telemetry is now recognized. Messages are printed for -usage that does not adhere to the published standard. - -Tracker function transmits location from GPS position. -New configuration file options: TBEACON and SMARTBEACONING. -(For Linux only. Warning - has not been well tested.) - -Experimental packet regeneration feature for HF use. -Will be documented later if proves to be useful... - -Several enhancements for trying to fix incorrect CRC. -- Additional types of attempts to fix a bad CRC. -- Optimized code to reduce execution time. -- Improved detection of duplicate packets from different fixup attempts. -- Set limit on number of packets in fix up later queue. - -Beacon positions can be specified in either latitude / longitude -or UTM coordinates. - - -* Bugs fixed: - -For Windows version, maximum serial port was COM9. -It is now possible to use COM10 and higher. - -Fixed issue with KISS protocol decoder state that showed up -only with "binary" data in packets (e.g. RMS Express). - -An extra 00 byte was being appended to packets from AGW -network protocol 'K' messages. - -Invalid data from an AGW client application could cause an -application crash. - -OSS (audio interface for non-Linux versions of Unix) should -be better now. - - ------------ -Version 1.0a May 2014 ------------ - -* Bug fix: - -Beacons sent directly to IGate server had incorrect source address. - - - ------------ -Version 1.0 May 2014 ------------ - -* New Features: - -Received audio can be obtained with a UDP socket or stdin. -This can be used to take audio from software defined radios -such as rtl_fm or gqrx. - -9600 baud data rate. - -New PBEACON and OBEACON configuration options. Previously -it was necessary to handcraft beacons. - -Less CPU power required for 300 baud. This is important -if you want to run a bunch of decoders at the same time -to tolerate off-frequency HF SSB signals. - -Improved support for UTF-8 character set. - -Improved troubleshooting display for APRStt macros. - -In earlier versions, the DTMF decoder was always active because it -took a negligible amount of CPU time. Unfortunately this sometimes -resulted in too many false positives from some other types of digital -transmissions heard on HF. Starting in version 1.0, the DTMF decoder -is enabled only when the APRStt gateway is configured. - - - - ------------ -Version 0.9 November 2013 ------------ - -* New Features: - -Selection of non-default audio device for Linux ALSA. - -Simplified audio device set up for Raspberry Pi. - -GPIO lines can be used for PTT on suitable Linux systems. - -Improved 1200 baud decoder. - -Multiple decoders per channel to tolerate HF SSB signals off frequency. - -Command line option "-t 0" to disable text colors. - -APRStt macros which allow short numeric only touch tone -sequences to be processed as much longer predefined sequences. - - - -* Bugs Fixed: - -Now works on 64 bit target. - - - -* New Restriction for Windows version: - -Minimum processor is now Pentium 3 or equivalent or later. -It's possible to run on something older but you will need -to rebuild it from source. - - - - ------------ -Version 0.8 August 2013 ------------ - -* New Features: - -Internet Gateway (IGate) including IPv6 support. - -Compatibility with YAAC. - -Preemptive digipeating option. - -KISS TNC should now work with connected AX.25 protocols -(e.g. AX25 for Linux), not just APRS. - - - ------------ -Version 0.7 March 2013 ------------ - -* New Features: - -Added APRStt gateway capability. For details, see: - -APRStt-Implementation-Notes.pdf - - - - ------------ -Version 0.6 February 2013 ------------ - - -* New Features: - -Improved performance of AFSK demodulator. -Now decodes 965 frames from Track 2 of WA8LMF’s TNC Test CD. - -KISS protocol now available thru a TCP socket. -Default port is 8001. -Change it with KISSPORT option in configuration file. - -Ability to salvage frames with bad FCS. -See section mentioning "bad apple" in the user guide. -Default of fixing 1 bit works well. -Fixing more bits not recommended because there is a high -probability of occasional corrupted data getting thru. - -Added AGW "monitor" format messages. -Now compatible with APRS-TW for telemetry. - - -* Bugs Fixed: - -None. - - - -* Known Problem: - -The Linux (but not Cygwin) version eventually hangs if nothing is -reading from the KISS pseudo terminal. Some operating system -queue fills up, the application write blocks, and decoding stops. - - -* Workaround: - -If another application is not using the serial KISS interface, -run this in another window: - - tail -f /tmp/kisstnc - - ------------ -Version 0.5 March 2012 ------------ - - -More error checking and messages for invalid APRS data. - - ------------ -Version 0.4 September 2011 ------------ - -First general availability. - diff --git a/CMakeLists.txt b/CMakeLists.txt new file mode 100644 index 00000000..182a9b4d --- /dev/null +++ b/CMakeLists.txt @@ -0,0 +1,414 @@ +cmake_minimum_required(VERSION 3.5.0) + +project(direwolf) + +# configure version +set(direwolf_VERSION_MAJOR "1") +set(direwolf_VERSION_MINOR "7") +set(direwolf_VERSION_PATCH "0") +set(direwolf_VERSION_SUFFIX "Development") + +# options +# 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) +# UNITTEST option must be after CMAKE_BUILT_TYPE + +# where cmake find custom modules +list(APPEND CMAKE_MODULE_PATH ${CMAKE_SOURCE_DIR}/cmake/modules) + +# fix c standard used on the project +set(CMAKE_C_STANDARD 99) + +# Set additional project information +set(COMPANY "wb2osz") +add_definitions("-DCOMPANY=\"${COMPANY}\"") +set(APPLICATION_NAME "Dire Wolf") +add_definitions("-DAPPLICATION_NAME=\"${APPLICATION_NAME}\"") +set(APPLICATION_MAINTAINER="John Langner, WB2OSZ") +set(COPYRIGHT "Copyright (c) 2019 John Langner, WB2OSZ. All rights reserved.") +add_definitions("-DCOPYRIGHT=\"${COPYRIGHT}\"") +set(IDENTIFIER "com.${COMPANY}.${APPLICATION_NAME}") +add_definitions("-DIDENTIFIER=\"${IDENTIFIER}\"") +# raspberry as only lxterminal not xterm +if(NOT (WIN32 OR CYGWIN)) + find_program(BINARY_TERMINAL_BIN lxterminal) + if(BINARY_TERMINAL_BIN) + set(APPLICATION_DESKTOP_EXEC "${BINARY_TERMINAL_BIN} -e ${CMAKE_PROJECT_NAME}") + else() + set(APPLICATION_DESKTOP_EXEC "xterm -e ${CMAKE_PROJECT_NAME}") + endif() +endif() + +find_package(Git) +if(GIT_FOUND AND EXISTS "${CMAKE_SOURCE_DIR}/.git/") + # we can also use `git describe --tags` + execute_process(COMMAND "${GIT_EXECUTABLE}" rev-parse --short HEAD + WORKING_DIRECTORY "${CMAKE_SOURCE_DIR}" + RESULT_VARIABLE res + OUTPUT_VARIABLE out + ERROR_QUIET + OUTPUT_STRIP_TRAILING_WHITESPACE) + if(NOT res) + string(REGEX REPLACE "^v([0-9]+)\.([0-9]+)\.([0-9]+)-" "" git_commit ${out}) + set(direwolf_VERSION_SUFFIX "-${git_commit}") + set(direwolf_VERSION_COMMIT "${git_commit}") + endif() +endif() + +# set variables +set(direwolf_VERSION "${direwolf_VERSION_MAJOR}.${direwolf_VERSION_MINOR}.${direwolf_VERSION_PATCH}${direwolf_VERSION_SUFFIX}") +message(STATUS "${APPLICATION_NAME} Version: ${direwolf_VERSION}") +add_definitions("-DIREWOLF_VERSION=\"${direwolf_VERSION}\"") +add_definitions("-DMAJOR_VERSION=${direwolf_VERSION_MAJOR}") +add_definitions("-DMINOR_VERSION=${direwolf_VERSION_MINOR}") +if(direwolf_VERSION_COMMIT) + add_definitions("-DEXTRA_VERSION=${direwolf_VERSION_COMMIT}") +endif() + +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") +set(CUSTOM_TELEMETRY_DIR "${CUSTOM_SCRIPTS_DIR}/telemetry-toolkit") +set(CUSTOM_CONF_DIR "${CMAKE_SOURCE_DIR}/conf") +set(CUSTOM_DOC_DIR "${CMAKE_SOURCE_DIR}/doc") +set(CUSTOM_MAN_DIR "${CMAKE_SOURCE_DIR}/man") +set(CUSTOM_TEST_DIR "${CMAKE_SOURCE_DIR}/test") +set(CUSTOM_TEST_SCRIPTS_DIR "${CUSTOM_TEST_DIR}/scripts") +set(CUSTOM_SHELL_SHABANG "#!/bin/sh -e") + +# cpack variables +set(CPACK_GENERATOR "ZIP") +set(CPACK_STRIP_FILES true) +set(CPACK_PACKAGE_NAME "${CMAKE_PROJECT_NAME}") +# 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 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 "") + set(CMAKE_BUILD_TYPE Release CACHE STRING "Build type" FORCE) +endif() +message(STATUS "Build type set to: ${CMAKE_BUILD_TYPE}") +message("CMake system: ${CMAKE_SYSTEM_NAME}") + +# Unittest should be on for dev builds and off for releases. +if(CMAKE_BUILD_TYPE MATCHES "Release") + option(UNITTEST "Build unittest binaries." OFF) +else() + option(UNITTEST "Build unittest binaries." ON) +endif() + +# set compiler +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 dependent variables +if(${CMAKE_SYSTEM_NAME} STREQUAL "Linux") + set(LINUX TRUE) + + 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 "FreeBSD") + set(FREEBSD TRUE) + 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") + else() + message(STATUS "Build for macOS target: ${CMAKE_OSX_DEPLOYMENT_TARGET}") + endif() + + # prepend path to find_*() + set(CMAKE_FIND_ROOT_PATH "/opt/local") + + 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(C_MSVC) + if (NOT VS2015 AND NOT VS2017 AND NOT VS2019) + message(FATAL_ERROR "You must use Microsoft Visual Studio 2015, 2017 or 2019 as compiler") + else() + # compile with full multicore + set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} /MP") + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /MP") + set(CUSTOM_SHELL_BIN "") + endif() + endif() +endif() + +if (C_CLANG OR C_GCC) + # _BSD_SOURCE is deprecated we need to use _DEFAULT_SOURCE. + # + # That works find for more modern compilers but we have issues with: + # Centos 7, gcc 4.8.5, glibc 2.17 + # Centos 6, gcc 4.4.7, glibc 2.12 + # + # CentOS 6 & 7: Without -D_BSD_SOURCE, we get Warning: Implicit declaration of + # functions alloca, cfmakeraw, scandir, setlinebuf, strcasecmp, strncasecmp, and strsep. + # When a function (like strsep) returns a pointer, the compiler instead assumes a 32 bit + # int and sign extends it out to be a 64 bit pointer. Use the pointer and Kaboom! + # + # CentOS 6: We have additional problem. Without -D_POSIX_C_SOURCE=199309L, we get + # implicit declaration of function clock_gettime and the linker can't find it. + # + # It turns out that -D_GNU_SOURCE can be used instead of both of those. For more information, + # see https://www.gnu.org/software/libc/manual/html_node/Feature-Test-Macros.html + # + # Why was this not an issue before? If gcc is used without the -std=c99 option, + # it is perfectly happy with clock_gettime, strsep, etc. but with the c99 option, it no longer + # recognizes a bunch of commonly used functions. Using _GNU_SOURCE, rather than _DEFAULT_SOURCE + # solves the problem for CentOS 6 & 7. This also makes -D_XOPEN_SOURCE= unnecessary. + # I hope it doesn't break with newer versions of glibc. + # + # 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() + # + # + # -lm is needed for functions in math.h + if (LINUX) + # We have another problem with CentOS 6. clock_gettime() is in librt so we need -lrt. + # The clock_* functions were moved into gnu libc for version 2.17. + # https://sourceware.org/ml/libc-announce/2012/msg00001.html + # If using gnu libc 2.17, or later, the -lrt is no longer needed but doesn't hurt. + # I'm making this conditional on LINUX because it is not needed for BSD and MacOSX. + link_libraries("-lrt -lm") + else() + link_libraries("-lm") + endif() +elseif (C_MSVC) + set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -W3 -MP ${EXTRA_FLAGS}") +endif() + +if (C_CLANG) + set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -ferror-limit=1") +elseif (C_GCC) + set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fmax-errors=1") +endif() + +# set installation directories +if (WIN32 OR CYGWIN) + set(INSTALL_BIN_DIR ".") + set(INSTALL_DOC_DIR "doc") + set(INSTALL_CONF_DIR ".") + set(INSTALL_SCRIPTS_DIR "scripts") + set(INSTALL_MAN_DIR "man") + set(INSTALL_DATA_DIR "data") +else() + set(INSTALL_BIN_DIR "bin") + set(INSTALL_DOC_DIR "share/doc/${CMAKE_PROJECT_NAME}") + set(INSTALL_CONF_DIR "${INSTALL_DOC_DIR}/conf") + set(INSTALL_SCRIPTS_DIR "${INSTALL_DOC_DIR}/scripts") + if(FREEBSD) + set(INSTALL_MAN_DIR "man/man1") + else() + set(INSTALL_MAN_DIR "share/man/man1") + endif() + set(INSTALL_DATA_DIR "share/${PROJECT_NAME}") +endif(WIN32 OR CYGWIN) + +# requirements + +include(CheckSymbolExists) + +# Some platforms provide their own strlcpy & strlcat. (BSD, MacOSX) +# Others don't so we provide our own. (Windows, most, but not all Linux) +# Here we detect whether these are provided by the OS and set a symbol +# so that: +# (1) libgps does not supply its own version. +# (2) we know whether we need to supply our own copy. +# +# This was all working fine until these were added to the gnu c library 2.38. +# References: +# - https://www.gnu.org/software/libc/sources.html +# - https://sourceware.org/git/?p=glibc.git;a=blob_plain;f=NEWS;hb=HEAD +# +# This test is not detecting them for glibc 2.38 resulting in a conflict. +# Why? Are they declared in a different file or in some strange way? +# +# This is how they are declared in include/string.h: +# +# extern __typeof (strlcpy) __strlcpy; +# libc_hidden_proto (__strlcpy) +# extern __typeof (strlcat) __strlcat; +# libc_hidden_proto (__strlcat) +# +# Apparently cmake does not recognize this style. +# Keep this here for BSD type systems where it behaves as expected. +# We will need to add a hack in direwolf.h to define these if glibc version >= 2.38. + +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) + +find_package(GPSD) +if(GPSD_FOUND) + set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -DENABLE_GPSD") +else() + set(GPSD_INCLUDE_DIRS "") + set(GPSD_LIBRARIES "") +endif() + +find_package(hamlib) +if(HAMLIB_FOUND) + set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -DUSE_HAMLIB") +else() + set(HAMLIB_INCLUDE_DIRS "") + set(HAMLIB_LIBRARIES "") +endif() + +if(LINUX) + find_package(ALSA REQUIRED) + if(ALSA_FOUND) + set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -DUSE_ALSA") + endif() + + find_package(udev) + if(UDEV_FOUND) + 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) + set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -DUSE_PORTAUDIO") + endif() + +else() + set(ALSA_INCLUDE_DIRS "") + 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 +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 +add_subdirectory(src) + +# ctest +if(UNITTEST) + message(STATUS "Build unit test binaries") + include(CTest) + enable_testing() + add_subdirectory(test) +endif(UNITTEST) + +# manage scripts +add_subdirectory(scripts) + +# manage config +add_subdirectory(conf) + +# install basic docs +install(FILES ${CMAKE_SOURCE_DIR}/CHANGES.md DESTINATION ${INSTALL_DOC_DIR}) +install(FILES ${CMAKE_SOURCE_DIR}/LICENSE DESTINATION ${INSTALL_DOC_DIR}) +install(FILES ${CMAKE_SOURCE_DIR}/external/LICENSE DESTINATION ${INSTALL_DOC_DIR}/external) +add_subdirectory(doc) +add_subdirectory(man) + +# install desktop link +if (LINUX OR FREEBSD) + install(FILES ${CMAKE_BINARY_DIR}/${CMAKE_PROJECT_NAME}.desktop DESTINATION share/applications) + install(FILES ${CMAKE_SOURCE_DIR}/cmake/cpack/${CMAKE_PROJECT_NAME}_icon.png DESTINATION share/pixmaps) +endif() + +############ uninstall target ################ +configure_file( + "${CMAKE_CURRENT_SOURCE_DIR}/cmake/include/uninstall.cmake.in" + "${CMAKE_CURRENT_BINARY_DIR}/uninstall.cmake" + IMMEDIATE @ONLY) + +add_custom_target(uninstall + COMMAND ${CMAKE_COMMAND} -P + ${CMAKE_CURRENT_BINARY_DIR}/uninstall.cmake) + +############ packaging ################ +add_subdirectory(cmake/cpack) diff --git a/LICENSE-dire-wolf.txt b/LICENSE similarity index 100% rename from LICENSE-dire-wolf.txt rename to LICENSE diff --git a/Makefile b/Makefile new file mode 100644 index 00000000..7b0dcf76 --- /dev/null +++ b/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 " " diff --git a/Makefile.linux b/Makefile.linux deleted file mode 100644 index 41526010..00000000 --- a/Makefile.linux +++ /dev/null @@ -1,341 +0,0 @@ -# -# Makefile for Linux version of Dire Wolf. -# - -all : direwolf decode_aprs text2tt tt2text ll2utm utm2ll aclients log2gpx - -CC = gcc - -# -# The DSP filters can be sped up considerably with the SSE -# instructions. The SSE instructions were introduced in 1999 -# with the Pentium III series. -# SSE2 instructions, added in 2000, don't seem to offer any advantage. -# -# Let's look at impact of various optimization levels. -# -# Benchmark results with Ubuntu gcc version 4.6.3, 32 bit platform. -# Intel(R) Celeron(R) CPU 2.53GHz. Appears to have only 32 bit instructions. -# -# seconds options, comments -# ------ ----------------- -# 123 -O2 -# 128 -O3 Slower than -O2 ? -# 123 -Ofast (should be same as -O3 -ffastmath) -# 126 -Ofast -march=pentium -# 88 -Ofast -msse -# 108 -Ofast -march=pentium -msse -# 88 -Ofast -march=pentium3 (this implies -msse) -# 89 -Ofast -march=pentium3 -msse -# -# -# Raspberry Pi, ARM11 (ARMv6 + VFP2) -# gcc (Debian 4.6.3-14+rpi1) 4.6.3 -# -# seconds options, comments -# ------ ----------------- -# 1015 -O2 -# 948 -O3 -# 928 -Ofast -# 937 -Ofast -fmpu=vfp (worse, no option for vfp2) -# -# Are we getting any vectorizing? -# - - - -# -# Release 0.9 added a new feature than can consume a lot of CPU -# power: multiple AFSK demodulators running in parallel. -# These spend a lot of time spinning around in little loops -# calculating the sums of products for the DSP filters. -# -# When gcc is generating code for a 32 bit x86 target, it -# assumes the ancient i386 processor. This is good for -# portability but bad for performance. -# -# The code can run considerably faster by taking advantage of -# the SSE instructions available in the Pentium 3 or later. -# Here we find out if the gcc compiler is generating code -# for the i386. If so, we add the option to assume we will -# have at least a Pentium 3 to run on. -# -# When generating code for the x86_64 target, it is automatically -# assumed that the SSE instructions are available. -# -# If you are using gcc version 4.6 or later, you might get a -# small improvement by using the new "-Ofast" option that is -# not available in older compilers. -# "-O3" is used here for compatibility with older compilers. -# -# You might also get some improvement by using "-march=native" -# to fine tune the application for your particular type of -# hardware. -# -# If you are planning to distribute the binary version to -# other people (in some ham radio software collection), avoid -# fine tuning it for your particular computer. It could -# cause compatibility issues for those with older computers. -# - -arch := $(shell echo | gcc -E -dM - | grep __i386__) - -ifneq ($(arch),) -# You might see improvement with -march fine tuned to your hardware. -# Probably should keep pentium3 if you will be redistributing binaries -# to other people. -CFLAGS := -O3 -march=pentium3 -pthread -Iutm -else -CFLAGS := -O3 -pthread -Iutm -endif - - - -# If you want to use OSS (for FreeBSD, OpenBSD) instead of -# ALSA (for Linux), comment out the two lines below. - -CFLAGS += -DUSE_ALSA -LDLIBS += -lasound - - -# Uncomment following lines to enable GPS interface & tracker function. - -#CFLAGS += -DENABLE_GPS -#LDLIBS += -lgps - - - -# Name of current directory. -# Used to generate zip file name for distribution. - -z=$(notdir ${CURDIR}) - - -# Main application. - -direwolf : direwolf.o config.o demod.o dsp.o demod_afsk.o demod_9600.o hdlc_rec.o \ - hdlc_rec2.o multi_modem.o redecode.o rdq.o rrbb.o \ - fcs_calc.o ax25_pad.o \ - decode_aprs.o symbols.o server.o kiss.o kissnet.o kiss_frame.o hdlc_send.o fcs_calc.o \ - gen_tone.o audio.o digipeater.o dedupe.o tq.o xmit.o \ - ptt.o beacon.o dwgps.o encode_aprs.o latlong.o encode_aprs.o latlong.o textcolor.o \ - dtmf.o aprs_tt.o tt_user.o tt_text.o igate.o nmea.o log.o telemetry.o \ - utm.a - $(CC) $(CFLAGS) -o $@ $^ -lpthread -lrt $(LDLIBS) -lm - - -# Optimization for slow processors. - -demod.o : fsk_fast_filter.h - -demod_afsk.o : fsk_fast_filter.h - - -fsk_fast_filter.h : demod_afsk.c - $(CC) $(CFLAGS) -o gen_fff -DGEN_FFF demod_afsk.c dsp.c textcolor.c -lm - ./gen_fff > fsk_fast_filter.h - - - -utm.a : LatLong-UTMconversion.o - ar -cr $@ $^ - -LatLong-UTMconversion.o : utm/LatLong-UTMconversion.c - $(CC) $(CFLAGS) -c -o $@ $^ - - -# Optional installation into /usr/local/... -# Needs to be run as root or with sudo. - -# TODO: Review file locations. - -install : direwolf decode_aprs tocalls.txt symbols-new.txt symbolsX.txt dw-icon.png direwolf.desktop - install direwolf /usr/local/bin - install decode_aprs /usr/local/bin - install text2tt /usr/local/bin - install tt2text /usr/local/bin - install ll2utm /usr/local/bin - install utm2ll /usr/local/bin - install aclients /usr/local/bin - install log2gpx /usr/local/bin - install -D --mode=644 tocalls.txt /usr/share/direwolf/tocalls.txt - install -D --mode=644 symbols-new.txt /usr/share/direwolf/symbols-new.txt - install -D --mode=644 symbolsX.txt /usr/share/direwolf/symbolsX.txt - install -D --mode=644 dw-icon.png /usr/share/direwolf/dw-icon.png - install -D --mode=644 direwolf.desktop /usr/share/applications/direwolf.desktop - install -D --mode=644 CHANGES.txt /usr/local/share/doc/direwolf/CHANGES.txt - install -D --mode=644 LICENSE-dire-wolf.txt /usr/local/share/doc/direwolf/LICENSE-dire-wolf.txt - install -D --mode=644 LICENSE-other.txt /usr/local/share/doc/direwolf/LICENSE-other.txt - install -D --mode=644 User-Guide.pdf /usr/local/share/doc/direwolf/User-Guide.pdf - install -D --mode=644 Raspberry-Pi-APRS.pdf /usr/local/share/doc/direwolf/Raspberry-Pi-APRS.pdf - install -D --mode=644 Raspberry-Pi-APRS-Tracker.pdf /usr/local/share/doc/direwolf/Raspberry-Pi-APRS-Tracker.pdf - install -D --mode=644 APRStt-Implementation-Notes.pdf /usr/local/share/doc/direwolf/APRStt-Implementation-Notes.pdf - install -D --mode=644 Quick-Start-Guide-Windows.pdf /usr/local/share/doc/direwolf/Quick-Start-Guide-Windows.pdf - - -# The Raspberry Pi has ~/Desktop but Ubuntu does not. - -# TODO: Handle Linux variations correctly. - - -install-rpi : dw-start.sh - cp dw-start.sh ~ - ln -f -s /usr/share/applications/direwolf.desktop ~/Desktop/direwolf.desktop - -install-conf : direwolf.conf - cp direwolf.conf ~ - - -# Separate application to decode raw data. - -decode_aprs : decode_aprs.c symbols.c ax25_pad.c textcolor.c fcs_calc.c latlong.c log.c telemetry.o - $(CC) $(CFLAGS) -o decode_aprs -DTEST $^ -lm - - - -# Convert between text and touch tone representation. - -text2tt : tt_text.c - $(CC) $(CFLAGS) -DENC_MAIN -o text2tt tt_text.c - -tt2text : tt_text.c - $(CC) $(CFLAGS) -DDEC_MAIN -o tt2text tt_text.c - - -# Convert between Latitude/Longitude and UTM coordinates. - -ll2utm : ll2utm.c utm.a - $(CC) $(CFLAGS) -o $@ $^ -lm - -utm2ll : utm2ll.c utm.a - $(CC) $(CFLAGS) -o $@ $^ -lm - - -# Convert from log file to GPX. - -log2gpx : log2gpx.c - $(CC) $(CFLAGS) -o $@ $^ -lm - - -# Test application to generate sound. - -gen_packets : gen_packets.c ax25_pad.c hdlc_send.c fcs_calc.c gen_tone.c textcolor.c - $(CC) $(CFLAGS) -o $@ $^ $(LDLIBS) -lm - -demod.o : tune.h -demod_afsk.o : tune.h -demod_9600.o : tune.h - -testagc : atest.c demod.c dsp.c demod_afsk.c demod_9600.c hdlc_rec.c hdlc_rec2.o multi_modem.o rrbb.o \ - fcs_calc.c ax25_pad.c decode_aprs.c telemetry.c latlong.c symbols.c tune.h textcolor.c - $(CC) $(CFLAGS) -o atest $^ -lm - ./atest 02_Track_2.wav | grep "packets decoded in" > atest.out - - -# Unit test for AFSK demodulator - - -atest : atest.c demod.c dsp.c demod_afsk.c demod_9600.c hdlc_rec.c hdlc_rec2.o multi_modem.o rrbb.o \ - fcs_calc.c ax25_pad.c decode_aprs.c telemetry.c latlong.c symbols.c textcolor.c - $(CC) $(CFLAGS) -o $@ $^ -lm -lrt - time ./atest ../direwolf-0.2/02_Track_2.wav - -# Unit test for inner digipeater algorithm - - -dtest : digipeater.c ax25_pad.c dedupe.c fcs_calc.c tq.c textcolor.c - $(CC) $(CFLAGS) -DTEST -o $@ $^ - ./dtest - - -# Unit test for IGate - - -itest : igate.c textcolor.c ax25_pad.c fcs_calc.c - $(CC) $(CFLAGS) -DITEST -o $@ $^ - ./itest - - -# Unit test for UDP reception with AFSK demodulator - -udptest : udp_test.c demod.c dsp.c demod_afsk.c demod_9600.c hdlc_rec.c hdlc_rec2.c multi_modem.c rrbb.c fcs_calc.c ax25_pad.c decode_aprs.c symbols.c textcolor.c - $(CC) $(CFLAGS) -o $@ $^ -lm -lrt - ./udptest - - -# Unit test for telemetry decoding. - - -etest : telemetry.c ax25_pad.c fcs_calc.c textcolor.c misc.a regex.a - $(CC) $(CFLAGS) -o $@ $^ -lm -lrt - ./etest - - -# Multiple AGWPE network or serial port clients to test TNCs side by side. - -aclients : aclients.c ax25_pad.c fcs_calc.c textcolor.c - $(CC) $(CFLAGS) -g -o $@ $^ - - -SRCS = direwolf.c demod.c dsp.c demod_afsk.c demod_9600.c hdlc_rec.c multi_modem.c fcs_calc.c ax25_pad.c decode_aprs.c symbols.c \ - server.c kiss.c kissnet.c kiss_frame.c hdlc_send.c fcs_calc.c gen_tone.c audio.c \ - digipeater.c dedupe.c tq.c xmit.c beacon.c encode_aprs.c latlong.c encode_aprs.c latlong.c telemetry.c log.c - - -depend : $(SRCS) - makedepend $(INCLUDES) $^ - - -clean : - rm -f direwolf decode_aprs text2tt tt2text ll2utm utm2ll fsk_fast_filter.h *.o *.a - echo " " > tune.h - - -# Package it up for distribution. - -dist-src : CHANGES.txt User-Guide.pdf Quick-Start-Guide-Windows.pdf Raspberry-Pi-APRS.pdf \ - Raspberry-Pi-APRS-Tracker.pdf direwolf.desktop dw-start.sh - rm -f fsk_fast_filter.h - echo " " > tune.h - rm -f ../$z-src.zip - (cd .. ; zip $z-src.zip $z/CHANGES.txt $z/LICENSE* \ - $z/User-Guide.pdf $z/Quick-Start-Guide-Windows.pdf $z/Raspberry-Pi-APRS.pdf Raspberry-Pi-APRS-Tracker.pdf \ - $z/Makefile* $z/*.c $z/*.h $z/regex/* $z/misc/* $z/utm/* \ - $z/*.conf $z/tocalls.txt $z/symbols-new.txt $z/symbolsX.txt \ - $z/dw-icon.png $z/dw-icon.rc $z/dw-icon.ico \ - $z/direwolf.desktop $z/dw-start.sh ) - - -#User-Guide.pdf : User-Guide.docx -# echo "***** User-Guide.pdf is out of date *****" - -#Quick-Start-Guide-Windows.pdf : Quick-Start-Guide-Windows.docx -# echo "***** Quick-Start-Guide-Windows.pdf is out of date *****" - -#Raspberry-Pi-APRS.pdf : Raspberry-Pi-APRS.docx -# echo "***** Raspberry-Pi-APRS.pdf is out of date *****" - -#Raspberry-Pi-APRS-Tracker.pdf : Raspberry-Pi-APRS-Tracker.docx -# echo "***** Raspberry-Pi-APRS-Tracker.pdf is out of date *****" - - -backup : - mkdir /cygdrive/e/backup-cygwin-home/`date +"%Y-%m-%d"` - cp -r . /cygdrive/e/backup-cygwin-home/`date +"%Y-%m-%d"` - -# -# The locations below appear to be the most recent. -# The copy at http://www.aprs.org/tocalls.txt is out of date. -# - -tocalls-symbols : - wget http://www.aprs.org/aprs11/tocalls.txt -O tocalls.txt - wget http://www.aprs.org/symbols/symbols-new.txt -O symbols-new.txt - wget http://www.aprs.org/symbols/symbolsX.txt -O symbolsX.txt - - -# -# The following is updated by "make depend" -# -# DO NOT DELETE - diff --git a/Makefile.win b/Makefile.win deleted file mode 100644 index a9b85f79..00000000 --- a/Makefile.win +++ /dev/null @@ -1,354 +0,0 @@ -# -# Makefile for native Windows version of Dire Wolf. -# -# -# This is built in the Cygwin environment but with the -# compiler from http://www.mingw.org/ so there is no -# dependency on extra DLLs. -# -# The MinGW/bin directory must be in the PATH for the -# compiler. e.g. export PATH=/cygdrive/c/MinGW/bin:$PATH -# -# Failure to have the path set correctly will result in the -# obscure message: Makefile.win:... recipe for target ... failed. -# -# Type "which gcc" to make sure you are getting the right one! -# - - -all : direwolf decode_aprs text2tt tt2text ll2utm utm2ll aclients log2gpx - - -# People say we need -mthreads option for threads to work properly. -# They also say it creates a dependency on mingwm10.dll but I'm not seeing that. - -#TODO: put -Ofast back in. - -CC = gcc -#CFLAGS = -g -Wall -Ofast -march=pentium3 -msse -Iregex -Iutm -mthreads -DUSE_REGEX_STATIC -CFLAGS = -g -Wall -march=pentium3 -msse -Iregex -Iutm -mthreads -DUSE_REGEX_STATIC -AR = ar - - -# -# Let's see impact of various optimization levels. -# Benchmark results with MinGW gcc version 4.6.2. -# -# seconds options, comments -# ------ ----------------- -# 119.8 -O2 Used for version 0.8 -# 92.1 -O3 -# 88.7 -Ofast (should be same as -O3 -ffastmath) -# 87.5 -Ofast -march=pentium -# 74.1 -Ofast -msse -# 72.2 -Ofast -march=pentium -msse -# 62.0 -Ofast -march=pentium3 (this implies -msse) -# 61.9 -Ofast -march=pentium3 -msse -# -# A minimum of Windows XP is required due to some of the system -# features being used. XP requires a Pentium processor or later. -# The DSP filters can be sped up considerably with the SSE instructions. -# The SSE instructions were introduced in 1999 with the -# Pentium III series. -# SSE2 instructions, added in 2000, don't seem to offer any advantage. -# -# For version 0.9, a Pentium 3 or equivalent is now the minimum required -# for the prebuilt Windows distribution. -# If you insist on using a computer from the previous century, -# you can compile this yourself with different options. -# - -# Name of zip file for distribution. - -z=$(notdir ${CURDIR}) - - - -# Main application. - -demod.o : fsk_demod_state.h -demod_9600.o : fsk_demod_state.h -demod_afsk.o : fsk_demod_state.h - - -direwolf : direwolf.o config.o demod.o dsp.o demod_afsk.o demod_9600.o hdlc_rec.o \ - hdlc_rec2.o multi_modem.o redecode.o rdq.o rrbb.o \ - fcs_calc.o ax25_pad.o \ - decode_aprs.o symbols.o server.o kiss.o kissnet.o kiss_frame.o hdlc_send.o fcs_calc.o \ - gen_tone.o audio_win.o digipeater.o dedupe.o tq.o xmit.o \ - ptt.o beacon.o dwgps.o encode_aprs.o latlong.o textcolor.o \ - dtmf.o aprs_tt.o tt_user.o tt_text.o igate.o nmea.o log.o telemetry.o \ - dw-icon.o regex.a misc.a utm.a - $(CC) $(CFLAGS) -g -o $@ $^ -lwinmm -lws2_32 - -dw-icon.o : dw-icon.rc dw-icon.ico - windres dw-icon.rc -o $@ - - -# Optimization for slow processors. - -demod.o : fsk_fast_filter.h - -demod_afsk.o : fsk_fast_filter.h - - -fsk_fast_filter.h : demod_afsk.c - $(CC) $(CFLAGS) -o gen_fff -DGEN_FFF demod_afsk.c dsp.c textcolor.c - ./gen_fff > fsk_fast_filter.h - - -utm.a : LatLong-UTMconversion.o - ar -cr $@ $^ - -LatLong-UTMconversion.o : utm/LatLong-UTMconversion.c - $(CC) $(CFLAGS) -c -o $@ $^ - - -# -# When building for Linux, we use regular expression -# functions supplied by the gnu C library. -# For the native WIN32 version, we need to use our own copy. -# These were copied from http://gnuwin32.sourceforge.net/packages/regex.htm -# - -regex.a : regex.o - ar -cr $@ $^ - -regex.o : regex/regex.c - $(CC) $(CFLAGS) -Dbool=int -Dtrue=1 -Dfalse=0 -c -o $@ $^ - - -# There are also a couple other functions in the misc -# subdirectory that are missing on Windows. - -misc.a : strsep.o strtok_r.o strcasestr.o - ar -cr $@ $^ - -strsep.o : misc/strsep.c - $(CC) $(CFLAGS) -c -o $@ $^ - -strtok_r.o : misc/strtok_r.c - $(CC) $(CFLAGS) -c -o $@ $^ - -strcasestr.o : misc/strcasestr.c - $(CC) $(CFLAGS) -c -o $@ $^ - - - -# Separate application to decode raw data. - -decode_aprs : decode_aprs.c symbols.c ax25_pad.c textcolor.c fcs_calc.c latlong.c log.o telemetry.o regex.a misc.a utm.a - $(CC) $(CFLAGS) -o decode_aprs -DTEST $^ - - -# Convert between text and touch tone representation. - -text2tt : tt_text.c - $(CC) $(CFLAGS) -DENC_MAIN -o text2tt tt_text.c - -tt2text : tt_text.c - $(CC) $(CFLAGS) -DDEC_MAIN -o tt2text tt_text.c - - -# Convert between Latitude/Longitude and UTM coordinates. - -ll2utm : ll2utm.c utm.a - $(CC) $(CFLAGS) -o $@ $^ - -utm2ll : utm2ll.c utm.a - $(CC) $(CFLAGS) -o $@ $^ - - -# Convert from log file to GPX. - -log2gpx : log2gpx.c misc/strsep.c misc/strtok_r.c - $(CC) $(CFLAGS) -o $@ $^ - - -# Test application to generate sound. - -gen_packets : gen_packets.o ax25_pad.o hdlc_send.o fcs_calc.o gen_tone.o textcolor.o misc.a regex.a - $(CC) $(CFLAGS) -o $@ $^ - -# For tweaking the demodulator. - -demod.o : tune.h -demod_9600.o : tune.h -demod_afsk.o : tune.h - - -testagc : atest.c demod.c dsp.c demod_afsk.c demod_9600.c hdlc_rec.c hdlc_rec2.c multi_modem.c \ - rrbb.c fcs_calc.c ax25_pad.c decode_aprs.c symbols.c textcolor.c telemetry.c regex.a misc.a \ - fsk_demod_agc.h - rm -f atest.exe - $(CC) $(CFLAGS) -DNOFIX -o atest $^ - ./atest ../direwolf-0.2/02_Track_2.wav | grep "packets decoded in" >atest.out - - -noisy3.wav : gen_packets - ./gen_packets -B 300 -n 100 -o noisy3.wav - -testagc3 : atest.c demod.c dsp.c demod_afsk.c demod_9600.c hdlc_rec.c hdlc_rec2.c multi_modem.c \ - rrbb.c fcs_calc.c ax25_pad.c decode_aprs.c symbols.c textcolor.c telemetry.c regex.a misc.a \ - tune.h - rm -f atest.exe - $(CC) $(CFLAGS) -o atest $^ - ./atest -B 300 -P D -D 3 noisy3.wav | grep "packets decoded in" >atest.out - - -noisy96.wav : gen_packets - ./gen_packets -B 9600 -n 100 -o noisy96.wav - -testagc9 : atest.c demod.c dsp.c demod_afsk.c demod_9600.c hdlc_rec.c hdlc_rec2.c multi_modem.c \ - rrbb.c fcs_calc.c ax25_pad.c decode_aprs.c symbols.c textcolor.c telemetry.c regex.a misc.a \ - tune.h - rm -f atest.exe - $(CC) $(CFLAGS) -o atest $^ - ./atest -B 9600 ../walkabout9600.wav | grep "packets decoded in" >atest.out - #./atest -B 9600 noisy96.wav | grep "packets decoded in" >atest.out - - -# Unit test for AFSK demodulator - - -atest : atest.c demod.c dsp.c demod_afsk.c demod_9600.c hdlc_rec.c hdlc_rec2.c multi_modem.c \ - rrbb.c fcs_calc.c ax25_pad.c decode_aprs.c latlong.c symbols.c textcolor.c telemetry.c misc.a regex.a \ - fsk_fast_filter.h - $(CC) $(CFLAGS) -o $@ $^ - echo " " > tune.h - ./atest ..\\direwolf-0.2\\02_Track_2.wav - -atest9 : atest.c demod.c dsp.c demod_afsk.c demod_9600.c hdlc_rec.c hdlc_rec2.c multi_modem.c \ - rrbb.c fcs_calc.c ax25_pad.c decode_aprs.c latlong.c symbols.c textcolor.c telemetry.c misc.a regex.a \ - fsk_fast_filter.h - $(CC) $(CFLAGS) -o $@ $^ - ./atest9 -B 9600 ../walkabout9600.wav | grep "packets decoded in" >atest.out - #./atest9 -B 9600 noise96.wav - - -# Unit test for inner digipeater algorithm - - -dtest : digipeater.c ax25_pad.c dedupe.c fcs_calc.c tq.c textcolor.c misc.a regex.a - $(CC) $(CFLAGS) -DTEST -o $@ $^ - ./dtest - rm dtest.exe - -# Unit test for APRStt. - -ttest : aprs_tt.c tt_text.c misc.a utm.a - $(CC) $(CFLAGS) -DTT_MAIN -o ttest aprs_tt.c tt_text.c misc.a utm.a - - -# Unit test for IGate - -itest : igate.c textcolor.c ax25_pad.c fcs_calc.c misc.a regex.a - $(CC) $(CFLAGS) -DITEST -g -o $@ $^ -lwinmm -lws2_32 - - -# Unit test for UDP reception with AFSK demodulator - -udptest : udp_test.c demod.c dsp.c demod_afsk.c demod_9600.c hdlc_rec.c hdlc_rec2.c multi_modem.c rrbb.c fcs_calc.c ax25_pad.c decode_aprs.c symbols.c textcolor.c - $(CC) $(CFLAGS) -o $@ $^ -lm -lrt - ./udptest - - -# Unit test for telemetry decoding. - - -etest : telemetry.c ax25_pad.c fcs_calc.c textcolor.c misc.a regex.a - $(CC) $(CFLAGS) -DTEST -o $@ $^ - ./etest - - -# Multiple AGWPE network or serial port clients to test TNCs side by side. - -aclients : aclients.c ax25_pad.c fcs_calc.c textcolor.c misc.a regex.a - $(CC) $(CFLAGS) -g -o $@ $^ -lwinmm -lws2_32 - - -SRCS = direwolf.c demod.c dsp.c demod_afsk.c demod_9600.c hdlc_rec.c \ - hdlc_rec2.c multi_modem.c redecode.c rdq.c rrbb.c \ - fcs_calc.c ax25_pad.c decode_aprs.c symbols.c \ - server.c kiss.c kissnet.c kiss_frame.c hdlc_send.c fcs_calc.c gen_tone.c audio_win.c \ - digipeater.c dedupe.c tq.c xmit.c beacon.c \ - encode_aprs.c latlong.c telemetry.c \ - dtmf.c aprs_tt.c tt_text.c igate.c - - -depend : $(SRCS) - makedepend $(INCLUDES) $^ - - -clean : - rm -f *.o *.a *.exe fsk_fast_filter.h noisy96.wav - echo " " > tune.h - - -# Package it up for distribution: Prebuilt Windows & source versions. - - -dist-win : direwolf.exe decode_aprs.exe CHANGES.txt User-Guide.pdf Quick-Start-Guide-Windows.pdf \ - Raspberry-Pi-APRS.pdf Raspberry-Pi-APRS-Tracker.pdf APRStt-Implementation-Notes.pdf - rm -f ../$z-win.zip - zip ../$z-win.zip CHANGES.txt User-Guide.pdf Quick-Start-Guide-Windows.pdf \ - Raspberry-Pi-APRS.pdf Raspberry-Pi-APRS-Tracker.pdf APRStt-Implementation-Notes.pdf LICENSE* *.conf \ - direwolf.exe decode_aprs.exe tocalls.txt symbols-new.txt symbolsX.txt \ - text2tt.exe tt2text.exe ll2utm.exe utm2ll.exe aclients.exe log2gpx.exe - -dist-src : CHANGES.txt User-Guide.pdf Quick-Start-Guide-Windows.pdf Raspberry-Pi-APRS.pdf \ - Raspberry-Pi-APRS-Tracker.pdf APRStt-Implementation-Notes.pdf \ - direwolf.desktop dw-start.sh \ - tocalls.txt symbols-new.txt symbolsX.txt - rm -f fsk_fast_filter.h - echo " " > tune.h - rm -f ../$z-src.zip - (cd .. ; zip $z-src.zip \ - $z/CHANGES.txt $z/LICENSE* \ - $z/User-Guide.pdf $z/Quick-Start-Guide-Windows.pdf \ - $z/Raspberry-Pi-APRS.pdf $z/Raspberry-Pi-APRS-Tracker.pdf $z/APRStt-Implementation-Notes.pdf \ - $z/Makefile* $z/*.c $z/*.h $z/regex/* $z/misc/* $z/utm/* \ - $z/*.conf $z/tocalls.txt $z/symbols-new.txt $z/symbolsX.txt \ - $z/dw-icon.png $z/dw-icon.rc $z/dw-icon.ico \ - $z/direwolf.desktop $z/dw-start.sh ) - - - -User-Guide.pdf : User-Guide.docx - echo "***** User-Guide.pdf is out of date *****" - -Quick-Start-Guide-Windows.pdf : Quick-Start-Guide-Windows.docx - echo "***** Quick-Start-Guide-Windows.pdf is out of date *****" - -Raspberry-Pi-APRS.pdf : Raspberry-Pi-APRS.docx - echo "***** Raspberry-Pi-APRS.pdf is out of date *****" - -Raspberry-Pi-APRS-Tracker.pdf : Raspberry-Pi-APRS-Tracker.docx - echo "***** Raspberry-Pi-APRS-Tracker.pdf is out of date *****" - - -APRStt-Implementation-Notes.pdf : APRStt-Implementation-Notes.docx - echo "***** APRStt-Implementation-Notes.pdf is out of date *****" - - -backup : - mkdir /cygdrive/e/backup-cygwin-home/`date +"%Y-%m-%d"` - cp -r . /cygdrive/e/backup-cygwin-home/`date +"%Y-%m-%d"` - -# -# The locations below appear to be the most recent. -# The copy at http://www.aprs.org/tocalls.txt is out of date. -# - -tocalls-symbols : - wget http://www.aprs.org/aprs11/tocalls.txt -O tocalls.txt - wget http://www.aprs.org/symbols/symbols-new.txt -O symbols-new.txt - wget http://www.aprs.org/symbols/symbolsX.txt -O symbolsX.txt - -# -# The following is updated by "make depend" -# -# DO NOT DELETE - - - diff --git a/Quick-Start-Guide-Windows.pdf b/Quick-Start-Guide-Windows.pdf deleted file mode 100644 index 6d155f0e..00000000 Binary files a/Quick-Start-Guide-Windows.pdf and /dev/null differ diff --git a/README.md b/README.md new file mode 100644 index 00000000..3006a1ef --- /dev/null +++ b/README.md @@ -0,0 +1,235 @@ + +# Dire Wolf # + +### Decoded Information from Radio Emissions for Windows Or Linux Fans ### + +In the early days of Amateur Packet Radio, it was necessary to use an expensive "Terminal Node Controller" (TNC) with specialized hardware. Those days are gone. You can now get better results at lower cost by connecting your radio to the "soundcard" interface of a computer and using software to decode the signals. + +Why waste $200 and settle for mediocre receive performance from a 1980's technology TNC using an old modem chip? Dire Wolf decodes over 1000 error-free frames from Track 2 of the [WA8LMF TNC Test CD](https://github.com/wb2osz/direwolf/tree/dev/doc/WA8LMF-TNC-Test-CD-Results.pdf), leaving all the hardware TNCs, and first generation "soundcard" modems, behind in the dust. + +![](tnc-test-cd-results.png) + +Dire Wolf includes [FX.25](https://en.wikipedia.org/wiki/FX.25_Forward_Error_Correction) which adds Forward Error Correction (FEC) in a way that is completely compatible with existing systems. If both ends are capable of FX.25, your information will continue to get through under conditions where regular AX.25 is completely useless. This was originally developed for satellites and is now seeing widespread use on HF. + +![](fx25.png) + +Version 1.7 adds [IL2P](https://en.wikipedia.org/wiki/Improved_Layer_2_Protocol), a different method of FEC with less overhead but it is not compatible with AX.25. + + + +### Dire Wolf is a modern software replacement for the old 1980's style TNC built with special hardware. ### + +Without any additional software, it can perform as: + + - APRS GPS Tracker + - Digipeater + - Internet Gateway (IGate) +- [APRStt](http://www.aprs.org/aprstt.html) gateway + + +It can also be used as a virtual TNC for other applications such as [APRSIS32](http://aprsisce.wikidot.com/), [Xastir](http://xastir.org/index.php/Main_Page), [APRS-TW](http://aprstw.blandranch.net/), [YAAC](http://www.ka2ddo.org/ka2ddo/YAAC.html), [PinPoint APRS](http://www.pinpointaprs.com/), [UI-View32](http://www.ui-view.net/),[UISS](http://users.belgacom.net/hamradio/uiss.htm), [Linux AX25](http://www.linux-ax25.org/wiki/Main_Page), [SARTrack](http://www.sartrack.co.nz/index.html), [Winlink Express (formerly known as RMS Express, formerly known as Winlink 2000 or WL2K)](http://www.winlink.org/RMSExpress), [BPQ32](http://www.cantab.net/users/john.wiseman/Documents/BPQ32.html), [Outpost PM](http://www.outpostpm.org/), [Ham Radio of Things](https://github.com/wb2osz/hrot), [Packet Compressed Sensing Imaging (PCSI)](https://maqifrnswa.github.io/PCSI/), and many others. + + +## Features & Benefits ## + +![](direwolf-block-diagram.png) + +### Dire Wolf includes: ### + + + +- **Beaconing, Tracker, Telemetry Toolkit.** + + Send periodic beacons to provide information to others. For tracking the location is provided by a GPS receiver. + Build your own telemetry applications with the toolkit. + + +- **APRStt Gateway.** + + Very few hams have portable equipment for APRS but nearly everyone has a handheld radio that can send DTMF tones. APRStt allows a user, equipped with only DTMF (commonly known as Touch Tone) generation capability, to enter information into the global APRS data network. Responses can be sent by Morse Code or synthesized speech. + +- **Digipeaters for APRS and traditional Packet Radio.** + + Extend the range of other stations by re-transmitting their signals. Unmatched flexibility for cross band repeating and filtering to limit what is retransmitted. + +- **Internet Gateway (IGate).** + + IGate stations allow communication between disjoint radio networks by allowing some content to flow between them over the Internet. + +- **Ham Radio of Things (HRoT).** + + There have been occasional mentions of merging Ham Radio with the Internet of Things but only ad hoc incompatible narrowly focused applications. Here is a proposal for a standardized more flexible method so different systems can communicate with each other. + + [Ham Radio of Things - IoT over Ham Radio](https://github.com/wb2osz/hrot) + +- **AX.25 v2.2 Link Layer.** + + Traditional connected mode packet radio where the TNC automatically retries transmissions and delivers data in the right order. + +- **KISS Interface (TCP/IP, serial port, Bluetooth) & AGW network Interface (TCP/IP).** + + Dire Wolf can be used as a virtual TNC for applications such as [APRSIS32](http://aprsisce.wikidot.com/), [Xastir](http://xastir.org/index.php/Main_Page), [APRS-TW](http://aprstw.blandranch.net/), [YAAC](http://www.ka2ddo.org/ka2ddo/YAAC.html), [PinPoint APRS](http://www.pinpointaprs.com/), [UI-View32](http://www.ui-view.net/),[UISS](http://users.belgacom.net/hamradio/uiss.htm), [Linux AX25](http://www.linux-ax25.org/wiki/Main_Page), [SARTrack](http://www.sartrack.co.nz/index.html), [Winlink Express (formerly known as RMS Express, formerly known as Winlink 2000 or WL2K)](http://www.winlink.org/RMSExpress), [BPQ32](http://www.cantab.net/users/john.wiseman/Documents/BPQ32.html), [Outpost PM](http://www.outpostpm.org/), [Ham Radio of Things](https://github.com/wb2osz/hrot), [Packet Compressed Sensing Imaging (PCSI)](https://maqifrnswa.github.io/PCSI/), and many others. + +### Radio Interfaces: ### + +- **Uses computer's "soundcard" and digital signal processing.** + + Lower cost and better performance than specialized hardware. + + Compatible interfaces include [DRAWS](http://nwdigitalradio.com/draws/), [UDRC](https://nw-digital-radio.groups.io/g/udrc/wiki/UDRC%E2%84%A2-and-Direwolf-Packet-Modem), [SignaLink USB](http://www.tigertronics.com/slusbmain.htm), [DMK URI](http://www.dmkeng.com/URI_Order_Page.htm), [RB-USB RIM](http://www.repeater-builder.com/products/usb-rim-lite.html), [RA-35](http://www.masterscommunications.com/products/radio-adapter/ra35.html), [DINAH](https://hamprojects.info/dinah/), [SHARI](https://hamprojects.info/shari/), and many others. + + + +- **Modems:** + + 300 bps AFSK for HF + + 1200 bps AFSK most common for VHF/UHF + + 2400 & 4800 bps PSK + + 9600 bps GMSK/G3RUH + + AIS reception + + EAS SAME reception + + + +- **DTMF ("Touch Tone") Decoding and Encoding.** + +- **Speech Synthesizer interface & Morse code generator.** + + Transmit human understandable messages. + +- **Compatible with Software Defined Radios such as gqrx, rtl_fm, and SDR#.** + +- **Concurrent operation with up to 3 soundcards and 6 radios.** + +### Portable & Open Source: ### + +- **Runs on Windows, Linux (PC/laptop, Raspberry Pi, etc.), Mac OSX.** + + + +## Documentation ## + + +[Stable Version](https://github.com/wb2osz/direwolf/tree/master/doc) + +[Latest Development Version ("dev" branch)](https://github.com/wb2osz/direwolf/tree/dev/doc) + +[Additional Topics](https://github.com/wb2osz/direwolf-doc) + +[Power Point presentations](https://github.com/wb2osz/direwolf-presentation) -- Why not give a talk at a local club meeting? + +Youtube has many interesting and helpful videos. Searching for [direwolf tnc](https://www.youtube.com/results?search_query=direwolf+tnc) or [direwolf aprs](https://www.youtube.com/results?search_query=direwolf+aprs) will produce the most relevant results. + +## Installation ## + +### Windows ### + +Go to the [**releases** page](https://github.com/wb2osz/direwolf/releases). Download a zip file with "win" in its name, unzip it, and run direwolf.exe from a command window. + +You can also build it yourself from source. For more details see the **User Guide** in the [**doc** directory](https://github.com/wb2osz/direwolf/tree/master/doc). + + + + +### Linux - Using git clone (recommended) ### + +***Note that this has changed for version 1.6. There are now a couple extra steps.*** + + +First you will need to install some software development packages using different commands depending on your flavor of Linux. +In most cases, the first few will already be there and the package installer will tell you that installation is not necessary. + +On Debian / Ubuntu / Raspbian / Raspberry Pi OS: + + sudo apt-get install git + sudo apt-get install gcc + sudo apt-get install g++ + sudo apt-get install make + sudo apt-get install cmake + sudo apt-get install libasound2-dev + sudo apt-get install libudev-dev + sudo apt-get install libavahi-client-dev + +Or on Red Hat / Fedora / CentOS: + + sudo yum install git + sudo yum install gcc + sudo yum install gcc-c++ + sudo yum install make + sudo yum install alsa-lib-devel + sudo yum install libudev-devel + sudo yum install avahi-devel + +CentOS 6 & 7 currently have cmake 2.8 but we need 3.1 or later. +First you need to enable the EPEL repository. Add a symlink if you don't already have the older version and want to type cmake rather than cmake3. + + sudo yum install epel-release + sudo rpm -e cmake + sudo yum install cmake3 + sudo ln -s /usr/bin/cmake3 /usr/bin/cmake + +Then on any flavor of Linux: + + cd ~ + git clone https://www.github.com/wb2osz/direwolf + cd direwolf + git checkout dev + mkdir build && cd build + cmake .. + make -j4 + sudo make install + make install-conf + +This gives you the latest development version. Leave out the "git checkout dev" to get the most recent stable release. + +For more details see the **User Guide** in the [**doc** directory](https://github.com/wb2osz/direwolf/tree/master/doc). Special considerations for the Raspberry Pi are found in **Raspberry-Pi-APRS.pdf** + + +### Linux - Using apt-get (Debian flavor operating systems) ### + +Results will vary depending on your hardware platform and operating system version because it depends on various volunteers who perform the packaging. Expect the version to lag significantly behind development. + + sudo apt-get update + apt-cache showpkg direwolf + sudo apt-get install direwolf + + +### Linux - Using yum (Red Hat flavor operating systems) ### + +Results will vary depending on your hardware platform and operating system version because it depends on various volunteers who perform the packaging. Expect the version to lag significantly behind development. + + sudo yum check-update + sudo yum list direwolf + sudo yum install direwolf + + +### Macintosh OS X ### + +Read the **User Guide** in the [**doc** directory](https://github.com/wb2osz/direwolf/tree/master/doc). It is more complicated than Linux. + +If you have problems, post them to the [Dire Wolf packet TNC](https://groups.io/g/direwolf) discussion group. + +You can also install a pre-built version from Mac Ports. Keeping this up to date depends on volunteers who perform the packaging. This version could lag behind development. + + sudo port install direwolf + + +## Join the conversation ## + +Here are some good places to ask questions and share your experience: + +- [Dire Wolf Software TNC](https://groups.io/g/direwolf) + +- [Raspberry Pi 4 Ham Radio](https://groups.io/g/RaspberryPi-4-HamRadio) + +- [linuxham](https://groups.io/g/linuxham) + +- [TAPR aprssig](http://www.tapr.org/pipermail/aprssig/) + + +The github "issues" section is for reporting software defects and enhancement requests. It is NOT a place to ask questions or have general discussions. Please use one of the locations above. diff --git a/Raspberry-Pi-APRS-Tracker.pdf b/Raspberry-Pi-APRS-Tracker.pdf deleted file mode 100644 index f4f581bf..00000000 Binary files a/Raspberry-Pi-APRS-Tracker.pdf and /dev/null differ diff --git a/Raspberry-Pi-APRS.pdf b/Raspberry-Pi-APRS.pdf deleted file mode 100644 index 50e85dc4..00000000 Binary files a/Raspberry-Pi-APRS.pdf and /dev/null differ diff --git a/User-Guide.pdf b/User-Guide.pdf deleted file mode 100644 index e1a7501e..00000000 Binary files a/User-Guide.pdf and /dev/null differ diff --git a/aprs_tt.c b/aprs_tt.c deleted file mode 100644 index 20fd5685..00000000 --- a/aprs_tt.c +++ /dev/null @@ -1,1449 +0,0 @@ -// -// This file is part of Dire Wolf, an amateur radio packet TNC. -// -// Copyright (C) 2013, 2014 John Langner, WB2OSZ -// -// This program 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 2 of the License, or -// (at your option) any later version. -// -// This program 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 this program. If not, see . -// - -/*------------------------------------------------------------------ - * - * Module: aprs_tt.c - * - * Purpose: APRStt gateway. - * - * Description: Transfer touch tone messages into the APRS network. - * - * References: This is based upon APRStt (TM) documents with some - * artistic freedom. - * - * http://www.aprs.org/aprstt.html - * - *---------------------------------------------------------------*/ - -#define APRS_TT_C 1 - - -// TODO: clean up terminolgy. -// "Message" has a specific meaning in APRS and this is not it. -// Touch Tone sequence might be appropriate. -// What do we call the parts separated by * key? Entry? Field? - - -#include -#include -#include -#include -#include - - -#include -#include - -#include "direwolf.h" -#include "ax25_pad.h" -#include "hdlc_rec2.h" /* for process_rec_frame */ -#include "textcolor.h" -#include "aprs_tt.h" -#include "tt_text.h" -#include "tt_user.h" -#include "symbols.h" -#include "latlong.h" - - -#if __WIN32__ -char *strtok_r(char *str, const char *delim, char **saveptr); -#endif - -#include "utm/LatLong-UTMconversion.h" - - -//TODO: #include "tt_user.h" - - - -/* - * Touch Tone sequences are accumulated here until # terminator found. - * Kept separate for each audio channel. - */ - -#define MAX_MSG_LEN 100 - -static char msg_str[MAX_CHANS][MAX_MSG_LEN+1]; -static int msg_len[MAX_CHANS]; - -static void aprs_tt_message (int chan, char *msg); -static int parse_fields (char *msg); -static int parse_callsign (char *e); -static int parse_object_name (char *e); -static int parse_symbol (char *e); -static int parse_location (char *e); -static int parse_comment (char *e); -static int expand_macro (char *e); -static void raw_tt_data_to_app (int chan, char *msg); -static int find_ttloc_match (char *e, char *xstr, char *ystr, char *zstr, char *bstr, char *dstr); - - - - -/*------------------------------------------------------------------ - * - * Name: aprs_tt_init - * - * Purpose: Initialize the APRStt gateway at system startup time. - * - * Inputs: Configuration options gathered by config.c. - * - * Global out: Make our own local copy of the structure here. - * - * Returns: None - * - * Description: The main program needs to call this at application - * start up time after reading the configuration file. - * - * TT_MAIN is defined for unit testing. - * - *----------------------------------------------------------------*/ - -static struct tt_config_s tt_config; - -#if TT_MAIN -#define NUM_TEST_CONFIG (sizeof(test_config) / sizeof (struct ttloc_s)) -static struct ttloc_s test_config[] = { - - { TTLOC_POINT, "B01", .point.lat = 12.25, .point.lon = 56.25 }, - { TTLOC_POINT, "B988", .point.lat = 12.50, .point.lon = 56.50 }, - - { TTLOC_VECTOR, "B5bbbdddd", .vector.lat = 53., .vector.lon = -1., .vector.scale = 1000. }, /* km units */ - - /* Hilltop Tower http://www.aprs.org/aprs-jamboree-2013.html */ - { TTLOC_VECTOR, "B5bbbddd", .vector.lat = 37+55.37/60., .vector.lon = -(81+7.86/60.), .vector.scale = 16.09344 }, /* .01 mile units */ - - { TTLOC_GRID, "B2xxyy", .grid.lat0 = 12.00, .grid.lon0 = 56.00, - .grid.lat9 = 12.99, .grid.lon9 = 56.99 }, - { TTLOC_GRID, "Byyyxxx", .grid.lat0 = 37 + 50./60.0, .grid.lon0 = 81, - .grid.lat9 = 37 + 59.99/60.0, .grid.lon9 = 81 + 9.99/60.0 }, - - { TTLOC_MACRO, "xxyyy", .macro.definition = "B9xx*AB166*AA2B4C5B3B0Ayyy" }, -}; -#endif - - -void aprs_tt_init (struct tt_config_s *p) -{ - int c; - -#if TT_MAIN - /* For unit testing. */ - - memset (&tt_config, 0, sizeof(struct tt_config_s)); - tt_config.ttloc_size = NUM_TEST_CONFIG; - tt_config.ttloc_ptr = test_config; - tt_config.ttloc_len = NUM_TEST_CONFIG; - - /* Don't care about xmit timing or corral here. */ -#else - memcpy (&tt_config, p, sizeof(struct tt_config_s)); -#endif - for (c=0; c= 0 && chan < MAX_CHANS); - - -// TODO: Might make more sense to put timeout here rather in the dtmf decoder. - - if (button == '$') { - -/* Timeout reset. */ - - msg_len[chan] = 0; - msg_str[chan][0] = '\0'; - } - else if (button != '.' && button != ' ') { - if (msg_len[chan] < MAX_MSG_LEN) { - msg_str[chan][msg_len[chan]++] = button; - msg_str[chan][msg_len[chan]] = '\0'; - } - if (button == '#') { - -/* Process complete message. */ - - aprs_tt_message (chan, msg_str[chan]); - msg_len[chan] = 0; - msg_str[chan][0] = '\0'; - } - } - else { - -/* Idle time. Poll occasionally for processing. */ - - poll_period++; - if (poll_period >= 39) { - poll_period = 0; - tt_user_background (); - } - } - -} /* end aprs_tt_button */ - -#endif - -/*------------------------------------------------------------------ - * - * Name: aprs_tt_message - * - * Purpose: Process complete received touch tone sequence - * terminated by #. - * - * Inputs: chan - Audio channel it came from. - * - * msg - String of DTMF buttons. - * # should be the final character. - * - * Returns: None - * - * Description: Process a complete message. - * It should have one or more fields separatedy by * - * and terminated by a final # like these: - * - * callsign # - * entry1 * callsign # - * entry1 * entry * callsign # - * - *----------------------------------------------------------------*/ - -static char m_callsign[20]; /* really object name */ - -/* - * Standard APRStt has symbol code 'A' (box) with overlay of 0-9, A-Z. - * - * Dire Wolf extension allows: - * Symbol table '/' (primary), any symbol code. - * Symbol table '\' (alternate), any symbol code. - * Alternate table symbol code, overlay of 0-9, A-Z. - */ -static char m_symtab_or_overlay; -static char m_symbol_code; - -static double m_longitude; -static double m_latitude; -static char m_comment[200]; -static char m_freq[12]; -static char m_mic_e; -static char m_dao[6]; -static int m_ssid; - -//#define G_UNKNOWN -999999 - - - -void aprs_tt_message (int chan, char *msg) -{ - int err; - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("\n\"%s\"\n", msg); -#endif - -/* - * Discard empty message. - * In case # is there as optional start. - */ - - if (msg[0] == '#') return; - -/* - * This takes the place of the usual line with audio level. - * Do it here, rather than in process_rec_frame, so any - * error messages are associated with the DTMF message - * rather than the most recent regular AX.25 frame. - */ - -#ifndef TT_MAIN - text_color_set(DW_COLOR_DEBUG); - dw_printf ("\nDTMF message\n"); -#endif - -/* - * The parse functions will fill these in. - */ - strcpy (m_callsign, ""); - m_symtab_or_overlay = '\\'; - m_symbol_code = 'A'; - m_longitude = G_UNKNOWN; - m_latitude = G_UNKNOWN; - strcpy (m_comment, ""); - strcpy (m_freq, ""); - m_mic_e = ' '; - strcpy (m_dao, "!T !"); /* start out unknown */ - m_ssid = 12; - -/* - * Send raw touch tone data to application. - */ - raw_tt_data_to_app (chan, msg); - -/* - * Parse the touch tone sequence. - */ - err = parse_fields (msg); - -#if defined(DEBUG) || defined(TT_MAIN) - text_color_set(DW_COLOR_DEBUG); - dw_printf ("callsign=\"%s\", ssid=%d, symbol=\"%c%c\", freq=\"%s\", comment=\"%s\", lat=%.4f, lon=%.4f, dao=\"%s\"\n", - m_callsign, m_ssid, m_symtab_or_overlay, m_symbol_code, m_freq, m_comment, m_latitude, m_longitude, m_dao); -#endif - - - if (err == 0) { - -/* - * Digested successfully. Add to our list of users and schedule transmissions. - */ - -#ifndef TT_MAIN - err = tt_user_heard (m_callsign, m_ssid, m_symtab_or_overlay, m_symbol_code, m_latitude, m_longitude, - m_freq, m_comment, m_mic_e, m_dao); -#endif - } - - // TODO send response to user. - // err == 0 OK, others, suitable error response. - - -} /* end aprs_tt_message */ - - -/*------------------------------------------------------------------ - * - * Name: parse_fields - * - * Purpose: Separate the complete string of touch tone characters - * into fields, delimited by *, and process each. - * - * Inputs: msg - String of DTMF buttons. - * - * Returns: None - * - * Description: It should have one or more fields separatedy by *. - * - * callsign # - * entry1 * callsign # - * entry1 * entry * callsign # - * - * Note that this will be used recursively when macros - * are expanded. - * - * "To iterate is human, to recurse divine." - * - * Returns: 0 for success or one of the TT_ERROR_... codes. - * - *----------------------------------------------------------------*/ - -static int parse_fields (char *msg) -{ - char stemp[MAX_MSG_LEN+1]; - char *e; - char *save; - - strcpy (stemp, msg); - e = strtok_r (stemp, "*#", &save); - while (e != NULL) { - - switch (*e) { - - case 'A': - - switch (e[1]) { - case 'A': - parse_object_name (e); - break; - case 'B': - parse_symbol (e); - break; - default: - parse_callsign (e); - break; - } - break; - - case 'B': - parse_location (e); - break; - - case 'C': - parse_comment (e); - break; - - case '0': - case '1': - case '2': - case '3': - case '4': - case '5': - case '6': - case '7': - case '8': - case '9': - expand_macro (e); - break; - - case '\0': - /* Empty field. Just ignore it. */ - /* This would happen if someone uses a leading *. */ - break; - - default: - - text_color_set(DW_COLOR_ERROR); - dw_printf ("Entry does not start with A, B, C, or digit: \"%s\"\n", msg); - return (TT_ERROR_D_MSG); - - } - - e = strtok_r (NULL, "*#", &save); - } - - return (0); - -} /* end parse_fields */ - - -/*------------------------------------------------------------------ - * - * Name: expand_macro - * - * Purpose: Expand compact form "macro" to full format then process. - * - * Inputs: e - An "entry" extracted from a complete - * APRStt messsage. - * In this case, it should contain only digits. - * - * Returns: 0 for success or one of the TT_ERROR_... codes. - * - * Description: Separate out the fields, perform substitution, - * call parse_fields for processing. - * - *----------------------------------------------------------------*/ - -static int expand_macro (char *e) -{ - int len; - int ipat; - char xstr[20], ystr[20], zstr[20], bstr[20], dstr[20]; - char stemp[MAX_MSG_LEN+1]; - char *d, *s; - - - text_color_set(DW_COLOR_DEBUG); - dw_printf ("Macro tone sequence: '%s'\n", e); - - len = strlen(e); - - ipat = find_ttloc_match (e, xstr, ystr, zstr, bstr, dstr); - - if (ipat >= 0) { - - dw_printf ("Matched pattern %3d: '%s', x=%s, y=%s, z=%s, b=%s, d=%s\n", ipat, tt_config.ttloc_ptr[ipat].pattern, xstr, ystr, zstr, bstr, dstr); - - dw_printf ("Replace with: '%s'\n", tt_config.ttloc_ptr[ipat].macro.definition); - - if (tt_config.ttloc_ptr[ipat].type != TTLOC_MACRO) { - - /* Found match to a different type. Really shouldn't be here. */ - /* Print internal error message... */ - dw_printf ("expand_macro: type != TTLOC_MACRO\n"); - return (TT_ERROR_INTERNAL); - } - -/* - * We found a match for the length and any fixed digits. - * Substitute values in to the definition. - */ - - strcpy (stemp, ""); - - for (d = tt_config.ttloc_ptr[ipat].macro.definition; *d != '\0'; d++) { - - while (( *d == 'x' || *d == 'y' || *d == 'z') && *d == d[1]) { - /* Collapse adjacent matching substitution characters. */ - d++; - } - - switch (*d) { - case 'x': - strcat (stemp, xstr); - break; - case 'y': - strcat (stemp, ystr); - break; - case 'z': - strcat (stemp, zstr); - break; - default: - { - char c1[2]; - c1[0] = *d; - c1[1] = '\0'; - strcat (stemp, c1); - } - break; - } - } -/* - * Process as if we heard this over the air. - */ - - dw_printf ("After substitution: '%s'\n", stemp); - return (parse_fields (stemp)); - } - else { - /* Send reject sound. */ - /* Does not match any macro definitions. */ - text_color_set(DW_COLOR_ERROR); - dw_printf ("Tone sequence did not match any pattern\n"); - return (TT_ERROR_MACRO_NOMATCH); - } - - /* should be unreachable */ - return (0); -} - - - -/*------------------------------------------------------------------ - * - * Name: parse_callsign - * - * Purpose: Extract callsign or object name from touch tone message. - * - * Inputs: e - An "entry" extracted from a complete - * APRStt messsage. - * In this case, it should start with "A". - * - * Outputs: m_callsign - * - * m_symtab_or_overlay - Set to 0-9 or A-Z if specified. - * - * m_symbol_code - Always set to 'A'. - * - * Returns: 0 for success or one of the TT_ERROR_... codes. - * - * Description: We recognize 3 different formats: - * - * Annn - 3 digits are a tactical callsign. No overlay. - * - * Annnvk - Abbreviation with 3 digits, numeric overlay, checksum. - * Annnvvk - Abbreviation with 3 digits, letter overlay, checksum. - * - * Att...ttvk - Full callsign in two key method, numeric overlay, checksum. - * Att...ttvvk - Full callsign in two key method, letter overlay, checksum. - * - *----------------------------------------------------------------*/ - -static int checksum_not_ok (char *str, int len, char found) -{ - int i; - int sum; - char expected; - - sum = 0; - for (i=0; i= 'A' && str[i] <= 'D') { - sum += str[i] - 'A' + 10; - } - else { - text_color_set(DW_COLOR_ERROR); - dw_printf ("aprs_tt: checksum: bad character \"%c\" in checksum calculation!\n", str[i]); - } - } - expected = '0' + (sum % 10); - - if (expected != found) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Bad checksum for \"%.*s\". Expected %c but received %c.\n", len, str, expected, found); - return (TT_ERROR_BAD_CHECKSUM); - } - return (0); -} - - -static int parse_callsign (char *e) -{ - int len; - int c_length; - char tttemp[40], stemp[30]; - - assert (*e == 'A'); - - len = strlen(e); - -/* - * special case: 3 digit tactical call. - */ - - if (len == 4 && isdigit(e[1]) && isdigit(e[2]) && isdigit(e[3])) { - strcpy (m_callsign, e+1); - return (0); - } - -/* - * 3 digit abbreviation: We only do the parsing here. - * Another part of application will try to find corresponding full call. - */ - - if ((len == 6 && isdigit(e[1]) && isdigit(e[2]) && isdigit(e[3]) && isdigit(e[4]) && isdigit(e[5])) || - (len == 7 && isdigit(e[1]) && isdigit(e[2]) && isdigit(e[3]) && isdigit(e[4]) && isupper(e[5]) && isdigit(e[6]))) { - - int cs_err = checksum_not_ok (e+1, len-2, e[len-1]); - - if (cs_err != 0) { - return (cs_err); - } - - strncpy (m_callsign, e+1, 3); - m_callsign[3] = '\0'; - - if (len == 7) { - tttemp[0] = e[len-3]; - tttemp[1] = e[len-2]; - tttemp[2] = '\0'; - tt_two_key_to_text (tttemp, 0, stemp); - m_symbol_code = 'A'; - m_symtab_or_overlay = stemp[0]; - } - else { - m_symbol_code = 'A'; - m_symtab_or_overlay = e[len-2]; - } - return (0); - } - -/* - * Callsign in two key format. - */ - - if (len >= 7 && len <= 24) { - - int cs_err = checksum_not_ok (e+1, len-2, e[len-1]); - - if (cs_err != 0) { - return (cs_err); - } - - - if (isupper(e[len-2])) { - strncpy (tttemp, e+1, len-4); - tttemp[len-4] = '\0'; - tt_two_key_to_text (tttemp, 0, m_callsign); - - tttemp[0] = e[len-3]; - tttemp[1] = e[len-2]; - tttemp[2] = '\0'; - tt_two_key_to_text (tttemp, 0, stemp); - m_symbol_code = 'A'; - m_symtab_or_overlay = stemp[0]; - } - else { - strncpy (tttemp, e+1, len-3); - tttemp[len-3] = '\0'; - tt_two_key_to_text (tttemp, 0, m_callsign); - - m_symbol_code = 'A'; - m_symtab_or_overlay = e[len-2]; - } - return (0); - } - - text_color_set(DW_COLOR_ERROR); - dw_printf ("Touch tone callsign not valid: \"%s\"\n", e); - return (TT_ERROR_INVALID_CALL); -} - -/*------------------------------------------------------------------ - * - * Name: parse_object_name - * - * Purpose: Extract object name from touch tone message. - * - * Inputs: e - An "entry" extracted from a complete - * APRStt messsage. - * In this case, it should start with "AA". - * - * Outputs: m_callsign - * - * m_ssid - Cleared to remove the default of 12. - * - * Returns: 0 for success or one of the TT_ERROR_... codes. - * - * Description: Data format - * - * AAtt...tt - Symbol name, two key method, up to 9 characters. - * - *----------------------------------------------------------------*/ - - -static int parse_object_name (char *e) -{ - int len; - int c_length; - char tttemp[40], stemp[30]; - - assert (e[0] == 'A'); - assert (e[1] == 'A'); - - len = strlen(e); - -/* - * Object name in two key format. - */ - - if (len >= 2 + 1 && len <= 30) { - - if (tt_two_key_to_text (e+2, 0, m_callsign) == 0) { - m_callsign[9] = '\0'; /* truncate to 9 */ - m_ssid = 0; /* No ssid for object name */ - return (0); - } - } - - text_color_set(DW_COLOR_ERROR); - dw_printf ("Touch tone object name not valid: \"%s\"\n", e); - - return (TT_ERROR_INVALID_OBJNAME); - -} /* end parse_oject_name */ - - -/*------------------------------------------------------------------ - * - * Name: parse_symbol - * - * Purpose: Extract symbol from touch tone message. - * - * Inputs: e - An "entry" extracted from a complete - * APRStt messsage. - * In this case, it should start with "AB". - * - * Outputs: m_symtab_or_overlay - * - * m_symbol_code - * - * Returns: 0 for success or one of the TT_ERROR_... codes. - * - * Description: Data format - * - * AB1nn - Symbol from primary symbol table. - * Two digits nn are the same as in the GPSCnn - * generic address used as a destination. - * - * AB2nn - Symbol from alternate symbol table. - * Two digits nn are the same as in the GPSEnn - * generic address used as a destination. - * - * AB0nnvv - Symbol from alternate symbol table. - * Two digits nn are the same as in the GPSEnn - * generic address used as a destination. - * vv is an overlay digit or letter in two key method. - * - *----------------------------------------------------------------*/ - - -static int parse_symbol (char *e) -{ - int len; - char nstr[4]; - int nn; - char stemp[10]; - - assert (e[0] == 'A'); - assert (e[1] == 'B'); - - len = strlen(e); - - if (len >= 4 && len <= 10) { - - nstr[0] = e[3]; - nstr[1] = e[4]; - nstr[2] = '\0'; - - nn = atoi (nstr); - if (nn < 1) { - nn = 1; - } - else if (nn > 94) { - nn = 94; - } - - switch (e[2]) { - - case '1': - m_symtab_or_overlay = '/'; - m_symbol_code = 32 + nn; - return (0); - break; - - case '2': - m_symtab_or_overlay = '\\'; - m_symbol_code = 32 + nn; - return (0); - break; - - case '0': - if (len >= 6) { - if (tt_two_key_to_text (e+5, 0, stemp) == 0) { - m_symbol_code = 32 + nn; - m_symtab_or_overlay = stemp[0]; - return (0); - } - } - break; - } - } - - text_color_set(DW_COLOR_ERROR); - dw_printf ("Touch tone symbol not valid: \"%s\"\n", e); - - return (TT_ERROR_INVALID_SYMBOL); - -} /* end parse_oject_name */ - - -/*------------------------------------------------------------------ - * - * Name: parse_location - * - * Purpose: Extract location from touch tone message. - * - * Inputs: e - An "entry" extracted from a complete - * APRStt messsage. - * In this case, it should start with "B". - * - * Outputs: m_latitude - * m_longitude - * m_dao - * - * Returns: 0 for success or one of the TT_ERROR_... codes. - * - * Description: There are many different formats recognizable - * by total number of digits and sometimes the first digit. - * - * We handle most of them in a general way, processing - * them in 4 groups: - * - * * points - * * vector - * * grid - * * utm - * - *----------------------------------------------------------------*/ - - - -/* Average radius of earth in meters. */ -#define R 6371000. - -/* Convert between degrees and radians. */ - -#define D2R(a) ((a) * 2. * M_PI / 360.) -#define R2D(a) ((a) * 360. / (2*M_PI)) - - -static int parse_location (char *e) -{ - int len; - int ipat; - char xstr[20], ystr[20], zstr[20], bstr[20], dstr[20]; - double x, y, dist, bearing; - double lat0, lon0; - double lat9, lon9; - double easting, northing; - - assert (*e == 'B'); - - m_dao[2] = e[0]; - m_dao[3] = e[1]; /* Type of location. e.g. !TB6! */ - /* Will be changed by point types. */ - - /* If this ever changes, be sure to update corresponding */ - /* section in process_comment() in decode_aprs.c */ - - len = strlen(e); - - ipat = find_ttloc_match (e, xstr, ystr, zstr, bstr, dstr); - if (ipat >= 0) { - - //dw_printf ("ipat=%d, x=%s, y=%s, b=%s, d=%s\n", ipat, xstr, ystr, bstr, dstr); - - switch (tt_config.ttloc_ptr[ipat].type) { - case TTLOC_POINT: - - m_latitude = tt_config.ttloc_ptr[ipat].point.lat; - m_longitude = tt_config.ttloc_ptr[ipat].point.lon; - - /* Is it one of ten or a hundred positions? */ - /* It's not hardwired to always be B0n or B9nn. */ - /* This is a pretty good approximation. */ - - if (strlen(e) == 3) { /* probably B0n --> !Tn ! */ - m_dao[2] = e[2]; - m_dao[3] = ' '; - } - if (strlen(e) == 4) { /* probably B9nn --> !Tnn! */ - m_dao[2] = e[2]; - m_dao[3] = e[3]; - } - break; - - case TTLOC_VECTOR: - - if (strlen(bstr) != 3) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Bearing \"%s\" should be 3 digits.\n", bstr); - // return error code? - } - if (strlen(dstr) < 1) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Distance \"%s\" should 1 or more digits.\n", dstr); - // return error code? - } - - lat0 = D2R(tt_config.ttloc_ptr[ipat].vector.lat); - lon0 = D2R(tt_config.ttloc_ptr[ipat].vector.lon); - dist = atof(dstr) * tt_config.ttloc_ptr[ipat].vector.scale; - bearing = D2R(atof(bstr)); - - /* Equations and caluculators found here: */ - /* http://movable-type.co.uk/scripts/latlong.html */ - - m_latitude = R2D(asin(sin(lat0) * cos(dist/R) + cos(lat0) * sin(dist/R) * cos(bearing))); - - m_longitude = R2D(lon0 + atan2(sin(bearing) * sin(dist/R) * cos(lat0), - cos(dist/R) - sin(lat0) * sin(D2R(m_latitude)))); - break; - - case TTLOC_GRID: - - if (strlen(xstr) == 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Missing X coordinate.\n"); - strcpy (xstr, "0"); - } - if (strlen(ystr) == 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Missing Y coordinate.\n"); - strcpy (ystr, "0"); - } - - lat0 = tt_config.ttloc_ptr[ipat].grid.lat0; - lat9 = tt_config.ttloc_ptr[ipat].grid.lat9; - y = atof(ystr); - m_latitude = lat0 + y * (lat9-lat0) / (pow(10., strlen(ystr)) - 1.); - - lon0 = tt_config.ttloc_ptr[ipat].grid.lon0; - lon9 = tt_config.ttloc_ptr[ipat].grid.lon9; - x = atof(xstr); - m_longitude = lon0 + x * (lon9-lon0) / (pow(10., strlen(xstr)) - 1.); - - break; - - case TTLOC_UTM: - - if (strlen(xstr) == 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Missing X coordinate.\n"); - /* Avoid divide by zero later. Put in middle of range. */ - strcpy (xstr, "5"); - } - if (strlen(ystr) == 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Missing Y coordinate.\n"); - /* Avoid divide by zero later. Put in middle of range. */ - strcpy (ystr, "5"); - } - - x = atof(xstr); - easting = x * tt_config.ttloc_ptr[ipat].utm.scale + tt_config.ttloc_ptr[ipat].utm.x_offset; - - y = atof(ystr); - northing = y * tt_config.ttloc_ptr[ipat].utm.scale + tt_config.ttloc_ptr[ipat].utm.y_offset; - - UTMtoLL (WSG84, northing, easting, tt_config.ttloc_ptr[ipat].utm.zone, - &m_latitude, &m_longitude); - break; - - default: - assert (0); - } - return (0); - } - - /* Send reject sound. */ - /* Does not match any location specification. */ - - return (TT_ERROR_INVALID_LOC); - -} /* end parse_location */ - - -/*------------------------------------------------------------------ - * - * Name: find_ttloc_match - * - * Purpose: Try to match the received position report to a pattern - * defined in the configuration file. - * - * Inputs: e - An "entry" extracted from a complete - * APRStt messsage. - * In this case, it should start with "B". - * - * Outputs: xstr - All digits matching x positions in configuration. - * ystr - y - * zstr - z - * bstr - b - * dstr - d - * - * Returns: >= 0 for index into table if found. - * -1 if not found. - * - * Description: - * - *----------------------------------------------------------------*/ - -static int find_ttloc_match (char *e, char *xstr, char *ystr, char *zstr, char *bstr, char *dstr) -{ - int ipat; /* Index into patterns from configuration file */ - int len; /* Length of pattern we are trying to match. */ - int match; - char mc; - int k; - -//TODO: remove dw_printf ("find_ttloc_match: e=%s\n", e); - - for (ipat=0; ipat 0) { - for (c=m_callsign, s=src; *c != '\0' && strlen(src) < 6; c++) { - if (isupper(*c) || isdigit(*c)) { - *s++ = *c; - *s = '\0'; - } - } - } - else { - strcpy (src, "APRSTT"); - } - - - // TODO: test this. - - err= symbols_into_dest (m_symtab_or_overlay, m_symbol_code, dest); - if (err) { - /* Error message was already printed. */ - /* Set reasonable default rather than keeping "GPS???" which */ - /* is invalid and causes trouble later. */ - - strcpy (dest, "GPSAA"); - } - - sprintf (raw_tt_msg, "%s>%s:t%s", src, dest, msg); - - pp = ax25_from_text (raw_tt_msg, 1); - -/* - * Process like a normal received frame. - * NOTE: This goes directly to application rather than - * thru the multi modem duplicate processing. - */ - - if (pp != NULL) { - app_process_rec_packet (chan, -1, pp, -2, RETRY_NONE, "tt"); - } - else { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Could not convert \"%s\" into APRS packet.\n", raw_tt_msg); - } - -#endif -} - - - -/*------------------------------------------------------------------ - * - * Name: main - * - * Purpose: Unit test for this file. - * - * Description: Run unit test like this: - * - * rm a.exe ; gcc tt_text.c -DTT_MAIN -DDEBUG aprs_tt.c strtok_r.o utm/LatLong-UTMconversion.c ; ./a.exe - * - * - * Bugs: No automatic checking. - * Just eyeball it to see if things look right. - * - *----------------------------------------------------------------*/ - - -#if TT_MAIN - - -void text_color_set (dw_color_t c) { return; } - -int dw_printf (const char *fmt, ...) -{ - va_list args; - int len; - - va_start (args, fmt); - len = vprintf (fmt, args); - va_end (args); - return (len); -} - - - -int main (int argc, char *argv[]) -{ - char text[256], buttons[256]; - int n; - - dw_printf ("Hello, world!\n"); - - aprs_tt_init (NULL); - - //if (argc < 2) { - //dw_printf ("Supply text string on command line.\n"); - //exit (1); - //} - -/* Callsigns & abbreviations. */ - - aprs_tt_message (0, "A9A2B42A7A7C71#"); /* WB4APR/7 */ - aprs_tt_message (0, "A27773#"); /* abbreviated form */ - /* Example in http://www.aprs.org/aprstt/aprstt-coding24.txt has a bad checksum! */ - aprs_tt_message (0, "A27776#"); /* Expect error message. */ - - aprs_tt_message (0, "A2A7A7C71#"); /* Spelled suffix, overlay, checksum */ - aprs_tt_message (0, "A27773#"); /* Suffix digits, overlay, checksum */ - - aprs_tt_message (0, "A9A2B26C7D9D71#"); /* WB2OSZ/7 numeric overlay */ - aprs_tt_message (0, "A67979#"); /* abbreviated form */ - - aprs_tt_message (0, "A9A2B26C7D9D5A9#"); /* WB2OSZ/J letter overlay */ - aprs_tt_message (0, "A6795A7#"); /* abbreviated form */ - - aprs_tt_message (0, "A277#"); /* Tactical call "277" no overlay and no checksum */ - -/* Locations */ - - aprs_tt_message (0, "B01*A67979#"); - aprs_tt_message (0, "B988*A67979#"); - - /* expect about 52.79 +0.83 */ - aprs_tt_message (0, "B51000125*A67979#"); - - /* Try to get from Hilltop Tower to Archery & Target Range. */ - /* Latitude comes out ok, 37.9137 -> 55.82 min. */ - /* Longitude -81.1254 -> 8.20 min */ - - aprs_tt_message (0, "B5206070*A67979#"); - - aprs_tt_message (0, "B21234*A67979#"); - aprs_tt_message (0, "B533686*A67979#"); - - -/* Comments */ - - aprs_tt_message (0, "C1"); - aprs_tt_message (0, "C2"); - aprs_tt_message (0, "C146520"); - aprs_tt_message (0, "C7788444222550227776669660333666990122223333"); - -/* Macros */ - - aprs_tt_message (0, "88345"); - - return(0); - -} /* end main */ - - - - -#endif - -/* end aprs_tt.c */ - diff --git a/atest.c b/atest.c deleted file mode 100644 index c74c491d..00000000 --- a/atest.c +++ /dev/null @@ -1,497 +0,0 @@ - -// -// This file is part of Dire Wolf, an amateur radio packet TNC. -// -// Copyright (C) 2011,2012,2013 John Langner, WB2OSZ -// -// This program 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 2 of the License, or -// (at your option) any later version. -// -// This program 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 this program. If not, see . -// - - -/*------------------------------------------------------------------- - * - * Name: atest.c - * - * Purpose: Unit test for the AFSK demodulator. - * - * Inputs: Takes audio from a .WAV file insted of the audio device. - * - * Description: This can be used to test the AFSK demodulator under - * controlled and reproducable conditions for tweaking. - * - * For example - * - * (1) Download WA8LMF's TNC Test CD image file from - * http://wa8lmf.net/TNCtest/index.htm - * - * (2) Burn a physical CD. - * - * (3) "Rip" the desired tracks with Windows Media Player. - * This results in .WMA files. - * - * (4) Upload the .WMA file(s) to http://media.io/ and - * convert to .WAV format. - * - * - * Comparison to others: - * - * Here are some other scores from Track 2 of the TNC Test CD: - * http://sites.google.com/site/ki4mcw/Home/arduino-tnc - * - * Without ONE_CHAN defined: - * - * Notice that the number of packets decoded, as reported by - * this test program, will be twice the number expected because - * we are decoding the left and right audio channels separately. - * - * - * With ONE_CHAN defined: - * - * Only process one channel. - * - * Version 0.4 decoded 870 packets. - * - * After a little tweaking, version 0.5 decodes 931 packets. - * - * After more tweaking, version 0.6 gets 965 packets. - * This is without the option to retry after getting a bad FCS. - * - *--------------------------------------------------------------------*/ - -// #define X 1 - - -#include -#include -//#include -#include -#include -#include -#include -#include - - -#define ATEST_C 1 - -#include "audio.h" -#include "demod.h" -// #include "fsk_demod_agc.h" -#include "textcolor.h" -#include "ax25_pad.h" -#include "hdlc_rec2.h" - - - -struct wav_header { /* .WAV file header. */ - char riff[4]; /* "RIFF" */ - int filesize; /* file length - 8 */ - char wave[4]; /* "WAVE" */ - char fmt[4]; /* "fmt " */ - int fmtsize; /* 16. */ - short wformattag; /* 1 for PCM. */ - short nchannels; /* 1 for mono, 2 for stereo. */ - int nsamplespersec; /* sampling freq, Hz. */ - int navgbytespersec; /* = nblockalign*nsamplespersec. */ - short nblockalign; /* = wbitspersample/8 * nchannels. */ - short wbitspersample; /* 16 or 8. */ - char data[4]; /* "data" */ - int datasize; /* number of bytes following. */ -} ; - - /* 8 bit samples are unsigned bytes */ - /* in range of 0 .. 255. */ - - /* 16 bit samples are signed short */ - /* in range of -32768 .. +32767. */ - -static struct wav_header header; -static FILE *fp; -static int e_o_f; -static int packets_decoded = 0; -static int decimate = 1; /* Reduce that sampling rate. */ - /* 1 = normal, 2 = half, etc. */ - - -int main (int argc, char *argv[]) -{ - - //int err; - int c; - struct audio_s modem; - int channel; - time_t start_time; - - text_color_init(1); - text_color_set(DW_COLOR_INFO); - -/* - * First apply defaults. - */ - - memset (&modem, 0, sizeof(modem)); - - modem.num_channels = DEFAULT_NUM_CHANNELS; - modem.samples_per_sec = DEFAULT_SAMPLES_PER_SEC; - modem.bits_per_sample = DEFAULT_BITS_PER_SAMPLE; - - // Results v0.9: - // - // fix_bits = 0 971 packets, 69 sec - // fix_bits = SINGLE 990 64 - // fix_bits = DOUBLE 992 65 - // fix_bits = TRIPLE 992 67 - // fix_bits = TWO_SEP 1004 476 - - // Essentially no difference in time for those with order N time. - // Time increases greatly for the one with order N^2 time. - - - // Results: version 1.1, decoder C, modem.fix_bits = RETRY_MAX - 1 - // - // 971 NONE - // +19 SINGLE - // +2 DOUBLE - // +12 TWO_SEP - // +3 REMOVE_MANY - // ---- - // 1007 Total in 1008 sec. More than twice as long as earlier version. - - // Results: version 1.1, decoders ABC, modem.fix_bits = RETRY_MAX - 1 - // - // 976 NONE - // +21 SINGLE - // +1 DOUBLE - // +22 TWO_SEP - // +1 MANY - // +3 REMOVE_MANY - // ---- - // 1024 Total in 2042 sec. - // About 34 minutes of CPU time for a roughly 40 minute CD. - // Many computers wouldn't be able to keep up. - - // The SINGLE and TWO_SEP techniques are the most effective. - // Should we reorder the enum values so that TWO_SEP - // comes after SINGLE? That way "FIX_BITS 2" would - // use the two most productive techniques and not waste - // time on the others. People with plenty of CPU power - // to spare can still specify larger numbers for the other - // techniques with less return on investment. - - - -// TODO: tabulate results from atest2.c.txt - - - /* TODO: should have a command line option for this. */ - - modem.fix_bits = RETRY_NONE; - //modem.fix_bits = RETRY_SWAP_SINGLE; - //modem.fix_bits = RETRY_SWAP_DOUBLE; - //modem.fix_bits = RETRY_SWAP_TRIPLE; - //modem.fix_bits = RETRY_INSERT_DOUBLE; - modem.fix_bits = RETRY_SWAP_TWO_SEP; - //modem.fix_bits = RETRY_REMOVE_MANY; - //modem.fix_bits = RETRY_MAX - 1; - - for (channel=0; channel 10000) { - fprintf (stderr, "Use a more reasonable bit rate in range of 100 - 10000.\n"); - exit (EXIT_FAILURE); - } - if (modem.baud[0] < 600) { - modem.modem_type[0] = AFSK; - modem.mark_freq[0] = 1600; - modem.space_freq[0] = 1800; - } - else if (modem.baud[0] > 2400) { - modem.modem_type[0] = SCRAMBLE; - modem.mark_freq[0] = 0; - modem.space_freq[0] = 0; - printf ("Using scrambled baseband signal rather than AFSK.\n"); - } - else { - modem.modem_type[0] = AFSK; - modem.mark_freq[0] = 1200; - modem.space_freq[0] = 2200; - } - break; - - case 'P': /* -P for modem profile. */ - - printf ("Demodulator profile set to \"%s\"\n", optarg); - strcpy (modem.profiles[0], optarg); - break; - - case 'D': /* -D reduce sampling rate for lower CPU usage. */ - - decimate = atoi(optarg); - printf ("Decimate factor = %d\n", decimate); - modem.decimate[0] = decimate; - break; - - case '?': - - /* Unknown option message was already printed. */ - //usage (argv); - break; - - default: - - /* Should not be here. */ - printf("?? getopt returned character code 0%o ??\n", c); - //usage (argv); - } - } - - if (optind >= argc) { - printf ("Specify .WAV file name on command line.\n"); - exit (1); - } - - fp = fopen(argv[optind], "rb"); - if (fp == NULL) { - text_color_set(DW_COLOR_ERROR); - fprintf (stderr, "Couldn't open file for read: %s\n", argv[optind]); - //perror ("more info?"); - exit (1); - } - - start_time = time(NULL); - - -/* - * Read the file header. - */ - - fread (&header, sizeof(header), (size_t)1, fp); - - assert (header.nchannels == 1 || header.nchannels == 2); - assert (header.wbitspersample == 8 || header.wbitspersample == 16); - - modem.samples_per_sec = header.nsamplespersec; - modem.samples_per_sec = modem.samples_per_sec; - modem.bits_per_sample = header.wbitspersample; - modem.num_channels = header.nchannels; - - text_color_set(DW_COLOR_INFO); - printf ("%d samples per second\n", modem.samples_per_sec); - printf ("%d bits per sample\n", modem.bits_per_sample); - printf ("%d audio channels\n", modem.num_channels); - printf ("%d audio bytes in file\n", (int)(header.datasize)); - - -/* - * Initialize the AFSK demodulator and HDLC decoder. - */ - multi_modem_init (&modem); - - - e_o_f = 0; - while ( ! e_o_f) - { - - - int audio_sample; - int c; - - for (c=0; c= 256 * 256) - e_o_f = 1; - -#define ONE_CHAN 1 /* only use one audio channel. */ - -#if ONE_CHAN - if (c != 0) continue; -#endif - - multi_modem_process_sample(c,audio_sample); - } - - /* When a complete frame is accumulated, */ - /* process_rec_frame, below, is called. */ - - } - text_color_set(DW_COLOR_INFO); - printf ("\n\n"); - printf ("%d packets decoded in %d seconds.\n", packets_decoded, (int)(time(NULL) - start_time)); - - exit (0); -} - - -/* - * Simulate sample from the audio device. - */ - -int audio_get (void) -{ - int ch; - - ch = getc(fp); - - if (ch < 0) e_o_f = 1; - - return (ch); -} - - - -/* - * Rather than queuing up frames with bad FCS, - * try to fix them immediately. - */ - -void rdq_append (rrbb_t rrbb) -{ - int chan; - int alevel; - int subchan; - - - chan = rrbb_get_chan(rrbb); - subchan = rrbb_get_subchan(rrbb); - alevel = rrbb_get_audio_level(rrbb); - - hdlc_rec2_try_to_fix_later (rrbb, chan, subchan, alevel); -} - - -/* - * This is called when we have a good frame. - */ - -void app_process_rec_packet (int chan, int subchan, packet_t pp, int alevel, retry_t retries, char *spectrum) -{ - - //int err; - //char *p; - char stemp[500]; - unsigned char *pinfo; - int info_len; - int h; - char heard[20]; - //packet_t pp; - - - packets_decoded++; - - - ax25_format_addrs (pp, stemp); - - info_len = ax25_get_info (pp, &pinfo); - - /* Print so we can see what is going on. */ - -#if 1 - /* Display audio input level. */ - /* Who are we hearing? Original station or digipeater. */ - - h = ax25_get_heard(pp); - ax25_get_addr_with_ssid(pp, h, heard); - - text_color_set(DW_COLOR_DEBUG); - printf ("\n"); - printf("DECODED[%d] ", packets_decoded ); - if (h != AX25_SOURCE) { - printf ("Digipeater "); - } - printf ("%s audio level = %d [%s] %s\n", heard, alevel, retry_text[(int)retries], spectrum); - - -#endif - -// Display non-APRS packets in a different color. - - if (ax25_is_aprs(pp)) { - text_color_set(DW_COLOR_REC); - printf ("[%d] ", chan); - } - else { - text_color_set(DW_COLOR_DEBUG); - printf ("[%d] ", chan); - } - - printf ("%s", stemp); /* stations followed by : */ - ax25_safe_print ((char *)pinfo, info_len, 0); - printf ("\n"); - - ax25_delete (pp); - -} /* end app_process_rec_packet */ - - -/* end atest.c */ diff --git a/audio.c b/audio.c deleted file mode 100644 index 7fd92eb9..00000000 --- a/audio.c +++ /dev/null @@ -1,1305 +0,0 @@ - -// Remove next line to eliminate annoying debug messages every 100 seconds. -#define STATISTICS 1 - - -// -// This file is part of Dire Wolf, an amateur radio packet TNC. -// -// Copyright (C) 2011, 2012, 2013, 2014 John Langner, WB2OSZ -// -// This program 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 2 of the License, or -// (at your option) any later version. -// -// This program 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 this program. If not, see . -// - - -/*------------------------------------------------------------------ - * - * Module: audio.c - * - * Purpose: Interface to audio device commonly called a "sound card" for - * historical reasons. - * - * This version is for Linux and Cygwin. - * - * Two different types of sound interfaces are supported: - * - * * OSS - For Cygwin or Linux versions with /dev/dsp. - * - * * ALSA - For Linux versions without /dev/dsp. - * In this case, define preprocessor symbol USE_ALSA. - * - * References: Some tips on on using Linux sound devices. - * - * http://www.oreilly.de/catalog/multilinux/excerpt/ch14-05.htm - * http://cygwin.com/ml/cygwin-patches/2004-q1/msg00116/devdsp.c - * http://manuals.opensound.com/developer/fulldup.c.html - * - * "Introduction to Sound Programming with ALSA" - * http://www.linuxjournal.com/article/6735?page=0,1 - * - * http://www.alsa-project.org/main/index.php/Asoundrc - * - * Credits: Release 1.0: Fabrice FAURE contributed code for the SDR UDP interface. - * - * Discussion here: http://gqrx.dk/doc/streaming-audio-over-udp - * - * Release 1.1: Gabor Berczi provided fixes for the OSS code - * which had fallen into decay. - * - * - *---------------------------------------------------------------*/ - - -#include -#include -#include -#include -#include -#include -#include -#include -#include - -#include -#include -#include - - -#if USE_ALSA -#include -#else -#ifdef __OpenBSD__ -#include -#else -#include -#endif -#endif - -#ifdef __FreeBSD__ -#include -#endif - -#include "direwolf.h" -#include "audio.h" -#include "textcolor.h" - - -#if USE_ALSA -static snd_pcm_t *audio_in_handle = NULL; -static snd_pcm_t *audio_out_handle = NULL; - -static int bytes_per_frame; /* number of bytes for a sample from all channels. */ - /* e.g. 4 for stereo 16 bit. */ - -static int set_alsa_params (snd_pcm_t *handle, struct audio_s *pa, char *name, char *dir); - -//static void alsa_select_device (char *pick_dev, int direction, char *result); -#else - -static int set_oss_params (int fd, struct audio_s *pa); -static int oss_audio_device_fd = -1; /* Single device, both directions. */ - -#endif - -static int inbuf_size_in_bytes = 0; /* number of bytes allocated */ -static unsigned char *inbuf_ptr = NULL; -static int inbuf_len = 0; /* number byte of actual data available. */ -static int inbuf_next = 0; /* index of next to remove. */ - -static int outbuf_size_in_bytes = 0; -static unsigned char *outbuf_ptr = NULL; -static int outbuf_len = 0; - -#define ONE_BUF_TIME 40 - -static enum audio_in_type_e audio_in_type; - -// UDP socket used for receiving data - -static int udp_sock; - - -#define roundup1k(n) (((n) + 0x3ff) & ~0x3ff) -#define calcbufsize(rate,chans,bits) roundup1k( ( (rate)*(chans)*(bits) / 8 * ONE_BUF_TIME)/1000 ) - - -/*------------------------------------------------------------------ - * - * Name: audio_open - * - * Purpose: Open the digital audio device. - * For "OSS", the device name is typically "/dev/dsp". - * For "ALSA", it's a lot more complicated. See User Guide. - * - * New in version 1.0, we recognize "udp:" optionally - * followed by a port number. - * - * Inputs: pa - Address of structure of type audio_s. - * - * Using a structure, rather than separate arguments - * seemed to make sense because we often pass around - * the same set of parameters various places. - * - * The fields that we care about are: - * num_channels - * samples_per_sec - * bits_per_sample - * If zero, reasonable defaults will be provided. - * - * The device names are in adevice_in and adevice_out. - * - For "OSS", the device name is typically "/dev/dsp". - * - For "ALSA", the device names are hw:c,d - * where c is the "card" (for historical purposes) - * and d is the "device" within the "card." - * - * - * Outputs: pa - The ACTUAL values are returned here. - * - * These might not be exactly the same as what was requested. - * - * Example: ask for stereo, 16 bits, 22050 per second. - * An ordinary desktop/laptop PC should be able to handle this. - * However, some other sort of smaller device might be - * more restrictive in its capabilities. - * It might say, the best I can do is mono, 8 bit, 8000/sec. - * - * The sofware modem must use this ACTUAL information - * that the device is supplying, that could be different - * than what the user specified. - * - * Returns: 0 for success, -1 for failure. - * - *----------------------------------------------------------------*/ - -int audio_open (struct audio_s *pa) -{ - int err; - int chan; - - char audio_in_name[30]; - char audio_out_name[30]; - -#if USE_ALSA - - assert (audio_in_handle == NULL); - assert (audio_out_handle == NULL); - -#else - - assert (oss_audio_device_fd == -1); -#endif - -/* - * Fill in defaults for any missing values. - */ - if (pa -> num_channels == 0) - pa -> num_channels = DEFAULT_NUM_CHANNELS; - - if (pa -> samples_per_sec == 0) - pa -> samples_per_sec = DEFAULT_SAMPLES_PER_SEC; - - if (pa -> bits_per_sample == 0) - pa -> bits_per_sample = DEFAULT_BITS_PER_SAMPLE; - - for (chan=0; chan mark_freq[chan] == 0) - pa -> mark_freq[chan] = DEFAULT_MARK_FREQ; - - if (pa -> space_freq[chan] == 0) - pa -> space_freq[chan] = DEFAULT_SPACE_FREQ; - - if (pa -> baud[chan] == 0) - pa -> baud[chan] = DEFAULT_BAUD; - - if (pa->num_subchan[chan] == 0) - pa->num_subchan[chan] = 1; - } - -/* - * Open audio device. - */ - - udp_sock = -1; - - inbuf_size_in_bytes = 0; - inbuf_ptr = NULL; - inbuf_len = 0; - inbuf_next = 0; - - outbuf_size_in_bytes = 0; - outbuf_ptr = NULL; - outbuf_len = 0; - -/* - * Determine the type of audio input. - */ - - audio_in_type = AUDIO_IN_TYPE_SOUNDCARD; - - if (strcasecmp(pa->adevice_in, "stdin") == 0 || strcmp(pa->adevice_in, "-") == 0) { - audio_in_type = AUDIO_IN_TYPE_STDIN; - /* Change - to stdin for readability. */ - strcpy (pa->adevice_in, "stdin"); - } - if (strncasecmp(pa->adevice_in, "udp:", 4) == 0) { - audio_in_type = AUDIO_IN_TYPE_SDR_UDP; - /* Supply default port if none specified. */ - if (strcasecmp(pa->adevice_in,"udp") == 0 || - strcasecmp(pa->adevice_in,"udp:") == 0) { - sprintf (pa->adevice_in, "udp:%d", DEFAULT_UDP_AUDIO_PORT); - } - } - -/* Let user know what is going on. */ - - /* If not specified, the device names should be "default". */ - - strcpy (audio_in_name, pa->adevice_in); - strcpy (audio_out_name, pa->adevice_out); - - text_color_set(DW_COLOR_INFO); - - if (strcmp(audio_in_name,audio_out_name) == 0) { - dw_printf ("Audio device for both receive and transmit: %s\n", audio_in_name); - } - else { - dw_printf ("Audio input device for receive: %s\n", audio_in_name); - dw_printf ("Audio out device for transmit: %s\n", audio_out_name); - } - -/* - * Now attempt actual opens. - */ - -/* - * Input device. - */ - switch (audio_in_type) { - -/* - * Soundcard - ALSA. - */ - case AUDIO_IN_TYPE_SOUNDCARD: -#if USE_ALSA - err = snd_pcm_open (&audio_in_handle, audio_in_name, SND_PCM_STREAM_CAPTURE, 0); - if (err < 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Could not open audio device %s for input\n%s\n", - audio_in_name, snd_strerror(err)); - return (-1); - } - - inbuf_size_in_bytes = set_alsa_params (audio_in_handle, pa, audio_in_name, "input"); - break; -#else // OSS - oss_audio_device_fd = open (pa->adevice_in, O_RDWR); - - if (oss_audio_device_fd < 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("%s:\n", pa->adevice_in); -// sprintf (message, "Could not open audio device %s", pa->adevice_in); -// perror (message); - return (-1); - } - - outbuf_size_in_bytes = inbuf_size_in_bytes = set_oss_params (oss_audio_device_fd, pa); - - if (inbuf_size_in_bytes <= 0 || outbuf_size_in_bytes <= 0) { - return (-1); - } -#endif - -/* - * UDP. - */ - case AUDIO_IN_TYPE_SDR_UDP: - - //Create socket and bind socket - - { - struct sockaddr_in si_me; - int slen=sizeof(si_me); - int data_size = 0; - - //Create UDP Socket - if ((udp_sock=socket(AF_INET, SOCK_DGRAM, IPPROTO_UDP))==-1) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Couldn't create socket, errno %d\n", errno); - return -1; - } - - memset((char *) &si_me, 0, sizeof(si_me)); - si_me.sin_family = AF_INET; - si_me.sin_port = htons((short)atoi(audio_in_name+4)); - si_me.sin_addr.s_addr = htonl(INADDR_ANY); - - //Bind to the socket - if (bind(udp_sock, (const struct sockaddr *) &si_me, sizeof(si_me))==-1) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Couldn't bind socket, errno %d\n", errno); - return -1; - } - } - inbuf_size_in_bytes = SDR_UDP_BUF_MAXLEN; - - break; - -/* - * stdin. - */ - case AUDIO_IN_TYPE_STDIN: - - /* Do we need to adjust any properties of stdin? */ - - inbuf_size_in_bytes = 1024; - - break; - - default: - - text_color_set(DW_COLOR_ERROR); - dw_printf ("Internal error, invalid audio_in_type\n"); - return (-1); - } - -/* - * Output device. Only "soundcard" is supported at this time. - */ - -#if USE_ALSA - err = snd_pcm_open (&audio_out_handle, audio_out_name, SND_PCM_STREAM_PLAYBACK, 0); - - if (err < 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Could not open audio device %s for output\n%s\n", - audio_out_name, snd_strerror(err)); - return (-1); - } - - outbuf_size_in_bytes = set_alsa_params (audio_out_handle, pa, audio_out_name, "output"); - - if (inbuf_size_in_bytes <= 0 || outbuf_size_in_bytes <= 0) { - return (-1); - } - -#endif - -/* - * Finally allocate buffer for each direction. - */ - inbuf_ptr = malloc(inbuf_size_in_bytes); - assert (inbuf_ptr != NULL); - inbuf_len = 0; - inbuf_next = 0; - - outbuf_ptr = malloc(outbuf_size_in_bytes); - assert (outbuf_ptr != NULL); - outbuf_len = 0; - - return (0); - -} /* end audio_open */ - - - - -#if USE_ALSA - -/* - * Set parameters for sound card. - * - * See ?? for details. - */ -/* - * Terminology: - * Sample - for one channel. e.g. 2 bytes for 16 bit. - * Frame - one sample for all channels. e.g. 4 bytes for 16 bit stereo - * Period - size of one transfer. - */ - -static int set_alsa_params (snd_pcm_t *handle, struct audio_s *pa, char *devname, char *inout) -{ - - snd_pcm_hw_params_t *hw_params; - snd_pcm_uframes_t fpp; /* Frames per period. */ - - unsigned int val; - - int dir; - int err; - - int buf_size_in_bytes; /* result, number of bytes per transfer. */ - - - err = snd_pcm_hw_params_malloc (&hw_params); - if (err < 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Could not alloc hw param structure.\n%s\n", - snd_strerror(err)); - dw_printf ("for %s %s.\n", devname, inout); - return (-1); - } - - err = snd_pcm_hw_params_any (handle, hw_params); - if (err < 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Could not init hw param structure.\n%s\n", - snd_strerror(err)); - dw_printf ("for %s %s.\n", devname, inout); - return (-1); - } - - /* Interleaved data: L, R, L, R, ... */ - - err = snd_pcm_hw_params_set_access (handle, hw_params, SND_PCM_ACCESS_RW_INTERLEAVED); - - if (err < 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Could not set interleaved mode.\n%s\n", - snd_strerror(err)); - dw_printf ("for %s %s.\n", devname, inout); - return (-1); - } - - /* Signed 16 bit little endian or unsigned 8 bit. */ - - - err = snd_pcm_hw_params_set_format (handle, hw_params, - pa->bits_per_sample == 8 ? SND_PCM_FORMAT_U8 : SND_PCM_FORMAT_S16_LE); - if (err < 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Could not set bits per sample.\n%s\n", - snd_strerror(err)); - dw_printf ("for %s %s.\n", devname, inout); - return (-1); - } - - /* Number of audio channels. */ - - - err = snd_pcm_hw_params_set_channels (handle, hw_params, pa->num_channels); - if (err < 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Could not set number of audio channels.\n%s\n", - snd_strerror(err)); - dw_printf ("for %s %s.\n", devname, inout); - return (-1); - } - - /* Audio sample rate. */ - - - val = pa->samples_per_sec; - - dir = 0; - - - err = snd_pcm_hw_params_set_rate_near (handle, hw_params, &val, &dir); - if (err < 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Could not set audio sample rate.\n%s\n", - snd_strerror(err)); - dw_printf ("for %s %s.\n", devname, inout); - return (-1); - } - - if (val != pa->samples_per_sec) { - - text_color_set(DW_COLOR_INFO); - dw_printf ("Asked for %d samples/sec but got %d.\n", - - pa->samples_per_sec, val); - dw_printf ("for %s %s.\n", devname, inout); - - pa->samples_per_sec = val; - - } - - /* Guessing around 20 reads/sec might be good. */ - /* Period too long = too much latency. */ - /* Period too short = too much overhead of many small transfers. */ - - fpp = pa->samples_per_sec / 20; - -#if DEBUG - - text_color_set(DW_COLOR_DEBUG); - - - dw_printf ("suggest period size of %d frames\n", (int)fpp); - -#endif - dir = 0; - err = snd_pcm_hw_params_set_period_size_near (handle, hw_params, &fpp, &dir); - - if (err < 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Could not set period size\n%s\n", snd_strerror(err)); - dw_printf ("for %s %s.\n", devname, inout); - return (-1); - } - - - - err = snd_pcm_hw_params (handle, hw_params); - if (err < 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Could not set hw params\n%s\n", snd_strerror(err)); - dw_printf ("for %s %s.\n", devname, inout); - return (-1); - } - - - /* Driver might not like our suggested period size */ - /* and might have another idea. */ - - err = snd_pcm_hw_params_get_period_size (hw_params, &fpp, NULL); - if (err < 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Could not get audio period size.\n%s\n", snd_strerror(err)); - dw_printf ("for %s %s.\n", devname, inout); - return (-1); - } - - snd_pcm_hw_params_free (hw_params); - - /* A "frame" is one sample for all channels. */ - - /* The read and write use units of frames, not bytes. */ - - bytes_per_frame = snd_pcm_frames_to_bytes (handle, 1); - assert (bytes_per_frame == pa->num_channels * pa->bits_per_sample / 8); - - - buf_size_in_bytes = fpp * bytes_per_frame; - - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("audio buffer size = %d (bytes per frame) x %d (frames per period) = %d \n", bytes_per_frame, (int)fpp, buf_size_in_bytes); -#endif - - return (buf_size_in_bytes); - - -} /* end alsa_set_params */ - - -#else - - -/* - * Set parameters for sound card. (OSS only) - * - * See /usr/include/sys/soundcard.h for details. - */ - -static int set_oss_params (int fd, struct audio_s *pa) -{ - int err; - int devcaps; - int asked_for; - char message[100]; - int ossbuf_size_in_bytes; - - - err = ioctl (fd, SNDCTL_DSP_CHANNELS, &(pa->num_channels)); - if (err == -1) { - text_color_set(DW_COLOR_ERROR); - perror("Not able to set audio device number of channels"); - return (-1); - } - - asked_for = pa->samples_per_sec; - - err = ioctl (fd, SNDCTL_DSP_SPEED, &(pa->samples_per_sec)); - if (err == -1) { - text_color_set(DW_COLOR_ERROR); - perror("Not able to set audio device sample rate"); - return (-1); - } - - if (pa->samples_per_sec != asked_for) { - text_color_set(DW_COLOR_INFO); - dw_printf ("Asked for %d samples/sec but actually using %d.\n", - asked_for, pa->samples_per_sec); - } - - /* This is actually a bit mask but it happens that */ - /* 0x8 is unsigned 8 bit samples and */ - /* 0x10 is signed 16 bit little endian. */ - - err = ioctl (fd, SNDCTL_DSP_SETFMT, &(pa->bits_per_sample)); - if (err == -1) { - text_color_set(DW_COLOR_ERROR); - perror("Not able to set audio device sample size"); - return (-1); - } - -/* - * Determine capabilities. - */ - err = ioctl (fd, SNDCTL_DSP_GETCAPS, &devcaps); - if (err == -1) { - text_color_set(DW_COLOR_ERROR); - perror("Not able to get audio device capabilities"); - // Is this fatal? // return (-1); - } - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("audio_open(): devcaps = %08x\n", devcaps); - if (devcaps & DSP_CAP_DUPLEX) dw_printf ("Full duplex record/playback.\n"); - if (devcaps & DSP_CAP_BATCH) dw_printf ("Device has some kind of internal buffers which may cause delays.\n"); - if (devcaps & ~ (DSP_CAP_DUPLEX | DSP_CAP_BATCH)) dw_printf ("Others...\n"); -#endif - - if (!(devcaps & DSP_CAP_DUPLEX)) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Audio device does not support full duplex\n"); - // Do we care? // return (-1); - } - - err = ioctl (fd, SNDCTL_DSP_SETDUPLEX, NULL); - if (err == -1) { - // text_color_set(DW_COLOR_ERROR); - // perror("Not able to set audio full duplex mode"); - // Unfortunate but not a disaster. - } - -/* - * Get preferred block size. - * Presumably this will provide the most efficient transfer. - * - * In my particular situation, this turned out to be - * 2816 for 11025 Hz 16 bit mono - * 5568 for 11025 Hz 16 bit stereo - * 11072 for 44100 Hz 16 bit mono - * - * Your milage may vary. - */ - err = ioctl (fd, SNDCTL_DSP_GETBLKSIZE, &ossbuf_size_in_bytes); - if (err == -1) { - text_color_set(DW_COLOR_ERROR); - perror("Not able to get audio block size"); - ossbuf_size_in_bytes = 2048; /* pick something reasonable */ - } - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("audio_open(): suggestd block size is %d\n", ossbuf_size_in_bytes); -#endif - -/* - * That's 1/8 of a second which seems rather long if we want to - * respond quickly. - */ - - ossbuf_size_in_bytes = calcbufsize(pa->samples_per_sec, pa->num_channels, pa->bits_per_sample); - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("audio_open(): using block size of %d\n", ossbuf_size_in_bytes); -#endif - - assert (ossbuf_size_in_bytes >= 256 && ossbuf_size_in_bytes <= 32768); - - - return (ossbuf_size_in_bytes); - -} /* end set_oss_params */ - - -#endif - - - -/*------------------------------------------------------------------ - * - * Name: audio_get - * - * Purpose: Get one byte from the audio device. - * - * Returns: 0 - 255 for a valid sample. - * -1 for any type of error. - * - * Description: The caller must deal with the details of mono/stereo - * and number of bytes per sample. - * - * This will wait if no data is currently available. - * - *----------------------------------------------------------------*/ - -// Use hot attribute for all functions called for every audio sample. - -__attribute__((hot)) -int audio_get (void) -{ - int n; - int retries = 0; - -#if STATISTICS - /* Gather numbers for read from audio device. */ - - static int duration = 100; /* report every 100 seconds. */ - static time_t last_time = 0; - time_t this_time; - static int sample_count; - static int error_count; -#endif - -#if DEBUGx - text_color_set(DW_COLOR_DEBUG); - - dw_printf ("audio_get():\n"); - -#endif - - assert (inbuf_size_in_bytes >= 100 && inbuf_size_in_bytes <= 32768); - - -#if USE_ALSA - - switch (audio_in_type) { - -/* - * Soundcard - ALSA - */ - case AUDIO_IN_TYPE_SOUNDCARD: - - while (inbuf_next >= inbuf_len) { - - assert (audio_in_handle != NULL); -#if DEBUGx - text_color_set(DW_COLOR_DEBUG); - dw_printf ("audio_get(): readi asking for %d frames\n", inbuf_size_in_bytes / bytes_per_frame); -#endif - n = snd_pcm_readi (audio_in_handle, inbuf_ptr, inbuf_size_in_bytes / bytes_per_frame); - -#if DEBUGx - text_color_set(DW_COLOR_DEBUG); - dw_printf ("audio_get(): readi asked for %d and got %d frames\n", - inbuf_size_in_bytes / bytes_per_frame, n); -#endif - -#if STATISTICS - if (last_time == 0) { - last_time = time(NULL); - sample_count = 0; - error_count = 0; - } - else { - if (n > 0) { - sample_count += n; - } - else { - error_count++; - } - this_time = time(NULL); - if (this_time >= last_time + duration) { - text_color_set(DW_COLOR_DEBUG); - dw_printf ("\nPast %d seconds, %d audio samples processed, %d errors.\n\n", - duration, sample_count, error_count); - last_time = this_time; - sample_count = 0; - error_count = 0; - } - } -#endif - - if (n > 0) { - - /* Success */ - - inbuf_len = n * bytes_per_frame; /* convert to number of bytes */ - inbuf_next = 0; - } - else if (n == 0) { - - /* Didn't expect this, but it's not a problem. */ - /* Wait a little while and try again. */ - - text_color_set(DW_COLOR_ERROR); - dw_printf ("Audio input got zero bytes: %s\n", snd_strerror(n)); - SLEEP_MS(10); - - inbuf_len = 0; - inbuf_next = 0; - } - else { - /* Error */ - // TODO: Needs more study and testing. - - // TODO: print n. should snd_strerror use n or errno? - // Audio input device error: Unknown error - - text_color_set(DW_COLOR_ERROR); - dw_printf ("Audio input device error: %s\n", snd_strerror(n)); - - /* Try to recover a few times and eventually give up. */ - if (++retries > 10) { - inbuf_len = 0; - inbuf_next = 0; - return (-1); - } - - if (n == -EPIPE) { - - /* EPIPE means overrun */ - - snd_pcm_recover (audio_in_handle, n, 1); - - } - else { - /* Could be some temporary condition. */ - /* Wait a little then try again. */ - /* Sometimes I get "Resource temporarily available" */ - /* when the Update Manager decides to run. */ - - SLEEP_MS (250); - snd_pcm_recover (audio_in_handle, n, 1); - } - } - } - break; - -/* - * UDP. - */ - - case AUDIO_IN_TYPE_SDR_UDP: - - while (inbuf_next >= inbuf_len) { - int ch, res,i; - - assert (udp_sock > 0); - res = recv(udp_sock, inbuf_ptr, inbuf_size_in_bytes, 0); - if (res < 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Can't read from udp socket, res=%d", res); - inbuf_len = 0; - inbuf_next = 0; - return (-1); - } - - inbuf_len = res; - inbuf_next = 0; - } - break; - -/* - * stdin. - */ - case AUDIO_IN_TYPE_STDIN: - - while (inbuf_next >= inbuf_len) { - int ch, res,i; - - res = read(STDIN_FILENO, inbuf_ptr, (size_t)inbuf_size_in_bytes); - if (res <= 0) { - text_color_set(DW_COLOR_INFO); - dw_printf ("\nEnd of file on stdin. Exiting.\n"); - exit (0); - } - - inbuf_len = res; - inbuf_next = 0; - } - - break; - } - - - -#else /* end ALSA, begin OSS */ - - while (audio_in_type == AUDIO_IN_TYPE_SOUNDCARD && inbuf_next >= inbuf_len) { - assert (oss_audio_device_fd > 0); - n = read (oss_audio_device_fd, inbuf_ptr, inbuf_size_in_bytes); - //text_color_set(DW_COLOR_DEBUG); - // dw_printf ("audio_get(): read %d returns %d\n", inbuf_size_in_bytes, n); - if (n < 0) { - text_color_set(DW_COLOR_ERROR); - perror("Can't read from audio device"); - inbuf_len = 0; - inbuf_next = 0; - return (-1); - } - inbuf_len = n; - inbuf_next = 0; - } - -#endif /* USE_ALSA */ - - - - if (inbuf_next < inbuf_len) - n = inbuf_ptr[inbuf_next++]; - //No data to read, avoid reading outside buffer - else - n = 0; - -#if DEBUGx - - text_color_set(DW_COLOR_DEBUG); - dw_printf ("audio_get(): returns %d\n", n); - -#endif - - - return (n); - -} /* end audio_get */ - - -/*------------------------------------------------------------------ - * - * Name: audio_put - * - * Purpose: Send one byte to the audio device. - * - * Inputs: c - One byte in range of 0 - 255. - * - * Returns: Normally non-negative. - * -1 for any type of error. - * - * Description: The caller must deal with the details of mono/stereo - * and number of bytes per sample. - * - * See Also: audio_flush - * audio_wait - * - *----------------------------------------------------------------*/ - -int audio_put (int c) -{ - /* Should never be full at this point. */ - assert (outbuf_len < outbuf_size_in_bytes); - - outbuf_ptr[outbuf_len++] = c; - - if (outbuf_len == outbuf_size_in_bytes) { - return (audio_flush()); - } - - return (0); - -} /* end audio_put */ - - -/*------------------------------------------------------------------ - * - * Name: audio_flush - * - * Purpose: Push out any partially filled output buffer. - * - * Returns: Normally non-negative. - * -1 for any type of error. - * - * See Also: audio_flush - * audio_wait - * - *----------------------------------------------------------------*/ - -int audio_flush (void) -{ -#if USE_ALSA - int k; - char *psound; - int retries = 10; - snd_pcm_status_t *status; - - assert (audio_out_handle != NULL); - - -/* - * Trying to set the automatic start threshold didn't have the desired - * effect. After the first transmitted packet, they are saved up - * for a few minutes and then all come out together. - * - * "Prepare" it if not already in the running state. - * We stop it at the end of each transmitted packet. - */ - - - snd_pcm_status_alloca(&status); - - k = snd_pcm_status (audio_out_handle, status); - if (k != 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Audio output get status error.\n%s\n", snd_strerror(k)); - } - - if ((k = snd_pcm_status_get_state(status)) != SND_PCM_STATE_RUNNING) { - - //text_color_set(DW_COLOR_DEBUG); - //dw_printf ("Audio output state = %d. Try to start.\n", k); - - k = snd_pcm_prepare (audio_out_handle); - - if (k != 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Audio output start error.\n%s\n", snd_strerror(k)); - } - } - - - psound = outbuf_ptr; - - while (retries-- > 0) { - - k = snd_pcm_writei (audio_out_handle, psound, outbuf_len / bytes_per_frame); -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("audio_flush(): snd_pcm_writei %d frames returns %d\n", - outbuf_len / bytes_per_frame, k); - fflush (stdout); -#endif - if (k == -EPIPE) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Audio output data underrun.\n"); - - /* No problemo. Recover and go around again. */ - - snd_pcm_recover (audio_out_handle, k, 1); - } - else if (k < 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Audio write error: %s\n", snd_strerror(k)); - - /* Some other error condition. */ - /* Try again. What do we have to lose? */ - - snd_pcm_recover (audio_out_handle, k, 1); - } - else if (k != outbuf_len / bytes_per_frame) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Audio write took %d frames rather than %d.\n", - k, outbuf_len / bytes_per_frame); - - /* Go around again with the rest of it. */ - - psound += k * bytes_per_frame; - outbuf_len -= k * bytes_per_frame; - } - else { - /* Success! */ - outbuf_len = 0; - return (0); - } - } - - text_color_set(DW_COLOR_ERROR); - dw_printf ("Audio write error retry count exceeded.\n"); - - outbuf_len = 0; - return (-1); - -#else /* OSS */ - - int k; - unsigned char *ptr; - int len; - - ptr = outbuf_ptr; - len = outbuf_len; - - while (len > 0) { - assert (oss_audio_device_fd > 0); - k = write (oss_audio_device_fd, ptr, len); -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("audio_flush(): write %d returns %d\n", len, k); - fflush (stdout); -#endif - if (k < 0) { - text_color_set(DW_COLOR_ERROR); - perror("Can't write to audio device"); - outbuf_len = 0; - return (-1); - } - if (k < len) { - /* presumably full but didn't block. */ - usleep (10000); - } - ptr += k; - len -= k; - } - - outbuf_len = 0; - return (0); -#endif - -} /* end audio_flush */ - - -/*------------------------------------------------------------------ - * - * Name: audio_wait - * - * Purpose: Wait until all the queued up audio out has been played. - * - * Inputs: duration - hint at number of milliseconds to wait. - * - * Returns: Normally non-negative. - * -1 for any type of error. - * - * Description: In our particular application, we would want to make sure - * that the entire packet has been sent out before turning - * off the transmitter PTT control. - * - * In an ideal world: - * - * We would like to ask the hardware when all the queued - * up sound has actually come out the speaker. - * There is an OSS system call for this but it doesn't work - * on Cygwin. The application crashes at a later time. - * - * Haven't yet verified correct operation with ALSA. - * - * In reality: - * - * Caller does the following: - * - * (1) Make note of when PTT is turned on. - * (2) Calculate how long it will take to transmit the - * frame including TXDELAY, frame (including - * "flags", data, FCS and bit stuffing), and TXTAIL. - * (3) Add (1) and (2) resulting in when PTT should be turned off. - * (4) Take difference between current time and PPT off time - * and provide this as the additional delay required. - * - *----------------------------------------------------------------*/ - -int audio_wait (int duration) -{ - int err = 0; - - audio_flush (); -#if DEBUGx - text_color_set(DW_COLOR_DEBUG); - dw_printf ("audio_wait(): before sync, fd=%d\n", oss_audio_device_fd); -#endif - -#if USE_ALSA - - //double t_enter, t_leave; - //int drain_ms; - - //t_enter = dtime_now(); - - /* For playback, this should wait for all pending frames */ - /* to be played and then stop. */ - - snd_pcm_drain (audio_out_handle); - - //t_leave = dtime_now(); - //drain_ms = (int)((t_leave - t_enter) * 1000.); - - //text_color_set(DW_COLOR_DEBUG); - //dw_printf ("audio_wait(): suggested delay = %d ms, actual = %d\n", - // duration, drain_ms); - - /* - * Experimentation reveals that snd_pcm_drain doesn't - * actually wait. It returns immediately. - * However it does serve a useful purpose of stopping - * the playback after all the queued up data is used. - * - * Keep the sleep delay so PTT is not turned off too soon. - */ - - if (duration > 0) { - SLEEP_MS (duration); - } - -#else - - assert (oss_audio_device_fd > 0); - - - // This causes a crash later on Cygwin. - // Haven't tried it on Linux yet. - - // err = ioctl (oss_audio_device_fd, SNDCTL_DSP_SYNC, NULL); - - if (duration > 0) { - SLEEP_MS (duration); - } - -#endif - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("audio_wait(): after sync, status=%d\n", err); -#endif - - return (err); - -} /* end audio_wait */ - - -/*------------------------------------------------------------------ - * - * Name: audio_close - * - * Purpose: Close the audio device. - * - * Returns: Normally non-negative. - * -1 for any type of error. - * - * - *----------------------------------------------------------------*/ - -int audio_close (void) -{ - int err = 0; - -#if USE_ALSA - assert (audio_in_handle != NULL); - assert (audio_out_handle != NULL); - - audio_wait (0); - - snd_pcm_close (audio_in_handle); - snd_pcm_close (audio_out_handle); - -#else - assert (oss_audio_device_fd > 0); - - audio_wait (0); - - close (oss_audio_device_fd); - - oss_audio_device_fd = -1; -#endif - free (inbuf_ptr); - free (outbuf_ptr); - - inbuf_size_in_bytes = 0; - inbuf_ptr = NULL; - inbuf_len = 0; - inbuf_next = 0; - - outbuf_size_in_bytes = 0; - outbuf_ptr = NULL; - outbuf_len = 0; - - return (err); - -} /* end audio_close */ - - -/* end audio.c */ - diff --git a/audio.h b/audio.h deleted file mode 100644 index 8c40afab..00000000 --- a/audio.h +++ /dev/null @@ -1,212 +0,0 @@ - -/*------------------------------------------------------------------ - * - * Module: audio.h - * - * Purpose: Interface to audio device commonly called a "sound card." - * - *---------------------------------------------------------------*/ - - -#ifndef AUDIO_H -#define AUDIO_H 1 - -#include "direwolf.h" /* for MAX_CHANS used throughout the application. */ -#include "hdlc_rec2.h" /* for enum retry_e */ - - -/* - * PTT control. - */ - -enum ptt_method_e { - PTT_METHOD_NONE, /* VOX or no transmit. */ - PTT_METHOD_SERIAL, /* Serial port RTS or DTR. */ - PTT_METHOD_GPIO, /* General purpose I/O, Linux only. */ - PTT_METHOD_LPT }; /* Parallel printer port, Linux only. */ - -typedef enum ptt_method_e ptt_method_t; - -enum ptt_line_e { PTT_LINE_RTS = 1, PTT_LINE_DTR = 2 }; -typedef enum ptt_line_e ptt_line_t; - -enum audio_in_type_e { - AUDIO_IN_TYPE_SOUNDCARD, - AUDIO_IN_TYPE_SDR_UDP, - AUDIO_IN_TYPE_STDIN }; - -struct audio_s { - - /* Properites of the sound device. */ - - char adevice_in[80]; /* Name of the audio input device (or file?). */ - /* TODO: Can be "-" to read from stdin. */ - - char adevice_out[80]; /* Name of the audio output device (or file?). */ - - int num_channels; /* Should be 1 for mono or 2 for stereo. */ - int samples_per_sec; /* Audio sampling rate. Typically 11025, 22050, or 44100. */ - int bits_per_sample; /* 8 (unsigned char) or 16 (signed short). */ - - enum audio_in_type_e audio_in_type; - /* Where is input (receive) audio coming from? */ - - /* Common to all channels. */ - - enum retry_e fix_bits; /* Level of effort to recover from */ - /* a bad FCS on the frame. */ - - /* Properties for each audio channel, common to receive and transmit. */ - /* Can be different for each radio channel. */ - - enum modem_t {AFSK, NONE, SCRAMBLE} modem_type[MAX_CHANS]; - /* Usual AFSK. */ - /* Baseband signal. */ - /* Scrambled http://www.amsat.org/amsat/articles/g3ruh/109/fig03.gif */ - - int decimate[MAX_CHANS]; /* Reduce AFSK sample rate by this factor to */ - /* decrease computational requirements. */ - - int mark_freq[MAX_CHANS]; /* Two tones for AFSK modulation, in Hz. */ - int space_freq[MAX_CHANS]; /* Standard tones are 1200 and 2200 for 1200 baud. */ - - int baud[MAX_CHANS]; /* Data bits (more accurately, symbols) per second. */ - /* Standard rates are 1200 for VHF and 300 for HF. */ - - char profiles[MAX_CHANS][16]; /* 1 or more of ABC etc. */ - - int num_freq[MAX_CHANS]; /* Number of different frequency pairs for decoders. */ - - int offset[MAX_CHANS]; /* Spacing between filter frequencies. */ - - int num_subchan[MAX_CHANS]; /* Total number of modems / hdlc decoders for each channel. */ - /* Potentially it could be product of strlen(profiles) * num_freq. */ - /* Currently can't use both at once. */ - - - /* Additional properties for transmit. */ - - ptt_method_t ptt_method[MAX_CHANS]; /* serial port or GPIO. */ - - char ptt_device[MAX_CHANS][20]; /* Serial device name for PTT. e.g. COM1 or /dev/ttyS0 */ - - ptt_line_t ptt_line[MAX_CHANS]; /* Control line wehn using serial port. */ - /* PTT_RTS, PTT_DTR. */ - - int ptt_gpio[MAX_CHANS]; /* GPIO number. */ - - int ptt_lpt_bit[MAX_CHANS]; /* Bit number for parallel printer port. */ - /* Bit 0 = pin 2, ..., bit 7 = pin 9. */ - - int ptt_invert[MAX_CHANS]; /* Invert the output. */ - - int slottime[MAX_CHANS]; /* Slot time in 10 mS units for persistance algorithm. */ - /* Typical value is 10 meaning 100 milliseconds. */ - - int persist[MAX_CHANS]; /* Sets probability for transmitting after each */ - /* slot time delay. Transmit if a random number */ - /* in range of 0 - 255 <= persist value. */ - /* Otherwise wait another slot time and try again. */ - /* Default value is 63 for 25% probability. */ - - int txdelay[MAX_CHANS]; /* After turning on the transmitter, */ - /* send "flags" for txdelay * 10 mS. */ - /* Default value is 30 meaning 300 milliseconds. */ - - int txtail[MAX_CHANS]; /* Amount of time to keep transmitting after we */ - /* are done sending the data. This is to avoid */ - /* dropping PTT too soon and chopping off the end */ - /* of the frame. Again 10 mS units. */ - /* At this point, I'm thinking of 10 as the default. */ -}; - -#if __WIN32__ -#define DEFAULT_ADEVICE "" /* Windows: Empty string = default audio device. */ -#else -#if USE_ALSA -#define DEFAULT_ADEVICE "default" /* Use default device for ALSA. */ -#else -#define DEFAULT_ADEVICE "/dev/dsp" /* First audio device for OSS. */ -#endif -#endif - - -/* - * UDP audio receiving port. Couldn't find any standard or usage precedent. - * Got the number from this example: http://gqrx.dk/doc/streaming-audio-over-udp - * Any better suggestions? - */ - -#define DEFAULT_UDP_AUDIO_PORT 7355 - - -// Maximum size of the UDP buffer (for allowing IP routing, udp packets are often limited to 1472 bytes) - -#define SDR_UDP_BUF_MAXLEN 2000 - - - -#define DEFAULT_NUM_CHANNELS 1 -#define DEFAULT_SAMPLES_PER_SEC 44100 /* Very early observations. Might no longer be valid. */ - /* 22050 works a lot better than 11025. */ - /* 44100 works a little better than 22050. */ - /* If you have a reasonable machine, use the highest rate. */ -#define MIN_SAMPLES_PER_SEC 8000 -#define MAX_SAMPLES_PER_SEC 48000 /* Formerly 44100. */ - /* Software defined radio often uses 48000. */ - -#define DEFAULT_BITS_PER_SAMPLE 16 - -#define DEFAULT_FIX_BITS RETRY_SWAP_SINGLE - -/* - * Standard for AFSK on VHF FM. - * Reversing mark and space makes no difference because - * NRZI encoding only cares about change or lack of change - * between the two tones. - * - * HF SSB uses 300 baud and 200 Hz shift. - * 1600 & 1800 Hz is a popular tone pair, sometimes - * called the KAM tones. - */ - -#define DEFAULT_MARK_FREQ 1200 -#define DEFAULT_SPACE_FREQ 2200 -#define DEFAULT_BAUD 1200 - - - -/* - * Typical transmit timings for VHF. - */ - -#define DEFAULT_SLOTTIME 10 -#define DEFAULT_PERSIST 63 -#define DEFAULT_TXDELAY 30 -#define DEFAULT_TXTAIL 10 /* not sure yet. */ - - -/* - * Note that we have two versions of these in audio.c and audio_win.c. - * Use one or the other depending on the platform. - */ - - -int audio_open (struct audio_s *pa); - -int audio_get (void); - -int audio_put (int c); - -int audio_flush (void); - -int audio_wait (int duration); - -int audio_close (void); - - -#endif /* ifdef AUDIO_H */ - - -/* end audio.h */ - diff --git a/audio_win.c b/audio_win.c deleted file mode 100644 index cd339555..00000000 --- a/audio_win.c +++ /dev/null @@ -1,1044 +0,0 @@ - -#define DEBUGUDP 1 - - -// -// This file is part of Dire Wolf, an amateur radio packet TNC. -// -// Copyright (C) 2011,2012,2013 John Langner, WB2OSZ -// -// This program 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 2 of the License, or -// (at your option) any later version. -// -// This program 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 this program. If not, see . -// - - -/*------------------------------------------------------------------ - * - * Module: audio.c - * - * Purpose: Interface to audio device commonly called a "sound card" for - * historical reasons. - * - * - * This version uses the native Windows sound interface. - * - * Credits: Fabrice FAURE contributed Linux code for the SDR UDP interface. - * - * Discussion here: http://gqrx.dk/doc/streaming-audio-over-udp - * - *---------------------------------------------------------------*/ - - -#include -#include -#include -#include -#include -#include -#include -#include - -#include -#include - -#ifndef WAVE_FORMAT_96M16 -#define WAVE_FORMAT_96M16 0x40000 -#define WAVE_FORMAT_96S16 0x80000 -#endif - -#include -#define _WIN32_WINNT 0x0501 -#include - - -#include "direwolf.h" -#include "audio.h" -#include "textcolor.h" -#include "ptt.h" - - - -/* - * Allocate enough buffers for 1 second each direction. - * Each buffer size is a trade off between being responsive - * to activity on the channel vs. overhead of having too - * many little transfers. - */ - -#define TOTAL_BUF_TIME 1000 -#define ONE_BUF_TIME 40 - -#define NUM_IN_BUF ((TOTAL_BUF_TIME)/(ONE_BUF_TIME)) -#define NUM_OUT_BUF ((TOTAL_BUF_TIME)/(ONE_BUF_TIME)) - -static enum audio_in_type_e audio_in_type; - -/* - * UDP socket for receiving audio stream. - * Buffer, length, and pointer for UDP or stdin. - */ - -static SOCKET udp_sock; -static char stream_data[SDR_UDP_BUF_MAXLEN]; -static int stream_len; -static int stream_next; - - -#define roundup1k(n) (((n) + 0x3ff) & ~0x3ff) -#define calcbufsize(rate,chans,bits) roundup1k( ( (rate)*(chans)*(bits) / 8 * ONE_BUF_TIME)/1000 ) - - -/* For sound output. */ -/* out_wavehdr.dwUser is used to keep track of output buffer state. */ - -#define DWU_FILLING 1 /* Ready to use or in process of being filled. */ -#define DWU_PLAYING 2 /* Was given to sound system for playing. */ -#define DWU_DONE 3 /* Sound system is done with it. */ - -static HWAVEOUT audio_out_handle = 0; - -static volatile WAVEHDR out_wavehdr[NUM_OUT_BUF]; -static int out_current; /* index to above. */ -static int outbuf_size; - - -/* For sound input. */ -/* In this case dwUser is index of next available byte to remove. */ - -static HWAVEIN audio_in_handle = 0; -static WAVEHDR in_wavehdr[NUM_IN_BUF]; -static volatile WAVEHDR *in_headp; /* head of queue to process. */ -static CRITICAL_SECTION in_cs; - - - - - - - -/*------------------------------------------------------------------ - * - * Name: print_capabilities - * - * Purpose: Display capabilities of the available audio devices. - * - * Example: - * - * - * Available audio input devices for receive (*=selected): - * 0: Microphone (Realtek High Defini mono: 11 22 44 96 stereo: 11 22 44 96 - * 1: Microphone (Bluetooth SCO Audio mono: 11 22 44 96 stereo: 11 22 44 96 - * 2: Microphone (Bluetooth AV Audio) mono: 11 22 44 96 stereo: 11 22 44 96 - * 3: Microphone (USB PnP Sound Devic mono: 11 22 44 96 stereo: 11 22 44 96 - * Available audio output devices for transmit (*=selected): - * 0: Speakers (Realtek High Definiti mono: 11 22 44 96 stereo: 11 22 44 96 - * 1: Speakers (Bluetooth SCO Audio) mono: 11 22 44 96 stereo: 11 22 44 96 - * 2: Realtek Digital Output (Realtek mono: 11 22 44 96 stereo: 11 22 44 96 - * 3: Realtek Digital Output(Optical) mono: 11 22 44 96 stereo: 11 22 44 96 - * 4: Speakers (Bluetooth AV Audio) mono: 11 22 44 96 stereo: 11 22 44 96 - * 5: Speakers (USB PnP Sound Device) mono: 11 22 44 96 stereo: 11 22 44 96 - * - * - * History: Removed in version 0.9. - * - * Post Mortem discussion: - * - * It turns out to be quite bogus and perhaps deceiving. - * - * The chip (http://www.szlnst.com/Uploadfiles/HS100.pdf) in the cheap - * USB Audio device is physically capable of only 44.1 and 48 KHz - * sampling rates. Input is mono only. Output is stereo only. - * There is discussion of this in the Raspberry Pi document. - * - * Here, it looks like it has much more general capabilities. - * It seems the audio system puts some virtual layer on top of - * it to provide resampling for different rates and silent - * right channel for stereo input. - * - * - *----------------------------------------------------------------*/ - -#if 0 -static void print_capabilities (DWORD formats) -{ - dw_printf (" mono:"); - dw_printf ("%s", (formats & WAVE_FORMAT_1M16) ? " 11" : " "); - dw_printf ("%s", (formats & WAVE_FORMAT_2M16) ? " 22" : " "); - dw_printf ("%s", (formats & WAVE_FORMAT_4M16) ? " 44" : " "); - dw_printf ("%s", (formats & WAVE_FORMAT_96M16) ? " 96" : " "); - - dw_printf (" stereo:"); - dw_printf ("%s", (formats & WAVE_FORMAT_1S16) ? " 11" : " "); - dw_printf ("%s", (formats & WAVE_FORMAT_2S16) ? " 22" : " "); - dw_printf ("%s", (formats & WAVE_FORMAT_4S16) ? " 44" : " "); - dw_printf ("%s", (formats & WAVE_FORMAT_96S16) ? " 96" : " "); -} -#endif - - - -/*------------------------------------------------------------------ - * - * Name: audio_open - * - * Purpose: Open the digital audio device. - * - * New in version 1.0, we recognize "udp:" optionally - * followed by a port number. - * - * Inputs: pa - Address of structure of type audio_s. - * - * Using a structure, rather than separate arguments - * seemed to make sense because we often pass around - * the same set of parameters various places. - * - * The fields that we care about are: - * num_channels - * samples_per_sec - * bits_per_sample - * If zero, reasonable defaults will be provided. - * - * Outputs: pa - The ACTUAL values are returned here. - * - * The Linux version adjusts strange values to the - * nearest valid value. Don't know, yet, if Windows - * does the same or just fails. Or performs some - * expensive resampling from a rate supported by - * hardware. - * - * These might not be exactly the same as what was requested. - * - * Example: ask for stereo, 16 bits, 22050 per second. - * An ordinary desktop/laptop PC should be able to handle this. - * However, some other sort of smaller device might be - * more restrictive in its capabilities. - * It might say, the best I can do is mono, 8 bit, 8000/sec. - * - * The sofware modem must use this ACTUAL information - * that the device is supplying, that could be different - * than what the user specified. - * - * Returns: 0 for success, -1 for failure. - * - * References: Multimedia Reference - * - * http://msdn.microsoft.com/en-us/library/windows/desktop/dd743606%28v=vs.85%29.aspx - * - *----------------------------------------------------------------*/ - - -static void CALLBACK in_callback (HWAVEIN handle, UINT msg, DWORD instance, DWORD param1, DWORD param2); -static void CALLBACK out_callback (HWAVEOUT handle, UINT msg, DWORD instance, DWORD param1, DWORD param2); - -int audio_open (struct audio_s *pa) -{ - int err; - int chan; - int n; - int in_dev_no; - int out_dev_no; - - WAVEFORMATEX wf; - - int num_devices; - WAVEINCAPS wic; - WAVEOUTCAPS woc; - - assert (audio_in_handle == 0); - assert (audio_out_handle == 0); - - -/* - * Fill in defaults for any missing values. - */ - if (pa -> num_channels == 0) - pa -> num_channels = DEFAULT_NUM_CHANNELS; - - if (pa -> samples_per_sec == 0) - pa -> samples_per_sec = DEFAULT_SAMPLES_PER_SEC; - - if (pa -> bits_per_sample == 0) - pa -> bits_per_sample = DEFAULT_BITS_PER_SAMPLE; - - for (chan=0; chan mark_freq[chan] == 0) - pa -> mark_freq[chan] = DEFAULT_MARK_FREQ; - - if (pa -> space_freq[chan] == 0) - pa -> space_freq[chan] = DEFAULT_SPACE_FREQ; - - if (pa -> baud[chan] == 0) - pa -> baud[chan] = DEFAULT_BAUD; - - if (pa->num_subchan[chan] == 0) - pa->num_subchan[chan] = 1; - } - - wf.wFormatTag = WAVE_FORMAT_PCM; - wf.nChannels = pa -> num_channels; - wf.nSamplesPerSec = pa -> samples_per_sec; - wf.wBitsPerSample = pa -> bits_per_sample; - wf.nBlockAlign = (wf.wBitsPerSample / 8) * wf.nChannels; - wf.nAvgBytesPerSec = wf.nBlockAlign * wf.nSamplesPerSec; - wf.cbSize = 0; - - outbuf_size = calcbufsize(wf.nSamplesPerSec,wf.nChannels,wf.wBitsPerSample); - - - udp_sock = INVALID_SOCKET; - - in_dev_no = WAVE_MAPPER; /* = -1 */ - out_dev_no = WAVE_MAPPER; - -/* - * Determine the type of audio input and select device. - */ - - if (strcasecmp(pa->adevice_in, "stdin") == 0 || strcmp(pa->adevice_in, "-") == 0) { - audio_in_type = AUDIO_IN_TYPE_STDIN; - /* Change - to stdin for readability. */ - strcpy (pa->adevice_in, "stdin"); - } - else if (strncasecmp(pa->adevice_in, "udp:", 4) == 0) { - audio_in_type = AUDIO_IN_TYPE_SDR_UDP; - /* Supply default port if none specified. */ - if (strcasecmp(pa->adevice_in,"udp") == 0 || - strcasecmp(pa->adevice_in,"udp:") == 0) { - sprintf (pa->adevice_in, "udp:%d", DEFAULT_UDP_AUDIO_PORT); - } - } - else { - audio_in_type = AUDIO_IN_TYPE_SOUNDCARD; - - /* Does config file have a number? */ - /* If so, it is an index into list of devices. */ - - if (strlen(pa->adevice_in) == 1 && isdigit(pa->adevice_in[0])) { - in_dev_no = atoi(pa->adevice_in); - } - - /* Otherwise, does it have search string? */ - - if (in_dev_no == WAVE_MAPPER && strlen(pa->adevice_in) >= 1) { - num_devices = waveInGetNumDevs(); - for (n=0 ; nadevice_in) != NULL) { - in_dev_no = n; - } - } - } - if (in_dev_no == WAVE_MAPPER) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("\"%s\" doesn't match any of the input devices.\n", pa->adevice_in); - } - } - } - -/* - * Select output device. - */ - if (strlen(pa->adevice_out) == 1 && isdigit(pa->adevice_out[0])) { - out_dev_no = atoi(pa->adevice_out); - } - - if (out_dev_no == WAVE_MAPPER && strlen(pa->adevice_out) >= 1) { - num_devices = waveOutGetNumDevs(); - for (n=0 ; nadevice_out) != NULL) { - out_dev_no = n; - } - } - } - if (out_dev_no == WAVE_MAPPER) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("\"%s\" doesn't match any of the output devices.\n", pa->adevice_out); - } - } - - -/* - * Display what is available and anything selected. - */ - text_color_set(DW_COLOR_INFO); - dw_printf ("Available audio input devices for receive (*=selected):\n"); - - num_devices = waveInGetNumDevs(); - if (in_dev_no < -1 || in_dev_no >= num_devices) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Invalid input (receive) audio device number %d.\n", in_dev_no); - in_dev_no = WAVE_MAPPER; - } - text_color_set(DW_COLOR_INFO); - for (n=0; nadevice_in); - } - - dw_printf ("Available audio output devices for transmit (*=selected):\n"); - - /* TODO? */ - /* No "*" is currently displayed when using the default device. */ - /* Should we put "*" next to the default device when using it? */ - /* Which is the default? The first one? */ - - num_devices = waveOutGetNumDevs(); - if (out_dev_no < -1 || out_dev_no >= num_devices) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Invalid output (transmit) audio device number %d.\n", out_dev_no); - out_dev_no = WAVE_MAPPER; - } - text_color_set(DW_COLOR_INFO); - for (n=0; nadevice_in + 4)); - si_me.sin_addr.s_addr = htonl(INADDR_ANY); - - // Bind to the socket - - if (bind(udp_sock, (SOCKADDR *) &si_me, sizeof(si_me)) != 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Couldn't bind socket, errno %d\n", WSAGetLastError()); - return -1; - } - stream_next= 0; - stream_len = 0; - } - - break; - -/* - * stdin. - */ - case AUDIO_IN_TYPE_STDIN: - - setmode (STDIN_FILENO, _O_BINARY); - stream_next= 0; - stream_len = 0; - - break; - - default: - - text_color_set(DW_COLOR_ERROR); - dw_printf ("Internal error, invalid audio_in_type\n"); - return (-1); - } - - return (0); - -} /* end audio_open */ - - - -/* - * Called when input audio block is ready. - */ - -static void CALLBACK in_callback (HWAVEIN handle, UINT msg, DWORD instance, DWORD param1, DWORD param2) -{ - if (msg == WIM_DATA) { - - WAVEHDR *p = (WAVEHDR*)param1; - - p->dwUser = -1; /* needs to be unprepared. */ - p->lpNext = NULL; - - EnterCriticalSection (&in_cs); - - if (in_headp == NULL) { - in_headp = p; /* first one in list */ - } - else { - WAVEHDR *last = (WAVEHDR*)in_headp; - - while (last->lpNext != NULL) { - last = last->lpNext; - } - last->lpNext = p; /* append to last one */ - } - - LeaveCriticalSection (&in_cs); - } -} - -/* - * Called when output system is done with a block and it - * is again available for us to fill. - */ - - -static void CALLBACK out_callback (HWAVEOUT handle, UINT msg, DWORD instance, DWORD param1, DWORD param2) -{ - if (msg == WOM_DONE) { - - WAVEHDR *p = (WAVEHDR*)param1; - - p->dwBufferLength = 0; - p->dwUser = DWU_DONE; - } -} - - -/*------------------------------------------------------------------ - * - * Name: audio_get - * - * Purpose: Get one byte from the audio device. - * - * Returns: 0 - 255 for a valid sample. - * -1 for any type of error. - * - * Description: The caller must deal with the details of mono/stereo - * and number of bytes per sample. - * - * This will wait if no data is currently available. - * - *----------------------------------------------------------------*/ - -// Use hot attribute for all functions called for every audio sample. - -__attribute__((hot)) -int audio_get (void) -{ - WAVEHDR *p; - int n; - int sample; - -#if DEBUGUDP - /* Gather numbers for read from UDP stream. */ - - static int duration = 100; /* report every 100 seconds. */ - static time_t last_time = 0; - time_t this_time; - static int sample_count; - static int error_count; -#endif - - switch (audio_in_type) { - -/* - * Soundcard. - */ - case AUDIO_IN_TYPE_SOUNDCARD: - - while (1) { - - /* - * Wait if nothing available. - * Could use an event to wake up but this is adequate. - */ - int timeout = 25; - - while (in_headp == NULL) { - SLEEP_MS (ONE_BUF_TIME / 5); - timeout--; - if (timeout <= 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Audio input failure.\n"); - return (-1); - } - } - - p = (WAVEHDR*)in_headp; /* no need to be volatile at this point */ - - if (p->dwUser == -1) { - waveInUnprepareHeader(audio_in_handle, p, sizeof(WAVEHDR)); - p->dwUser = 0; /* Index for next byte. */ - } - - if (p->dwUser < p->dwBytesRecorded) { - n = ((unsigned char*)(p->lpData))[p->dwUser++]; -#if DEBUGx - - text_color_set(DW_COLOR_DEBUG); - dw_printf ("audio_get(): returns %d\n", n); - -#endif - return (n); - } - /* - * Buffer is all used up. Give it back to sound input system. - */ - - EnterCriticalSection (&in_cs); - in_headp = p->lpNext; - LeaveCriticalSection (&in_cs); - - p->dwFlags = 0; - waveInPrepareHeader(audio_in_handle, p, sizeof(WAVEHDR)); - waveInAddBuffer(audio_in_handle, p, sizeof(WAVEHDR)); - } - break; -/* - * UDP. - */ - case AUDIO_IN_TYPE_SDR_UDP: - - while (stream_next >= stream_len) { - int res; - - assert (udp_sock > 0); - - res = recv (udp_sock, stream_data, SDR_UDP_BUF_MAXLEN, 0); - if (res <= 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Can't read from udp socket, errno %d", WSAGetLastError()); - stream_len = 0; - stream_next = 0; - return (-1); - } - -#if DEBUGUDP - if (last_time == 0) { - last_time = time(NULL); - sample_count = 0; - error_count = 0; - } - else { - if (res > 0) { - sample_count += res/2; - } - else { - error_count++; - } - this_time = time(NULL); - if (this_time >= last_time + duration) { - text_color_set(DW_COLOR_DEBUG); - dw_printf ("\nPast %d seconds, %d audio samples processed, %d errors.\n\n", - duration, sample_count, error_count); - last_time = this_time; - sample_count = 0; - error_count = 0; - } - } -#endif - stream_len = res; - stream_next = 0; - } - sample = stream_data[stream_next] & 0xff; - stream_next++; - return (sample); - break; -/* - * stdin. - */ - case AUDIO_IN_TYPE_STDIN: - - while (stream_next >= stream_len) { - int res; - - res = read(STDIN_FILENO, stream_data, 1024); - if (res <= 0) { - text_color_set(DW_COLOR_INFO); - dw_printf ("\nEnd of file on stdin. Exiting.\n"); - exit (0); - } - - stream_len = res; - stream_next = 0; - } - return (stream_data[stream_next++] & 0xff); - break; - } - - return (-1); - -} /* end audio_get */ - - -/*------------------------------------------------------------------ - * - * Name: audio_put - * - * Purpose: Send one byte to the audio device. - * - * Inputs: c - One byte in range of 0 - 255. - * - * - * Global In: out_current - index of output buffer currenly being filled. - * - * Returns: Normally non-negative. - * -1 for any type of error. - * - * Description: The caller must deal with the details of mono/stereo - * and number of bytes per sample. - * - * See Also: audio_flush - * audio_wait - * - *----------------------------------------------------------------*/ - -int audio_put (int c) -{ - WAVEHDR *p; - -/* - * Wait if no buffers are available. - * Don't use p yet because compiler might might consider dwFlags a loop invariant. - */ - - int timeout = 10; - while ( out_wavehdr[out_current].dwUser == DWU_PLAYING) { - SLEEP_MS (ONE_BUF_TIME); - timeout--; - if (timeout <= 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Audio output failure waiting for buffer.\n"); - ptt_term (); - return (-1); - } - } - - p = (LPWAVEHDR)(&(out_wavehdr[out_current])); - - if (p->dwUser == DWU_DONE) { - waveOutUnprepareHeader (audio_out_handle, p, sizeof(WAVEHDR)); - p->dwBufferLength = 0; - p->dwUser = DWU_FILLING; - } - - /* Should never be full at this point. */ - - assert (p->dwBufferLength >= 0); - assert (p->dwBufferLength < outbuf_size); - - p->lpData[p->dwBufferLength++] = c; - - if (p->dwBufferLength == outbuf_size) { - return (audio_flush()); - } - - return (0); - -} /* end audio_put */ - - -/*------------------------------------------------------------------ - * - * Name: audio_flush - * - * Purpose: Send current buffer to the audio output system. - * - * Returns: Normally non-negative. - * -1 for any type of error. - * - * See Also: audio_flush - * audio_wait - * - *----------------------------------------------------------------*/ - -int audio_flush (void) -{ - WAVEHDR *p; - MMRESULT e; - - - p = (LPWAVEHDR)(&(out_wavehdr[out_current])); - - if (p->dwUser == DWU_FILLING && p->dwBufferLength > 0) { - - p->dwUser = DWU_PLAYING; - - waveOutPrepareHeader(audio_out_handle, p, sizeof(WAVEHDR)); - - e = waveOutWrite(audio_out_handle, p, sizeof(WAVEHDR)); - if (e != MMSYSERR_NOERROR) { - text_color_set (DW_COLOR_ERROR); - dw_printf ("audio out write error %d\n", e); - - /* I don't expect this to ever happen but if it */ - /* does, make the buffer available for filling. */ - - p->dwUser = DWU_DONE; - return (-1); - } - out_current = (out_current + 1) % NUM_OUT_BUF; - } - return (0); - -} /* end audio_flush */ - - -/*------------------------------------------------------------------ - * - * Name: audio_wait - * - * Purpose: Wait until all the queued up audio out has been played. - * - * Inputs: duration - hint at number of milliseconds to wait. - * - * Returns: Normally non-negative. - * -1 for any type of error. - * - * Description: In our particular application, we want to make sure - * that the entire packet has been sent out before turning - * off the transmitter PTT control. - * - * In an ideal world: - * - * We would like to ask the hardware when all the queued - * up sound has actually come out the speaker. - * - * The original implementation (on Cygwin) tried using: - * - * ioctl (audio_device_fd, SNDCTL_DSP_SYNC, NULL); - * - * but this caused the application to crash at a later time. - * - * This might be revisited someday for the Windows version, - * but for now, we continue to use the work-around because it - * works fine. - * - * In reality: - * - * Caller does the following: - * - * (1) Make note of when PTT is turned on. - * (2) Calculate how long it will take to transmit the - * frame including TXDELAY, frame (including - * "flags", data, FCS and bit stuffing), and TXTAIL. - * (3) Add (1) and (2) resulting in when PTT should be turned off. - * (4) Take difference between current time and PPT off time - * and provide this as the additional delay required. - * - *----------------------------------------------------------------*/ - -int audio_wait (int duration) -{ - int err = 0; - - audio_flush (); -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("audio_wait(): before sync, fd=%d\n", audio_device_fd); -#endif - - - if (duration > 0) { - SLEEP_MS (duration); - } - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("audio_wait(): after sync, status=%d\n", err); -#endif - - return (err); - -} /* end audio_wait */ - - -/*------------------------------------------------------------------ - * - * Name: audio_close - * - * Purpose: Close the audio device. - * - * Returns: Normally non-negative. - * -1 for any type of error. - * - * - *----------------------------------------------------------------*/ - -int audio_close (void) -{ - int err = 0; - - int n; - - - assert (audio_in_handle != 0); - assert (audio_out_handle != 0); - - audio_wait (0); - -/* Shutdown audio input. */ - - waveInReset(audio_in_handle); - waveInStop(audio_in_handle); - waveInClose(audio_in_handle); - audio_in_handle = 0; - - for (n = 0; n < NUM_IN_BUF; n++) { - - waveInUnprepareHeader (audio_in_handle, (LPWAVEHDR)(&(in_wavehdr[n])), sizeof(WAVEHDR)); - in_wavehdr[n].dwFlags = 0; - free (in_wavehdr[n].lpData); - in_wavehdr[n].lpData = NULL; - } - - DeleteCriticalSection (&in_cs); - - -/* Make sure all output buffers have been played then free them. */ - - for (n = 0; n < NUM_OUT_BUF; n++) { - if (out_wavehdr[n].dwUser == DWU_PLAYING) { - - int timeout = 2 * NUM_OUT_BUF; - while (out_wavehdr[n].dwUser == DWU_PLAYING) { - SLEEP_MS (ONE_BUF_TIME); - timeout--; - if (timeout <= 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Audio output failure on close.\n"); - } - } - - waveOutUnprepareHeader (audio_out_handle, (LPWAVEHDR)(&(out_wavehdr[n])), sizeof(WAVEHDR)); - - out_wavehdr[n].dwUser = DWU_DONE; - } - free (out_wavehdr[n].lpData); - out_wavehdr[n].lpData = NULL; - } - - waveOutClose (audio_out_handle); - audio_out_handle = 0; - - return (err); - -} /* end audio_close */ - -/* end audio_win.c */ - diff --git a/ax25_pad.c b/ax25_pad.c deleted file mode 100644 index 40609eb7..00000000 --- a/ax25_pad.c +++ /dev/null @@ -1,1906 +0,0 @@ - -// -// This file is part of Dire Wolf, an amateur radio packet TNC. -// -// Copyright (C) 2011 , 2013, 2014 John Langner, WB2OSZ -// -// This program 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 2 of the License, or -// (at your option) any later version. -// -// This program 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 this program. If not, see . -// - - -/*------------------------------------------------------------------ - * - * Name: ax25_pad - * - * Purpose: Packet assembler and disasembler. - * - * We can obtain AX.25 packets from different sources: - * - * (a) from an HDLC frame. - * (b) from text representation. - * (c) built up piece by piece. - * - * We also want to use a packet in different ways: - * - * (a) transmit as an HDLC frame. - * (b) print in human-readable text. - * (c) take it apart piece by piece. - * - * Looking at the more general case, we also want to modify - * an existing packet. For instance an APRS repeater might - * want to change "WIDE2-2" to "WIDE2-1" and retransmit it. - * - * - * Description: - * - * - * A UI frame starts with 2-10 addressses (14-70 octets): - * - * * Destination Address - * * Source Address - * * 0-8 Digipeater Addresses (Could there ever be more as a result of - * digipeaters inserting their own call - * and decrementing the remaining count in - * WIDEn-n, TRACEn-n, etc.? - * NO. The limit is 8 when transmitting AX.25 over the radio. - * However, communication with an IGate server could have - * a longer VIA path but that is only in text form, not here.) - * - * Each address is composed of: - * - * * 6 upper case letters or digits, blank padded. - * These are shifted left one bit, leaving the the LSB always 0. - * * a 7th octet containing the SSID and flags. - * The LSB is always 0 except for the last octet of the address field. - * - * The final octet of the Destination has the form: - * - * C R R SSID 0, where, - * - * C = command/response = 1 - * R R = Reserved = 1 1 - * SSID = substation ID - * 0 = zero - * - * The final octet of the Source has the form: - * - * C R R SSID 0, where, - * - * C = command/response = 1 - * R R = Reserved = 1 1 - * SSID = substation ID - * 0 = zero (or 1 if no repeaters) - * - * The final octet of each repeater has the form: - * - * H R R SSID 0, where, - * - * H = has-been-repeated = 0 initially. - * Set to 1 after this address has been used. - * R R = Reserved = 1 1 - * SSID = substation ID - * 0 = zero (or 1 if last repeater in list) - * - * A digipeater would repeat this frame if it finds its address - * with the "H" bit set to 0 and all earlier repeater addresses - * have the "H" bit set to 1. - * The "H" bit would be set to 1 in the repeated frame. - * - * When monitoring, an asterisk is displayed after the last digipeater with - * the "H" bit set. No asterisk means the source is being heard directly. - * - * Example, if we can hear all stations involved, - * - * SRC>DST,RPT1,RPT2,RPT3: -- we heard SRC - * SRC>DST,RPT1*,RPT2,RPT3: -- we heard RPT1 - * SRC>DST,RPT1,RPT2*,RPT3: -- we heard RPT2 - * SRC>DST,RPT1,RPT2,RPT3*: -- we heard RPT3 - * - * - * Next we have: - * - * * One byte Control Field - APRS uses 3 for UI frame - * The more general AX.25 frame can have two. - * - * * One byte Protocol ID - APRS uses 0xf0 for no layer 3 - * - * Finally the Information Field of 1-256 bytes. - * - * And, of course, the 2 byte CRC. - * - * - * Constructors: ax25_init - Clear everything. - * ax25_from_text - Tear apart a text string - * ax25_from_frame - Tear apart an AX.25 frame. - * Must be called before any other function. - * - * Get methods: .... - Extract destination, source, or digipeater - * address from frame. - * - * Assumptions: CRC has already been verified to be correct. - * - *------------------------------------------------------------------*/ - -#define AX25_PAD_C /* this will affect behavior of ax25_pad.h */ - - -#include -#include -#include -#include -#include -#ifndef _POSIX_C_SOURCE - -#define _POSIX_C_SOURCE 1 -#endif - -#include "regex.h" - -#if __WIN32__ -char *strtok_r(char *str, const char *delim, char **saveptr); -#endif - -#include "ax25_pad.h" -#include "textcolor.h" -#include "fcs_calc.h" - -/* - * Accumulate statistics. - * If new_count gets more than a few larger than delete_count plus the size of - * the transmit queue we have a memory leak. - */ - -static int new_count = 0; -static int delete_count = 0; - -#define CLEAR_LAST_ADDR_FLAG this_p->frame_data[this_p->num_addr*7-1] &= ~ SSID_LAST_MASK -#define SET_LAST_ADDR_FLAG this_p->frame_data[this_p->num_addr*7-1] |= SSID_LAST_MASK - - -/*------------------------------------------------------------------------------ - * - * Name: ax25_new - * - * Purpose: Allocate memory for a new packet object. - * - * Returns: Identifier for a new packet object. - * In the current implementation this happens to be a pointer. - * - *------------------------------------------------------------------------------*/ - - -static packet_t ax25_new (void) -{ - struct packet_s *this_p; - - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("ax25_new(): before alloc, new=%d, delete=%d\n", new_count, delete_count); -#endif - - new_count++; - -/* - * check for memory leak. - */ - if (new_count > delete_count + 100) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Memory leak for packet objects. new=%d, delete=%d\n", new_count, delete_count); - } - - this_p = calloc(sizeof (struct packet_s), (size_t)1); - this_p->magic1 = MAGIC; - this_p->magic2 = MAGIC; - this_p->num_addr = (-1); - return (this_p); -} - -/*------------------------------------------------------------------------------ - * - * Name: ax25_delete - * - * Purpose: Destroy a packet object, freeing up memory it was using. - * - *------------------------------------------------------------------------------*/ - -void ax25_delete (packet_t this_p) -{ -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("ax25_delete(): before free, new=%d, delete=%d\n", new_count, delete_count); -#endif - assert (this_p->magic1 == MAGIC); - assert (this_p->magic2 == MAGIC); - memset (this_p, 0, sizeof (struct packet_s)); - delete_count++; - free (this_p); -} - - - -/*------------------------------------------------------------------------------ - * - * Name: ax25_from_text - * - * Purpose: Parse a frame in human-readable monitoring format and change - * to internal representation. - * - * Input: monitor - "TNC-2" format of a monitored packet. i.e. - * source>dest[,repeater1,repeater2,...]:information - * - * strict - True to enforce rules for packets sent over the air. - * False to be more lenient for packets from IGate server. - * - * Messages from an IGate server can have longer - * addresses after qAC. Up to 9 observed so far. - * - * We can just truncate the name because we will only - * end up discarding it. TODO: check on this. - * - * Returns: Pointer to new packet object in the current implementation. - * - * Outputs: Use the "get" functions to retrieve information in different ways. - * - *------------------------------------------------------------------------------*/ - -packet_t ax25_from_text (char *monitor, int strict) -{ - -/* - * Tearing it apart is destructive so make our own copy first. - */ - char stuff[512]; - - char *pinfo; - char *pa; - char *saveptr; /* Used with strtok_r because strtok is not thread safe. */ - - static int first_time = 1; - static regex_t unhex_re; - int e; - char emsg[100]; -#define MAXMATCH 1 - regmatch_t match[MAXMATCH]; - int keep_going; - char temp[512]; - int ssid_temp, heard_temp; - char atemp[AX25_MAX_ADDR_LEN]; - - - packet_t this_p = ax25_new (); - - /* Is it possible to have a nul character (zero byte) in the */ - /* information field of an AX.25 frame? */ - /* Yes, but it would be difficult in the from-text case. */ - - strcpy (stuff, monitor); - -/* - * Translate hexadecimal values like <0xff> to non-printing characters. - * MIC-E message type uses 5 different non-printing characters. - */ - - if (first_time) - { - e = regcomp (&unhex_re, "<0x[0-9a-fA-F][0-9a-fA-F]>", 0); - if (e) { - regerror (e, &unhex_re, emsg, sizeof(emsg)); - text_color_set(DW_COLOR_ERROR); - dw_printf ("%s:%d: %s\n", __FILE__, __LINE__, emsg); - } - - first_time = 0; - } - -#if 0 - text_color_set(DW_COLOR_DEBUG); - dw_printf ("BEFORE: %s\n", stuff); - ax25_safe_print (stuff, -1, 0); - dw_printf ("\n"); -#endif - keep_going = 1; - while (keep_going) { - if (regexec (&unhex_re, stuff, MAXMATCH, match, 0) == 0) { - int n; - char *p; - - stuff[match[0].rm_so + 5] = '\0'; - n = strtol (stuff + match[0].rm_so + 3, &p, 16); - stuff[match[0].rm_so] = n; - strcpy (temp, stuff + match[0].rm_eo); - strcpy (stuff + match[0].rm_so + 1, temp); - } - else { - keep_going = 0; - } - } -#if 0 - text_color_set(DW_COLOR_DEBUG); - dw_printf ("AFTER: %s\n", stuff); - ax25_safe_print (stuff, -1, 0); - dw_printf ("\n"); -#endif - -/* - * Initialize the packet with two addresses and control/pid - * for APRS. - */ - memset (this_p->frame_data + AX25_DESTINATION*7, ' ' << 1, 6); - this_p->frame_data[AX25_DESTINATION*7+6] = SSID_H_MASK | SSID_RR_MASK; - - memset (this_p->frame_data + AX25_SOURCE*7, ' ' << 1, 6); - this_p->frame_data[AX25_SOURCE*7+6] = SSID_H_MASK | SSID_RR_MASK | SSID_LAST_MASK; - - this_p->frame_data[14] = AX25_UI_FRAME; - this_p->frame_data[15] = AX25_NO_LAYER_3; - - this_p->frame_len = 7 + 7 + 1 + 1; - this_p->num_addr = (-1); - assert (ax25_get_num_addr(this_p) == 2); - - -/* - * Separate the addresses from the rest. - */ - pinfo = strchr (stuff, ':'); - - if (pinfo == NULL) { - ax25_delete (this_p); - return (NULL); - } - - *pinfo = '\0'; - pinfo++; - - if (strlen(pinfo) > AX25_MAX_INFO_LEN) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Warning: Information part truncated to %d characters.\n", AX25_MAX_INFO_LEN); - pinfo[AX25_MAX_INFO_LEN] = '\0'; - } - -/* - * Separate the addresses. - * Note that source and destination order is swappped. - */ - -/* - * Source address. - * Don't use traditional strtok because it is not thread safe. - */ - pa = strtok_r (stuff, ">", &saveptr); - if (pa == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Failed to create packet from text. No source address\n"); - ax25_delete (this_p); - return (NULL); - } - - if ( ! ax25_parse_addr (pa, strict, atemp, &ssid_temp, &heard_temp)) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Failed to create packet from text. Bad source address\n"); - ax25_delete (this_p); - return (NULL); - } - - ax25_set_addr (this_p, AX25_SOURCE, pa); - ax25_set_h (this_p, AX25_SOURCE); // c/r in this position - - ax25_set_ssid (this_p, AX25_SOURCE, ssid_temp); - -/* - * Destination address. - */ - - pa = strtok_r (NULL, ",", &saveptr); - if (pa == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Failed to create packet from text. No destination address\n"); - ax25_delete (this_p); - return (NULL); - } - - if ( ! ax25_parse_addr (pa, strict, atemp, &ssid_temp, &heard_temp)) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Failed to create packet from text. Bad destination address\n"); - ax25_delete (this_p); - return (NULL); - } - - ax25_set_addr (this_p, AX25_DESTINATION, pa); - ax25_set_h (this_p, AX25_DESTINATION); // c/r in this position - - ax25_set_ssid (this_p, AX25_DESTINATION, ssid_temp); - -/* - * VIA path. - */ - while (( pa = strtok_r (NULL, ",", &saveptr)) != NULL && this_p->num_addr < AX25_MAX_ADDRS ) { - - //char *last; - int k; - - k = this_p->num_addr; - - // JWL 10:38 this_p->num_addr++; - - if ( ! ax25_parse_addr (pa, strict, atemp, &ssid_temp, &heard_temp)) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Failed to create packet from text. Bad digipeater address\n"); - ax25_delete (this_p); - return (NULL); - } - - ax25_set_addr (this_p, k, pa); - - ax25_set_ssid (this_p, k, ssid_temp); - - // Does it have an "*" at the end? - // TODO: Complain if more than one "*". - // Could also check for all has been repeated bits are adjacent. - - if (heard_temp) { - for ( ; k >= AX25_REPEATER_1; k--) { - ax25_set_h (this_p, k); - } - } - } - -/* - * Append the info part. - */ - strcpy ((char*)(this_p->frame_data+this_p->frame_len), pinfo); - this_p->frame_len += strlen(pinfo); - - - return (this_p); -} - - -/*------------------------------------------------------------------------------ - * - * Name: ax25_from_frame - * - * Purpose: Split apart an HDLC frame to components. - * - * Inputs: fbuf - Pointer to beginning of frame. - * - * flen - Length excluding the two FCS bytes. - * - * alevel - Audio level of received signal. - * Maximum range 0 - 100. - * -1 might be used when not applicable. - * - * Returns: Pointer to new packet object or NULL if error. - * - * Outputs: Use the "get" functions to retrieve information in different ways. - * - *------------------------------------------------------------------------------*/ - - -packet_t ax25_from_frame (unsigned char *fbuf, int flen, int alevel) -{ - unsigned char *pf; - //int found_last; - packet_t this_p; - - int a; - int addr_bytes; - -/* - * First make sure we have an acceptable length: - * - * We are not concerned with the FCS (CRC) because someone else checked it. - * - * Is is possible to have zero length for info? - * - * In the original version, assuming APRS, the answer was no. - * We always had at least 3 octets after the address part: - * control, protocol, and first byte of info part for data type. - * - * In later versions, this restriction was relaxed so other - * variations of AX.25 could be used. Now the minimum length - * is 7+7 for addresses plus 1 for control. - * - */ - - if (flen < AX25_MIN_PACKET_LEN || flen > AX25_MAX_PACKET_LEN) - { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Frame length %d not in allowable range of %d to %d.\n", flen, AX25_MIN_PACKET_LEN, AX25_MAX_PACKET_LEN); - return (NULL); - } - - this_p = ax25_new (); - -/* Copy the whole thing intact. */ - - memcpy (this_p->frame_data, fbuf, flen); - this_p->frame_data[flen] = 0; - this_p->frame_len = flen; - -/* Find number of addresses. */ - - this_p->num_addr = (-1); - (void) ax25_get_num_addr (this_p); - - return (this_p); -} - - -/*------------------------------------------------------------------------------ - * - * Name: ax25_dup - * - * Purpose: Make a copy of given packet object. - * - * Inputs: copy_from - Existing packet object. - * - * Returns: Pointer to new packet object or NULL if error. - * - * - *------------------------------------------------------------------------------*/ - - -packet_t ax25_dup (packet_t copy_from) -{ - - packet_t this_p; - - - this_p = ax25_new (); - - memcpy (this_p, copy_from, sizeof (struct packet_s)); - - return (this_p); - -} - - -/*------------------------------------------------------------------------------ - * - * Name: ax25_parse_addr - * - * Purpose: Parse address with optional ssid. - * - * Inputs: in_addr - Input such as "WB2OSZ-15*" - * - * strict - TRUE for strict checking (6 characters, no lower case, - * SSID must be in range of 0 to 15). - * Strict is appropriate for packets sent - * over the radio. Communication with IGate - * allows lower case (e.g. "qAR") and two - * alphanumeric characters for the SSID. - * We also get messages like this from a server. - * KB1POR>APU25N,TCPIP*,qAC,T2NUENGLD:... - * - * Outputs: out_addr - Address without any SSID. - * Must be at least AX25_MAX_ADDR_LEN bytes. - * - * out_ssid - Numeric value of SSID. - * - * out_heard - True if "*" found. - * - * Returns: True (1) if OK, false (0) if any error. - * - * - *------------------------------------------------------------------------------*/ - - -int ax25_parse_addr (char *in_addr, int strict, char *out_addr, int *out_ssid, int *out_heard) -{ - char *p; - char sstr[4]; - int i, j, k; - int maxlen; - - strcpy (out_addr, ""); - *out_ssid = 0; - *out_heard = 0; - - //dw_printf ("ax25_parse_addr in: %s\n", in_addr); - - maxlen = strict ? 6 : (AX25_MAX_ADDR_LEN-1); - p = in_addr; - i = 0; - for (p = in_addr; isalnum(*p); p++) { - if (i >= maxlen) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Address is too long. \"%s\" has more than %d characters.\n", in_addr, maxlen); - return 0; - } - out_addr[i++] = *p; - out_addr[i] = '\0'; - if (strict && islower(*p)) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Address has lower case letters. \"%s\" must be all upper case.\n", in_addr); - return 0; - } - } - - strcpy (sstr, ""); - j = 0; - if (*p == '-') { - for (p++; isalnum(*p); p++) { - if (j >= 2) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("SSID is too long. SSID part of \"%s\" has more than 2 characters.\n", in_addr); - return 0; - } - sstr[j++] = *p; - sstr[j] = '\0'; - if (strict && ! isdigit(*p)) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("SSID must be digits. \"%s\" has letters in SSID.\n", in_addr); - return 0; - } - } - k = atoi(sstr); - if (k < 0 || k > 15) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("SSID out of range. SSID of \"%s\" not in range of 0 to 15.\n", in_addr); - return 0; - } - *out_ssid = k; - } - - if (*p == '*') { - *out_heard = 1; - p++; - } - - if (*p != '\0') { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Invalid character \"%c\" found in address \"%s\".\n", *p, in_addr); - return 0; - } - - //dw_printf ("ax25_parse_addr out: %s %d %d\n", out_addr, *out_ssid, *out_heard); - - return (1); - -} /* end ax25_parse_addr */ - - -/*------------------------------------------------------------------------------ - * - * Name: ax25_unwrap_third_party - * - * Purpose: Unwrap a third party messge from the header. - * - * Inputs: copy_from - Existing packet object. - * - * Returns: Pointer to new packet object or NULL if error. - * - * Example: Input: A>B,C:}D>E,F:info - * Output: D>E,F:info - * - *------------------------------------------------------------------------------*/ - -packet_t ax25_unwrap_third_party (packet_t from_pp) -{ - unsigned char *info_p; - packet_t result_pp; - - if (ax25_get_dti(from_pp) != '}') { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Internal error: ax25_unwrap_third_party: wrong data type.\n"); - return (NULL); - } - - (void) ax25_get_info (from_pp, &info_p); - - result_pp = ax25_from_text((char *)info_p + 1, 0); - - return (result_pp); -} - - - -/*------------------------------------------------------------------------------ - * - * Name: ax25_set_addr - * - * Purpose: Add or change an address. - * - * Inputs: n - Index of address. Use the symbols - * AX25_DESTINATION, AX25_SOURCE, AX25_REPEATER1, etc. - * - * Must be either an existing address or one greater - * than the final which causes a new one to be added. - * - * ad - Address with optional dash and substation id. - * - * Assumption: ax25_from_text or ax25_from_frame was called first. - * - * TODO: ax25_from_text could use this. - * - * Returns: None. - * - *------------------------------------------------------------------------------*/ - -void ax25_set_addr (packet_t this_p, int n, char *ad) -{ - int ssid_temp, heard_temp; - char atemp[AX25_MAX_ADDR_LEN]; - int i; - - assert (this_p->magic1 == MAGIC); - assert (this_p->magic2 == MAGIC); - assert (n >= 0 && n < AX25_MAX_ADDRS); - assert (strlen(ad) < AX25_MAX_ADDR_LEN); - - //dw_printf ("ax25_set_addr (%d, %s) num_addr=%d\n", n, ad, this_p->num_addr); - - if (n >= 0 && n < this_p->num_addr) { - - //dw_printf ("ax25_set_addr , existing case\n"); -/* - * Set existing address position. - */ - ax25_parse_addr (ad, 0, atemp, &ssid_temp, &heard_temp); - - memset (this_p->frame_data + n*7, ' ' << 1, 6); - - for (i=0; i<6 && atemp[i] != '\0'; i++) { - this_p->frame_data[n*7+i] = atemp[i] << 1; - } - ax25_set_ssid (this_p, n, ssid_temp); - } - else if (n == this_p->num_addr) { - - //dw_printf ("ax25_set_addr , appending case\n"); -/* - * One beyond last position, process as insert. - */ - - ax25_insert_addr (this_p, n, ad); - } - else { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Internal error, ax25_set_addr, bad position %d for '%s'\n", n, ad); - } - - //dw_printf ("------\n"); - //dw_printf ("dump after ax25_set_addr (%d, %s)\n", n, ad); - //ax25_hex_dump (this_p); - //dw_printf ("------\n"); -} - - -/*------------------------------------------------------------------------------ - * - * Name: ax25_insert_addr - * - * Purpose: Insert address at specified position, shifting others up one - * position. - * This is used when a digipeater wants to insert its own call - * for tracing purposes. - * For example: - * W1ABC>TEST,WIDE3-3 - * Would become: - * W1ABC>TEST,WB2OSZ-1*,WIDE3-2 - * - * Inputs: n - Index of address. Use the symbols - * AX25_DESTINATION, AX25_SOURCE, AX25_REPEATER1, etc. - * - * ad - Address with optional dash and substation id. - * - * Bugs: Little validity or bounds checking is performed. Be careful. - * - * Assumption: ax25_from_text or ax25_from_frame was called first. - * - * Returns: None. - * - * - *------------------------------------------------------------------------------*/ - -void ax25_insert_addr (packet_t this_p, int n, char *ad) -{ - int k; - int ssid_temp, heard_temp; - char atemp[AX25_MAX_ADDR_LEN]; - int i; - int expect; - - assert (this_p->magic1 == MAGIC); - assert (this_p->magic2 == MAGIC); - assert (n >= AX25_REPEATER_1 && n < AX25_MAX_ADDRS); - assert (strlen(ad) < AX25_MAX_ADDR_LEN); - - //dw_printf ("ax25_insert_addr (%d, %s)\n", n, ad); - - /* Don't do it if we already have the maximum number. */ - /* Should probably return success/fail code but currently the caller doesn't care. */ - - if ( this_p->num_addr >= AX25_MAX_ADDRS) { - return; - } - - CLEAR_LAST_ADDR_FLAG; - - this_p->num_addr++; - - memmove (this_p->frame_data + (n+1)*7, this_p->frame_data + n*7, this_p->frame_len - (n*7)); - memset (this_p->frame_data + n*7, ' ' << 1, 6); - this_p->frame_len += 7; - this_p->frame_data[n*7+6] = SSID_RR_MASK; - - SET_LAST_ADDR_FLAG; - - ax25_parse_addr (ad, 0, atemp, &ssid_temp, &heard_temp); - memset (this_p->frame_data + n*7, ' ' << 1, 6); - for (i=0; i<6 && atemp[i] != '\0'; i++) { - this_p->frame_data[n*7+i] = atemp[i] << 1; - } - - ax25_set_ssid (this_p, n, ssid_temp); - - // Sanity check after messing with number of addresses. - - expect = this_p->num_addr; - this_p->num_addr = (-1); - if (expect != ax25_get_num_addr (this_p)) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Internal error ax25_remove_addr expect %d, actual %d\n", expect, this_p->num_addr); - } -} - - -/*------------------------------------------------------------------------------ - * - * Name: ax25_remove_addr - * - * Purpose: Remove address at specified position, shifting others down one position. - * This is used when we want to remove something from the digipeater list. - * - * Inputs: n - Index of address. Use the symbols - * AX25_REPEATER1, AX25_REPEATER2, etc. - * - * Bugs: Little validity or bounds checking is performed. Be careful. - * - * Assumption: ax25_from_text or ax25_from_frame was called first. - * - * Returns: None. - * - * - *------------------------------------------------------------------------------*/ - -void ax25_remove_addr (packet_t this_p, int n) -{ - int k; - int expect; - - assert (this_p->magic1 == MAGIC); - assert (this_p->magic2 == MAGIC); - assert (n >= AX25_REPEATER_1 && n < AX25_MAX_ADDRS); - - /* Shift those beyond to fill this position. */ - - CLEAR_LAST_ADDR_FLAG; - - this_p->num_addr--; - - memmove (this_p->frame_data + n*7, this_p->frame_data + (n+1)*7, this_p->frame_len - ((n+1)*7)); - this_p->frame_len -= 7; - SET_LAST_ADDR_FLAG; - - // Sanity check after messing with number of addresses. - - expect = this_p->num_addr; - this_p->num_addr = (-1); - if (expect != ax25_get_num_addr (this_p)) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Internal error ax25_remove_addr expect %d, actual %d\n", expect, this_p->num_addr); - } - -} - - -/*------------------------------------------------------------------------------ - * - * Name: ax25_get_num_addr - * - * Purpose: Return number of addresses in current packet. - * - * Assumption: ax25_from_text or ax25_from_frame was called first. - * - * Returns: Number of addresses in the current packet. - * Should be in the range of 2 .. AX25_MAX_ADDRS. - * - * Version 0.9: Could be zero for a non AX.25 frame in KISS mode. - * - *------------------------------------------------------------------------------*/ - -int ax25_get_num_addr (packet_t this_p) -{ - unsigned char *pf; - int a; - int addr_bytes; - - - assert (this_p->magic1 == MAGIC); - assert (this_p->magic2 == MAGIC); - -/* Use cached value if already set. */ - - if (this_p->num_addr >= 0) { - return (this_p->num_addr); - } - -/* Otherwise, determine the number ofaddresses. */ - - this_p->num_addr = 0; /* Number of addresses extracted. */ - - addr_bytes = 0; - for (a = 0; a < this_p->frame_len && addr_bytes == 0; a++) { - if (this_p->frame_data[a] & SSID_LAST_MASK) { - addr_bytes = a + 1; - } - } - - if (addr_bytes % 7 == 0) { - int addrs = addr_bytes / 7; - if (addrs >= AX25_MIN_ADDRS && addrs <= AX25_MAX_ADDRS) { - this_p->num_addr = addrs; - } - } - - return (this_p->num_addr); -} - - -/*------------------------------------------------------------------------------ - * - * Name: ax25_get_num_repeaters - * - * Purpose: Return number of repeater addresses in current packet. - * - * Assumption: ax25_from_text or ax25_from_frame was called first. - * - * Returns: Number of addresses in the current packet - 2. - * Should be in the range of 0 .. AX25_MAX_ADDRS - 2. - * - *------------------------------------------------------------------------------*/ - -int ax25_get_num_repeaters (packet_t this_p) -{ - assert (this_p->magic1 == MAGIC); - assert (this_p->magic2 == MAGIC); - - if (this_p->num_addr >= 2) { - return (this_p->num_addr - 2); - } - - return (0); -} - - -/*------------------------------------------------------------------------------ - * - * Name: ax25_get_addr_with_ssid - * - * Purpose: Return specified address with any SSID in current packet. - * - * Inputs: n - Index of address. Use the symbols - * AX25_DESTINATION, AX25_SOURCE, AX25_REPEATER1, etc. - * - * Outputs: station - String representation of the station, including the SSID. - * e.g. "WB2OSZ-15" - * - * Bugs: No bounds checking is performed. Be careful. - * - * Assumption: ax25_from_text or ax25_from_frame was called first. - * - * Returns: Character string in usual human readable format, - * - * - *------------------------------------------------------------------------------*/ - -void ax25_get_addr_with_ssid (packet_t this_p, int n, char *station) -{ - int ssid; - char sstr[4]; - int i; - - assert (this_p->magic1 == MAGIC); - assert (this_p->magic2 == MAGIC); - - - if (n < 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Internal error detected in ax25_get_addr_with_ssid, %s, line %d.\n", __FILE__, __LINE__); - dw_printf ("Address index, %d, is less than zero.\n", n); - strcpy (station, "??????"); - return; - } - - if (n >= this_p->num_addr) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Internal error detected in ax25_get_addr_with_ssid, %s, line %d.\n", __FILE__, __LINE__); - dw_printf ("Address index, %d, is too large for number of addresses, %d.\n", n, this_p->num_addr); - strcpy (station, "??????"); - return; - } - - memset (station, 0, 7); - for (i=0; i<6; i++) { - unsigned char ch; - - ch = (this_p->frame_data[n*7+i] >> 1) & 0x7f; - if (ch <= ' ') break; - station[i] = ch; - } - - ssid = ax25_get_ssid (this_p, n); - if (ssid != 0) { - sprintf (sstr, "-%d", ssid); - strcat (station, sstr); - } -} - - -/*------------------------------------------------------------------------------ - * - * Name: ax25_get_ssid - * - * Purpose: Return SSID of specified address in current packet. - * - * Inputs: n - Index of address. Use the symbols - * AX25_DESTINATION, AX25_SOURCE, AX25_REPEATER1, etc. - * - * Assumption: ax25_from_text or ax25_from_frame was called first. - * - * Returns: Substation id, as integer 0 .. 15. - * - *------------------------------------------------------------------------------*/ - -int ax25_get_ssid (packet_t this_p, int n) -{ - - assert (this_p->magic1 == MAGIC); - assert (this_p->magic2 == MAGIC); - - if (n >= 0 && n < this_p->num_addr) { - return ((this_p->frame_data[n*7+6] & SSID_SSID_MASK) >> SSID_SSID_SHIFT); - } - else { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Internal error: ax25_get_ssid(%d), num_addr=%d\n", n, this_p->num_addr); - return (0); - } -} - - -/*------------------------------------------------------------------------------ - * - * Name: ax25_set_ssid - * - * Purpose: Set the SSID of specified address in current packet. - * - * Inputs: n - Index of address. Use the symbols - * AX25_DESTINATION, AX25_SOURCE, AX25_REPEATER1, etc. - * - * ssid - New SSID. Must be in range of 0 to 15. - * - * Assumption: ax25_from_text or ax25_from_frame was called first. - * - * Bugs: Rewrite to keep call and SSID separate internally. - * - *------------------------------------------------------------------------------*/ - -void ax25_set_ssid (packet_t this_p, int n, int ssid) -{ - - assert (this_p->magic1 == MAGIC); - assert (this_p->magic2 == MAGIC); - - - if (n >= 0 && n < this_p->num_addr) { - this_p->frame_data[n*7+6] = (this_p->frame_data[n*7+6] & ~ SSID_SSID_MASK) | - ((ssid << SSID_SSID_SHIFT) & SSID_SSID_MASK) ; - } - else { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Internal error: ax25_set_ssid(%d,%d), num_addr=%d\n", n, ssid, this_p->num_addr); - } -} - - -/*------------------------------------------------------------------------------ - * - * Name: ax25_get_h - * - * Purpose: Return "has been repeated" flag of specified address in current packet. - * - * Inputs: n - Index of address. Use the symbols - * AX25_DESTINATION, AX25_SOURCE, AX25_REPEATER1, etc. - * - * Bugs: No bounds checking is performed. Be careful. - * - * Assumption: ax25_from_text or ax25_from_frame was called first. - * - * Returns: True or false. - * - *------------------------------------------------------------------------------*/ - -int ax25_get_h (packet_t this_p, int n) -{ - - assert (this_p->magic1 == MAGIC); - assert (this_p->magic2 == MAGIC); - assert (n >= 0 && n < this_p->num_addr); - - if (n >= 0 && n < this_p->num_addr) { - return ((this_p->frame_data[n*7+6] & SSID_H_MASK) >> SSID_H_SHIFT); - } - else { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Internal error: ax25_get_h(%d), num_addr=%d\n", n, this_p->num_addr); - return (0); - } -} - - -/*------------------------------------------------------------------------------ - * - * Name: ax25_set_h - * - * Purpose: Set the "has been repeated" flag of specified address in current packet. - * - * Inputs: n - Index of address. Use the symbols - * Should be in range of AX25_REPEATER_1 .. AX25_REPEATER_8. - * - * Bugs: No bounds checking is performed. Be careful. - * - * Assumption: ax25_from_text or ax25_from_frame was called first. - * - * Returns: None - * - *------------------------------------------------------------------------------*/ - -void ax25_set_h (packet_t this_p, int n) -{ - - assert (this_p->magic1 == MAGIC); - assert (this_p->magic2 == MAGIC); - - if (n >= 0 && n < this_p->num_addr) { - this_p->frame_data[n*7+6] |= SSID_H_MASK; - } - else { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Internal error: ax25_set_hd(%d), num_addr=%d\n", n, this_p->num_addr); - } -} - - -/*------------------------------------------------------------------------------ - * - * Name: ax25_get_heard - * - * Purpose: Return index of the station that we heard. - * - * Inputs: none - * - * - * Assumption: ax25_from_text or ax25_from_frame was called first. - * - * Returns: If any of the digipeaters have the has-been-repeated bit set, - * return the index of the last one. Otherwise return index for source. - * - *------------------------------------------------------------------------------*/ - -int ax25_get_heard(packet_t this_p) -{ - int i; - int result; - - assert (this_p->magic1 == MAGIC); - assert (this_p->magic2 == MAGIC); - - result = AX25_SOURCE; - - for (i = AX25_REPEATER_1; i < ax25_get_num_addr(this_p); i++) { - - if (ax25_get_h(this_p,i)) { - result = i; - } - } - return (result); -} - - - -/*------------------------------------------------------------------------------ - * - * Name: ax25_get_first_not_repeated - * - * Purpose: Return index of the first repeater that does NOT have the - * "has been repeated" flag set or -1 if none. - * - * Inputs: none - * - * - * Assumption: ax25_from_text or ax25_from_frame was called first. - * - * Returns: In range of X25_REPEATER_1 .. X25_REPEATER_8 or -1 if none. - * - *------------------------------------------------------------------------------*/ - -int ax25_get_first_not_repeated(packet_t this_p) -{ - int i; - - assert (this_p->magic1 == MAGIC); - assert (this_p->magic2 == MAGIC); - - for (i = AX25_REPEATER_1; i < ax25_get_num_addr(this_p); i++) { - - if ( ! ax25_get_h(this_p,i)) { - return (i); - } - } - return (-1); -} - - -/*------------------------------------------------------------------------------ - * - * Name: ax25_get_info - * - * Purpose: Obtain Information part of current packet. - * - * Inputs: None. - * - * Outputs: paddr - Starting address is returned here. - * - * Assumption: ax25_from_text or ax25_from_frame was called first. - * - * Returns: Number of octets in the Information part. - * Should be in the range of AX25_MIN_INFO_LEN .. AX25_MAX_INFO_LEN. - * - *------------------------------------------------------------------------------*/ - -int ax25_get_info (packet_t this_p, unsigned char **paddr) -{ - unsigned char *info_ptr; - int info_len; - - - assert (this_p->magic1 == MAGIC); - assert (this_p->magic2 == MAGIC); - - if (this_p->num_addr >= 2) { - - /* AX.25 */ - - info_ptr = this_p->frame_data + ax25_get_info_offset(this_p); - info_len = ax25_get_num_info(this_p); - } - else { - - /* Not AX.25. Treat Whole packet as info. */ - - info_ptr = this_p->frame_data; - info_len = this_p->frame_len; - } - - /* Add nul character in case caller treats as printable string. */ - - assert (info_len >= 0); - - info_ptr[info_len] = '\0'; - - *paddr = info_ptr; - return (info_len); -} - - -/*------------------------------------------------------------------------------ - * - * Name: ax25_get_dti - * - * Purpose: Get Data Type Identifier from Information part. - * - * Inputs: None. - * - * Assumption: ax25_from_text or ax25_from_frame was called first. - * - * Returns: First byte from the information part. - * - *------------------------------------------------------------------------------*/ - -int ax25_get_dti (packet_t this_p) -{ - assert (this_p->magic1 == MAGIC); - assert (this_p->magic2 == MAGIC); - - if (this_p->num_addr >= 2) { - return (this_p->frame_data[ax25_get_info_offset(this_p)]); - } - return (' '); -} - -/*------------------------------------------------------------------------------ - * - * Name: ax25_set_nextp - * - * Purpose: Set next packet object in queue. - * - * Inputs: this_p - Current packet object. - * - * next_p - pointer to next one - * - * Description: This is used to build a linked list for a queue. - * - *------------------------------------------------------------------------------*/ - -void ax25_set_nextp (packet_t this_p, packet_t next_p) -{ - assert (this_p->magic1 == MAGIC); - assert (this_p->magic2 == MAGIC); - - this_p->nextp = next_p; -} - - - -/*------------------------------------------------------------------------------ - * - * Name: ax25_get_nextp - * - * Purpose: Obtain next packet object in queue. - * - * Inputs: Packet object. - * - * Returns: Following object in queue or NULL. - * - *------------------------------------------------------------------------------*/ - -packet_t ax25_get_nextp (packet_t this_p) -{ - assert (this_p->magic1 == MAGIC); - assert (this_p->magic2 == MAGIC); - - return (this_p->nextp); -} - - - -/*------------------------------------------------------------------ - * - * Function: ax25_format_addrs - * - * Purpose: Format all the addresses suitable for printing. - * - * The AX.25 spec refers to this as "Source Path Header" - "TNC-2" Format - * - * Inputs: Current packet. - * - * Outputs: result - All addresses combined into a single string of the form: - * - * "Source > Destination [ , repeater ... ] :" - * - * An asterisk is displayed after the last digipeater - * with the "H" bit set. e.g. If we hear RPT2, - * - * SRC>DST,RPT1,RPT2*,RPT3: - * - * No asterisk means the source is being heard directly. - * Needs to be 101 characters to avoid overflowing. - * (Up to 100 characters + \0) - * - * Errors: No error checking so caller needs to be careful. - * - * - *------------------------------------------------------------------*/ - -void ax25_format_addrs (packet_t this_p, char *result) -{ - int i; - int heard; - char stemp[AX25_MAX_ADDR_LEN]; - - assert (this_p->magic1 == MAGIC); - assert (this_p->magic2 == MAGIC); - *result = '\0'; - - /* New in 0.9. */ - /* Don't get upset if no addresses. */ - /* This will allow packets that do not comply to AX.25 format. */ - - if (this_p->num_addr == 0) { - return; - } - - ax25_get_addr_with_ssid (this_p, AX25_SOURCE, stemp); - strcat (result, stemp); - strcat (result, ">"); - - ax25_get_addr_with_ssid (this_p, AX25_DESTINATION, stemp); - strcat (result, stemp); - - heard = ax25_get_heard(this_p); - - for (i=(int)AX25_REPEATER_1; inum_addr; i++) { - ax25_get_addr_with_ssid (this_p, i, stemp); - strcat (result, ","); - strcat (result, stemp); - if (i == heard) { - strcat (result, "*"); - } - } - - strcat (result, ":"); -} - - -/*------------------------------------------------------------------ - * - * Function: ax25_pack - * - * Purpose: Put all the pieces into format ready for transmission. - * - * Inputs: this_p - pointer to packet object. - * - * Outputs: result - Frame buffer, AX25_MAX_PACKET_LEN bytes. - * Should also have two extra for FCS to be - * added later. - * - * Returns: Number of octets in the frame buffer. - * Does NOT include the extra 2 for FCS. - * - * Errors: Returns -1. - * - *------------------------------------------------------------------*/ - -int ax25_pack (packet_t this_p, unsigned char result[AX25_MAX_PACKET_LEN]) -{ - - assert (this_p->magic1 == MAGIC); - assert (this_p->magic2 == MAGIC); - - assert (this_p->frame_len > 0 && this_p->frame_len <= AX25_MAX_PACKET_LEN); - - memcpy (result, this_p->frame_data, this_p->frame_len); - - return (this_p->frame_len); -} - - -/*------------------------------------------------------------------ - * - * Function: ax25_hex_dump - * - * Purpose: Print out packet in hexadecimal for debugging. - * - * Inputs: fptr - Pointer to frame data. - * - * flen - Frame length, bytes. Does not include CRC. - * - *------------------------------------------------------------------*/ - -static void hex_dump (unsigned char *p, int len) -{ - int n, i, offset; - - offset = 0; - while (len > 0) { - n = len < 16 ? len : 16; - dw_printf (" %03x: ", offset); - for (i=0; i>5)&7, (c>>4)&1, (c>>1)&7); } - else if ((c & 0xf) == 0x01) { sprintf (out, "S frame RR: n(r)=%d, p/f=%d", (c>>5)&7, (c>>4)&1); } - else if ((c & 0xf) == 0x05) { sprintf (out, "S frame RNR: n(r)=%d, p/f=%d", (c>>5)&7, (c>>4)&1); } - else if ((c & 0xf) == 0x09) { sprintf (out, "S frame REJ: n(r)=%d, p/f=%d", (c>>5)&7, (c>>4)&1); } - else if ((c & 0xf) == 0x0D) { sprintf (out, "S frame sREJ: n(r)=%d, p/f=%d", (c>>5)&7, (c>>4)&1); } - else if ((c & 0xef) == 0x6f) { sprintf (out, "U frame SABME: p=%d", (c>>4)&1); } - else if ((c & 0xef) == 0x2f) { sprintf (out, "U frame SABM: p=%d", (c>>4)&1); } - else if ((c & 0xef) == 0x43) { sprintf (out, "U frame DISC: p=%d", (c>>4)&1); } - else if ((c & 0xef) == 0x0f) { sprintf (out, "U frame DM: f=%d", (c>>4)&1); } - else if ((c & 0xef) == 0x63) { sprintf (out, "U frame UA: f=%d", (c>>4)&1); } - else if ((c & 0xef) == 0x87) { sprintf (out, "U frame FRMR: f=%d", (c>>4)&1); } - else if ((c & 0xef) == 0x03) { sprintf (out, "U frame UI: p/f=%d", (c>>4)&1); } - else if ((c & 0xef) == 0xAF) { sprintf (out, "U frame XID: p/f=%d", (c>>4)&1); } - else if ((c & 0xef) == 0xe3) { sprintf (out, "U frame TEST: p/f=%d", (c>>4)&1); } - else { sprintf (out, "Unknown frame type for control = 0x%02x", c); } -} - -/* Text description of protocol id octet. */ - -static void pid_to_text (int p, char *out) -{ - - if ((p & 0x30) == 0x10) { sprintf (out, "AX.25 layer 3 implemented."); } - else if ((p & 0x30) == 0x20) { sprintf (out, "AX.25 layer 3 implemented."); } - else if (p == 0x01) { sprintf (out, "ISO 8208/CCITT X.25 PLP"); } - else if (p == 0x06) { sprintf (out, "Compressed TCP/IP packet. Van Jacobson (RFC 1144)"); } - else if (p == 0x07) { sprintf (out, "Uncompressed TCP/IP packet. Van Jacobson (RFC 1144)"); } - else if (p == 0x08) { sprintf (out, "Segmentation fragment"); } - else if (p == 0xC3) { sprintf (out, "TEXNET datagram protocol"); } - else if (p == 0xC4) { sprintf (out, "Link Quality Protocol"); } - else if (p == 0xCA) { sprintf (out, "Appletalk"); } - else if (p == 0xCB) { sprintf (out, "Appletalk ARP"); } - else if (p == 0xCC) { sprintf (out, "ARPA Internet Protocol"); } - else if (p == 0xCD) { sprintf (out, "ARPA Address resolution"); } - else if (p == 0xCE) { sprintf (out, "FlexNet"); } - else if (p == 0xCF) { sprintf (out, "NET/ROM"); } - else if (p == 0xF0) { sprintf (out, "No layer 3 protocol implemented."); } - else if (p == 0xFF) { sprintf (out, "Escape character. Next octet contains more Level 3 protocol information."); } - else { sprintf (out, "Unknown protocol id = 0x%02x", p); } -} - - - -void ax25_hex_dump (packet_t this_p) -{ - int n; - unsigned char *fptr = this_p->frame_data; - int flen = this_p->frame_len; - - - - if (this_p->num_addr >= AX25_MIN_ADDRS && this_p->num_addr <= AX25_MAX_ADDRS) { - int c, p; - char cp_text[120]; - char l_text[20]; - - c = fptr[this_p->num_addr*7]; - p = fptr[this_p->num_addr*7+1]; - - ctrl_to_text (c, cp_text); - - if ( (c & 0x01) == 0 || /* I xxxx xxx0 */ - c == 0x03 || c == 0x13) { /* UI 000x 0011 */ - - char p_text[100]; - - pid_to_text (p, p_text); - - strcat (cp_text, ", "); - strcat (cp_text, p_text); - - } - - sprintf (l_text, ", length = %d", flen); - strcat (cp_text, l_text); - - dw_printf ("%s\n", cp_text); - } - - - dw_printf (" dest %c%c%c%c%c%c %2d c/r=%d res=%d last=%d\n", - fptr[0]>>1, fptr[1]>>1, fptr[2]>>1, fptr[3]>>1, fptr[4]>>1, fptr[5]>>1, - (fptr[6]&SSID_SSID_MASK)>>SSID_SSID_SHIFT, - (fptr[6]&SSID_H_MASK)>>SSID_H_SHIFT, - (fptr[6]&SSID_RR_MASK)>>SSID_RR_SHIFT, - fptr[6]&SSID_LAST_MASK); - - dw_printf (" source %c%c%c%c%c%c %2d c/r=%d res=%d last=%d\n", - fptr[7]>>1, fptr[8]>>1, fptr[9]>>1, fptr[10]>>1, fptr[11]>>1, fptr[12]>>1, - (fptr[13]&SSID_SSID_MASK)>>SSID_SSID_SHIFT, - (fptr[13]&SSID_H_MASK)>>SSID_H_SHIFT, - (fptr[13]&SSID_RR_MASK)>>SSID_RR_SHIFT, - fptr[13]&SSID_LAST_MASK); - - for (n=2; nnum_addr; n++) { - - dw_printf (" digi %d %c%c%c%c%c%c %2d h=%d res=%d last=%d\n", - n - 1, - fptr[n*7+0]>>1, fptr[n*7+1]>>1, fptr[n*7+2]>>1, fptr[n*7+3]>>1, fptr[n*7+4]>>1, fptr[n*7+5]>>1, - (fptr[n*7+6]&SSID_SSID_MASK)>>SSID_SSID_SHIFT, - (fptr[n*7+6]&SSID_H_MASK)>>SSID_H_SHIFT, - (fptr[n*7+6]&SSID_RR_MASK)>>SSID_RR_SHIFT, - fptr[n*7+6]&SSID_LAST_MASK); - - } - - hex_dump (fptr, flen); - -} /* end ax25_hex_dump */ - - - -/*------------------------------------------------------------------ - * - * Function: ax25_is_aprs - * - * Purpose: Is this packet APRS format? - * - * Inputs: this_p - pointer to packet object. - * - * Returns: True if this frame has the proper control - * octets for an APRS packet. - * control 3 for UI frame - * protocol id 0xf0 for no layer 3 - * - * - * Description: Dire Wolf should be able to act as a KISS TNC for - * any type of AX.25 activity. However, there are other - * places where we want to process only APRS. - * (e.g. digipeating and IGate.) - * - *------------------------------------------------------------------*/ - - -int ax25_is_aprs (packet_t this_p) -{ - int ctrl, pid, is_aprs; - - assert (this_p->magic1 == MAGIC); - assert (this_p->magic2 == MAGIC); - - ctrl = ax25_get_control(this_p); - pid = ax25_get_pid(this_p); - - is_aprs = this_p->num_addr >= 2 && ctrl == AX25_UI_FRAME && pid == AX25_NO_LAYER_3; - -#if 0 - text_color_set(DW_COLOR_ERROR); - dw_printf ("ax25_is_aprs(): ctrl=%02x, pid=%02x, is_aprs=%d\n", ctrl, pid, is_aprs); -#endif - return (is_aprs); -} - -/*------------------------------------------------------------------ - * - * Function: ax25_get_control - * - * Purpose: Get Control field from packet. - * - * Inputs: this_p - pointer to packet object. - * - * Returns: APRS uses AX25_UI_FRAME. - * This could also be used in other situations. - * - *------------------------------------------------------------------*/ - - -int ax25_get_control (packet_t this_p) -{ - assert (this_p->magic1 == MAGIC); - assert (this_p->magic2 == MAGIC); - - if (this_p->num_addr >= 2) { - return (this_p->frame_data[ax25_get_control_offset(this_p)]); - } - return (-1); -} - -/*------------------------------------------------------------------ - * - * Function: ax25_get_pid - * - * Purpose: Get protocol ID from packet. - * - * Inputs: this_p - pointer to packet object. - * - * Returns: APRS uses 0xf0 for no layer 3. - * This could also be used in other situations. - * - * AX.25: "The Protocol Identifier (PID) field appears in information - * frames (I and UI) only. It identifies which kind of - * Layer 3 protocol, if any, is in use." - * - *------------------------------------------------------------------*/ - - -int ax25_get_pid (packet_t this_p) -{ - assert (this_p->magic1 == MAGIC); - assert (this_p->magic2 == MAGIC); - - if (this_p->num_addr >= 2) { - return (this_p->frame_data[ax25_get_pid_offset(this_p)]); - } - return (-1); -} - - -/*------------------------------------------------------------------------------ - * - * Name: ax25_dedupe_crc - * - * Purpose: Calculate a checksum for the packet source, destination, and - * information but NOT the digipeaters. - * This is used for duplicate detection in the digipeater - * and IGate algorithms. - * - * Input: pp - Pointer to packet object. - * - * Returns: Value which will be the same for a duplicate but very unlikely - * to match a non-duplicate packet. - * - * Description: For detecting duplicates, we need to look - * + source station - * + destination - * + information field - * but NOT the changing list of digipeaters. - * - * Typically, only a checksum is kept to reduce memory - * requirements and amount of compution for comparisons. - * There is a very very small probability that two unrelated - * packets will result in the same checksum, and the - * undesired dropping of the packet. - * - *------------------------------------------------------------------------------*/ - -unsigned short ax25_dedupe_crc (packet_t pp) -{ - unsigned short crc; - char src[AX25_MAX_ADDR_LEN]; - char dest[AX25_MAX_ADDR_LEN]; - unsigned char *pinfo; - int info_len; - - ax25_get_addr_with_ssid(pp, AX25_SOURCE, src); - ax25_get_addr_with_ssid(pp, AX25_DESTINATION, dest); - info_len = ax25_get_info (pp, &pinfo); - - crc = 0xffff; - crc = crc16((unsigned char *)src, strlen(src), crc); - crc = crc16((unsigned char *)dest, strlen(dest), crc); - crc = crc16(pinfo, info_len, crc); - - return (crc); -} - -/*------------------------------------------------------------------------------ - * - * Name: ax25_m_m_crc - * - * Purpose: Calculate a checksum for the packet. - * This is used for the multimodem duplicate detection. - * - * Input: pp - Pointer to packet object. - * - * Returns: Value which will be the same for a duplicate but very unlikely - * to match a non-duplicate packet. - * - * Description: For detecting duplicates, we need to look the entire packet. - * - * Typically, only a checksum is kept to reduce memory - * requirements and amount of compution for comparisons. - * There is a very very small probability that two unrelated - * packets will result in the same checksum, and the - * undesired dropping of the packet. - - *------------------------------------------------------------------------------*/ - -unsigned short ax25_m_m_crc (packet_t pp) -{ - unsigned short crc; - unsigned char fbuf[AX25_MAX_PACKET_LEN]; - int flen; - - flen = ax25_pack (pp, fbuf); - - crc = 0xffff; - crc = crc16(fbuf, flen, crc); - - return (crc); -} - - -/*------------------------------------------------------------------ - * - * Function: ax25_safe_print - * - * Purpose: Print given string, changing non printable characters to - * hexadecimal notation. Note that character values - * , 28, 29, 30, and 31 can appear in MIC-E message. - * - * Inputs: pstr - Pointer to string. - * - * len - Maximum length if not -1. - * - * ascii_only - Restrict output to only ASCII. - * Normally we allow UTF-8. - * - * Stops after non-zero len characters or at nul. - * - * Returns: none - * - * Description: Print a string in a "safe" manner. - * Anything that is not a printable character - * will be converted to a hexadecimal representation. - * For example, a Line Feed character will appear as <0x0a> - * rather than dropping down to the next line on the screen. - * - * ax25_from_text can accept this format. - * - * - * Example: W1MED-1>T2QP0S,N1OHZ,N8VIM*,WIDE1-1:'cQBl <0x1c>-/]<0x0d> - * ------ ------ - * - * Questions: What should we do about UTF-8? Should that be displayed - * as hexadecimal for troubleshooting? Maybe an option so the - * packet raw data is in hexadecimal but an extracted - * comment displays UTF-8? Or a command line option for only ASCII? - * - *------------------------------------------------------------------*/ - -#define MAXSAFE 500 - -void ax25_safe_print (char *pstr, int len, int ascii_only) -{ - int ch; - char safe_str[MAXSAFE*6+1]; - int safe_len; - - safe_len = 0; - safe_str[safe_len] = '\0'; - - - if (len < 0) - len = strlen(pstr); - - if (len > MAXSAFE) - len = MAXSAFE; - - while (len > 0 && *pstr != '\0') - { - ch = *((unsigned char *)pstr); - - if (ch < ' ' || ch == 0x7f || ch == 0xfe || ch == 0xff || - (ascii_only && ch >= 0x80) ) { - - /* Control codes and delete. */ - /* UTF-8 does not use fe and ff except in a possible */ - /* "Byte Order Mark" (BOM) at the beginning. */ - - sprintf (safe_str + safe_len, "<0x%02x>", ch); - safe_len += 6; - } - else { - /* Let everything else thru so we can handle UTF-8 */ - /* Maybe we should have an option to display 0x80 */ - /* and above as hexadecimal. */ - - safe_str[safe_len++] = ch; - safe_str[safe_len] = '\0'; - } - - pstr++; - len--; - } - - dw_printf ("%s", safe_str); - -} /* end ax25_safe_print */ - - - -/* end ax25_pad.c */ diff --git a/beacon.c b/beacon.c deleted file mode 100644 index 92e75a89..00000000 --- a/beacon.c +++ /dev/null @@ -1,792 +0,0 @@ -//#define DEBUG 1 -//#define DEBUG_SIM 1 - - -// -// This file is part of Dire Wolf, an amateur radio packet TNC. -// -// Copyright (C) 2011,2013,2014 John Langner, WB2OSZ -// -// This program 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 2 of the License, or -// (at your option) any later version. -// -// This program 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 this program. If not, see . -// - - -/*------------------------------------------------------------------ - * - * Module: beacon.c - * - * Purpose: Transmit messages on a fixed schedule. - * - * Description: Transmit periodic messages as specified in the config file. - * - *---------------------------------------------------------------*/ - -#include -#include -#include -#include -#include -#include - -#include -#if __WIN32__ -#include -#endif - -#include "direwolf.h" -#include "ax25_pad.h" -#include "textcolor.h" -#include "audio.h" -#include "tq.h" -#include "xmit.h" -#include "config.h" -#include "digipeater.h" -#include "version.h" -#include "encode_aprs.h" -#include "beacon.h" -#include "latlong.h" -#include "dwgps.h" -#include "log.h" - - - -/* - * Are we using GPS data? - * Incremented if tracker beacons configured. - * Cleared if dwgps_init fails. - */ - -static int g_using_gps = 0; - -/* - * Save pointers to configuration settings. - */ - -static struct misc_config_s *g_misc_config_p; -static struct digi_config_s *g_digi_config_p; - - - -#if __WIN32__ -static unsigned __stdcall beacon_thread (void *arg); -#else -static void * beacon_thread (void *arg); -#endif - -static int g_tracker_debug_level = 0; // 1 for data from gps. - // 2 + Smart Beaconing logic. - // 3 + Send transmissions to log file. - - -void beacon_tracker_set_debug (int level) -{ - g_tracker_debug_level = level; -} - - - -/*------------------------------------------------------------------- - * - * Name: beacon_init - * - * Purpose: Initialize the beacon process. - * - * Inputs: pconfig - misc. configuration from config file. - * pdigi - digipeater configuration from config file. - * Use to obtain "mycall" for each channel. - * - * - * Outputs: Remember required information for future use. - * - * Description: Initialize the queue to be empty and set up other - * mechanisms for sharing it between different threads. - * - * Start up xmit_thread to actually send the packets - * at the appropriate time. - * - *--------------------------------------------------------------------*/ - - - -void beacon_init (struct misc_config_s *pconfig, struct digi_config_s *pdigi) -{ - time_t now; - int j; - int count; -#if __WIN32__ - HANDLE beacon_th; -#else - pthread_t beacon_tid; -#endif - - - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("beacon_init ( ... )\n"); -#endif - - - -/* - * Save parameters for later use. - */ - g_misc_config_p = pconfig; - g_digi_config_p = pdigi; - -/* - * Precompute the packet contents so any errors are - * Reported once at start up time rather than for each transmission. - * If a serious error is found, set type to BEACON_IGNORE and that - * table entry should be ignored later on. - */ - for (j=0; jnum_beacons; j++) { - int chan = g_misc_config_p->beacon[j].sendto_chan; - - if (chan < 0) chan = 0; /* For IGate, use channel 0 call. */ - - if (chan < pdigi->num_chans) { - - if (strlen(pdigi->mycall[chan]) > 0 && strcasecmp(pdigi->mycall[chan], "NOCALL") != 0) { - - switch (g_misc_config_p->beacon[j].btype) { - - case BEACON_OBJECT: - - /* Object name is required. */ - - if (strlen(g_misc_config_p->beacon[j].objname) == 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Config file, line %d: OBJNAME is required for OBEACON.\n", g_misc_config_p->beacon[j].lineno); - g_misc_config_p->beacon[j].btype = BEACON_IGNORE; - continue; - } - /* Fall thru. Ignore any warning about missing break. */ - - case BEACON_POSITION: - - /* Location is required. */ - - if (g_misc_config_p->beacon[j].lat == G_UNKNOWN || g_misc_config_p->beacon[j].lon == G_UNKNOWN) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Config file, line %d: Latitude and longitude are required.\n", g_misc_config_p->beacon[j].lineno); - g_misc_config_p->beacon[j].btype = BEACON_IGNORE; - continue; - } - break; - - case BEACON_TRACKER: - -#if defined(ENABLE_GPS) || defined(DEBUG_SIM) - g_using_gps++; -#else - text_color_set(DW_COLOR_ERROR); - dw_printf ("Config file, line %d: GPS tracker feature is not enabled.\n", g_misc_config_p->beacon[j].lineno); - g_misc_config_p->beacon[j].btype = BEACON_IGNORE; - continue; -#endif - break; - - case BEACON_CUSTOM: - - /* INFO is required. */ - - if (g_misc_config_p->beacon[j].custom_info == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Config file, line %d: INFO is required for custom beacon.\n", g_misc_config_p->beacon[j].lineno); - g_misc_config_p->beacon[j].btype = BEACON_IGNORE; - continue; - } - break; - - case BEACON_IGNORE: - break; - } - } - else { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Config file, line %d: MYCALL must be set for beacon on channel %d. \n", g_misc_config_p->beacon[j].lineno, chan); - g_misc_config_p->beacon[j].btype = BEACON_IGNORE; - } - } - else { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Config file, line %d: Invalid channel number %d for beacon. \n", g_misc_config_p->beacon[j].lineno, chan); - g_misc_config_p->beacon[j].btype = BEACON_IGNORE; - } - } - -/* - * Calculate next time for each beacon. - */ - - now = time(NULL); - - for (j=0; jnum_beacons; j++) { -#if DEBUG - - text_color_set(DW_COLOR_DEBUG); - dw_printf ("beacon[%d] chan=%d, delay=%d, every=%d\n", - j, - g_misc_config_p->beacon[j].chan, - g_misc_config_p->beacon[j].delay, - g_misc_config_p->beacon[j].every); -#endif - g_misc_config_p->beacon[j].next = now + g_misc_config_p->beacon[j].delay; - } - - -/* - * Connect to GPS receiver if any tracker beacons are configured. - * If open fails, disable all tracker beacons. - */ - -#if DEBUG_SIM - - g_using_gps = 1; - -#elif ENABLE_GPS - - if (g_using_gps > 0) { - int err; - - err = dwgps_init(); - if (err != 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("All tracker beacons disabled.\n"); - g_using_gps = 0; - - for (j=0; jnum_beacons; j++) { - if (g_misc_config_p->beacon[j].btype == BEACON_TRACKER) { - g_misc_config_p->beacon[j].btype = BEACON_IGNORE; - } - } - } - - } -#endif - - -/* - * Start up thread for processing only if at least one is valid. - */ - - count = 0; - for (j=0; jnum_beacons; j++) { - if (g_misc_config_p->beacon[j].btype != BEACON_IGNORE) { - count++; - } - } - - if (count >= 1) { - -#if __WIN32__ - beacon_th = (HANDLE)_beginthreadex (NULL, 0, &beacon_thread, NULL, 0, NULL); - if (beacon_th == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Could not create beacon thread\n"); - return; - } -#else - int e; - - e = pthread_create (&beacon_tid, NULL, beacon_thread, (void *)0); - if (e != 0) { - text_color_set(DW_COLOR_ERROR); - perror("Could not create beacon thread"); - return; - } -#endif - } - - -} /* end beacon_init */ - - - - - -/*------------------------------------------------------------------- - * - * Name: beacon_thread - * - * Purpose: Transmit beacons when it is time. - * - * Inputs: g_misc_config_p->beacon - * - * Outputs: g_misc_config_p->beacon[].next_time - * - * Description: Go to sleep until it is time for the next beacon. - * Transmit any beacons scheduled for now. - * Repeat. - * - *--------------------------------------------------------------------*/ - -#define MIN(x,y) ((x) < (y) ? (x) : (y)) - - -/* Difference between two angles. */ - -static inline float heading_change (float a, float b) -{ - float diff; - - diff = fabs(a - b); - if (diff <= 180.) - return (diff); - else - return (360. - diff); -} - - -#if __WIN32__ -static unsigned __stdcall beacon_thread (void *arg) -#else -static void * beacon_thread (void *arg) -#endif -{ - int j; - time_t earliest; - time_t now; - -/* - * Information from GPS. - */ - int fix = 0; /* 0 = none, 2 = 2D, 3 = 3D */ - double my_lat = 0; /* degrees */ - double my_lon = 0; - float my_course = 0; /* degrees */ - float my_speed_knots = 0; - float my_speed_mph = 0; - float my_alt_m = G_UNKNOWN; /* meters */ - int my_alt_ft = G_UNKNOWN; - -/* - * SmartBeaconing state. - */ - time_t sb_prev_time = 0; /* Time of most recent transmission. */ - float sb_prev_course = 0; /* Most recent course reported. */ - //float sb_prev_speed_mph; /* Most recent speed reported. */ - int sb_every; /* Calculated time between transmissions. */ - - -#if DEBUG - struct tm tm; - char hms[20]; - - now = time(NULL); - localtime_r (&now, &tm); - strftime (hms, sizeof(hms), "%H:%M:%S", &tm); - text_color_set(DW_COLOR_DEBUG); - dw_printf ("beacon_thread: started %s\n", hms); -#endif - now = time(NULL); - - while (1) { - - assert (g_misc_config_p->num_beacons >= 1); - -/* - * Sleep until time for the earliest scheduled or - * the soonest we could transmit due to corner pegging. - */ - - earliest = g_misc_config_p->beacon[0].next; - for (j=1; jnum_beacons; j++) { - if (g_misc_config_p->beacon[j].btype == BEACON_IGNORE) - continue; - earliest = MIN(g_misc_config_p->beacon[j].next, earliest); - } - - if (g_misc_config_p->sb_configured && g_using_gps) { - earliest = MIN(now + g_misc_config_p->sb_turn_time, earliest); - earliest = MIN(now + g_misc_config_p->sb_fast_rate, earliest); - } - - if (earliest > now) { - SLEEP_SEC (earliest - now); - } - -/* - * Woke up. See what needs to be done. - */ - now = time(NULL); - -#if DEBUG - localtime_r (&now, &tm); - strftime (hms, sizeof(hms), "%H:%M:%S", &tm); - text_color_set(DW_COLOR_DEBUG); - dw_printf ("beacon_thread: woke up %s\n", hms); -#endif - -/* - * Get information from GPS if being used. - * This needs to be done before the next scheduled tracker - * beacon because corner pegging make it sooner. - */ - -#if DEBUG_SIM - FILE *fp; - char cs[40]; - - fp = fopen ("c:\\cygwin\\tmp\\cs", "r"); - if (fp != NULL) { - fscanf (fp, "%f %f", &my_course, &my_speed_knots); - fclose (fp); - } - else { - fprintf (stderr, "Can't read /tmp/cs.\n"); - } - fix = 3; - my_speed_mph = DW_KNOTS_TO_MPH(my_speed_knots); - my_lat = 42.99; - my_lon = 71.99; - my_alt_m = 100; -#else - if (g_using_gps) { - - fix = dwgps_read (&my_lat, &my_lon, &my_speed_knots, &my_course, &my_alt_m); - my_speed_mph = DW_KNOTS_TO_MPH(my_speed_knots); - - if (g_tracker_debug_level >= 1) { - struct tm tm; - char hms[20]; - - localtime_r (&now, &tm); - strftime (hms, sizeof(hms), "%H:%M:%S", &tm); - text_color_set(DW_COLOR_DEBUG); - if (fix == 3) { - dw_printf ("%s 3D, %.6f, %.6f, %.1f mph, %.0f\xc2\xb0, %.1f m\n", hms, my_lat, my_lon, my_speed_mph, my_course, my_alt_m); - } - else if (fix == 2) { - dw_printf ("%s 2D, %.6f, %.6f, %.1f mph, %.0f\xc2\xb0\n", hms, my_lat, my_lon, my_speed_mph, my_course); - } - else { - dw_printf ("%s No GPS fix\n", hms); - } - } - - /* Transmit altitude only if 3D fix and user asked for it. */ - - my_alt_ft = G_UNKNOWN; - if (fix >= 3 && my_alt_m != G_UNKNOWN && g_misc_config_p->beacon[j].alt_m != G_UNKNOWN) { - my_alt_ft = DW_METERS_TO_FEET(my_alt_m); - } - - /* Don't complain here for no fix. */ - /* Possibly at the point where about to transmit. */ - } -#endif - -/* - * Run SmartBeaconing calculation if configured and GPS data available. - */ - if (g_misc_config_p->sb_configured && g_using_gps && fix >= 2) { - - if (my_speed_mph > g_misc_config_p->sb_fast_speed) { - sb_every = g_misc_config_p->sb_fast_rate; - if (g_tracker_debug_level >= 2) { - text_color_set(DW_COLOR_DEBUG); - dw_printf ("my speed %.1f > fast %d mph, interval = %d sec\n", my_speed_mph, g_misc_config_p->sb_fast_speed, sb_every); - } - } - else if (my_speed_mph < g_misc_config_p->sb_slow_speed) { - sb_every = g_misc_config_p->sb_slow_rate; - if (g_tracker_debug_level >= 2) { - text_color_set(DW_COLOR_DEBUG); - dw_printf ("my speed %.1f < slow %d mph, interval = %d sec\n", my_speed_mph, g_misc_config_p->sb_slow_speed, sb_every); - } - } - else { - /* Can't divide by 0 assuming sb_slow_speed > 0. */ - sb_every = ( g_misc_config_p->sb_fast_rate * g_misc_config_p->sb_fast_speed ) / my_speed_mph; - if (g_tracker_debug_level >= 2) { - text_color_set(DW_COLOR_DEBUG); - dw_printf ("my speed %.1f mph, interval = %d sec\n", my_speed_mph, sb_every); - } - } - -#if DEBUG_SIM - text_color_set(DW_COLOR_DEBUG); - dw_printf ("SB: fast %d %d slow %d %d speed=%.1f every=%d\n", - g_misc_config_p->sb_fast_speed, g_misc_config_p->sb_fast_rate, - g_misc_config_p->sb_slow_speed, g_misc_config_p->sb_slow_rate, - my_speed_mph, sb_every); -#endif - -/* - * Test for "Corner Pegging" if moving. - */ - if (my_speed_mph >= 1.0) { - int turn_threshold = g_misc_config_p->sb_turn_angle + - g_misc_config_p->sb_turn_slope / my_speed_mph; - -#if DEBUG_SIM - text_color_set(DW_COLOR_DEBUG); - dw_printf ("SB-moving: course %.0f prev %.0f thresh %d\n", - my_course, sb_prev_course, turn_threshold); -#endif - if (heading_change(my_course, sb_prev_course) > turn_threshold && - now >= sb_prev_time + g_misc_config_p->sb_turn_time) { - - if (g_tracker_debug_level >= 2) { - text_color_set(DW_COLOR_DEBUG); - dw_printf ("heading change (%.0f, %.0f) > threshold %d and %d since last >= turn time %d\n", - my_course, sb_prev_course, turn_threshold, - (int)(now - sb_prev_time), g_misc_config_p->sb_turn_time); - } - - /* Send it now. */ - for (j=0; jnum_beacons; j++) { - if (g_misc_config_p->beacon[j].btype == BEACON_TRACKER) { - g_misc_config_p->beacon[j].next = now; - } - } - } /* significant change in direction */ - } /* is moving */ - } /* apply SmartBeaconing */ - - - for (j=0; jnum_beacons; j++) { - - if (g_misc_config_p->beacon[j].btype == BEACON_IGNORE) - continue; - - if (g_misc_config_p->beacon[j].next <= now) { - - int strict = 1; /* Strict packet checking because they will go over air. */ - char stemp[20]; - char info[AX25_MAX_INFO_LEN]; - char beacon_text[AX25_MAX_PACKET_LEN]; - packet_t pp = NULL; - char mycall[AX25_MAX_ADDR_LEN]; - int alt_ft; - -/* - * Obtain source call for the beacon. - * This could potentially be different on different channels. - * When sending to IGate server, use call from first radio channel. - * - * Check added in version 1.0a. Previously used index of -1. - * - * Version 1.1 - channel should now be 0 for IGate. - * Type of destination is encoded separately. - */ - strcpy (mycall, "NOCALL"); - - assert (g_misc_config_p->beacon[j].sendto_chan >= 0); - - strcpy (mycall, g_digi_config_p->mycall[g_misc_config_p->beacon[j].sendto_chan]); - - if (strlen(mycall) == 0 || strcmp(mycall, "NOCALL") == 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("MYCALL not set for beacon in config file line %d.\n", g_misc_config_p->beacon[j].lineno); - continue; - } - -/* - * Prepare the monitor format header. - * - * src > dest [ , via ] - */ - - strcpy (beacon_text, mycall); - strcat (beacon_text, ">"); - - if (g_misc_config_p->beacon[j].dest != NULL) { - strcat (beacon_text, g_misc_config_p->beacon[j].dest); - } - else { - sprintf (stemp, "%s%1d%1d", APP_TOCALL, MAJOR_VERSION, MINOR_VERSION); - strcat (beacon_text, stemp); - } - - if (g_misc_config_p->beacon[j].via != NULL) { - strcat (beacon_text, ","); - strcat (beacon_text, g_misc_config_p->beacon[j].via); - } - strcat (beacon_text, ":"); - -/* - * Add the info part depending on beacon type. - */ - switch (g_misc_config_p->beacon[j].btype) { - - case BEACON_POSITION: - - alt_ft = DW_METERS_TO_FEET(g_misc_config_p->beacon[j].alt_m); - - encode_position (g_misc_config_p->beacon[j].messaging, - g_misc_config_p->beacon[j].compress, g_misc_config_p->beacon[j].lat, g_misc_config_p->beacon[j].lon, alt_ft, - g_misc_config_p->beacon[j].symtab, g_misc_config_p->beacon[j].symbol, - g_misc_config_p->beacon[j].power, g_misc_config_p->beacon[j].height, g_misc_config_p->beacon[j].gain, g_misc_config_p->beacon[j].dir, - 0, 0, /* course, speed */ - g_misc_config_p->beacon[j].freq, g_misc_config_p->beacon[j].tone, g_misc_config_p->beacon[j].offset, - g_misc_config_p->beacon[j].comment, - info); - strcat (beacon_text, info); - g_misc_config_p->beacon[j].next = now + g_misc_config_p->beacon[j].every; - break; - - case BEACON_OBJECT: - - encode_object (g_misc_config_p->beacon[j].objname, g_misc_config_p->beacon[j].compress, 0, g_misc_config_p->beacon[j].lat, g_misc_config_p->beacon[j].lon, - g_misc_config_p->beacon[j].symtab, g_misc_config_p->beacon[j].symbol, - g_misc_config_p->beacon[j].power, g_misc_config_p->beacon[j].height, g_misc_config_p->beacon[j].gain, g_misc_config_p->beacon[j].dir, - 0, 0, /* course, speed */ - g_misc_config_p->beacon[j].freq, g_misc_config_p->beacon[j].tone, g_misc_config_p->beacon[j].offset, g_misc_config_p->beacon[j].comment, - info); - strcat (beacon_text, info); - g_misc_config_p->beacon[j].next = now + g_misc_config_p->beacon[j].every; - break; - - case BEACON_TRACKER: - - if (fix >= 2) { - int coarse; /* APRS encoder wants 1 - 360. */ - /* 0 means none or unknown. */ - - coarse = (int)roundf(my_course); - if (coarse == 0) { - coarse = 360; - } - encode_position (g_misc_config_p->beacon[j].messaging, - g_misc_config_p->beacon[j].compress, - my_lat, my_lon, my_alt_ft, - g_misc_config_p->beacon[j].symtab, g_misc_config_p->beacon[j].symbol, - g_misc_config_p->beacon[j].power, g_misc_config_p->beacon[j].height, g_misc_config_p->beacon[j].gain, g_misc_config_p->beacon[j].dir, - coarse, (int)roundf(my_speed_knots), - g_misc_config_p->beacon[j].freq, g_misc_config_p->beacon[j].tone, g_misc_config_p->beacon[j].offset, - g_misc_config_p->beacon[j].comment, - info); - strcat (beacon_text, info); - - /* Remember most recent tracker beacon. */ - - sb_prev_time = now; - sb_prev_course = my_course; - //sb_prev_speed_mph = my_speed_mph; - - /* Calculate time for next transmission. */ - if (g_misc_config_p->sb_configured) { - g_misc_config_p->beacon[j].next = now + sb_every; - } - else { - g_misc_config_p->beacon[j].next = now + g_misc_config_p->beacon[j].every; - } - - /* Write to log file for testing. */ - /* The idea is to run log2gpx and map the result rather than */ - /* actually transmitting and relying on someone else to receive */ - /* the signals. */ - - if (g_tracker_debug_level >= 3) { - - decode_aprs_t A; - - memset (&A, 0, sizeof(A)); - A.g_freq = G_UNKNOWN; - A.g_offset = G_UNKNOWN; - A.g_tone = G_UNKNOWN; - A.g_dcs = G_UNKNOWN; - - strcpy (A.g_src, mycall); - A.g_symbol_table = g_misc_config_p->beacon[j].symtab; - A.g_symbol_code = g_misc_config_p->beacon[j].symbol; - A.g_lat = my_lat; - A.g_lon = my_lon; - A.g_speed = DW_KNOTS_TO_MPH(my_speed_knots); - A.g_course = coarse; - A.g_altitude = my_alt_ft; - - /* Fake channel of 999 to distinguish from real data. */ - log_write (999, &A, NULL, 0, 0); - } - } - else { - g_misc_config_p->beacon[j].next = now + 2; - continue; /* No fix. Try again in a couple seconds. */ - } - break; - - case BEACON_CUSTOM: - - if (g_misc_config_p->beacon[j].custom_info != NULL) { - strcat (beacon_text, g_misc_config_p->beacon[j].custom_info); - } - else { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Internal error. custom_info is null. %s %d\n", __FILE__, __LINE__); - continue; - } - g_misc_config_p->beacon[j].next = now + g_misc_config_p->beacon[j].every; - break; - - case BEACON_IGNORE: - default: - break; - - } /* switch beacon type. */ - -/* - * Parse monitor format into form for transmission. - */ - pp = ax25_from_text (beacon_text, strict); - - if (pp != NULL) { - - /* Send to desired destination. */ - - switch (g_misc_config_p->beacon[j].sendto_type) { - - case SENDTO_IGATE: - - -#if 1 - text_color_set(DW_COLOR_XMIT); - dw_printf ("[ig] %s\n", beacon_text); -#endif - igate_send_rec_packet (0, pp); - ax25_delete (pp); - break; - - case SENDTO_XMIT: - default: - - tq_append (g_misc_config_p->beacon[j].sendto_chan, TQ_PRIO_1_LO, pp); - break; - - case SENDTO_RECV: - - // TODO: Put into receive queue rather than calling directly. - - app_process_rec_packet (g_misc_config_p->beacon[j].sendto_chan, 0, pp, -1, 0, ""); - break; - } - } - else { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Config file: Failed to parse packet constructed from line %d.\n", g_misc_config_p->beacon[j].lineno); - dw_printf ("%s\n", beacon_text); - } - - } /* if time to send it */ - - } /* for each configured beacon */ - - } /* do forever */ - -} /* end beacon_thread */ - -/* end beacon.c */ diff --git a/beacon.h b/beacon.h deleted file mode 100644 index a94e6aa0..00000000 --- a/beacon.h +++ /dev/null @@ -1,6 +0,0 @@ - -/* beacon.h */ - -void beacon_init (struct misc_config_s *pconfig, struct digi_config_s *pdigi); - -void beacon_tracker_set_debug (int level); diff --git a/cmake/cpack/CMakeLists.txt b/cmake/cpack/CMakeLists.txt new file mode 100644 index 00000000..845c377c --- /dev/null +++ b/cmake/cpack/CMakeLists.txt @@ -0,0 +1 @@ +include(CPack) diff --git a/cmake/cpack/direwolf.desktop.in b/cmake/cpack/direwolf.desktop.in new file mode 100644 index 00000000..79c63aa6 --- /dev/null +++ b/cmake/cpack/direwolf.desktop.in @@ -0,0 +1,10 @@ +[Desktop Entry] +Name=@APPLICATION_NAME@ +Comment=APRS Soundcard TNC +Exec=@APPLICATION_DESKTOP_EXEC@ +Icon=@CMAKE_PROJECT_NAME@_icon.png +StartupNotify=true +Terminal=false +Type=Application +Categories=HamRadio +Keywords=Ham Radio;APRS;Soundcard TNC;KISS;AGWPE;AX.25 \ No newline at end of file diff --git a/cmake/cpack/direwolf.rc b/cmake/cpack/direwolf.rc new file mode 100644 index 00000000..99de6d9f --- /dev/null +++ b/cmake/cpack/direwolf.rc @@ -0,0 +1 @@ +MAINICON ICON "direwolf_icon.ico" \ No newline at end of file diff --git a/dw-icon.ico b/cmake/cpack/direwolf_icon.ico similarity index 100% rename from dw-icon.ico rename to cmake/cpack/direwolf_icon.ico diff --git a/dw-icon.png b/cmake/cpack/direwolf_icon.png similarity index 100% rename from dw-icon.png rename to cmake/cpack/direwolf_icon.png diff --git a/cmake/cpu_tests/test_arm_neon.cxx b/cmake/cpu_tests/test_arm_neon.cxx new file mode 100644 index 00000000..cb48159f --- /dev/null +++ b/cmake/cpu_tests/test_arm_neon.cxx @@ -0,0 +1,16 @@ +#include +#include +#include +#include + +void signalHandler(int signum) { + exit(signum); // SIGILL = 4 +} + +int main(int argc, char* argv[]) +{ + signal(SIGILL, signalHandler); + uint32x4_t x={0}; + x=veorq_u32(x,x); + return 0; +} diff --git a/cmake/cpu_tests/test_x86_avx.cxx b/cmake/cpu_tests/test_x86_avx.cxx new file mode 100644 index 00000000..2344fbcb --- /dev/null +++ b/cmake/cpu_tests/test_x86_avx.cxx @@ -0,0 +1,15 @@ +#include +#include +#include + +void signalHandler(int signum) { + exit(signum); // SIGILL = 4 +} + +int main(int argc, char* argv[]) +{ + signal(SIGILL, signalHandler); + __m256d x = _mm256_setzero_pd(); + x=_mm256_addsub_pd(x,x); + return 0; +} diff --git a/cmake/cpu_tests/test_x86_avx2.cxx b/cmake/cpu_tests/test_x86_avx2.cxx new file mode 100644 index 00000000..369186de --- /dev/null +++ b/cmake/cpu_tests/test_x86_avx2.cxx @@ -0,0 +1,15 @@ +#include +#include +#include + +void signalHandler(int signum) { + exit(signum); // SIGILL = 4 +} + +int main(int argc, char* argv[]) +{ + signal(SIGILL, signalHandler); + __m256i x = _mm256_setzero_si256(); + x=_mm256_add_epi64 (x,x); + return 0; +} diff --git a/cmake/cpu_tests/test_x86_avx512.cxx b/cmake/cpu_tests/test_x86_avx512.cxx new file mode 100644 index 00000000..eed07d3f --- /dev/null +++ b/cmake/cpu_tests/test_x86_avx512.cxx @@ -0,0 +1,16 @@ +#include +#include +#include +#include + +void signalHandler(int signum) { + exit(signum); // SIGILL = 4 +} + +int main(int argc, char* argv[]) +{ + signal(SIGILL, signalHandler); + uint64_t x[8] = {0}; + __m512i y = _mm512_loadu_si512((__m512i*)x); + return 0; +} diff --git a/cmake/cpu_tests/test_x86_sse2.cxx b/cmake/cpu_tests/test_x86_sse2.cxx new file mode 100644 index 00000000..98eb27ea --- /dev/null +++ b/cmake/cpu_tests/test_x86_sse2.cxx @@ -0,0 +1,15 @@ +#include +#include +#include + +void signalHandler(int signum) { + exit(signum); // SIGILL = 4 +} + +int main(int argc, char* argv[]) +{ + signal(SIGILL, signalHandler); + __m128i x = _mm_setzero_si128(); + x=_mm_add_epi64(x,x); + return 0; +} diff --git a/cmake/cpu_tests/test_x86_sse3.cxx b/cmake/cpu_tests/test_x86_sse3.cxx new file mode 100644 index 00000000..70a31e3f --- /dev/null +++ b/cmake/cpu_tests/test_x86_sse3.cxx @@ -0,0 +1,16 @@ +#include +#include +#include +#include + +void signalHandler(int signum) { + exit(signum); // SIGILL = 4 +} + +int main(int argc, char* argv[]) +{ + signal(SIGILL, signalHandler); + __m128d x = _mm_setzero_pd(); + x=_mm_addsub_pd(x,x); + return 0; +} diff --git a/cmake/cpu_tests/test_x86_sse41.cxx b/cmake/cpu_tests/test_x86_sse41.cxx new file mode 100644 index 00000000..e08697fb --- /dev/null +++ b/cmake/cpu_tests/test_x86_sse41.cxx @@ -0,0 +1,18 @@ +#include +#include +#include +#include + +void signalHandler(int signum) { + exit(signum); // SIGILL = 4 +} + +int main(int argc, char* argv[]) +{ + signal(SIGILL, signalHandler); + __m128i x = _mm_setzero_si128(); + __m128i a = _mm_setzero_si128(); + __m128i b = _mm_setzero_si128(); + x=_mm_blend_epi16(a,b,4); + return 0; +} diff --git a/cmake/cpu_tests/test_x86_sse42.cxx b/cmake/cpu_tests/test_x86_sse42.cxx new file mode 100644 index 00000000..58032a57 --- /dev/null +++ b/cmake/cpu_tests/test_x86_sse42.cxx @@ -0,0 +1,15 @@ +#include +#include +#include + +void signalHandler(int signum) { + exit(signum); // SIGILL = 4 +} + +int main(int argc, char* argv[]) +{ + signal(SIGILL, signalHandler); + unsigned int x=32; + x=_mm_crc32_u8(x,4); + return 0; +} diff --git a/cmake/cpu_tests/test_x86_ssse3.cxx b/cmake/cpu_tests/test_x86_ssse3.cxx new file mode 100644 index 00000000..01688f4a --- /dev/null +++ b/cmake/cpu_tests/test_x86_ssse3.cxx @@ -0,0 +1,16 @@ +#include +#include +#include +#include + +void signalHandler(int signum) { + exit(signum); // SIGILL = 4 +} + +int main(int argc, char* argv[]) +{ + signal(SIGILL, signalHandler); + __m128i x = _mm_setzero_si128(); + x=_mm_alignr_epi8(x,x,2); + return 0; +} diff --git a/cmake/include/uninstall.cmake.in b/cmake/include/uninstall.cmake.in new file mode 100644 index 00000000..2037e365 --- /dev/null +++ b/cmake/include/uninstall.cmake.in @@ -0,0 +1,21 @@ +if(NOT EXISTS "@CMAKE_CURRENT_BINARY_DIR@/install_manifest.txt") + message(FATAL_ERROR "Cannot find install manifest: @CMAKE_CURRENT_BINARY_DIR@/install_manifest.txt") +endif(NOT EXISTS "@CMAKE_CURRENT_BINARY_DIR@/install_manifest.txt") + +file(READ "@CMAKE_CURRENT_BINARY_DIR@/install_manifest.txt" files) +string(REGEX REPLACE "\n" ";" files "${files}") +foreach(file ${files}) + message(STATUS "Uninstalling $ENV{DESTDIR}${file}") + if(IS_SYMLINK "$ENV{DESTDIR}${file}" OR EXISTS "$ENV{DESTDIR}${file}") + exec_program( + "@CMAKE_COMMAND@" ARGS "-E remove \"$ENV{DESTDIR}${file}\"" + OUTPUT_VARIABLE rm_out + RETURN_VALUE rm_retval + ) + if(NOT "${rm_retval}" STREQUAL 0) + message(FATAL_ERROR "Problem when removing $ENV{DESTDIR}${file}") + endif(NOT "${rm_retval}" STREQUAL 0) + else(IS_SYMLINK "$ENV{DESTDIR}${file}" OR EXISTS "$ENV{DESTDIR}${file}") + message(STATUS "File $ENV{DESTDIR}${file} does not exist.") + endif(IS_SYMLINK "$ENV{DESTDIR}${file}" OR EXISTS "$ENV{DESTDIR}${file}") +endforeach(file) diff --git a/cmake/modules/FindAvahi.cmake b/cmake/modules/FindAvahi.cmake new file mode 100644 index 00000000..9dc27618 --- /dev/null +++ b/cmake/modules/FindAvahi.cmake @@ -0,0 +1,19 @@ + +find_library(AVAHI_COMMON_LIBRARY NAMES avahi-common PATHS ${PC_AVAHI_CLIENT_LIBRARY_DIRS}) +if(AVAHI_COMMON_LIBRARY) + set(AVAHI_COMMON_FOUND TRUE) +endif() + +find_library(AVAHI_CLIENT_LIBRARY NAMES avahi-client PATHS ${PC_AVAHI_CLIENT_LIBRARY_DIRS}) +if(AVAHI_CLIENT_LIBRARY) + set(AVAHI_CLIENT_FOUND TRUE) +endif() + +FIND_PACKAGE_HANDLE_STANDARD_ARGS(Avahi DEFAULT_MSG AVAHI_COMMON_FOUND AVAHI_CLIENT_FOUND) + +if (AVAHI_FOUND) + set(AVAHI_INCLUDE_DIRS ${AVAHI_UI_INCLUDE_DIR}) + set(AVAHI_LIBRARIES ${AVAHI_COMMON_LIBRARY} ${AVAHI_CLIENT_LIBRARY}) +endif() + +mark_as_advanced(AVAHI_INCLUDE_DIRS AVAHI_LIBRARIES) diff --git a/cmake/modules/FindCPUflags.cmake b/cmake/modules/FindCPUflags.cmake new file mode 100644 index 00000000..abb9e184 --- /dev/null +++ b/cmake/modules/FindCPUflags.cmake @@ -0,0 +1,383 @@ +# Clang or AppleClang (see CMP0025) +if(NOT DEFINED C_CLANG AND CMAKE_CXX_COMPILER_ID MATCHES "Clang") + set(C_CLANG 1) +elseif(NOT DEFINED C_GCC AND CMAKE_CXX_COMPILER_ID MATCHES "GNU") + set(C_GCC 1) +elseif(NOT DEFINED C_MSVC AND CMAKE_CXX_COMPILER_ID MATCHES "MSVC") + set(C_MSVC 1) +endif() + +# Detect current compilation architecture and create standard definitions +include(CheckSymbolExists) +function(detect_architecture symbol arch) + if (NOT DEFINED ARCHITECTURE) + set(CMAKE_REQUIRED_QUIET 1) + check_symbol_exists("${symbol}" "" ARCHITECTURE_${arch}) + unset(CMAKE_REQUIRED_QUIET) + + # The output variable needs to be unique across invocations otherwise + # CMake's crazy scope rules will keep it defined + if (ARCHITECTURE_${arch}) + set(ARCHITECTURE "${arch}" PARENT_SCOPE) + set(ARCHITECTURE_${arch} 1 PARENT_SCOPE) + add_definitions(-DARCHITECTURE_${arch}=1) + endif() + endif() +endfunction() + +# direwolf versions thru 1.5 were available pre-built for 32 bit Windows targets. +# Research and experimentation revealed that the SSE instructions made a big +# difference in runtime speed but SSE2 and later were not significantly better +# for this application. I decided to build with only the SSE instructions making +# the Pentium 3 the minimum requirement. SSE2 would require at least a Pentium 4 +# and offered no significant performance advantage. +# These are ancient history - from the previous Century - but old computers, generally +# considered useless for anything else, often end up in the ham shack. +# +# When cmake was first used for direwolf, the default target became 64 bit and the +# SSE2, SSE3, SSE4.1, and SSE4.2 instructions were automatically enabled based on the +# build machine capabilities. This was fine until I tried running the application +# on a computer much older than where it was built. It did not have the SSE4 instructions +# and the application died without a clue for the reason. +# Just how much benefit do these new instructions provide for this application? +# +# These were all run on the same computer, but compiled in different ways. +# Times to run atest with Track 1 of the TNC test CD: +# +# direwolf 1.5 - 32 bit target - gcc 6.3.0 +# +# 60.4 sec. Pentium 3 with SSE +# +# direwolf 1.6 - 32 bit target - gcc 7.4.0 +# +# 81.0 sec. with no SIMD instructions enabled. +# 54.4 sec. with SSE +# 52.0 sec. with SSE2 +# 52.4 sec. with SSE2, SSE3 +# 52.3 sec. with SSE2, SSE3, SSE4.1, SSE4.2 +# 49.9 sec. Fedora standard: -m32 -march=i686 -mtune=generic -msse2 -mfpmath=sse +# 50.4 sec. sse not sse2: -m32 -march=i686 -mtune=generic -msse -mfpmath=sse +# +# That's what I found several years ago with a much older compiler. +# The original SSE helped a lot but SSE2 and later made little difference. +# +# direwolf 1.6 - 64 bit target - gcc 7.4.0 +# +# 34.8 sec. with no SIMD instructions enabled. +# 34.8 sec. with SSE +# 34.8 sec. with SSE2 +# 34.2 sec. with SSE2, SSE3 +# 33.5 sec. with SSE2, SSE3, SSE4.1, SSE4.2 +# 33.4 Fedora standard: -mtune=generic +# +# Why do we see such little variation? 64-bit target implies +# SSE, SSE2, SSE3 instructions are available. +# +# Building for a 64 bit target makes it run about 1.5x faster on the same hardware. +# +# The default will be set for maximum portability so packagers won't need to +# to anything special. +# +# +# While ENABLE_GENERIC also had the desired result (for x86_64), I don't think +# it is the right approach. It prevents the detection of the architecture, +# i.e. x86, x86_64, ARM, ARM64. That's why it did not go looking for the various +# SSE instructions. For x86, we would miss out on using SSE. + +if (NOT ENABLE_GENERIC) + if (C_MSVC) + detect_architecture("_M_AMD64" x86_64) + detect_architecture("_M_IX86" x86) + detect_architecture("_M_ARM" ARM) + detect_architecture("_M_ARM64" ARM64) + else() + detect_architecture("__x86_64__" x86_64) + detect_architecture("__i386__" x86) + detect_architecture("__arm__" ARM) + detect_architecture("__aarch64__" ARM64) + endif() +endif() +if (NOT DEFINED ARCHITECTURE) + set(ARCHITECTURE "GENERIC") + set(ARCHITECTURE_GENERIC 1) + add_definitions(-DARCHITECTURE_GENERIC=1) +endif() +message(STATUS "Target architecture: ${ARCHITECTURE}") + +set(TEST_DIR ${PROJECT_SOURCE_DIR}/cmake/cpu_tests) + +# flag that set the minimum cpu flag requirements +# used to create re-distribuitable binary + +if (${ARCHITECTURE} MATCHES "x86_64|x86" AND (FORCE_SSE OR FORCE_SSSE3 OR FORCE_SSE41)) + if (FORCE_SSE) + set(HAS_SSE ON CACHE BOOL "SSE SIMD enabled") + if(C_GCC OR C_CLANG) + if (${ARCHITECTURE} MATCHES "x86_64") + # All 64-bit capable chips support MMX, SSE, SSE2, and SSE3 + # so they are all enabled automatically. We don't want to use + # SSE4, based on build machine capabilites, because the application + # would not run properly on an older CPU. + set( CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -mtune=generic" ) + set( CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -mtune=generic" ) + else() + # Fedora standard uses -msse2 here. + # I dropped it down to -msse for greater compatibility and little penalty. + set( CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -m32 -march=i686 -mtune=generic -msse -mfpmath=sse" ) + set( CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -m32 -march=i686 -mtune=generic -msse -mfpmath=sse" ) + endif() + message(STATUS "Use SSE SIMD instructions") + add_definitions(-DUSE_SSE) + elseif(C_MSVC) + set( CMAKE_C_FLAGS_DEBUG "${CMAKE_C_FLAGS_DEBUG} /arch:SSE" ) + set( CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} /arch:SSE" ) + set( CMAKE_C_FLAGS_RELEASE "${CMAKE_C_FLAGS_RELEASE} /Oi /GL /Ot /Ox" ) + set( CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS_RELEASE} /Oi /GL /Ot /Ox" ) + set( CMAKE_EXE_LINKER_FLAGS_RELEASE "${CMAKE_EXE_LINKER_FLAGS_RELEASE} /LTCG" ) + message(STATUS "Use MSVC SSSE3 SIMD instructions") + add_definitions (/D "_CRT_SECURE_NO_WARNINGS") + add_definitions(-DUSE_SSSE3) + endif() + elseif (FORCE_SSSE3) + set(HAS_SSSE3 ON CACHE BOOL "SSSE3 SIMD enabled") + if(C_GCC OR C_CLANG) + set( CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -mssse3" ) + set( CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -mssse3" ) + message(STATUS "Use SSSE3 SIMD instructions") + add_definitions(-DUSE_SSSE3) + elseif(C_MSVC) + set( CMAKE_C_FLAGS_DEBUG "${CMAKE_C_FLAGS_DEBUG} /arch:SSSE3" ) + set( CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} /arch:SSSE3" ) + set( CMAKE_C_FLAGS_RELEASE "${CMAKE_C_FLAGS_RELEASE} /Oi /GL /Ot /Ox" ) + set( CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS_RELEASE} /Oi /GL /Ot /Ox" ) + set( CMAKE_EXE_LINKER_FLAGS_RELEASE "${CMAKE_EXE_LINKER_FLAGS_RELEASE} /LTCG" ) + message(STATUS "Use MSVC SSSE3 SIMD instructions") + add_definitions (/D "_CRT_SECURE_NO_WARNINGS") + add_definitions(-DUSE_SSSE3) + endif() + elseif (FORCE_SSE41) + set(HAS_SSSE3 ON CACHE BOOL "SSSE3 SIMD enabled") + set(HAS_SSE4_1 ON CACHE BOOL "Architecture has SSE 4.1 SIMD enabled") + if(C_GCC OR C_CLANG) + set( CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -msse4.1" ) + set( CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -msse4.1" ) + message(STATUS "Use SSE 4.1 SIMD instructions") + add_definitions(-DUSE_SSSE3) + add_definitions(-DUSE_SSE4_1) + elseif(C_MSVC) + # seems that from MSVC 2015 comiler doesn't support those flags + set( CMAKE_C_FLAGS_DEBUG "${CMAKE_C_FLAGS_DEBUG} /arch:SSE4_1" ) + set( CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} /arch:SSE4_1" ) + set( CMAKE_C_FLAGS_RELEASE "${CMAKE_C_FLAGS_RELEASE} /Oi /GL /Ot /Ox" ) + set( CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS_RELEASE} /Oi /GL /Ot /Ox" ) + set( CMAKE_EXE_LINKER_FLAGS_RELEASE "${CMAKE_EXE_LINKER_FLAGS_RELEASE} /LTCG" ) + message(STATUS "Use SSE 4.1 SIMD instructions") + add_definitions (/D "_CRT_SECURE_NO_WARNINGS") + add_definitions(-DUSE_SSSE3) + add_definitions(-DUSE_SSE4_1) + endif() + endif() +else () + if (${ARCHITECTURE} MATCHES "x86_64|x86") + if(C_MSVC) + try_run(RUN_SSE2 COMPILE_SSE2 "${CMAKE_BINARY_DIR}/tmp" "${TEST_DIR}/test_x86_sse2.cxx" COMPILE_DEFINITIONS /O0) + else() + try_run(RUN_SSE2 COMPILE_SSE2 "${CMAKE_BINARY_DIR}/tmp" "${TEST_DIR}/test_x86_sse2.cxx" COMPILE_DEFINITIONS -msse2 -O0) + endif() + if(COMPILE_SSE2 AND RUN_SSE2 EQUAL 0) + set(HAS_SSE2 ON CACHE BOOL "Architecture has SSSE2 SIMD enabled") + message(STATUS "Use SSE2 SIMD instructions") + if(C_GCC OR C_CLANG) + set( CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -msse2" ) + set( CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -msse2" ) + add_definitions(-DUSE_SSE2) + elseif(C_MSVC) + set( CMAKE_C_FLAGS_DEBUG "${CMAKE_C_FLAGS_DEBUG} /arch:SSE2" ) + set( CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} /arch:SSE2" ) + set( CMAKE_C_FLAGS_RELEASE "${CMAKE_C_FLAGS_RELEASE} /Oi /GL /Ot /Ox /arch:SSE2" ) + set( CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS_RELEASE} /Oi /GL /Ot /Ox /arch:SSE2" ) + set( CMAKE_EXE_LINKER_FLAGS_RELEASE "${CMAKE_EXE_LINKER_FLAGS_RELEASE} /LTCG" ) + add_definitions (/D "_CRT_SECURE_NO_WARNINGS") + add_definitions(-DUSE_SSE2) + endif() + else() + set(HAS_SSE2 OFF CACHE BOOL "Architecture does not have SSSE2 SIMD enabled") + endif() + if(C_MSVC) + try_run(RUN_SSSE3 COMPILE_SSSE3 "${CMAKE_BINARY_DIR}/tmp" "${TEST_DIR}/test_x86_ssse3.cxx" COMPILE_DEFINITIONS /O0) + else() + try_run(RUN_SSSE3 COMPILE_SSSE3 "${CMAKE_BINARY_DIR}/tmp" "${TEST_DIR}/test_x86_ssse3.cxx" COMPILE_DEFINITIONS -mssse3 -O0) + endif() + if(COMPILE_SSSE3 AND RUN_SSSE3 EQUAL 0) + set(HAS_SSSE3 ON CACHE BOOL "Architecture has SSSE3 SIMD enabled") + message(STATUS "Use SSSE3 SIMD instructions") + if(C_GCC OR C_CLANG) + set( CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -mssse3" ) + set( CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -mssse3" ) + add_definitions(-DUSE_SSSE3) + elseif(C_MSVC) + # seems not present on MSVC 2017 + #set( CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS_RELEASE} /Oi /GL /Ot /Ox /arch:SSSE3" ) + set( CMAKE_C_FLAGS_RELEASE "${CMAKE_CXX_FLAGS_RELEASE} /Oi /GL /Ot /Ox" ) + set( CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS_RELEASE} /Oi /GL /Ot /Ox" ) + set( CMAKE_EXE_LINKER_FLAGS_RELEASE "${CMAKE_EXE_LINKER_FLAGS_RELEASE} /LTCG" ) + add_definitions (/D "_CRT_SECURE_NO_WARNINGS") + add_definitions(-DUSE_SSSE3) + endif() + else() + set(HAS_SSSE3 OFF CACHE BOOL "Architecture does not have SSSE3 SIMD enabled") + endif() + if(C_MSVC) + try_run(RUN_SSE4_1 COMPILE_SSE4_1 "${CMAKE_BINARY_DIR}/tmp" "${TEST_DIR}/test_x86_sse41.cxx" COMPILE_DEFINITIONS /O0) + else() + try_run(RUN_SSE4_1 COMPILE_SSE4_1 "${CMAKE_BINARY_DIR}/tmp" "${TEST_DIR}/test_x86_sse41.cxx" COMPILE_DEFINITIONS -msse4.1 -O0) + endif() + if(COMPILE_SSE4_1 AND RUN_SSE4_1 EQUAL 0) + set(HAS_SSE4_1 ON CACHE BOOL "Architecture has SSE 4.1 SIMD enabled") + message(STATUS "Use SSE 4.1 SIMD instructions") + if(C_GCC OR C_CLANG) + set( CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -msse4.1" ) + set( CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -msse4.1" ) + add_definitions(-DUSE_SSE4_1) + elseif(C_MSVC) + # seems not present on MSVC 2017 + #set( CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} /arch:SSE4_1" ) + #set( CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS_RELEASE} /Oi /GL /Ot /Ox /arch:SSE4_1" ) + set( CMAKE_C_FLAGS_RELEASE "${CMAKE_C_FLAGS_RELEASE} /Oi /GL /Ot /Ox" ) + set( CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS_RELEASE} /Oi /GL /Ot /Ox" ) + set( CMAKE_EXE_LINKER_FLAGS_RELEASE "${CMAKE_EXE_LINKER_FLAGS_RELEASE} /LTCG" ) + add_definitions (/D "_CRT_SECURE_NO_WARNINGS") + add_definitions(-DUSE_SSE4_1) + endif() + else() + set(HAS_SSE4_1 OFF CACHE BOOL "Architecture does not have SSE 4.1 SIMD enabled") + endif() + if(C_MSVC) + try_run(RUN_SSE4_2 COMPILE_SSE4_2 "${CMAKE_BINARY_DIR}/tmp" "${TEST_DIR}/test_x86_sse42.cxx" COMPILE_DEFINITIONS /O0) + else() + try_run(RUN_SSE4_2 COMPILE_SSE4_2 "${CMAKE_BINARY_DIR}/tmp" "${TEST_DIR}/test_x86_sse42.cxx" COMPILE_DEFINITIONS -msse4.2 -O0) + endif() + if(COMPILE_SSE4_2 AND RUN_SSE4_2 EQUAL 0) + set(HAS_SSE4_2 ON CACHE BOOL "Architecture has SSE 4.2 SIMD enabled") + message(STATUS "Use SSE 4.2 SIMD instructions") + if(C_GCC OR C_CLANG) + set( CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -msse4.2" ) + set( CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -msse4.2" ) + add_definitions(-DUSE_SSE4_2) + elseif(C_MSVC) + # seems not present on MSVC 2017 + #set( CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} /arch:SSE4_2" ) + #set( CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS_RELEASE} /Oi /GL /Ot /Ox /arch:SSE4_2" ) + set( CMAKE_C_FLAGS_RELEASE "${CMAKE_C_FLAGS_RELEASE} /Oi /GL /Ot /Ox" ) + set( CMAKE_CXX_FLAGS_RELEASE "${CMAKE_C_FLAGS_RELEASE} /Oi /GL /Ot /Ox" ) + set( CMAKE_EXE_LINKER_FLAGS_RELEASE "${CMAKE_EXE_LINKER_FLAGS_RELEASE} /LTCG" ) + add_definitions (/D "_CRT_SECURE_NO_WARNINGS") + add_definitions(-DUSE_SSE4_2) + endif() + else() + set(HAS_SSE4_2 OFF CACHE BOOL "Architecture does not have SSE 4.2 SIMD enabled") + endif() + if(C_MSVC) + try_run(RUN_AVX COMPILE_AVX "${CMAKE_BINARY_DIR}/tmp" "${TEST_DIR}/test_x86_avx.cxx" COMPILE_DEFINITIONS /O0) + else() + try_run(RUN_AVX COMPILE_AVX "${CMAKE_BINARY_DIR}/tmp" "${TEST_DIR}/test_x86_avx.cxx" COMPILE_DEFINITIONS -mavx -O0) + endif() + if(COMPILE_AVX AND RUN_AVX EQUAL 0) + set(HAS_AVX ON CACHE BOOL "Architecture has AVX SIMD enabled") + message(STATUS "Use AVX SIMD instructions") + if(C_GCC OR C_CLANG) + set( CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -mavx" ) + set( CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -mavx" ) + add_definitions(-DUSE_AVX) + elseif(C_MSVC) + set( CMAKE_C_FLAGS_DEBUG "${CMAKE_C_FLAGS_DEBUG} /arch:AVX" ) + set( CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} /arch:AVX" ) + set( CMAKE_C_FLAGS_RELEASE "${CMAKE_C_FLAGS_RELEASE} /Oi /GL /Ot /Ox /arch:AVX" ) + set( CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS_RELEASE} /Oi /GL /Ot /Ox /arch:AVX" ) + set( CMAKE_EXE_LINKER_FLAGS_RELEASE "${CMAKE_EXE_LINKER_FLAGS_RELEASE} /LTCG" ) + add_definitions (/D "_CRT_SECURE_NO_WARNINGS") + add_definitions(-DUSE_AVX) + endif() + else() + set(HAS_AVX OFF CACHE BOOL "Architecture does not have AVX SIMD enabled") + endif() + if(C_MSVC) + try_run(RUN_AVX2 COMPILE_AVX2 "${CMAKE_BINARY_DIR}/tmp" "${TEST_DIR}/test_x86_avx2.cxx" COMPILE_DEFINITIONS /O0) + else() + try_run(RUN_AVX2 COMPILE_AVX2 "${CMAKE_BINARY_DIR}/tmp" "${TEST_DIR}/test_x86_avx2.cxx" COMPILE_DEFINITIONS -mavx2 -O0) + endif() + if(COMPILE_AVX2 AND RUN_AVX2 EQUAL 0) + set(HAS_AVX2 ON CACHE BOOL "Architecture has AVX2 SIMD enabled") + message(STATUS "Use AVX2 SIMD instructions") + if(C_GCC OR C_CLANG) + set( CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -mavx2" ) + set( CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -mavx2" ) + add_definitions(-DUSE_AVX2) + elseif(C_MSVC) + set( CMAKE_C_FLAGS_DEBUG "${CMAKE_C_FLAGS_DEBUG} /arch:AVX2" ) + set( CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} /arch:AVX2" ) + set( CMAKE_C_FLAGS_RELEASE "${CMAKE_C_FLAGS_RELEASE} /Oi /GL /Ot /Ox /arch:AVX2" ) + set( CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS_RELEASE} /Oi /GL /Ot /Ox /arch:AVX2" ) + set( CMAKE_EXE_LINKER_FLAGS_RELEASE "${CMAKE_EXE_LINKER_FLAGS_RELEASE} /LTCG" ) + add_definitions (/D "_CRT_SECURE_NO_WARNINGS") + add_definitions(-DUSE_AVX2) + endif() + else() + set(HAS_AVX2 OFF CACHE BOOL "Architecture does not have AVX2 SIMD enabled") + endif() + if(C_MSVC) + try_run(RUN_AVX512 COMPILE_AVX512 "${CMAKE_BINARY_DIR}/tmp" "${TEST_DIR}/test_x86_avx512.cxx" COMPILE_DEFINITIONS /O0) + else() + try_run(RUN_AVX512 COMPILE_AVX512 "${CMAKE_BINARY_DIR}/tmp" "${TEST_DIR}/test_x86_avx512.cxx" COMPILE_DEFINITIONS -mavx512f -O0) + endif() + if(COMPILE_AVX512 AND RUN_AVX512 EQUAL 0) + set(HAS_AVX512 ON CACHE BOOL "Architecture has AVX512 SIMD enabled") + message(STATUS "Use AVX512 SIMD instructions") + if(C_GCC OR C_CLANG) + set( CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -mavx512f" ) + set( CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -mavx512f" ) + add_definitions(-DUSE_AVX512) + elseif(C_MSVC) + set( CMAKE_C_FLAGS_DEBUG "${CMAKE_C_FLAGS_DEBUG} /arch:AVX512" ) + set( CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} /arch:AVX512" ) + set( CMAKE_C_FLAGS_RELEASE "${CMAKE_C_FLAGS_RELEASE} /Oi /GL /Ot /Ox /arch:AVX512" ) + set( CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS_RELEASE} /Oi /GL /Ot /Ox /arch:AVX512" ) + set( CMAKE_EXE_LINKER_FLAGS_RELEASE "${CMAKE_EXE_LINKER_FLAGS_RELEASE} /LTCG" ) + add_definitions (/D "_CRT_SECURE_NO_WARNINGS") + add_definitions(-DUSE_AVX512) + endif() + else() + set(HAS_AVX512 OFF CACHE BOOL "Architecture does not have AVX512 SIMD enabled") + endif() +elseif(ARCHITECTURE_ARM) + if(C_MSVC) + try_run(RUN_NEON COMPILE_NEON "${CMAKE_BINARY_DIR}/tmp" "${TEST_DIR}/test_arm_neon.cxx" COMPILE_DEFINITIONS /O0) + else() + if(${CMAKE_HOST_SYSTEM_PROCESSOR} STREQUAL ${CMAKE_SYSTEM_PROCESSOR}) + try_run(RUN_NEON COMPILE_NEON "${CMAKE_BINARY_DIR}/tmp" "${TEST_DIR}/test_arm_neon.cxx" COMPILE_DEFINITIONS -mfpu=neon -O0) + else() + try_compile(COMPILE_NEON "${CMAKE_BINARY_DIR}/tmp" "${TEST_DIR}/test_arm_neon.cxx" COMPILE_DEFINITIONS -mfpu=neon -O0) + set(RUN_NEON 0) + endif() + endif() + if(COMPILE_NEON AND RUN_NEON EQUAL 0) + set(HAS_NEON ON CACHE BOOL "Architecture has NEON SIMD enabled") + message(STATUS "Use NEON SIMD instructions") + if(C_GCC OR C_CLANG) + set( CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -mfpu=neon" ) + set( CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -mfpu=neon" ) + add_definitions(-DUSE_NEON) + endif() + else() + set(HAS_NEON OFF CACHE BOOL "Architecture does not have NEON SIMD enabled") + endif() +elseif(ARCHITECTURE_ARM64) + # Advanced SIMD (aka NEON) is mandatory for AArch64 + set(HAS_NEON ON CACHE BOOL "Architecture has NEON SIMD enabled") + message(STATUS "Use NEON SIMD instructions") + add_definitions(-DUSE_NEON) +endif() +endif() + +# clear binary test folder +FILE(REMOVE_RECURSE ${CMAKE_BINARY_DIR}/tmp) diff --git a/cmake/modules/FindCompiler.cmake b/cmake/modules/FindCompiler.cmake new file mode 100644 index 00000000..fe036e4b --- /dev/null +++ b/cmake/modules/FindCompiler.cmake @@ -0,0 +1,15 @@ +# Clang or AppleClang (see CMP0025) +if(NOT DEFINED C_CLANG AND CMAKE_CXX_COMPILER_ID MATCHES "Clang") + set(C_CLANG 1) +elseif(NOT DEFINED C_GCC AND CMAKE_CXX_COMPILER_ID MATCHES "GNU") + set(C_GCC 1) +elseif(NOT DEFINED C_MSVC AND CMAKE_CXX_COMPILER_ID MATCHES "MSVC") + set(C_MSVC 1) + if(MSVC_VERSION GREATER_EQUAL 1920 AND MSVC_VERSION LESS_EQUAL 1929) + set(VS2019 ON) + elseif(MSVC_VERSION GREATER_EQUAL 1910 AND MSVC_VERSION LESS_EQUAL 1919) + set(VS2017 ON) + elseif(MSVC_VERSION GREATER 1899 AND MSVC_VERSION LESS 1910) + set(VS2015 ON) + endif() +endif() diff --git a/cmake/modules/FindGPSD.cmake b/cmake/modules/FindGPSD.cmake new file mode 100644 index 00000000..d21b3311 --- /dev/null +++ b/cmake/modules/FindGPSD.cmake @@ -0,0 +1,88 @@ +# - Try to find GPSD +# Once done this will define +# +# GPSD_FOUND - system has GPSD +# GPSD_INCLUDE_DIRS - the GPSD include directory +# GPSD_LIBRARIES - Link these to use GPSD +# GPSD_DEFINITIONS - Compiler switches required for using GPSD +# +# Copyright (c) 2006 Andreas Schneider +# +# Redistribution and use is allowed according to the terms of the New +# BSD license. +# For details see the accompanying COPYING-CMAKE-SCRIPTS file. +# + +set(GPSD_ROOT_DIR + "${GPSD_ROOT_DIR}" + CACHE + PATH + "Directory to search for gpsd") + +find_package(PkgConfig QUIET) +if(PKG_CONFIG_FOUND) + pkg_check_modules(PC_GPSD libgps) +endif() + +if (GPSD_LIBRARIES AND GPSD_INCLUDE_DIRS) + # in cache already + set(GPSD_FOUND TRUE) +else (GPSD_LIBRARIES AND GPSD_INCLUDE_DIRS) + find_path(GPSD_INCLUDE_DIRS + NAMES + gps.h + PATHS + /usr/include + /usr/local/include + /opt/local/include + /sw/include + /usr/include/gps + /usr/local/include/gps + /opt/local/include/gps + /sw/include/gps + HINTS + ${PC_GPSD_INCLUDEDIR} + ${GPSD_ROOT_DIR} + ) + + # debian uses version suffixes + # add suffix evey new release + find_library(GPSD_LIBRARIES + NAMES + gps + PATHS + /usr/lib64 + /usr/lib + /usr/local/lib + /opt/local/lib + /sw/lib + HINTS + ${PC_GPSD_LIBDIR} + ${GPSD_ROOT_DIR} + ) + + if (GPSD_INCLUDE_DIRS AND GPSD_LIBRARIES) + set(GPSD_FOUND TRUE) + endif (GPSD_INCLUDE_DIRS AND GPSD_LIBRARIES) + + if (GPSD_FOUND) + if (NOT GPSD_FIND_QUIETLY) + message(STATUS "Found GPSD: ${GPSD_LIBRARIES}") + endif (NOT GPSD_FIND_QUIETLY) + else (GPSD_FOUND) + if (GPSD_FIND_REQUIRED) + message(FATAL_ERROR "Could not find GPSD") + endif (GPSD_FIND_REQUIRED) + endif (GPSD_FOUND) + + # show the GPSD_INCLUDE_DIRS and GPSD_LIBRARIES variables only in the advanced view + mark_as_advanced(GPSD_INCLUDE_DIRS GPSD_LIBRARIES) + +endif (GPSD_LIBRARIES AND GPSD_INCLUDE_DIRS) + +# maybe on CYGWIN gpsd works +if (WIN32) + set(GPSD_FOUND FALSE) + set(GPSD_LIBRARIES "") + set(GPSD_INCLUDE_DIRS "") +endif (WIN32) diff --git a/cmake/modules/FindPortaudio.cmake b/cmake/modules/FindPortaudio.cmake new file mode 100644 index 00000000..9cda3428 --- /dev/null +++ b/cmake/modules/FindPortaudio.cmake @@ -0,0 +1,64 @@ +# - Try to find Portaudio +# Once done this will define +# +# PORTAUDIO_FOUND - system has Portaudio +# PORTAUDIO_INCLUDE_DIRS - the Portaudio include directory +# PORTAUDIO_LIBRARIES - Link these to use Portaudio + +set(PORTAUDIO_ROOT_DIR + "${PORTAUDIO_ROOT_DIR}" + CACHE + PATH + "Directory to search for portaudio") + +find_package(PkgConfig QUIET) +if(PKG_CONFIG_FOUND) + pkg_check_modules(PC_PORTAUDIO portaudio-2.0) +endif() + +find_path(PORTAUDIO_INCLUDE_DIRS + NAMES + portaudio.h + PATHS + /usr/local/include + /usr/include + /opt/local/include + HINTS + ${PC_PORTAUDIO_INCLUDEDIR} + ${PORTAUDIO_ROOT_DIR} + ) + +find_library(PORTAUDIO_LIBRARIES + NAMES + portaudio + PATHS + /usr/local/lib + /usr/lib + /usr/lib64 + /opt/local/lib + HINTS + ${PC_PORTAUDIO_LIBDIR} + ${PORTAUDIO_ROOT_DIR} + ) + +mark_as_advanced(PORTAUDIO_INCLUDE_DIRS PORTAUDIO_LIBRARIES) + +# Found PORTAUDIO, but it may be version 18 which is not acceptable. +if(EXISTS ${PORTAUDIO_INCLUDE_DIRS}/portaudio.h) + include(CheckCXXSourceCompiles) + set(CMAKE_REQUIRED_INCLUDES_SAVED ${CMAKE_REQUIRED_INCLUDES}) + set(CMAKE_REQUIRED_INCLUDES ${PORTAUDIO_INCLUDE_DIRS}) + CHECK_CXX_SOURCE_COMPILES( + "#include \nPaDeviceIndex pa_find_device_by_name(const char *name); int main () {return 0;}" + PORTAUDIO2_FOUND) + set(CMAKE_REQUIRED_INCLUDES ${CMAKE_REQUIRED_INCLUDES_SAVED}) + unset(CMAKE_REQUIRED_INCLUDES_SAVED) + if(PORTAUDIO2_FOUND) + INCLUDE(FindPackageHandleStandardArgs) + FIND_PACKAGE_HANDLE_STANDARD_ARGS(PORTAUDIO DEFAULT_MSG PORTAUDIO_INCLUDE_DIRS PORTAUDIO_LIBRARIES) + else(PORTAUDIO2_FOUND) + message(STATUS + " portaudio.h not compatible (requires API 2.0)") + set(PORTAUDIO_FOUND FALSE) + endif(PORTAUDIO2_FOUND) +endif() diff --git a/cmake/modules/Findhamlib.cmake b/cmake/modules/Findhamlib.cmake new file mode 100644 index 00000000..16ca5685 --- /dev/null +++ b/cmake/modules/Findhamlib.cmake @@ -0,0 +1,67 @@ +# - Try to find Hamlib +# +# HAMLIB_FOUND - system has Hamlib +# HAMLIB_LIBRARIES - location of the library for hamlib +# HAMLIB_INCLUDE_DIRS - location of the include files for hamlib +# +# Requires these CMake modules: +# FindPackageHandleStandardArgs (known included with CMake >=2.6.2) +# +# Original Author: +# 2019 Davide Gerhard + +set(HAMLIB_ROOT_DIR + "${HAMLIB_ROOT_DIR}" + CACHE + PATH + "Directory to search for hamlib") + +find_package(PkgConfig QUIET) +if(PKG_CONFIG_FOUND) + pkg_check_modules(PC_HAMLIB hamlib) +endif() + +find_path(HAMLIB_INCLUDE_DIR + NAMES hamlib/rig.h + PATHS + /usr/include + /usr/local/include + /opt/local/include + HINTS + ${PC_HAMLIB_INCLUDEDIR} + ${HAMLIB_ROOT_DIR} + ) + +find_library(HAMLIB_LIBRARY + NAMES hamlib + PATHS + /usr/lib64/hamlib + /usr/lib/hamlib + /usr/lib64 + /usr/lib + /usr/local/lib64/hamlib + /usr/local/lib/hamlib + /usr/local/lib64 + /usr/local/lib + /opt/local/lib + /opt/local/lib/hamlib + HINTS + ${PC_HAMLIB_LIBDIR} + ${HAMLIB_ROOT_DIR} + + ) + +include(FindPackageHandleStandardArgs) +find_package_handle_standard_args(hamlib + DEFAULT_MSG + HAMLIB_LIBRARY + HAMLIB_INCLUDE_DIR + ) + +if(HAMLIB_FOUND) + list(APPEND HAMLIB_LIBRARIES ${HAMLIB_LIBRARY}) + list(APPEND HAMLIB_INCLUDE_DIRS ${HAMLIB_INCLUDE_DIR}) + mark_as_advanced(HAMLIB_ROOT_DIR) +endif() + +mark_as_advanced(HAMLIB_INCLUDE_DIR HAMLIB_LIBRARY) diff --git a/cmake/modules/Findsndio.cmake b/cmake/modules/Findsndio.cmake new file mode 100644 index 00000000..e7292d5d --- /dev/null +++ b/cmake/modules/Findsndio.cmake @@ -0,0 +1,42 @@ +# - Try to find sndio +# +# SNDIO_FOUND - system has sndio +# SNDIO_LIBRARIES - location of the library for sndio +# SNDIO_INCLUDE_DIRS - location of the include files for sndio + +set(SNDIO_ROOT_DIR + "${SNDIO_ROOT_DIR}" + CACHE + PATH + "Directory to search for sndio") + +# no need to check pkg-config + +find_path(SNDIO_INCLUDE_DIRS + NAMES + sndio.h + PATHS + /usr/local/include + /usr/include + /opt/local/include + HINTS + ${SNDIO_ROOT_DIR} + ) + +find_library(SNDIO_LIBRARIES + NAMES + sndio + PATHS + /usr/local/lib + /usr/lib + /usr/lib64 + /opt/local/lib + HINTS + ${SNDIIO_ROOT_DIR} + ) + + +include(FindPackageHandleStandardArgs) +find_package_handle_standard_args(SNDIO DEFAULT_MSG SNDIO_INCLUDE_DIRS SNDIO_LIBRARIES) + +mark_as_advanced(SNDIO_INCLUDE_DIRS SNDIO_LIBRARIES) diff --git a/cmake/modules/Findudev.cmake b/cmake/modules/Findudev.cmake new file mode 100644 index 00000000..c8c4b624 --- /dev/null +++ b/cmake/modules/Findudev.cmake @@ -0,0 +1,85 @@ +# - try to find the udev library +# +# Cache Variables: (probably not for direct use in your scripts) +# UDEV_INCLUDE_DIR +# UDEV_SOURCE_DIR +# UDEV_LIBRARY +# +# Non-cache variables you might use in your CMakeLists.txt: +# UDEV_FOUND +# UDEV_INCLUDE_DIRS +# UDEV_LIBRARIES +# +# Requires these CMake modules: +# FindPackageHandleStandardArgs (known included with CMake >=2.6.2) +# +# Original Author: +# 2014 Kevin M. Godby +# +# Distributed under the Boost Software License, Version 1.0. +# (See accompanying file LICENSE_1_0.txt or copy at +# http://www.boost.org/LICENSE_1_0.txt) + +set(UDEV_ROOT_DIR + "${UDEV_ROOT_DIR}" + CACHE + PATH + "Directory to search for udev") + +find_package(PkgConfig QUIET) +if(PKG_CONFIG_FOUND) + pkg_check_modules(PC_LIBUDEV libudev) +endif() + +find_library(UDEV_LIBRARY + NAMES + udev + PATHS + ${PC_LIBUDEV_LIBRARY_DIRS} + ${PC_LIBUDEV_LIBDIR} + /usr/lib64 + /usr/lib + /usr/local/lib + HINTS + "${UDEV_ROOT_DIR}" + PATH_SUFFIXES + lib + ) + +get_filename_component(_libdir "${UDEV_LIBRARY}" PATH) + +find_path(UDEV_INCLUDE_DIR + NAMES + libudev.h + PATHS + /usr/include + /usr/local/include + ${PC_LIBUDEV_INCLUDE_DIRS} + ${PC_LIBUDEV_INCLUDEDIR} + HINTS + "${_libdir}" + "${_libdir}/.." + "${UDEV_ROOT_DIR}" + PATH_SUFFIXES + include + ) + +include(FindPackageHandleStandardArgs) +find_package_handle_standard_args(udev + DEFAULT_MSG + UDEV_LIBRARY + UDEV_INCLUDE_DIR + ) + +if (UDEV_INCLUDE_DIR AND UDEV_LIBRARY) + set(UDEV_FOUND TRUE) +endif (UDEV_INCLUDE_DIR AND UDEV_LIBRARY) + +if(UDEV_FOUND) + list(APPEND UDEV_LIBRARIES ${UDEV_LIBRARY}) + list(APPEND UDEV_INCLUDE_DIRS ${UDEV_INCLUDE_DIR}) + mark_as_advanced(UDEV_ROOT_DIR) +endif() + +mark_as_advanced(UDEV_INCLUDE_DIR + UDEV_LIBRARY) diff --git a/conf/99-direwolf-cmedia.rules b/conf/99-direwolf-cmedia.rules new file mode 100644 index 00000000..94e1828f --- /dev/null +++ b/conf/99-direwolf-cmedia.rules @@ -0,0 +1,36 @@ +# Normally, all of /dev/hidraw* are accessible only by root. +# +# $ ls -l /dev/hidraw* +# crw------- 1 root root 247, 0 Sep 24 09:40 /dev/hidraw0 +# +# An ordinary user, trying to access it will be denied. +# +# Unnecessarily running applications as root is generally a bad idea because it makes it too easy +# to accidentally trash your system. We need to relax the restrictions so ordinary users can use these devices. +# +# If all went well with installation, the /etc/udev/rules.d directory should contain a file called +# 99-direwolf-cmedia.rules containing: +# + +SUBSYSTEM=="hidraw", ATTRS{idVendor}=="0d8c", GROUP="audio", MODE="0660" + +# +# I used the "audio" group, mimicking the permissions on the sound side of the device. +# +# $ ls -l /dev/snd/pcm* +# crw-rw----+ 1 root audio 116, 16 Sep 24 09:40 /dev/snd/pcmC0D0p +# crw-rw----+ 1 root audio 116, 17 Sep 24 09:40 /dev/snd/pcmC0D1p +# +# You should see something similar to this where someone in the "audio" group has read-write access. +# +# $ ls -l /dev/hidraw* +# crw-rw---- 1 root audio 247, 0 Oct 6 19:24 /dev/hidraw0 +# +# Read the User Guide and run the "cm108" application for more information. +# + +# +# Same thing for the "All In One Cable." +# + +SUBSYSTEM=="hidraw", ATTRS{idVendor}=="1209", ATTRS{idProduct}=="7388", GROUP="audio", MODE="0660" diff --git a/conf/CMakeLists.txt b/conf/CMakeLists.txt new file mode 100644 index 00000000..d4a229d7 --- /dev/null +++ b/conf/CMakeLists.txt @@ -0,0 +1,48 @@ +# generate conf per platform +file(READ "${CUSTOM_CONF_DIR}/generic.conf" file_content) + +if(LINUX) + string(REGEX REPLACE "\n%W%[^\n]*" "" file_content "${file_content}") + string(REGEX REPLACE "\n%M%[^\n]*" "" file_content "${file_content}") + string(REGEX REPLACE "\n%L%([^\n]*)" "\n\\1" file_content "${file_content}") +elseif(WIN32 OR CYGWIN) + string(REGEX REPLACE "\n%M%[^\n]*" "" file_content "${file_content}") + string(REGEX REPLACE "\n%L%[^\n]*" "" file_content "${file_content}") + string(REGEX REPLACE "\n%W%([^\n]*)" "\n\\1" file_content "${file_content}") +else() # macOS FreeBSD OpenBSD + string(REGEX REPLACE "\n%W%[^\n]*" "" file_content "${file_content}") + string(REGEX REPLACE "\n%L%[^\n]*" "" file_content "${file_content}") + string(REGEX REPLACE "\n%M%([^\n]*)" "\n\\1" file_content "${file_content}") +endif() + +# remove remark +string(REGEX REPLACE "\n%R%[^\n]*" "" file_content "${file_content}") + +# clear common lines +string(REGEX REPLACE "\n%C%([^\n]*)" "\n\\1" file_content "${file_content}") +string(REGEX REPLACE "^%C%([^\n]*)" "\\1" file_content "${file_content}") + +file(WRITE "${CMAKE_BINARY_DIR}/direwolf.conf" "${file_content}") + +# install udev rules for CM108 +if(LINUX) + install(FILES "${CUSTOM_CONF_DIR}/99-direwolf-cmedia.rules" DESTINATION /etc/udev/rules.d/) +endif() + +install(FILES "${CMAKE_BINARY_DIR}/direwolf.conf" DESTINATION ${INSTALL_CONF_DIR}) +install(FILES "${CUSTOM_CONF_DIR}/sdr.conf" DESTINATION ${INSTALL_CONF_DIR}) + +# Put sample configuration & startup files in home directory. +# This step would be done as ordinary user. +# Some people like to put the direwolf config file in /etc/ax25. +# Note that all of these are also in $(DESTDIR)/share/doc/direwolf/examples/. +if(NOT (WIN32 OR CYGWIN)) + add_custom_target(install-conf + COMMAND ${CMAKE_COMMAND} + -DCUSTOM_BINARY_DIR="${CMAKE_BINARY_DIR}" + -DCUSTOM_CONF_DIR="${CUSTOM_CONF_DIR}" + -DCUSTOM_SCRIPTS_DIR="${CUSTOM_SCRIPTS_DIR}" + -DCUSTOM_TELEMETRY_DIR="${CUSTOM_TELEMETRY_DIR}" + -P "${CMAKE_SOURCE_DIR}/conf/install_conf.cmake" + ) +endif() diff --git a/conf/generic.conf b/conf/generic.conf new file mode 100644 index 00000000..9a19d8a2 --- /dev/null +++ b/conf/generic.conf @@ -0,0 +1,537 @@ +%C%############################################################# +%C%# # +%C%# Configuration file for Dire Wolf # +%C%# # +%L%# Linux version # +%W%# Windows version # +%M%# Macintosh version # +%C%# # +%C%############################################################# +%R% +%R% +%R% The sample config file was getting pretty messy +%R% with the Windows and Linux differences. +%R% It would be a maintenance burden to keep most of +%R% two different versions in sync. +%R% This common source is now used to generate the +%R% two different variations while having only a single +%R% copy of the common parts. +%R% +%R% The first column contains one of the following: +%R% +%R% R remark which is discarded. +%R% C common to both versions. +%R% W Windows version only. +%R% L Linux version only. +%R% M Macintosh version and possibly others (portaudio used). +%R% +%C%# +%C%# Extensive documentation can be found here: +%C%# Stable release - https://github.com/wb2osz/direwolf/tree/master/doc +%C%# Latest development - https://github.com/wb2osz/direwolf/tree/dev/doc +%C%# Additional topics - https://github.com/wb2osz/direwolf-doc +%C%# +%W%# The basic documentation set can also be found in the doc folder. +%L%# The basic documentation set can also be found in +%L%# /usr/local/share/doc/direwolf/ or /usr/share/doc/direwolf/ +%L%# Concise "man" pages are also available for Linux. +%M%# /usr/local/share/doc/direwolf/ or /usr/share/doc/direwolf/ +%M%# Concise "man" pages are also available for Mac OSX. +%C%# +%C%# Questions??? Join the discussion forum: https://groups.io/g/direwolf +%C%# +%C%# +%C%# This sample file does not have examples for all of the possibilities. +%C%# Consult the User Guide for more details on configuration options +%C%# and other documents for more details for different uses. +%C%# +%C%# These are the most likely settings you might change: +%C%# +%C%# (1) MYCALL - call sign and SSID for your station. +%C%# +%C%# Look for lines starting with MYCALL and +%C%# change NOCALL to your own. +%C%# +%C%# (2) PBEACON - enable position beaconing. +%C%# +%C%# Look for lines starting with PBEACON and +%C%# modify for your call, location, etc. +%C%# +%C%# (3) DIGIPEATER - configure digipeating rules. +%C%# +%C%# Look for lines starting with DIGIPEATER. +%C%# Most people will probably use the given example. +%C%# Just remove the "#" from the start of the line +%C%# to enable it. +%C%# +%C%# (4) IGSERVER, IGLOGIN - IGate server and login +%C%# +%C%# Configure an IGate client to relay messages between +%C%# radio and internet servers. +%C%# +%C%# +%C%# The default location is "direwolf.conf" in the current working directory. +%L%# On Linux, the user's home directory will also be searched. +%C%# An alternate configuration file location can be specified with the "-c" command line option. +%C%# +%C%# As you probably guessed by now, # indicates a comment line. +%C%# +%C%# Remove the # at the beginning of a line if you want to use a sample +%C%# configuration that is currently commented out. +%C%# +%C%# Commands are a keyword followed by parameters. +%C%# +%C%# Command key words are case insensitive. i.e. upper and lower case are equivalent. +%C%# +%C%# Command parameters are generally case sensitive. i.e. upper and lower case are different. +%C%# +%C% +%C% +%C%############################################################# +%C%# # +%C%# FIRST AUDIO DEVICE PROPERTIES # +%C%# (Channel 0 + 1 if in stereo) # +%C%# # +%C%############################################################# +%C% +%C%# +%C%# Many people will simply use the default sound device. +%C%# Some might want to use an alternative device by choosing it here. +%C%# +%C%# +%C%# Many examples of radio interfaces and PTT options can be found in: +%C%# https://github.com/wb2osz/direwolf-doc/blob/main/Radio-Interface-Guide.pdf +%C%# +%C%# +%R% ---------- Windows ---------- +%R% +%W%# When the Windows version starts up, it displays something like +%W%# this with the available sound devices and capabilities: +%W%# +%W%# Available audio input devices for receive (*=selected): +%W%# * 0: Microphone (C-Media USB Headpho (channel 2) +%W%# 1: Microphone (Bluetooth SCO Audio +%W%# 2: Microphone (Bluetooth AV Audio) +%W%# * 3: Microphone (Realtek High Defini (channels 0 & 1) +%W%# Available audio output devices for transmit (*=selected): +%W%# * 0: Speakers (C-Media USB Headphone (channel 2) +%W%# 1: Speakers (Bluetooth SCO Audio) +%W%# 2: Realtek Digital Output(Optical) +%W%# 3: Speakers (Bluetooth AV Audio) +%W%# * 4: Speakers (Realtek High Definiti (channels 0 & 1) +%W%# 5: Realtek Digital Output (Realtek +%W%# +%W%# Example: To use the microphone and speaker connections on the +%W%# system board, either of these forms can be used: +%W% +%W%#ADEVICE High +%W%#ADEVICE 3 4 +%W% +%W% +%W%# Example: To use the USB Audio, use a command like this with +%W%# the input and output device numbers. (Remove the # comment character.) +%W%#ADEVICE USB +%W% +%W%# You can also use "-" or "stdin" to pipe stdout from +%W%# some other application such as a software defined radio. +%W%# "stdin" is not an audio device. Don't use this unless you +%W%# understand what this means. Read the User Guide. +%W%# You can also specify "UDP:" and an optional port for input. +%W%# Something different must be specified for output. +%W% +%W%# ADEVICE stdin 0 +%W%# ADEVICE UDP:7355 0 +%W% +%W%# The position in the list can change when devices (e.g. USB) are added and removed. +%W%# You can also specify devices by using part of the name. +%W%# Here is an example of specifying the USB Audio device. +%W%# This is case-sensitive. Upper and lower case are not treated the same. +%W% +%W%#ADEVICE USB +%W% +%W% +%R% ---------- Linux ---------- +%R% +%L%# Linux ALSA is complicated. See User Guide for discussion. +%L%# To use something other than the default, generally use plughw +%L%# and a card number reported by "arecord -l" command. Example: +%L% +%L%# ADEVICE plughw:1,0 +%L% +%L%# You can also use "-" or "stdin" to pipe stdout from +%L%# some other application such as a software defined radio. +%L%# "stdin" is not an audio device. Don't use this unless you +%L%# understand what this means. Read the User Guide. +%L%# You can also specify "UDP:" and an optional port for input. +%L%# Something different must be specified for output. +%L% +%L%# ADEVICE stdin plughw:1,0 +%L%# ADEVICE UDP:7355 default +%L% +%R% ---------- Mac ---------- +%R% +%M%# Macintosh Operating System uses portaudio driver for audio +%M%# input/output. Default device selection not available. User/OP +%M%# must configure the sound input/output option. Note that +%M%# the device names can contain spaces. In this case, the names +%M%# must be enclosed by quotes. +%M%# +%M%# Examples: +%M%# +%M%ADEVICE "Built-in Input" "Built-in Output" +%M% +%M%# ADEVICE "USB Audio Codec:6" "USB Audio Codec:5" +%M%# +%M%# +%M%# You can also use "-" or "stdin" to pipe stdout from +%M%# some other application such as a software defined radio. +%M%# "stdin" is not an audio device. Don't use this unless you +%M%# understand what this means. Read the User Guide. +%M%# You can also specify "UDP:" and an optional port for input. +%M%# Something different must be specified for output. +%M% +%M%# ADEVICE UDP:7355 default +%M%# +%C% +%C%# +%C%# Number of audio channels for this souncard: 1 (mono) or 2 (stereo). +%C%# 1 is the default so there is no need to specify it. +%C%# +%C% +%C%#ACHANNELS 2 +%C% +%C% +%C%############################################################# +%C%# # +%C%# SECOND AUDIO DEVICE PROPERTIES # +%C%# (Channel 2 + 3 if in stereo) # +%C%# # +%C%############################################################# +%C% +%C%#ADEVICE1 ... +%C% +%C% +%C%############################################################# +%C%# # +%C%# THIRD AUDIO DEVICE PROPERTIES # +%C%# (Channel 4 + 5 if in stereo) # +%C%# # +%C%############################################################# +%C% +%C%#ADEVICE2 ... +%C% +%C% +%C%############################################################# +%C%# # +%C%# CHANNEL 0 PROPERTIES # +%C%# # +%C%############################################################# +%C% +%C%CHANNEL 0 +%C% +%C%# +%C%# The following MYCALL, MODEM, PTT, etc. configuration items +%C%# apply to the most recent CHANNEL. +%C%# +%C% +%C%# +%C%# Station identifier for this channel. +%C%# Multiple channels can have the same or different names. +%C%# +%C%# It can be up to 6 letters and digits with an optional ssid. +%C%# The APRS specification requires that it be upper case. +%C%# +%C%# Example (don't use this unless you are me): MYCALL WB2OSZ-5 +%C%# +%C% +%C%MYCALL N0CALL +%C% +%C%# +%C%# Pick a suitable modem speed based on your situation. +%C%# 1200 Most common for VHF/UHF. This is the default if not specified. +%C%# 2400 QPSK compatible with MFJ-2400, and probably PK232-2400 & KPC-2400. +%C%# 300 Low speed for HF SSB. Default tones 1600 & 1800. +%C%# EAS Emergency Alert System (EAS) Specific Area Message Encoding (SAME). +%C%# 9600 G3RUH style - Can't use Microphone and Speaker connections. +%C%# AIS International system for tracking ships on VHF. +%C%# Also uses 9600 bps so Speaker connection won't work. +%C%# +%C%# In most cases you can just specify the speed. Examples: +%C%# +%C% +%C%MODEM 1200 +%C%#MODEM 9600 +%C% +%C%# +%C%# Many options are available for great flexibility. +%C%# See User Guide for details. +%C%# +%C% +%C%# +%C%# Uncomment line below to enable the DTMF decoder for this channel. +%C%# +%C% +%C%#DTMF +%C% +%C%# Push to Talk (PTT) can be confusing because there are so many different cases. +%C%# Radio-Interface-Guide.pdf in https://github.com/wb2osz/direwolf-doc +%C%# goes into detail about the various options. +%C% +%L%# If using a C-Media CM108/CM119 or similar USB Audio Adapter, +%L%# you can use a GPIO pin for PTT control. This is very convenient +%L%# because a single USB connection is used for both audio and PTT. +%L%# Example: +%L% +%L%#PTT CM108 +%L% +%W%# If using a C-Media CM108/CM119 or similar USB Audio Adapter, +%W%# you can use a GPIO pin for PTT control. This is very convenient +%W%# because a single USB connection is used for both audio and PTT. +%W%# Example: +%W% +%W%#PTT CM108 +%W%%C%# +%C%# The transmitter Push to Talk (PTT) control can be wired to a serial port +%C%# with a suitable interface circuit. DON'T connect it directly! +%C%# +%C%# For the PTT command, specify the device and either RTS or DTR. +%C%# RTS or DTR may be preceded by "-" to invert the signal. +%C%# Both can be used for interfaces that want them driven with opposite polarity. +%C%# +%L%# COM1 can be used instead of /dev/ttyS0, COM2 for /dev/ttyS1, and so on. +%L%# +%C% +%C%#PTT COM1 RTS +%C%#PTT COM1 RTS -DTR +%L%#PTT /dev/ttyUSB0 RTS +%L%#PTT /dev/ttyUSB0 RTS -DTR +%C% +%L%# +%L%# On Linux, you can also use general purpose I/O pins if +%L%# your system is configured for user access to them. +%L%# This would apply mostly to microprocessor boards, not a regular PC. +%L%# See separate Raspberry Pi document for more details. +%L%# The number may be preceded by "-" to invert the signal. +%L%# +%L% +%L%#PTT GPIO 25 +%L% +%C%# The Data Carrier Detect (DCD) signal can be sent to most of the same places +%C%# as the PTT signal. This could be used to light up an LED like a normal TNC. +%C% +%C%#DCD COM1 -DTR +%L%#DCD GPIO 24 +%C% +%C% +%C%############################################################# +%C%# # +%C%# CHANNEL 1 PROPERTIES # +%C%# # +%C%############################################################# +%C% +%C%#CHANNEL 1 +%C% +%C%# +%C%# Specify MYCALL, MODEM, PTT, etc. configuration items for +%C%# CHANNEL 1. Repeat for any other channels. +%C% +%C% +%C%############################################################# +%C%# # +%C%# TEXT TO SPEECH COMMAND FILE # +%C%# # +%C%############################################################# +%C% +%W%#SPEECH dwespeak.bat +%L%#SPEECH dwespeak.sh +%C% +%C% +%C%############################################################# +%C%# # +%C%# VIRTUAL TNC SERVER PROPERTIES # +%C%# # +%C%############################################################# +%C% +%C%# +%C%# Dire Wolf acts as a virtual TNC and can communicate with +%C%# client applications by different protocols: +%C%# +%C%# - the "AGW TCPIP Socket Interface" - default port 8000 +%C%# - KISS protocol over TCP socket - default port 8001 +%W%# - KISS TNC via serial port +%L%# - KISS TNC via pseudo terminal (-p command line option) +%C%# +%C% +%C%AGWPORT 8000 +%C%KISSPORT 8001 +%C% +%W%# +%W%# Some applications are designed to operate with only a physical +%W%# TNC attached to a serial port. For these, we provide a virtual serial +%W%# port that appears to be connected to a TNC. +%W%# +%W%# Take a look at the User Guide for instructions to set up +%W%# two virtual serial ports named COM3 and COM4 connected by +%W%# a null modem. +%W%# +%W%# Using the configuration described, Dire Wolf will connect to +%W%# COM3 and the client application will use COM4. +%W%# +%W%# Uncomment following line to use this feature. +%W% +%W%#NULLMODEM COM3 +%W% +%W% +%C%# +%C%# It is sometimes possible to recover frames with a bad FCS. +%C%# This is not a global setting. +%C%# It applies only the the most recent CHANNEL specified. +%C%# +%C%# 0 - Don't try to repair. (default) +%C%# 1 - Attempt to fix single bit error. +%C%# +%C% +%C%#FIX_BITS 0 +%C% +%C%# +%C%############################################################# +%C%# # +%C%# FIXED POSIION BEACONING PROPERTIES # +%C%# # +%C%############################################################# +%C% +%C% +%C%# +%C%# Beaconing is configured with these two commands: +%C%# +%C%# PBEACON - for a position report (usually yourself) +%C%# OBEACON - for an object report (usually some other entity) +%C%# +%C%# Each has a series of keywords and values for options. +%C%# See User Guide for details. +%C%# +%C%# Example: +%C%# +%C%# This results in a broadcast once every 10 minutes. +%C%# Every half hour, it can travel via one digipeater hop. +%C%# The others are kept local. +%C%# +%C% +%C%#PBEACON delay=1 every=30 overlay=S symbol="digi" lat=42^37.14N long=071^20.83W power=50 height=20 gain=4 comment="Chelmsford MA" via=WIDE1-1 +%C%#PBEACON delay=11 every=30 overlay=S symbol="digi" lat=42^37.14N long=071^20.83W power=50 height=20 gain=4 comment="Chelmsford MA" +%C%#PBEACON delay=21 every=30 overlay=S symbol="digi" lat=42^37.14N long=071^20.83W power=50 height=20 gain=4 comment="Chelmsford MA" +%C% +%C%# +%C%# Did you know that APRS comments and messages can contain UTF-8 characters, not only plain ASCII? +%C%# +%C%#PBEACON delay=1 every=30 overlay=S symbol="digi" lat=42^37.14N long=071^20.83W comment=" Did you know that APRS comments and messages can contain UTF-8 characters? \xe0\xb8\xa7\xe0\xb8\xb4\xe0\xb8\x97\xe0\xb8\xa2\xe0\xb8\xb8\xe0\xb8\xaa\xe0\xb8\xa1\xe0\xb8\xb1\xe0\xb8\x84\xe0\xb8\xa3\xe0\xb9\x80\xe0\xb8\xa5\xe0\xb9\x88\xe0\xb8\x99" +%C%#PBEACON delay=11 every=30 overlay=S symbol="digi" lat=42^37.14N long=071^20.83W comment=" Did you know that APRS comments and messages can contain UTF-8 characters? \xce\xa1\xce\xb1\xce\xb4\xce\xb9\xce\xbf\xce\xb5\xcf\x81\xce\xb1\xcf\x83\xce\xb9\xcf\x84\xce\xb5\xcf\x87\xce\xbd\xce\xb9\xcf\x83\xce\xbc\xcf\x8c\xcf\x82" +%C%#PBEACON delay=21 every=30 overlay=S symbol="digi" lat=42^37.14N long=071^20.83W comment=" Did you know that APRS comments and messages can contain UTF-8 characters? \xe3\x82\xa2\xe3\x83\x9e\xe3\x83\x81\xe3\x83\xa5\xe3\x82\xa2\xe7\x84\xa1\xe7\xb7\x9a" +%C%# +%C%# With UTM coordinates instead of latitude and longitude. +%C% +%C%#PBEACON delay=1 every=10 overlay=S symbol="digi" zone=19T easting=307477 northing=4720178 +%C% +%C% +%C%# +%C%# When the destination field is set to "SPEECH" the information part is +%C%# converted to speech rather than transmitted as a data frame. +%C%# +%C% +%C%#CBEACON dest="SPEECH" info="Club meeting tonight at 7 pm." +%C% +%C%# Similar for Morse code. If SSID is specified, it is multiplied +%C%# by 2 to get speed in words per minute (WPM). +%C% +%C%#CBEACON dest="MORSE-6" info="de MYCALL" +%C% +%C% +%C%# +%C%# Modify for your particular situation before removing +%C%# the # comment character from the beginning of appropriate lines above. +%C%# +%C% +%C% +%C%############################################################# +%C%# # +%C%# APRS DIGIPEATER PROPERTIES # +%C%# # +%C%############################################################# +%C% +%C%# +%C%# For most common situations, use something like this by removing +%C%# the "#" from the beginning of the line below. +%C%# +%C% +%C%#DIGIPEAT 0 0 ^WIDE[3-7]-[1-7]$|^TEST$ ^WIDE[12]-[12]$ +%C% +%C%# See User Guide and "APRS-Digipeaters.pdf" for more explanation of what +%C%# this means and how it can be customized for your particular needs. +%C% +%C% +%C%# Traditional connected mode packet radio uses a different +%C%# type of digipeating. See User Guide for details. +%C% +%C%############################################################# +%C%# # +%C%# INTERNET GATEWAY # +%C%# # +%C%############################################################# +%C% +%C%# First you need to specify the name of a Tier 2 server. +%C%# The current preferred way is to use one of these regional rotate addresses: +%C% +%C%# noam.aprs2.net - for North America +%C%# soam.aprs2.net - for South America +%C%# euro.aprs2.net - for Europe and Africa +%C%# asia.aprs2.net - for Asia +%C%# aunz.aprs2.net - for Oceania +%C% +%C%#IGSERVER noam.aprs2.net +%C% +%C%# You also need to specify your login name and passcode. +%C%# Contact the author if you can't figure out how to generate the passcode. +%C% +%C%#IGLOGIN WB2OSZ-5 123456 +%C% +%C%# That's all you need for a receive only IGate which relays +%C%# messages from the local radio channel to the global servers. +%C% +%C%# Some might want to send an IGate client position directly to a server +%C%# without sending it over the air and relying on someone else to +%C%# forward it to an IGate server. This is done by using sendto=IG rather +%C%# than a radio channel number. Overlay R for receive only, T for two way. +%C%# There is no need to send it as often as you would over the radio. +%C% +%C%#PBEACON sendto=IG delay=0:30 every=60:00 symbol="igate" overlay=R lat=42^37.14N long=071^20.83W +%C%#PBEACON sendto=IG delay=0:30 every=60:00 symbol="igate" overlay=T lat=42^37.14N long=071^20.83W +%C% +%C% +%C%# To relay messages from the Internet to radio, you need to add +%C%# one more option with the transmit channel number and a VIA path. +%C% +%C%#IGTXVIA 0 WIDE1-1,WIDE2-1 +%C% +%C% +%C%# Finally, we don't want to flood the radio channel. +%C%# The IGate function will limit the number of packets transmitted +%C%# during 1 minute and 5 minute intervals. If a limit would +%C%# be exceeded, the packet is dropped and message is displayed in red. +%C%# This might be low for APRS Thursday when there is abnormally high activity. +%C% +%C%IGTXLIMIT 6 10 +%C% +%C% +%C%############################################################# +%C%# # +%C%# APRStt GATEWAY # +%C%# # +%C%############################################################# +%C% +%C%# +%C%# Dire Wolf can receive DTMF (commonly known as Touch Tone) +%C%# messages and convert them to packet objects. +%C%# +%C%# See separate "APRStt-Implementation-Notes" document for details. +%C%# + diff --git a/conf/install_conf.cmake b/conf/install_conf.cmake new file mode 100644 index 00000000..af111a76 --- /dev/null +++ b/conf/install_conf.cmake @@ -0,0 +1,23 @@ +if(NOT EXISTS $ENV{HOME}/direwolf.conf) + configure_file("${CUSTOM_BINARY_DIR}/direwolf.conf" $ENV{HOME}) +endif() + +if(NOT EXISTS $ENV{HOME}/sdr.conf) + configure_file("${CUSTOM_CONF_DIR}/sdr.conf" $ENV{HOME}) +endif() + +if(NOT EXISTS $ENV{HOME}/dw-start.sh) + configure_file("${CUSTOM_SCRIPTS_DIR}/dw-start.sh" $ENV{HOME}) +endif() + +if(NOT EXISTS $ENV{HOME}/telem-m0xer-3.txt) + configure_file("${CUSTOM_TELEMETRY_DIR}/telem-m0xer-3.txt" $ENV{HOME}) +endif() + +if(NOT EXISTS $ENV{HOME}/telem-balloon.conf) + configure_file("${CUSTOM_TELEMETRY_DIR}/telem-balloon.conf" $ENV{HOME}) +endif() + +if(NOT EXISTS $ENV{HOME}/telem-volts.conf) + configure_file("${CUSTOM_TELEMETRY_DIR}/telem-volts.conf" $ENV{HOME}) +endif() diff --git a/conf/sdr.conf b/conf/sdr.conf new file mode 100644 index 00000000..e506e523 --- /dev/null +++ b/conf/sdr.conf @@ -0,0 +1,30 @@ +# +# Sample configuration for SDR read-only IGate. +# + +# We might not have an audio output device so set to null. +# We will override the input half on the command line. +ADEVICE null null +CHANNEL 0 +MYCALL xxx + +# First you need to specify the name of a Tier 2 server. +# The current preferred way is to use one of these regional rotate addresses: + +# noam.aprs2.net - for North America +# soam.aprs2.net - for South America +# euro.aprs2.net - for Europe and Africa +# asia.aprs2.net - for Asia +# aunz.aprs2.net - for Oceania + +IGSERVER noam.aprs2.net + +# You also need to specify your login name and passcode. +# Contact the author if you can't figure out how to generate the passcode. + +IGLOGIN xxx 123456 + +# That's all you need for a receive only IGate which relays +# messages from the local radio channel to the global servers. + + diff --git a/config.c b/config.c deleted file mode 100644 index 11f42b03..00000000 --- a/config.c +++ /dev/null @@ -1,2689 +0,0 @@ -// -// This file is part of Dire Wolf, an amateur radio packet TNC. -// -// Copyright (C) 2011, 2012, 2013, 2014 John Langner, WB2OSZ -// -// This program 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 2 of the License, or -// (at your option) any later version. -// -// This program 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 this program. If not, see . -// - - -// #define DEBUG 1 - -/*------------------------------------------------------------------ - * - * Module: config.c - * - * Purpose: Read configuration information from a file. - * - * Description: This started out as a simple little application with a few - * command line options. Due to creeping featurism, it's now - * time to add a configuration file to specify options. - * - *---------------------------------------------------------------*/ - -#include -#include -#include -#include -#include -#include - -#if __WIN32__ -#include "pthreads/pthread.h" -#else -#include -#endif - -#include "ax25_pad.h" -#include "textcolor.h" -#include "audio.h" -#include "digipeater.h" -#include "config.h" -#include "aprs_tt.h" -#include "igate.h" -#include "latlong.h" -#include "symbols.h" -#include "LatLong-UTMconversion.h" - - -//#include "tq.h" - -/* - * Conversions from various units to meters. - * There is some disagreement about the exact values for some of these. - * Close enough for our purposes. - * Parsec, light year, and angstrom are probably not useful. - */ - -static const struct units_s { - char *name; - float meters; -} units[] = { - { "barleycorn", 0.008466667 }, - { "inch", 0.0254 }, - { "in", 0.0254 }, - { "hand", 0.1016 }, - { "shaku", 0.3030 }, - { "foot", 0.304801 }, - { "ft", 0.304801 }, - { "cubit", 0.4572 }, - { "megalithicyard", 0.8296 }, - { "my", 0.8296 }, - { "yard", 0.914402 }, - { "yd", 0.914402 }, - { "m", 1. }, - { "meter", 1. }, - { "metre", 1. }, - { "ell", 1.143 }, - { "ken", 1.818 }, - { "hiro", 1.818 }, - { "fathom", 1.8288 }, - { "fath", 1.8288 }, - { "toise", 1.949 }, - { "jo", 3.030 }, - { "twain", 3.6576074 }, - { "rod", 5.0292 }, - { "rd", 5.0292 }, - { "perch", 5.0292 }, - { "pole", 5.0292 }, - { "rope", 6.096 }, - { "dekameter", 10. }, - { "dekametre", 10. }, - { "dam", 10. }, - { "chain", 20.1168 }, - { "ch", 20.1168 }, - { "actus", 35.47872 }, - { "arpent", 58.471 }, - { "hectometer", 100. }, - { "hectometre", 100. }, - { "hm", 100. }, - { "cho", 109.1 }, - { "furlong", 201.168 }, - { "fur", 201.168 }, - { "kilometer", 1000. }, - { "kilometre", 1000. }, - { "km", 1000. }, - { "mile", 1609.344 }, - { "mi", 1609.344 }, - { "ri", 3927. }, - { "league", 4828.032 }, - { "lea", 4828.032 } }; - -#define NUM_UNITS (sizeof(units) / sizeof(struct units_s)) - -static int beacon_options(char *cmd, struct beacon_s *b, int line); - - -/*------------------------------------------------------------------ - * - * Name: parse_ll - * - * Purpose: Parse latitude or longitude from configuration file. - * - * Inputs: str - String like [-]deg[^min][hemisphere] - * - * which - LAT or LON for error checking and message. - * - * line - Line number for use in error message. - * - * Returns: Coordinate in signed degrees. - * - *----------------------------------------------------------------*/ - -/* Acceptable symbols to separate degrees & minutes. */ -/* Degree symbol is not in ASCII so documentation says to use "^" instead. */ -/* Some wise guy will try to use degree symbol. */ - -#define DEG1 '^' -#define DEG2 0xb0 /* ISO Latin1 */ -#define DEG3 0xf8 /* Microsoft code page 437 */ - -// TODO: recognize UTF-8 degree symbol. - - -enum parse_ll_which_e { LAT, LON }; - -static double parse_ll (char *str, enum parse_ll_which_e which, int line) -{ - char stemp[40]; - int sign; - double degrees, minutes; - char *endptr; - char hemi; - int limit; - unsigned char sep; - -/* - * Remove any negative sign. - */ - strcpy (stemp, str); - sign = +1; - if (stemp[0] == '-') { - sign = -1; - stemp[0] = ' '; - } -/* - * Process any hemisphere on the end. - */ - if (strlen(stemp) >= 2) { - endptr = stemp + strlen(stemp) - 1; - if (isalpha(*endptr)) { - - hemi = *endptr; - *endptr = '\0'; - if (islower(hemi)) { - hemi = toupper(hemi); - } - - if (hemi == 'W' || hemi == 'S') { - sign = -sign; - } - - if (which == LAT) { - if (hemi != 'N' && hemi != 'S') { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Latitude hemisphere in \"%s\" is not N or S.\n", line, str); - } - } - else { - if (hemi != 'E' && hemi != 'W') { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Longitude hemisphere in \"%s\" is not E or W.\n", line, str); - } - } - } - } - -/* - * Parse the degrees part. - */ - degrees = strtod (stemp, &endptr); - -/* - * Is there a minutes part? - */ - sep = *endptr; - if (sep != '\0') { - - if (sep == DEG1 || sep == DEG2 || sep == DEG3) { - - minutes = strtod (endptr+1, &endptr); - if (*endptr != '\0') { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Unexpected character '%c' in location \"%s\"\n", line, sep, str); - } - if (minutes >= 60.0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Number of minutes in \"%s\" is >= 60.\n", line, str); - } - degrees += minutes / 60.0; - } - else { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Unexpected character '%c' in location \"%s\"\n", line, sep, str); - } - } - - degrees = degrees * sign; - - limit = which == LAT ? 90 : 180; - if (degrees < -limit || degrees > limit) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Number of degrees in \"%s\" is out of range for %s\n", line, str, - which == LAT ? "latitude" : "longitude"); - } - //dw_printf ("%s = %f\n", str, degrees); - return (degrees); -} - -#if 0 -main () -{ - - parse_ll ("12.5", LAT); - parse_ll ("12.5N", LAT); - parse_ll ("12.5E", LAT); // error - - parse_ll ("-12.5", LAT); - parse_ll ("12.5S", LAT); - parse_ll ("12.5W", LAT); // error - - parse_ll ("12.5", LON); - parse_ll ("12.5E", LON); - parse_ll ("12.5N", LON); // error - - parse_ll ("-12.5", LON); - parse_ll ("12.5W", LON); - parse_ll ("12.5S", LON); // error - - parse_ll ("12^30", LAT); - parse_ll ("12°30", LAT); - - parse_ll ("91", LAT); // out of range - parse_ll ("91", LON); - parse_ll ("181", LON); // out of range - - parse_ll ("12&5", LAT); // bad character -} -#endif - - -/*------------------------------------------------------------------ - * - * Name: parse_interval - * - * Purpose: Parse time interval from configuration file. - * - * Inputs: str - String like 10 or 9:30 - * - * line - Line number for use in error message. - * - * Returns: Number of seconds. - * - * Description: This is used by the BEACON configuration items - * for initial delay or time between beacons. - * - * The format is either minutes or minutes:seconds. - * - *----------------------------------------------------------------*/ - - -static int parse_interval (char *str, int line) -{ - char *p; - int sec; - int nc = 0; - int bad = 0; - - for (p = str; *p != '\0'; p++) { - if (*p == ':') nc++; - else if ( ! isdigit(*p)) bad++; - } - if (bad > 0 || nc > 1) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Config file, line %d: Time interval must be of the form minutes or minutes:seconds.\n", line); - } - - p = strchr (str, ':'); - - if (p != NULL) { - sec = atoi(str) * 60 + atoi(p+1); - } - else { - sec = atoi(str) * 60; - } - - return (sec); - -} /* end parse_interval */ - - - -/*------------------------------------------------------------------- - * - * Name: config_init - * - * Purpose: Read configuration file when application starts up. - * - * Inputs: fname - Name of configuration file. - * - * Outputs: p_modem - Radio channel parameters stored here. - * - * p_digi_config - Digipeater configuration stored here. - * - * p_tt_config - APRStt stuff. - * - * p_igate_config - Internet Gateway. - * - * p_misc_config - Everything else. This wasn't thought out well. - * - * Description: Apply default values for various parameters then read the - * the configuration file which can override those values. - * - * Errors: For invalid input, display line number and message on stdout (not stderr). - * In many cases this will result in keeping the default rather than aborting. - * - * Bugs: Very simple-minded parsing. - * Not much error checking. (e.g. atoi() will return 0 for invalid string.) - * Not very forgiving about sloppy input. - * - *--------------------------------------------------------------------*/ - - -void config_init (char *fname, struct audio_s *p_modem, - struct digi_config_s *p_digi_config, - struct tt_config_s *p_tt_config, - struct igate_config_s *p_igate_config, - struct misc_config_s *p_misc_config) -{ - FILE *fp; - char stuff[256]; - //char *p; - //int c, p; - //int err; - int line; - int channel; - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("config_init ( %s )\n", fname); -#endif - -/* - * First apply defaults. - */ - - memset (p_modem, 0, sizeof(struct audio_s)); - - strcpy (p_modem->adevice_in, DEFAULT_ADEVICE); - strcpy (p_modem->adevice_out, DEFAULT_ADEVICE); - - p_modem->num_channels = DEFAULT_NUM_CHANNELS; /* -2 stereo */ - p_modem->samples_per_sec = DEFAULT_SAMPLES_PER_SEC; /* -r option */ - p_modem->bits_per_sample = DEFAULT_BITS_PER_SAMPLE; /* -8 option for 8 instead of 16 bits */ - p_modem->fix_bits = DEFAULT_FIX_BITS; - - for (channel=0; channelmodem_type[channel] = AFSK; - p_modem->mark_freq[channel] = DEFAULT_MARK_FREQ; /* -m option */ - p_modem->space_freq[channel] = DEFAULT_SPACE_FREQ; /* -s option */ - p_modem->baud[channel] = DEFAULT_BAUD; /* -b option */ - - /* None. Will set default later based on other factors. */ - strcpy (p_modem->profiles[channel], ""); - - p_modem->num_freq[channel] = 1; - p_modem->num_subchan[channel] = 1; - p_modem->offset[channel] = 0; - - // temp test. - // p_modem->num_subchan[channel] = 9; - // p_modem->offset[channel] = 60; - - p_modem->ptt_method[channel] = PTT_METHOD_NONE; - strcpy (p_modem->ptt_device[channel], ""); - p_modem->ptt_line[channel] = PTT_LINE_RTS; - p_modem->ptt_gpio[channel] = 0; - p_modem->ptt_lpt_bit[channel] = 0; - p_modem->ptt_invert[channel] = 0; - - p_modem->slottime[channel] = DEFAULT_SLOTTIME; - p_modem->persist[channel] = DEFAULT_PERSIST; - p_modem->txdelay[channel] = DEFAULT_TXDELAY; - p_modem->txtail[channel] = DEFAULT_TXTAIL; - } - - memset (p_digi_config, 0, sizeof(struct digi_config_s)); - p_digi_config->num_chans = p_modem->num_channels; - p_digi_config->dedupe_time = DEFAULT_DEDUPE; - - memset (p_tt_config, 0, sizeof(struct tt_config_s)); - p_tt_config->ttloc_size = 2; /* Start with at least 2. */ - /* When full, it will be increased by 50 %. */ - p_tt_config->ttloc_ptr = malloc (sizeof(struct ttloc_s) * p_tt_config->ttloc_size); - p_tt_config->ttloc_len = 0; - - /* Retention time and decay algorithm from 13 Feb 13 version of */ - /* http://www.aprs.org/aprstt/aprstt-coding24.txt */ - - p_tt_config->retain_time = 80 * 60; - p_tt_config->num_xmits = 7; - assert (p_tt_config->num_xmits <= TT_MAX_XMITS); - p_tt_config->xmit_delay[0] = 3; /* Before initial transmission. */ - p_tt_config->xmit_delay[1] = 16; - p_tt_config->xmit_delay[2] = 32; - p_tt_config->xmit_delay[3] = 64; - p_tt_config->xmit_delay[4] = 2 * 60; - p_tt_config->xmit_delay[5] = 4 * 60; - p_tt_config->xmit_delay[6] = 8 * 60; - - memset (p_misc_config, 0, sizeof(struct misc_config_s)); - p_misc_config->num_channels = p_modem->num_channels; - p_misc_config->agwpe_port = DEFAULT_AGWPE_PORT; - p_misc_config->kiss_port = DEFAULT_KISS_PORT; - p_misc_config->enable_kiss_pt = 0; /* -p option */ - - /* Defaults from http://info.aprs.net/index.php?title=SmartBeaconing */ - - p_misc_config->sb_configured = 0; /* TRUE if SmartBeaconing is configured. */ - p_misc_config->sb_fast_speed = 60; /* MPH */ - p_misc_config->sb_fast_rate = 180; /* seconds */ - p_misc_config->sb_slow_speed = 5; /* MPH */ - p_misc_config->sb_slow_rate = 1800; /* seconds */ - p_misc_config->sb_turn_time = 15; /* seconds */ - p_misc_config->sb_turn_angle = 30; /* degrees */ - p_misc_config->sb_turn_slope = 255; /* degrees * MPH */ - - memset (p_igate_config, 0, sizeof(struct igate_config_s)); - p_igate_config->t2_server_port = DEFAULT_IGATE_PORT; - p_igate_config->tx_chan = -1; /* IS->RF not enabled */ - p_igate_config->tx_limit_1 = 6; - p_igate_config->tx_limit_5 = 20; - - - /* People find this confusing. */ - /* Ideally we'd like to figure out if com0com is installed */ - /* and automatically enable this. */ - - //strcpy (p_misc_config->nullmodem, DEFAULT_NULLMODEM); - strcpy (p_misc_config->nullmodem, ""); - strcpy (p_misc_config->nmea_port, ""); - strcpy (p_misc_config->logdir, ""); - - -/* - * Try to extract options from a file. - * - * Windows: File must be in current working directory. - * - * Linux: Search current directory then home directory. - */ - - - channel = 0; - - fp = fopen (fname, "r"); -#ifndef __WIN32__ - if (fp == NULL && strcmp(fname, "direwolf.conf") == 0) { - /* Failed to open the default location. Try home dir. */ - char *p; - - p = getenv("HOME"); - if (p != NULL) { - strcpy (stuff, p); - strcat (stuff, "/direwolf.conf"); - fp = fopen (stuff, "r"); - } - } -#endif - if (fp == NULL) { - // TODO: not exactly right for all situations. - text_color_set(DW_COLOR_ERROR); - dw_printf ("ERROR - Could not open config file %s\n", fname); - dw_printf ("Try using -c command line option for alternate location.\n"); - return; - } - - - line = 0; - while (fgets(stuff, sizeof(stuff), fp) != NULL) { - char *t; - - line++; - - - t = strtok (stuff, " ,\t\n\r"); - if (t == NULL) { - continue; - } - - if (*t == '#' || *t == '*') { - continue; - } - - - -/* - * ==================== Audio device parameters ==================== - */ - -/* - * ADEVICE - Name of input sound device, and optionally output, if different. - */ - - /* Note that ALSA name can contain comma such as hw:1,0 */ - - if (strcasecmp(t, "ADEVICE") == 0) { - t = strtok (NULL, " \t\n\r"); - if (t == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Config file: Missing name of audio device for ADEVICE command on line %d.\n", line); - continue; - } - strncpy (p_modem->adevice_in, t, sizeof(p_modem->adevice_in)-1); - strncpy (p_modem->adevice_out, t, sizeof(p_modem->adevice_out)-1); - - t = strtok (NULL, " \t\n\r"); - if (t != NULL) { - strncpy (p_modem->adevice_out, t, sizeof(p_modem->adevice_out)-1); - } - } - -/* - * ARATE - Audio samples per second, 11025, 22050, 44100, etc. - */ - - else if (strcasecmp(t, "ARATE") == 0) { - int n; - t = strtok (NULL, " ,\t\n\r"); - if (t == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Missing audio sample rate for ARATE command.\n", line); - continue; - } - n = atoi(t); - if (n >= MIN_SAMPLES_PER_SEC && n <= MAX_SAMPLES_PER_SEC) { - p_modem->samples_per_sec = n; - } - else { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Use a more reasonable audio sample rate in range of %d - %d.\n", - line, MIN_SAMPLES_PER_SEC, MAX_SAMPLES_PER_SEC); - } - } - -/* - * ACHANNELS - Number of audio channels: 1 or 2 - */ - - else if (strcasecmp(t, "ACHANNELS") == 0) { - int n; - t = strtok (NULL, " ,\t\n\r"); - if (t == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Missing number of audio channels for ACHANNELS command.\n", line); - continue; - } - n = atoi(t); - if (n >= 1 && n <= MAX_CHANS) { - p_modem->num_channels = n; - p_digi_config->num_chans = p_modem->num_channels; - p_misc_config->num_channels = p_modem->num_channels; - } - else { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Number of audio channels must be 1 or 2.\n", line); - } - } - -/* - * ==================== Radio channel parameters ==================== - */ - -/* - * CHANNEL - Set channel for following commands. - */ - - else if (strcasecmp(t, "CHANNEL") == 0) { - int n; - t = strtok (NULL, " ,\t\n\r"); - if (t == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Missing channel number for CHANNEL command.\n", line); - continue; - } - n = atoi(t); - if (n >= 0 && n < MAX_CHANS) { - channel = n; - } - else { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Audio channel number must be 0 or 1.\n", line); - channel = 0; - } - } - -/* - * MYCALL station - */ - else if (strcasecmp(t, "mycall") == 0) { - t = strtok (NULL, " ,\t\n\r"); - if (t == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Config file: Missing value for MYCALL command on line %d.\n", line); - continue; - } - else { - - // Definitely set for current channel. - // Set for other channels which have not been set yet. - - int c; - - for (c = 0; c < MAX_CHANS; c++) { - - if (c == channel || strlen(p_digi_config->mycall[c]) == 0 || strcasecmp(p_digi_config->mycall[c], "NOCALL") == 0) { - - char *p; - - strncpy (p_digi_config->mycall[c], t, sizeof(p_digi_config->mycall[c])-1); - - for (p = p_digi_config->mycall[c]; *p != '\0'; p++) { - if (islower(*p)) { - *p = toupper(*p); /* silently force upper case. */ - } - } - // TODO: additional checks if valid - } - } - } - } - - -/* - * MODEM - Replaces former HBAUD, MARK, SPACE, and adds new multi modem capability. - * - * MODEM baud [ mark space [A][B][C] [ num-decoders spacing ] ] - */ - - else if (strcasecmp(t, "MODEM") == 0) { - int n; - t = strtok (NULL, " ,\t\n\r"); - if (t == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Missing date transmission rate for MODEM command.\n", line); - continue; - } - n = atoi(t); - if (n >= 100 && n <= 10000) { - p_modem->baud[channel] = n; - if (n != 300 && n != 1200 && n != 9600) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Warning: Non-standard baud rate. Are you sure?\n", line); - } - } - else { - p_modem->baud[channel] = DEFAULT_BAUD; - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Unreasonable baud rate. Using %d.\n", - line, p_modem->baud[channel]); - } - - - - /* Get mark frequency. */ - - t = strtok (NULL, " ,\t\n\r"); - if (t == NULL) { - text_color_set(DW_COLOR_INFO); - dw_printf ("Note: Using scrambled baseband rather than AFSK modem.\n"); - p_modem->modem_type[channel] = SCRAMBLE; - p_modem->mark_freq[channel] = 0; - p_modem->space_freq[channel] = 0; - continue; - } - - n = atoi(t); - /* Originally the upper limit was 3000. */ - /* Version 1.0 increased to 5000 because someone */ - /* wanted to use 2400/4800 Hz AFSK. */ - /* Of course the MIC and SPKR connections won't */ - /* have enough bandwidth so radios must be modified. */ - if (n >= 300 && n <= 5000) { - p_modem->mark_freq[channel] = n; - } - else { - p_modem->mark_freq[channel] = DEFAULT_MARK_FREQ; - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Unreasonable mark tone frequency. Using %d.\n", - line, p_modem->mark_freq[channel]); - } - - /* Get space frequency */ - - t = strtok (NULL, " ,\t\n\r"); - if (t == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Missing tone frequency for space.\n", line); - continue; - } - n = atoi(t); - if (n >= 300 && n <= 5000) { - p_modem->space_freq[channel] = n; - } - else { - p_modem->space_freq[channel] = DEFAULT_SPACE_FREQ; - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Unreasonable space tone frequency. Using %d.\n", - line, p_modem->space_freq[channel]); - } - - /* New feature in 0.9 - Optional filter profile(s). */ - - /* First, set a default based on platform and baud. */ - - if (p_modem->baud[channel] < 600) { - - /* "D" is a little better at 300 baud. */ - - strcpy (p_modem->profiles[channel], "D"); - } - else { -#if __arm__ - /* We probably don't have a lot of CPU power available. */ - - if (p_modem->baud[channel] == DEFAULT_BAUD && - p_modem->mark_freq[channel] == DEFAULT_MARK_FREQ && - p_modem->space_freq[channel] == DEFAULT_SPACE_FREQ && - p_modem->samples_per_sec == DEFAULT_SAMPLES_PER_SEC) { - - strcpy (p_modem->profiles[channel], "F"); - } - else { - strcpy (p_modem->profiles[channel], "A"); - } -#else - strcpy (p_modem->profiles[channel], "C"); -#endif - } - - t = strtok (NULL, " ,\t\n\r"); - if (t != NULL) { - if (isalpha(t[0])) { - // TODO: should check all letters. - strncpy (p_modem->profiles[channel], t, sizeof(p_modem->profiles[channel])); - p_modem->num_subchan[channel] = strlen(p_modem->profiles[channel]); - t = strtok (NULL, " ,\t\n\r"); - if (strlen(p_modem->profiles[channel]) > 1 && t != NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Can't combine multiple demodulator types and multiple frequencies.\n", line); - continue; - } - } - } - - /* New feature in 0.9 - optional number of decoders and frequency offset between. */ - - if (t != NULL) { - n = atoi(t); - if (n < 1 || n > MAX_SUBCHANS) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Number of modems is out of range. Using 3.\n", line); - n = 3; - } - p_modem->num_freq[channel] = n; - p_modem->num_subchan[channel] = n; - - t = strtok (NULL, " ,\t\n\r"); - if (t != NULL) { - n = atoi(t); - if (n < 5 || n > abs(p_modem->mark_freq[channel] - p_modem->space_freq[channel])/2) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Unreasonable value for offset between modems. Using 50 Hz.\n", line); - n = 50; - } - p_modem->offset[channel] = n; - } - else { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Missing frequency offset between modems. Using 50 Hz.\n", line); - p_modem->offset[channel] = 50; - } - -// TODO: power saver - } - } - -/* - * (deprecated) HBAUD - Set data bits per second. Standard values are 300 & 1200 for AFSK - * and 9600 for baseband with scrambling. - */ - - else if (strcasecmp(t, "HBAUD") == 0) { - int n; - t = strtok (NULL, " ,\t\n\r"); - if (t == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Missing date transmission rate for HBAUD command.\n", line); - continue; - } - n = atoi(t); - if (n >= 100 && n <= 10000) { - p_modem->baud[channel] = n; - if (n != 300 && n != 1200 && n != 9600) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Warning: Non-standard baud rate. Are you sure?\n", line); - } - if (n == 9600) { - /* TODO: should be separate option to keep it more general. */ - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Note: Using scrambled baseband for 9600 baud.\n", line); - p_modem->modem_type[channel] = SCRAMBLE; - } - } - else { - p_modem->baud[channel] = DEFAULT_BAUD; - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Unreasonable baud rate. Using %d.\n", - line, p_modem->baud[channel]); - } - } - -/* - * (deprecated) MARK - Mark tone frequency. - */ - - else if (strcasecmp(t, "MARK") == 0) { - int n; - t = strtok (NULL, " ,\t\n\r"); - if (t == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Missing tone frequency for MARK command.\n", line); - continue; - } - n = atoi(t); - if (n >= 300 && n <= 3000) { - p_modem->mark_freq[channel] = n; - } - else { - p_modem->mark_freq[channel] = DEFAULT_MARK_FREQ; - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Unreasonable mark tone frequency. Using %d.\n", - line, p_modem->mark_freq[channel]); - } - } - -/* - * (deprecated) SPACE - Space tone frequency. - */ - - else if (strcasecmp(t, "SPACE") == 0) { - int n; - t = strtok (NULL, " ,\t\n\r"); - if (t == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Missing tone frequency for SPACE command.\n", line); - continue; - } - n = atoi(t); - if (n >= 300 && n <= 3000) { - p_modem->space_freq[channel] = n; - } - else { - p_modem->space_freq[channel] = DEFAULT_SPACE_FREQ; - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Unreasonable space tone frequency. Using %d.\n", - line, p_modem->space_freq[channel]); - } - } - -/* - * PTT - Push To Talk signal line. - * - * PTT serial-port [-]rts-or-dtr - * PTT GPIO [-]gpio-num - * PTT LPT [-]bit-num - */ - - else if (strcasecmp(t, "PTT") == 0) { - //int n; - t = strtok (NULL, " ,\t\n\r"); - if (t == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Config file line %d: Missing serial port name for PTT command.\n", - line); - continue; - } - - if (strcasecmp(t, "GPIO") == 0) { - -/* GPIO case, Linux only. */ - -#if __WIN32__ - text_color_set(DW_COLOR_ERROR); - dw_printf ("Config file line %d: PTT with GPIO is only available on Linux.\n", line); -#else - t = strtok (NULL, " ,\t\n\r"); - if (t == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Config file line %d: Missing GPIO number.\n", line); - continue; - } - - if (*t == '-') { - p_modem->ptt_gpio[channel] = atoi(t+1); - p_modem->ptt_invert[channel] = 1; - } - else { - p_modem->ptt_gpio[channel] = atoi(t); - p_modem->ptt_invert[channel] = 0; - } - p_modem->ptt_method[channel] = PTT_METHOD_GPIO; -#endif - } - else if (strcasecmp(t, "LPT") == 0) { - -/* Parallel printer case, x86 Linux only. */ - -#if ( defined(__i386__) || defined(__x86_64__) ) && ( defined(__linux__) || defined(__unix__) ) - - t = strtok (NULL, " ,\t\n\r"); - if (t == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Config file line %d: Missing LPT bit number.\n", line); - continue; - } - - if (*t == '-') { - p_modem->ptt_lpt_bit[channel] = atoi(t+1); - p_modem->ptt_invert[channel] = 1; - } - else { - p_modem->ptt_lpt_bit[channel] = atoi(t); - p_modem->ptt_invert[channel] = 0; - } - p_modem->ptt_method[channel] = PTT_METHOD_LPT; -#else - text_color_set(DW_COLOR_ERROR); - dw_printf ("Config file line %d: PTT with LPT is only available on x86 Linux.\n", line); -#endif - } - else { - -/* serial port case. */ - - strncpy (p_modem->ptt_device[channel], t, sizeof(p_modem->ptt_device[channel])); - - t = strtok (NULL, " ,\t\n\r"); - if (t == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Config file line %d: Missing RTS or DTR after PTT device name.\n", - line); - continue; - } - - if (strcasecmp(t, "rts") == 0) { - p_modem->ptt_line[channel] = PTT_LINE_RTS; - p_modem->ptt_invert[channel] = 0; - } - else if (strcasecmp(t, "dtr") == 0) { - p_modem->ptt_line[channel] = PTT_LINE_DTR; - p_modem->ptt_invert[channel] = 0; - } - else if (strcasecmp(t, "-rts") == 0) { - p_modem->ptt_line[channel] = PTT_LINE_RTS; - p_modem->ptt_invert[channel] = 1; - } - else if (strcasecmp(t, "-dtr") == 0) { - p_modem->ptt_line[channel] = PTT_LINE_DTR; - p_modem->ptt_invert[channel] = 1; - } - else { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Config file line %d: Expected RTS or DTR after PTT device name.\n", - line); - continue; - } - - p_modem->ptt_method[channel] = PTT_METHOD_SERIAL; - } - - } - - -/* - * SLOTTIME - For non-digipeat transmit delay timing. - */ - - else if (strcasecmp(t, "SLOTTIME") == 0) { - int n; - t = strtok (NULL, " ,\t\n\r"); - if (t == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Missing delay time for SLOTTIME command.\n", line); - continue; - } - n = atoi(t); - if (n >= 0 && n <= 255) { - p_modem->slottime[channel] = n; - } - else { - p_modem->slottime[channel] = DEFAULT_SLOTTIME; - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Invalid delay time for persist algorithm. Using %d.\n", - line, p_modem->slottime[channel]); - } - } - -/* - * PERSIST - For non-digipeat transmit delay timing. - */ - - else if (strcasecmp(t, "PERSIST") == 0) { - int n; - t = strtok (NULL, " ,\t\n\r"); - if (t == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Missing probability for PERSIST command.\n", line); - continue; - } - n = atoi(t); - if (n >= 0 && n <= 255) { - p_modem->persist[channel] = n; - } - else { - p_modem->persist[channel] = DEFAULT_PERSIST; - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Invalid probability for persist algorithm. Using %d.\n", - line, p_modem->persist[channel]); - } - } - -/* - * TXDELAY - For transmit delay timing. - */ - - else if (strcasecmp(t, "TXDELAY") == 0) { - int n; - t = strtok (NULL, " ,\t\n\r"); - if (t == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Missing time for TXDELAY command.\n", line); - continue; - } - n = atoi(t); - if (n >= 0 && n <= 255) { - p_modem->txdelay[channel] = n; - } - else { - p_modem->txdelay[channel] = DEFAULT_TXDELAY; - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Invalid time for transmit delay. Using %d.\n", - line, p_modem->txdelay[channel]); - } - } - -/* - * TXTAIL - For transmit timing. - */ - - else if (strcasecmp(t, "TXTAIL") == 0) { - int n; - t = strtok (NULL, " ,\t\n\r"); - if (t == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Missing time for TXTAIL command.\n", line); - continue; - } - n = atoi(t); - if (n >= 0 && n <= 255) { - p_modem->txtail[channel] = n; - } - else { - p_modem->txtail[channel] = DEFAULT_TXTAIL; - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Invalid time for transmit timing. Using %d.\n", - line, p_modem->txtail[channel]); - } - } - -/* - * ==================== Digipeater parameters ==================== - */ - - else if (strcasecmp(t, "digipeat") == 0) { - int from_chan, to_chan; - int e; - char message[100]; - - - t = strtok (NULL, " ,\t\n\r"); - if (t == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Config file: Missing FROM-channel on line %d.\n", line); - continue; - } - from_chan = atoi(t); - if (from_chan < 0 || from_chan > p_digi_config->num_chans-1) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Config file: FROM-channel must be in range of 0 to %d on line %d.\n", - p_digi_config->num_chans-1, line); - continue; - } - - t = strtok (NULL, " ,\t\n\r"); - if (t == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Config file: Missing TO-channel on line %d.\n", line); - continue; - } - to_chan = atoi(t); - if (to_chan < 0 || to_chan > p_digi_config->num_chans-1) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Config file: TO-channel must be in range of 0 to %d on line %d.\n", - p_digi_config->num_chans-1, line); - continue; - } - - t = strtok (NULL, " ,\t\n\r"); - if (t == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Config file: Missing alias pattern on line %d.\n", line); - continue; - } - e = regcomp (&(p_digi_config->alias[from_chan][to_chan]), t, REG_EXTENDED|REG_NOSUB); - if (e != 0) { - regerror (e, &(p_digi_config->alias[from_chan][to_chan]), message, sizeof(message)); - text_color_set(DW_COLOR_ERROR); - dw_printf ("Config file: Invalid alias matching pattern on line %d:\n%s\n", - line, message); - continue; - } - - t = strtok (NULL, " ,\t\n\r"); - if (t == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Config file: Missing wide pattern on line %d.\n", line); - continue; - } - e = regcomp (&(p_digi_config->wide[from_chan][to_chan]), t, REG_EXTENDED|REG_NOSUB); - if (e != 0) { - regerror (e, &(p_digi_config->wide[from_chan][to_chan]), message, sizeof(message)); - text_color_set(DW_COLOR_ERROR); - dw_printf ("Config file: Invalid wide matching pattern on line %d:\n%s\n", - line, message); - continue; - } - - p_digi_config->enabled[from_chan][to_chan] = 1; - p_digi_config->preempt[from_chan][to_chan] = PREEMPT_OFF; - - t = strtok (NULL, " ,\t\n\r"); - if (t != NULL) { - if (strcasecmp(t, "OFF") == 0) { - p_digi_config->preempt[from_chan][to_chan] = PREEMPT_OFF; - } - else if (strcasecmp(t, "DROP") == 0) { - p_digi_config->preempt[from_chan][to_chan] = PREEMPT_DROP; - } - else if (strcasecmp(t, "MARK") == 0) { - p_digi_config->preempt[from_chan][to_chan] = PREEMPT_MARK; - } - else if (strcasecmp(t, "TRACE") == 0) { - p_digi_config->preempt[from_chan][to_chan] = PREEMPT_TRACE; - } - else { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Config file: Expected OFF, DROP, MARK, or TRACE on line %d.\n", line); - } - - } - } - -/* - * DEDUPE - Time to suppress digipeating of duplicate packets. - */ - - else if (strcasecmp(t, "DEDUPE") == 0) { - int n; - t = strtok (NULL, " ,\t\n\r"); - if (t == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Missing time for DEDUPE command.\n", line); - continue; - } - n = atoi(t); - if (n >= 0 && n < 600) { - p_digi_config->dedupe_time = n; - } - else { - p_digi_config->dedupe_time = DEFAULT_DEDUPE; - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Unreasonable value for dedupe time. Using %d.\n", - line, p_digi_config->dedupe_time); - } - } - -/* - * REGEN - Signal regeneration. - */ - - else if (strcasecmp(t, "regen") == 0) { - int from_chan, to_chan; - //int e; - //char message[100]; - - - t = strtok (NULL, " ,\t\n\r"); - if (t == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Config file: Missing FROM-channel on line %d.\n", line); - continue; - } - from_chan = atoi(t); - if (from_chan < 0 || from_chan > p_digi_config->num_chans-1) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Config file: FROM-channel must be in range of 0 to %d on line %d.\n", - p_digi_config->num_chans-1, line); - continue; - } - - t = strtok (NULL, " ,\t\n\r"); - if (t == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Config file: Missing TO-channel on line %d.\n", line); - continue; - } - to_chan = atoi(t); - if (to_chan < 0 || to_chan > p_digi_config->num_chans-1) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Config file: TO-channel must be in range of 0 to %d on line %d.\n", - p_digi_config->num_chans-1, line); - continue; - } - - - p_digi_config->regen[from_chan][to_chan] = 1; - - } - -/* - * ==================== APRStt gateway ==================== - */ - -/* - * TTCORRAL - How to handle unknown positions - * - * TTCORRAL latitude longitude offset-or-ambiguity - */ - - else if (strcasecmp(t, "TTCORRAL") == 0) { - //int n; - t = strtok (NULL, " ,\t\n\r"); - if (t == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Missing latitude for TTCORRAL command.\n", line); - continue; - } - p_tt_config->corral_lat = parse_ll(t,LAT,line); - - t = strtok (NULL, " ,\t\n\r"); - if (t == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Missing longitude for TTCORRAL command.\n", line); - continue; - } - p_tt_config->corral_lon = parse_ll(t,LON,line); - - t = strtok (NULL, " ,\t\n\r"); - if (t == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Missing longitude for TTCORRAL command.\n", line); - continue; - } - p_tt_config->corral_offset = parse_ll(t,LAT,line); - if (p_tt_config->corral_offset == 1 || - p_tt_config->corral_offset == 2 || - p_tt_config->corral_offset == 3) { - p_tt_config->corral_ambiguity = p_tt_config->corral_offset; - p_tt_config->corral_offset = 0; - } - - //dw_printf ("DEBUG: corral %f %f %f %d\n", p_tt_config->corral_lat, - // p_tt_config->corral_lon, p_tt_config->corral_offset, p_tt_config->corral_ambiguity); - } - -/* - * TTPOINT - Define a point represented by touch tone sequence. - * - * TTPOINT pattern latitude longitude - */ - else if (strcasecmp(t, "TTPOINT") == 0) { - - struct ttloc_s *tl; - int j; - - assert (p_tt_config->ttloc_size >= 2); - assert (p_tt_config->ttloc_len >= 0 && p_tt_config->ttloc_len <= p_tt_config->ttloc_size); - - /* Allocate new space, but first, if already full, make larger. */ - if (p_tt_config->ttloc_len == p_tt_config->ttloc_size) { - p_tt_config->ttloc_size += p_tt_config->ttloc_size / 2; - p_tt_config->ttloc_ptr = realloc (p_tt_config->ttloc_ptr, sizeof(struct ttloc_s) * p_tt_config->ttloc_size); - } - p_tt_config->ttloc_len++; - assert (p_tt_config->ttloc_len >= 0 && p_tt_config->ttloc_len <= p_tt_config->ttloc_size); - - tl = &(p_tt_config->ttloc_ptr[p_tt_config->ttloc_len-1]); - tl->type = TTLOC_POINT; - strcpy(tl->pattern, ""); - tl->point.lat = 0; - tl->point.lon = 0; - - /* Pattern: B and digits */ - - t = strtok (NULL, " ,\t\n\r"); - if (t == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Missing pattern for TTPOINT command.\n", line); - continue; - } - strcpy (tl->pattern, t); - - if (t[0] != 'B') { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: TTPOINT pattern must begin with upper case 'B'.\n", line); - } - for (j=1; jpoint.lat = parse_ll(t,LAT,line); - - /* Longitude */ - - t = strtok (NULL, " ,\t\n\r"); - if (t == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Missing longitude for TTPOINT command.\n", line); - continue; - } - tl->point.lon = parse_ll(t,LON,line); - - /* temp debugging */ - - //for (j=0; jttloc_len; j++) { - // dw_printf ("debug ttloc %d/%d %s\n", j, p_tt_config->ttloc_size, - // p_tt_config->ttloc_ptr[j].pattern); - //} - } - -/* - * TTVECTOR - Touch tone location with bearing and distance. - * - * TTVECTOR pattern latitude longitude scale unit - */ - else if (strcasecmp(t, "TTVECTOR") == 0) { - - struct ttloc_s *tl; - int j; - double scale; - double meters; - - assert (p_tt_config->ttloc_size >= 2); - assert (p_tt_config->ttloc_len >= 0 && p_tt_config->ttloc_len <= p_tt_config->ttloc_size); - - /* Allocate new space, but first, if already full, make larger. */ - if (p_tt_config->ttloc_len == p_tt_config->ttloc_size) { - p_tt_config->ttloc_size += p_tt_config->ttloc_size / 2; - p_tt_config->ttloc_ptr = realloc (p_tt_config->ttloc_ptr, sizeof(struct ttloc_s) * p_tt_config->ttloc_size); - } - p_tt_config->ttloc_len++; - assert (p_tt_config->ttloc_len >= 0 && p_tt_config->ttloc_len <= p_tt_config->ttloc_size); - - tl = &(p_tt_config->ttloc_ptr[p_tt_config->ttloc_len-1]); - tl->type = TTLOC_VECTOR; - strcpy(tl->pattern, ""); - tl->vector.lat = 0; - tl->vector.lon = 0; - tl->vector.scale = 1; - - /* Pattern: B5bbbd... */ - - t = strtok (NULL, " ,\t\n\r"); - if (t == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Missing pattern for TTVECTOR command.\n", line); - continue; - } - strcpy (tl->pattern, t); - - if (t[0] != 'B') { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: TTVECTOR pattern must begin with upper case 'B'.\n", line); - } - if (strncmp(t+1, "5bbb", 4) != 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: TTVECTOR pattern would normally contain \"5bbb\".\n", line); - } - for (j=1; jvector.lat = parse_ll(t,LAT,line); - - /* Longitude */ - - t = strtok (NULL, " ,\t\n\r"); - if (t == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Missing longitude for TTVECTOR command.\n", line); - continue; - } - tl->vector.lon = parse_ll(t,LON,line); - - /* Longitude */ - - t = strtok (NULL, " ,\t\n\r"); - if (t == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Missing scale for TTVECTOR command.\n", line); - continue; - } - scale = atof(t); - - /* Unit. */ - - t = strtok (NULL, " ,\t\n\r"); - if (t == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Missing unit for TTVECTOR command.\n", line); - continue; - } - meters = 0; - for (j=0; jvector.scale = scale * meters; - - //dw_printf ("ttvector: %f meters\n", tl->vector.scale); - - /* temp debugging */ - - //for (j=0; jttloc_len; j++) { - // dw_printf ("debug ttloc %d/%d %s\n", j, p_tt_config->ttloc_size, - // p_tt_config->ttloc_ptr[j].pattern); - //} - } - -/* - * TTGRID - Define a grid for touch tone locations. - * - * TTGRID pattern min-latitude min-longitude max-latitude max-longitude - */ - else if (strcasecmp(t, "TTGRID") == 0) { - - struct ttloc_s *tl; - int j; - - assert (p_tt_config->ttloc_size >= 2); - assert (p_tt_config->ttloc_len >= 0 && p_tt_config->ttloc_len <= p_tt_config->ttloc_size); - - /* Allocate new space, but first, if already full, make larger. */ - if (p_tt_config->ttloc_len == p_tt_config->ttloc_size) { - p_tt_config->ttloc_size += p_tt_config->ttloc_size / 2; - p_tt_config->ttloc_ptr = realloc (p_tt_config->ttloc_ptr, sizeof(struct ttloc_s) * p_tt_config->ttloc_size); - } - p_tt_config->ttloc_len++; - assert (p_tt_config->ttloc_len >= 0 && p_tt_config->ttloc_len <= p_tt_config->ttloc_size); - - tl = &(p_tt_config->ttloc_ptr[p_tt_config->ttloc_len-1]); - tl->type = TTLOC_GRID; - strcpy(tl->pattern, ""); - tl->grid.lat0 = 0; - tl->grid.lon0 = 0; - tl->grid.lat9 = 0; - tl->grid.lon9 = 0; - - /* Pattern: B [digit] x... y... */ - - t = strtok (NULL, " ,\t\n\r"); - if (t == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Missing pattern for TTGRID command.\n", line); - continue; - } - strcpy (tl->pattern, t); - - if (t[0] != 'B') { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: TTGRID pattern must begin with upper case 'B'.\n", line); - } - for (j=1; jgrid.lat0 = parse_ll(t,LAT,line); - - /* Minimum Longitude - all zeros in received data */ - - t = strtok (NULL, " ,\t\n\r"); - if (t == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Missing longitude for TTGRID command.\n", line); - continue; - } - tl->grid.lon0 = parse_ll(t,LON,line); - - /* Maximum Latitude - all nines in received data */ - - t = strtok (NULL, " ,\t\n\r"); - if (t == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Missing latitude for TTGRID command.\n", line); - continue; - } - tl->grid.lat9 = parse_ll(t,LAT,line); - - /* Maximum Longitude - all nines in received data */ - - t = strtok (NULL, " ,\t\n\r"); - if (t == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Missing longitude for TTGRID command.\n", line); - continue; - } - tl->grid.lon0 = parse_ll(t,LON,line); - - /* temp debugging */ - - //for (j=0; jttloc_len; j++) { - // dw_printf ("debug ttloc %d/%d %s\n", j, p_tt_config->ttloc_size, - // p_tt_config->ttloc_ptr[j].pattern); - //} - } - -/* - * TTUTM - Specify UTM zone for touch tone locations. - * - * TTUTM pattern zone [ scale [ x-offset y-offset ] ] - */ - else if (strcasecmp(t, "TTUTM") == 0) { - - struct ttloc_s *tl; - int j; - int znum; - char *zlet; - - assert (p_tt_config->ttloc_size >= 2); - assert (p_tt_config->ttloc_len >= 0 && p_tt_config->ttloc_len <= p_tt_config->ttloc_size); - - /* Allocate new space, but first, if already full, make larger. */ - if (p_tt_config->ttloc_len == p_tt_config->ttloc_size) { - p_tt_config->ttloc_size += p_tt_config->ttloc_size / 2; - p_tt_config->ttloc_ptr = realloc (p_tt_config->ttloc_ptr, sizeof(struct ttloc_s) * p_tt_config->ttloc_size); - } - p_tt_config->ttloc_len++; - assert (p_tt_config->ttloc_len >= 0 && p_tt_config->ttloc_len <= p_tt_config->ttloc_size); - - tl = &(p_tt_config->ttloc_ptr[p_tt_config->ttloc_len-1]); - tl->type = TTLOC_UTM; - strcpy(tl->pattern, ""); - strcpy(tl->utm.zone, ""); - tl->utm.scale = 1; - tl->utm.x_offset = 0; - tl->utm.y_offset = 0; - - /* Pattern: B [digit] x... y... */ - - t = strtok (NULL, " ,\t\n\r"); - if (t == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Missing pattern for TTUTM command.\n", line); - continue; - } - strcpy (tl->pattern, t); - - if (t[0] != 'B') { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: TTUTM pattern must begin with upper case 'B'.\n", line); - } - for (j=1; jutm.zone, 0, sizeof (tl->utm.zone)); - strncpy (tl->utm.zone, t, sizeof (tl->utm.zone) - 1); - - znum = strtoul(tl->utm.zone, &zlet, 10); - - if (znum < 1 || znum > 60) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Zone number is out of range.\n\n", line); - continue; - } - - if (*zlet != '\0' && strchr ("CDEFGHJKLMNPQRSTUVWX", *zlet) == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Latitudinal band must be one of CDEFGHJKLMNPQRSTUVWX.\n\n", line); - continue; - } - - /* Optional scale. */ - - t = strtok (NULL, " ,\t\n\r"); - if (t == NULL) { - continue; - } - tl->utm.scale = atof(t); - - /* Optional x offset. */ - - t = strtok (NULL, " ,\t\n\r"); - if (t == NULL) { - continue; - } - tl->utm.x_offset = atof(t); - - /* Optional y offset. */ - - t = strtok (NULL, " ,\t\n\r"); - if (t == NULL) { - continue; - } - tl->utm.y_offset = atof(t); - } - -/* - * TTMACRO - Define compact message format with full expansion - * - * TTMACRO pattern definition - */ - else if (strcasecmp(t, "TTMACRO") == 0) { - - struct ttloc_s *tl; - int j; - //char ch; - int p_count[3], d_count[3]; - - assert (p_tt_config->ttloc_size >= 2); - assert (p_tt_config->ttloc_len >= 0 && p_tt_config->ttloc_len <= p_tt_config->ttloc_size); - - /* Allocate new space, but first, if already full, make larger. */ - if (p_tt_config->ttloc_len == p_tt_config->ttloc_size) { - p_tt_config->ttloc_size += p_tt_config->ttloc_size / 2; - p_tt_config->ttloc_ptr = realloc (p_tt_config->ttloc_ptr, sizeof(struct ttloc_s) * p_tt_config->ttloc_size); - } - p_tt_config->ttloc_len++; - assert (p_tt_config->ttloc_len >= 0 && p_tt_config->ttloc_len <= p_tt_config->ttloc_size); - - tl = &(p_tt_config->ttloc_ptr[p_tt_config->ttloc_len-1]); - tl->type = TTLOC_MACRO; - strcpy(tl->pattern, ""); - - /* Pattern: Any combination of digits, x, y, and z. */ - /* Also make note of which letters are used in pattern and defintition. */ - - t = strtok (NULL, " ,\t\n\r"); - if (t == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Missing pattern for TTMACRO command.\n", line); - continue; - } - strcpy (tl->pattern, t); - - p_count[0] = p_count[1] = p_count[2] = 0; - - for (j=0; j= 'x' && t[j] <= 'z') { - p_count[t[j]-'x']++; - } - } - - /* Now gather up the definition. */ - /* It can contain touch tone characters and lower case x, y, z for substitutions. */ - - t = strtok (NULL, " ,\t\n\r"); - if (t == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Missing definition for TTMACRO command.\n", line); - tl->macro.definition = ""; /* Don't die on null pointer later. */ - continue; - } - tl->macro.definition = strdup(t); - - d_count[0] = d_count[1] = d_count[2] = 0; - - for (j=0; j= 'x' && t[j] <= 'z') { - d_count[t[j]-'x']++; - } - } - - /* A little validity checking. */ - - for (j=0; j<3; j++) { - if (p_count[j] > 0 && d_count[j] == 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: '%c' is in TTMACRO pattern but is not used in definition.\n", line, 'x'+j); - } - if (d_count[j] > 0 && p_count[j] == 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: '%c' is referenced in TTMACRO definition but does not appear in the pattern.\n", line, 'x'+j); - } - } - } - -/* - * TTOBJ - TT Object Report options. - * - * TTOBJ xmit-chan header - */ - - -// TODO: header can be generated automatically. Should not be in config file. - - - else if (strcasecmp(t, "TTOBJ") == 0) { - int n; - - t = strtok (NULL, " ,\t\n\r"); - if (t == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Missing transmit channel for TTOBJ command.\n", line); - continue; - } - - n = atoi(t); - if (n < 0 || n > p_digi_config->num_chans-1) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Config file: Transmit channel must be in range of 0 to %d on line %d.\n", - p_digi_config->num_chans-1, line); - continue; - } - p_tt_config->obj_xmit_chan = n; - - t = strtok (NULL, " ,\t\n\r"); - if (t == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Missing object header for TTOBJ command.\n", line); - continue; - } - // TODO: Should do some validity checking. - - strncpy (p_tt_config->obj_xmit_header, t, sizeof(p_tt_config->obj_xmit_header)); - - } - -/* - * ==================== Internet gateway ==================== - */ - -/* - * IGSERVER - Name of IGate server. - * - * IGSERVER hostname [ port ] -- original implementation. - * - * IGSERVER hostname:port -- more in line with usual conventions. - */ - - else if (strcasecmp(t, "IGSERVER") == 0) { - t = strtok (NULL, " ,\t\n\r"); - if (t == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Missing IGate server name for IGSERVER command.\n", line); - continue; - } - strncpy (p_igate_config->t2_server_name, t, sizeof(p_igate_config->t2_server_name)-1); - - /* If there is a : in the name, split it out as the port number. */ - - t = strchr (p_igate_config->t2_server_name, ':'); - if (t != NULL) { - *t = '\0'; - t++; - int n = atoi(t); - if (n >= MIN_IP_PORT_NUMBER && n <= MAX_IP_PORT_NUMBER) { - p_igate_config->t2_server_port = n; - } - else { - p_igate_config->t2_server_port = DEFAULT_IGATE_PORT; - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Invalid port number for IGate server. Using default %d.\n", - line, p_igate_config->t2_server_port); - } - } - - /* Alternatively, the port number could be separated by white space. */ - - t = strtok (NULL, " ,\t\n\r"); - if (t != NULL) { - int n = atoi(t); - if (n >= MIN_IP_PORT_NUMBER && n <= MAX_IP_PORT_NUMBER) { - p_igate_config->t2_server_port = n; - } - else { - p_igate_config->t2_server_port = DEFAULT_IGATE_PORT; - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Invalid port number for IGate server. Using default %d.\n", - line, p_igate_config->t2_server_port); - } - } - //printf ("DEBUG server=%s port=%d\n", p_igate_config->t2_server_name, p_igate_config->t2_server_port); - //exit (0); - } - -/* - * IGLOGIN - Login callsign and passcode for IGate server - * - * IGLOGIN callsign passcode - */ - - else if (strcasecmp(t, "IGLOGIN") == 0) { - t = strtok (NULL, " ,\t\n\r"); - if (t == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Missing login callsign for IGLOGIN command.\n", line); - continue; - } - // TODO: Wouldn't hurt to do validity checking of format. - strncpy (p_igate_config->t2_login, t, sizeof(p_igate_config->t2_login)-1); - - t = strtok (NULL, " ,\t\n\r"); - if (t == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Missing passcode for IGLOGIN command.\n", line); - continue; - } - strncpy (p_igate_config->t2_passcode, t, sizeof(p_igate_config->t2_passcode)-1); - } - -/* - * IGTXVIA - Transmit channel and VIA path for messages from IGate server - * - * IGTXVIA channel [ path ] - */ - - else if (strcasecmp(t, "IGTXVIA") == 0) { - int n; - - t = strtok (NULL, " ,\t\n\r"); - if (t == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Missing transmit channel for IGTXVIA command.\n", line); - continue; - } - - n = atoi(t); - if (n < 0 || n > p_digi_config->num_chans-1) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Config file: Transmit channel must be in range of 0 to %d on line %d.\n", - p_digi_config->num_chans-1, line); - continue; - } - p_igate_config->tx_chan = n; - - t = strtok (NULL, " \t\n\r"); - if (t != NULL) { - char *p; - p_igate_config->tx_via[0] = ','; - strncpy (p_igate_config->tx_via + 1, t, sizeof(p_igate_config->tx_via)-2); - for (p = p_igate_config->tx_via; *p != '\0'; p++) { - if (islower(*p)) { - *p = toupper(*p); /* silently force upper case. */ - } - } - } - } - -/* - * IGFILTER - Filter for messages from IGate server - * - * IGFILTER filter-spec ... - */ - - else if (strcasecmp(t, "IGFILTER") == 0) { - //int n; - - t = strtok (NULL, "\n\r"); /* Take rest of line as one string. */ - - if (t != NULL && strlen(t) > 0) { - p_igate_config->t2_filter = strdup (t); - } - } - - -/* - * IGTXLIMIT - Limit transmissions during 1 and 5 minute intervals. - * - * IGTXLIMIT one-minute-limit five-minute-limit - */ - - else if (strcasecmp(t, "IGTXLIMIT") == 0) { - int n; - - t = strtok (NULL, " ,\t\n\r"); - if (t == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Missing one minute limit for IGTXLIMIT command.\n", line); - continue; - } - - /* limits of 20 and 100 are unfriendly but not insane. */ - - n = atoi(t); - if (n >= 1 && n <= 20) { - p_igate_config->tx_limit_1 = n; - } - else { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Invalid one minute transmit limit. Using %d.\n", - line, p_igate_config->tx_limit_1); - } - - t = strtok (NULL, " ,\t\n\r"); - if (t == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Missing five minute limit for IGTXLIMIT command.\n", line); - continue; - } - - n = atoi(t); - if (n >= 1 && n <= 100) { - p_igate_config->tx_limit_5 = n; - } - else { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Invalid one minute transmit limit. Using %d.\n", - line, p_igate_config->tx_limit_5); - } - } - -/* - * ==================== All the left overs ==================== - */ - -/* - * AGWPORT - Port number for "AGW TCPIP Socket Interface" - */ - - else if (strcasecmp(t, "AGWPORT") == 0) { - int n; - t = strtok (NULL, " ,\t\n\r"); - if (t == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Missing port number for AGWPORT command.\n", line); - continue; - } - n = atoi(t); - if (n >= MIN_IP_PORT_NUMBER && n <= MAX_IP_PORT_NUMBER) { - p_misc_config->agwpe_port = n; - } - else { - p_misc_config->agwpe_port = DEFAULT_AGWPE_PORT; - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Invalid port number for AGW TCPIP Socket Interface. Using %d.\n", - line, p_misc_config->agwpe_port); - } - } - -/* - * KISSPORT - Port number for KISS over IP. - */ - - else if (strcasecmp(t, "KISSPORT") == 0) { - int n; - t = strtok (NULL, " ,\t\n\r"); - if (t == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Missing port number for KISSPORT command.\n", line); - continue; - } - n = atoi(t); - if (n >= MIN_IP_PORT_NUMBER && n <= MAX_IP_PORT_NUMBER) { - p_misc_config->kiss_port = n; - } - else { - p_misc_config->kiss_port = DEFAULT_KISS_PORT; - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Invalid port number for KISS TCPIP Socket Interface. Using %d.\n", - line, p_misc_config->kiss_port); - } - } - -/* - * NULLMODEM - Device name for our end of the virtual "null modem" - */ - else if (strcasecmp(t, "nullmodem") == 0) { - t = strtok (NULL, " ,\t\n\r"); - if (t == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Config file: Missing device name for my end of the 'null modem' on line %d.\n", line); - continue; - } - else { - strncpy (p_misc_config->nullmodem, t, sizeof(p_misc_config->nullmodem)-1); - } - } - -/* - * NMEA - Device name for communication with NMEA device. - */ - else if (strcasecmp(t, "nmea") == 0) { - t = strtok (NULL, " ,\t\n\r"); - if (t == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Config file: Missing device name for NMEA port on line %d.\n", line); - continue; - } - else { - strncpy (p_misc_config->nmea_port, t, sizeof(p_misc_config->nmea_port)-1); - } - } - -/* - * LOGDIR - Directory name for storing log files. Use "." for current working directory. - */ - else if (strcasecmp(t, "logdir") == 0) { - t = strtok (NULL, " ,\t\n\r"); - if (t == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Config file: Missing directory name for LOGDIR on line %d.\n", line); - continue; - } - else { - strncpy (p_misc_config->logdir, t, sizeof(p_misc_config->logdir)-1); - } - } - -/* - * FIX_BITS - Attempt to fix frames with bad FCS. - */ - - else if (strcasecmp(t, "FIX_BITS") == 0) { - int n; - t = strtok (NULL, " ,\t\n\r"); - if (t == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Missing value for FIX_BITS command.\n", line); - continue; - } - n = atoi(t); - if (n >= RETRY_NONE && n <= RETRY_REMOVE_TWO_SEP) { - p_modem->fix_bits = (retry_t)n; - } - else { - p_modem->fix_bits = DEFAULT_FIX_BITS; - text_color_set(DW_COLOR_ERROR); - dw_printf ("Line %d: Invalid value for FIX_BITS. Using %d.\n", - line, p_modem->fix_bits); - } - } - -/* - * BEACON channel delay every message - * - * Original handcrafted style. Removed in version 1.0. - */ - - else if (strcasecmp(t, "BEACON") == 0) { - - text_color_set(DW_COLOR_ERROR); - dw_printf ("Config file, line %d: Old style 'BEACON' has been replaced with new commands.\n", line); - dw_printf ("Use PBEACON, OBEACON, or CBEACON instead.\n"); - - } - - -/* - * PBEACON keyword=value ... - * OBEACON keyword=value ... - * TBEACON keyword=value ... - * CBEACON keyword=value ... - * - * New style with keywords for options. - */ - - else if (strcasecmp(t, "PBEACON") == 0 || - strcasecmp(t, "OBEACON") == 0 || - strcasecmp(t, "TBEACON") == 0 || - strcasecmp(t, "CBEACON") == 0) { -#if __WIN32__ - if (strcasecmp(t, "TBEACON") == 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Config file, line %d: TBEACON is available only in Linux version.\n", line); - continue; - } -#endif - -#ifndef ENABLE_GPS - if (strcasecmp(t, "TBEACON") == 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Config file, line %d: Rebuild with GPS support for TBEACON to be available.\n", line); - continue; - } -#endif - if (p_misc_config->num_beacons < MAX_BEACONS) { - - memset (&(p_misc_config->beacon[p_misc_config->num_beacons]), 0, sizeof(struct beacon_s)); - if (strcasecmp(t, "PBEACON") == 0) { - p_misc_config->beacon[p_misc_config->num_beacons].btype = BEACON_POSITION; - } - else if (strcasecmp(t, "OBEACON") == 0) { - p_misc_config->beacon[p_misc_config->num_beacons].btype = BEACON_OBJECT; - } - else if (strcasecmp(t, "TBEACON") == 0) { - p_misc_config->beacon[p_misc_config->num_beacons].btype = BEACON_TRACKER; - } - else { - p_misc_config->beacon[p_misc_config->num_beacons].btype = BEACON_CUSTOM; - } - - /* Save line number because some errors will be reported later. */ - p_misc_config->beacon[p_misc_config->num_beacons].lineno = line; - - if (beacon_options(t + strlen("xBEACON") + 1, &(p_misc_config->beacon[p_misc_config->num_beacons]), line)) { - p_misc_config->num_beacons++; - } - } - else { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Config file: Maximum number of beacons exceeded on line %d.\n", line); - continue; - } - } - - -/* - * SMARTBEACONING fast_speed fast_rate slow_speed slow_rate turn_time turn_angle turn_slope - */ - - else if (strcasecmp(t, "SMARTBEACON") == 0 || - strcasecmp(t, "SMARTBEACONING") == 0) { - - int n; - -#define SB_NUM(name,sbvar,minn,maxx,unit) \ - t = strtok (NULL, " ,\t\n\r"); \ - if (t == NULL) { \ - text_color_set(DW_COLOR_ERROR); \ - dw_printf ("Line %d: Missing %s for SmartBeaconing.\n", line, name); \ - continue; \ - } \ - n = atoi(t); \ - if (n >= minn && n <= maxx) { \ - p_misc_config->sbvar = n; \ - } \ - else { \ - text_color_set(DW_COLOR_ERROR); \ - dw_printf ("Line %d: Invalid %s for SmartBeaconing. Using default %d %s.\n", \ - line, name, p_misc_config->sbvar, unit); \ - } - -#define SB_TIME(name,sbvar,minn,maxx,unit) \ - t = strtok (NULL, " ,\t\n\r"); \ - if (t == NULL) { \ - text_color_set(DW_COLOR_ERROR); \ - dw_printf ("Line %d: Missing %s for SmartBeaconing.\n", line, name); \ - continue; \ - } \ - n = parse_interval(t,line); \ - if (n >= minn && n <= maxx) { \ - p_misc_config->sbvar = n; \ - } \ - else { \ - text_color_set(DW_COLOR_ERROR); \ - dw_printf ("Line %d: Invalid %s for SmartBeaconing. Using default %d %s.\n", \ - line, name, p_misc_config->sbvar, unit); \ - } - - - SB_NUM ("fast speed", sb_fast_speed, 2, 90, "MPH") - SB_TIME ("fast rate", sb_fast_rate, 10, 300, "seconds") - - SB_NUM ("slow speed", sb_slow_speed, 1, 30, "MPH") - SB_TIME ("slow rate", sb_slow_rate, 30, 3600, "seconds") - - SB_TIME ("turn time", sb_turn_time, 5, 180, "seconds") - SB_NUM ("turn angle", sb_turn_angle, 5, 90, "degrees") - SB_NUM ("turn slope", sb_turn_slope, 1, 255, "deg*mph") - - /* If I was ambitious, I might allow optional */ - /* unit at end for miles or km / hour. */ - - p_misc_config->sb_configured = 1; - } - -/* - * Invalid command. - */ - else { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Config file: Unrecognized command '%s' on line %d.\n", t, line); - } - - } - - fclose (fp); - -/* - * A little error checking for option interactions. - */ - -/* - * Require that MYCALL be set when digipeating or IGating. - * - * Suggest that beaconing be enabled when digipeating. - */ - int i, j, k, b; - - for (i=0; inum_chans; i++) { - for (j=0; jnum_chans; j++) { - - if (p_digi_config->enabled[i][j]) { - - if (strcmp(p_digi_config->mycall[i], "NOCALL") == 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Config file: MYCALL must be set for receive channel %d before digipeating is allowed.\n", i); - p_digi_config->enabled[i][j] = 0; - } - - if (strcmp(p_digi_config->mycall[j], "NOCALL") == 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Config file: MYCALL must be set for transmit channel %d before digipeating is allowed.\n", i); - p_digi_config->enabled[i][j] = 0; - } - - b = 0; - for (k=0; knum_beacons; k++) { - if (p_misc_config->beacon[p_misc_config->num_beacons].sendto_chan == j) b++; - } - if (b == 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Config file: Beaconing should be configured for channel %d when digipeating is enabled.\n", i); - // It's a recommendation, not a requirement. - // Was there some good reason to turn it off in earlier version? - //p_digi_config->enabled[i][j] = 0; - } - } - } - - if (strlen(p_igate_config->t2_login) > 0) { - - if (strcmp(p_digi_config->mycall[i], "NOCALL") == 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Config file: MYCALL must be set for receive channel %d before Rx IGate is allowed.\n", i); - strcpy (p_igate_config->t2_login, ""); - } - if (p_igate_config->tx_chan >= 0 && - strcmp(p_digi_config->mycall[p_igate_config->tx_chan], "NOCALL") == 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Config file: MYCALL must be set for transmit channel %d before Tx IGate is allowed.\n", i); - p_igate_config->tx_chan = -1; - } - } - - } - -} /* end config_init */ - - -/* - * Parse the PBEACON or OBEACON options. - * Returns 1 for success, 0 for serious error. - */ - -static int beacon_options(char *cmd, struct beacon_s *b, int line) -{ - char options[1000]; - char *o; - char *t; - char *p; - int q; - char temp_symbol[100]; - int ok; - char zone[8]; - double easting = G_UNKNOWN; - double northing = G_UNKNOWN; - - strcpy (temp_symbol, ""); - strcpy (zone, ""); - - b->sendto_type = SENDTO_XMIT; - b->sendto_chan = 0; - b->delay = 60; - b->every = 600; - //b->delay = 6; // temp test. - //b->every = 3600; - b->lat = G_UNKNOWN; - b->lon = G_UNKNOWN; - b->alt_m = G_UNKNOWN; - b->symtab = '/'; - b->symbol = '-'; /* house */ - -/* - * cmd should be rest of command line after ?BEACON was removed. - * - * Quoting is required for any values containing spaces. - * This could happen for an object name, comment, symbol description, ... - * To prevent strtok from stopping at those spaces, change them to - * non-breaking space character temporarily. After spliting everything - * up at white space, change them back to normal spaces. - */ - -#define NBSP (' ' + 0x80) - - p = cmd; /* Process from here. */ - o = options; /* to here. */ - q = 0; /* Keep track of whether in quoted part. */ - - for ( ; *p != '\0' ; p++) { - - switch (*p) { - - case '"': - if (!q) { /* opening quote */ - if (*(p-1) != '=') { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Config file: line %d: Suspicious use of \" not after =.\n", line); - dw_printf ("Suggestion: Double it and quote entire value.\n"); - *o++ = '"'; /* Treat as regular character. */ - } - else { - q = 1; - } - } - else { /* embedded or closing quote */ - if (*(p+1) == '"') { - *o++ = '"'; /* reduce double to single */ - p++; - } - else if (isspace(*(p+1)) || *(p+1) == '\0') { - q = 0; - } - else { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Config file: line %d: Suspicious use of \" not at end of value.\n", line); - dw_printf ("Suggestion: Double it and quote entire value.\n"); - *o++ = '"'; /* Treat as regular character. */ - } - } - break; - - case ' ': - - *o++ = q ? NBSP : ' '; - break; - - default: - *o++ = *p; - break; - } - } - *o = '\0'; - - for (t = strtok (options, " \t\n\r"); t != NULL; t = strtok (NULL, " \t\n\r")) { - - char keyword[20]; - char value[200]; - char *e; - char *p; - //int q; - - - e = strchr(t, '='); - if (e == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Config file: No = found in, %s, on line %d.\n", t, line); - return (0); - } - *e = '\0'; - strcpy (keyword, t); - strcpy (value, e+1); - -/* Put back normal spaces. */ - - for (p = value; *p != '\0'; p++) { - // char is signed for MinGW! - if (((int)(*p) & 0xff) == NBSP) *p = ' '; - } - - if (strcasecmp(keyword, "DELAY") == 0) { - b->delay = parse_interval(value,line); - } - else if (strcasecmp(keyword, "EVERY") == 0) { - b->every = parse_interval(value,line); - } - else if (strcasecmp(keyword, "SENDTO") == 0) { - if (value[0] == 'i' || value[0] == 'I') { - b->sendto_type = SENDTO_IGATE; - b->sendto_chan = 0; - } - else if (value[0] == 'r' || value[0] == 'R') { - b->sendto_type = SENDTO_RECV; - b->sendto_chan = atoi(value+1); - } - else if (value[0] == 't' || value[0] == 'T' || value[0] == 'x' || value[0] == 'X') { - b->sendto_type = SENDTO_XMIT; - b->sendto_chan = atoi(value+1); - } - else { - b->sendto_type = SENDTO_XMIT; - b->sendto_chan = atoi(value); - } - } - else if (strcasecmp(keyword, "DEST") == 0) { - b->dest = strdup(value); - for (p = b->dest; *p != '\0'; p++) { - if (islower(*p)) { - *p = toupper(*p); /* silently force upper case. */ - } - } - if (strlen(b->dest) > 9) { - b->dest[9] = '\0'; - } - } - else if (strcasecmp(keyword, "VIA") == 0) { - b->via = strdup(value); - for (p = b->via; *p != '\0'; p++) { - if (islower(*p)) { - *p = toupper(*p); /* silently force upper case. */ - } - } - } - else if (strcasecmp(keyword, "INFO") == 0) { - b->custom_info = strdup(value); - } - else if (strcasecmp(keyword, "OBJNAME") == 0) { - strncpy(b->objname, value, 9); - } - else if (strcasecmp(keyword, "LAT") == 0) { - b->lat = parse_ll (value, LAT, line); - } - else if (strcasecmp(keyword, "LONG") == 0 || strcasecmp(keyword, "LON") == 0) { - b->lon = parse_ll (value, LON, line); - } - else if (strcasecmp(keyword, "ALT") == 0 || strcasecmp(keyword, "ALTITUDE") == 0) { - b->alt_m = atof(value); - } - else if (strcasecmp(keyword, "ZONE") == 0) { - strncpy(zone, value, sizeof(zone)); - } - else if (strcasecmp(keyword, "EAST") == 0 || strcasecmp(keyword, "EASTING") == 0) { - easting = atof(value); - } - else if (strcasecmp(keyword, "NORTH") == 0 || strcasecmp(keyword, "NORTHING") == 0) { - northing = atof(value); - } - else if (strcasecmp(keyword, "SYMBOL") == 0) { - /* Defer processing in case overlay appears later. */ - strcpy (temp_symbol, value); - } - else if (strcasecmp(keyword, "OVERLAY") == 0) { - if (strlen(value) == 1 && (isupper(value[0]) || isdigit(value[0]))) { - b->symtab = value[0]; - } - else { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Config file: Overlay must be one character in range of 0-9 or A-Z, upper case only, on line %d.\n", line); - } - } - else if (strcasecmp(keyword, "POWER") == 0) { - b->power = atoi(value); - } - else if (strcasecmp(keyword, "HEIGHT") == 0) { - b->height = atoi(value); - } - else if (strcasecmp(keyword, "GAIN") == 0) { - b->gain = atoi(value); - } - else if (strcasecmp(keyword, "DIR") == 0 || strcasecmp(keyword, "DIRECTION") == 0) { - strncpy(b->dir, value, 2); - } - else if (strcasecmp(keyword, "FREQ") == 0) { - b->freq = atof(value); - } - else if (strcasecmp(keyword, "TONE") == 0) { - b->tone = atof(value); - } - else if (strcasecmp(keyword, "OFFSET") == 0 || strcasecmp(keyword, "OFF") == 0) { - b->offset = atof(value); - } - else if (strcasecmp(keyword, "COMMENT") == 0) { - b->comment = strdup(value); - } - else if (strcasecmp(keyword, "COMPRESS") == 0 || strcasecmp(keyword, "COMPRESSED") == 0) { - b->compress = atoi(value); - } - else if (strcasecmp(keyword, "MESSAGING") == 0) { - b->messaging = atoi(value); - } - else { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Config file, line %d: Invalid option keyword, %s.\n", line, keyword); - return (0); - } - } - -/* - * Convert UTM coordintes to lat / long. - */ - if (strlen(zone) > 0 || easting != G_UNKNOWN || northing != G_UNKNOWN) { - - if (strlen(zone) > 0 && easting != G_UNKNOWN && northing != G_UNKNOWN) { - - int znum; - char *zlet; - - znum = strtoul(zone, &zlet, 10); - - if (znum >= 1 && znum <= 60) { - - //printf ("zlet = %c 0x%02x\n", *zlet, *zlet); - - if (*zlet == '\0' || strchr ("CDEFGHJKLMNPQRSTUVWX", *zlet) != NULL) { - - if (easting >= 0 && easting <= 999999) { - - if (northing >= 0 && northing <= 9999999) { - - UTMtoLL (WSG84, northing, easting, zone, &b->lat, &b->lon); - - // printf ("config UTM debug: latitude = %.6f, longitude = %.6f\n", b->lat, b->lon); - - } - else { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Config file, line %d: Northing value is out of range.\n", line); - } - } - else { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Config file, line %d: Easting value is out of range.\n", line); - } - } - else { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Config file, line %d: Latitudinal band must be one of CDEFGHJKLMNPQRSTUVWX.\n", line); - } - } - else { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Config file, line %d: UTM zone is out of range.\n", line); - } - } - else { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Config file, line %d: When any of ZONE, EASTING, NORTHING specifed, they must all be specified.\n", line); - } - } - -/* - * Process symbol now that we have any later overlay. - */ - if (strlen(temp_symbol) > 0) { - - if (strlen(temp_symbol) == 2 && - (temp_symbol[0] == '/' || temp_symbol[0] == '\\' || isupper(temp_symbol[0]) || isdigit(temp_symbol[0])) && - temp_symbol[1] >= '!' && temp_symbol[1] <= '~') { - - /* Explicit table and symbol. */ - - if (isupper(b->symtab) || isdigit(b->symtab)) { - b->symbol = temp_symbol[1]; - } - else { - b->symtab = temp_symbol[0]; - b->symbol = temp_symbol[1]; - } - } - else { - - /* Try to look up by description. */ - ok = symbols_code_from_description (b->symtab, temp_symbol, &(b->symtab), &(b->symbol)); - if (!ok) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Config file, line %d: Could not find symbol matching %s.\n", line, temp_symbol); - } - } - } - - return (1); -} - -/* end config.c */ diff --git a/config.h b/config.h deleted file mode 100644 index 534555b1..00000000 --- a/config.h +++ /dev/null @@ -1,156 +0,0 @@ - -/*---------------------------------------------------------------------------- - * - * Name: config.h - * - * Purpose: - * - * Description: - * - *-----------------------------------------------------------------------------*/ - - -#ifndef CONFIG_H -#define CONFIG_H 1 - -#include "audio.h" /* for struct audio_s */ -#include "digipeater.h" /* for struct digi_config_s */ -#include "aprs_tt.h" /* for struct tt_config_s */ -#include "igate.h" /* for struct igate_config_s */ - -/* - * All the leftovers. - * This wasn't thought out. It just happened. - */ - -enum beacon_type_e { BEACON_IGNORE, BEACON_POSITION, BEACON_OBJECT, BEACON_TRACKER, BEACON_CUSTOM }; - -enum sendto_type_e { SENDTO_XMIT, SENDTO_IGATE, SENDTO_RECV }; - - -#define MAX_BEACONS 30 - -struct misc_config_s { - - int num_channels; /* Number of radio channels. */ - - int agwpe_port; /* Port number for the “AGW TCPIP Socket Interface” */ - int kiss_port; /* Port number for the “KISS” protocol. */ - int enable_kiss_pt; /* Enable pseudo terminal for KISS. */ - /* Want this to be off by default because it hangs */ - /* after a while if nothing is reading from other end. */ - - char nullmodem[40]; /* Serial port name for our end of the */ - /* virtual null modem for native Windows apps. */ - - char nmea_port[40]; /* Serial port name for NMEA communication with GPS */ - /* receiver and/or mapping application. */ - - char logdir[80]; /* Directory for saving activity logs. */ - - int sb_configured; /* TRUE if SmartBeaconing is configured. */ - int sb_fast_speed; /* MPH */ - int sb_fast_rate; /* seconds */ - int sb_slow_speed; /* MPH */ - int sb_slow_rate; /* seconds */ - int sb_turn_time; /* seconds */ - int sb_turn_angle; /* degrees */ - int sb_turn_slope; /* degrees * MPH */ - - - int num_beacons; /* Number of beacons defined. */ - - struct beacon_s { - - enum beacon_type_e btype; /* Position or object. */ - - int lineno; /* Line number from config file for later error messages. */ - - enum sendto_type_e sendto_type; - - /* SENDTO_XMIT - Usually beacons go to a radio transmitter. */ - /* chan, below is the channel number. */ - /* SENDTO_IGATE - Send to IGate, probably to announce my position */ - /* rather than relying on someone else to hear */ - /* me on the radio and report me. */ - /* SENDTO_RECV - Pretend this was heard on the specified */ - /* radio channel. Mostly for testing. It is a */ - /* convenient way to send packets to attached apps. */ - - int sendto_chan; /* Transmit or simulated receive channel for above. Should be 0 for IGate. */ - - int delay; /* Seconds to delay before first transmission. */ - - int every; /* Time between transmissions, seconds. */ - /* Remains fixed for PBEACON and OBEACON. */ - /* Dynamically adjusted for TBEACON. */ - - time_t next; /* Unix time to transmit next one. */ - - char *dest; /* NULL or explicit AX.25 destination to use */ - /* instead of the software version such as APDW11. */ - - int compress; /* Use more compact form? */ - - char objname[10]; /* Object name. Any printable characters. */ - - char *via; /* Path, e.g. "WIDE1-1,WIDE2-1" or NULL. */ - - char *custom_info; /* Info part for handcrafted custom beacon. */ - /* Ignore the rest below if this is set. */ - - int messaging; /* Set messaging attribute for position report. */ - /* i.e. Data Type Indicator of '=' rather than '!' */ - - double lat; /* Latitude and longitude. */ - double lon; - float alt_m; /* Altitude in meters. */ - - char symtab; /* Symbol table: / or \ or overlay character. */ - char symbol; /* Symbol code. */ - - float power; /* For PHG. */ - float height; - float gain; /* Original protocol spec was unclear. */ - /* Addendum 1.1 clarifies it is dBi not dBd. */ - - char dir[3]; /* 1 or 2 of N,E,W,S, or empty for omni. */ - - float freq; /* MHz. */ - float tone; /* Hz. */ - float offset; /* MHz. */ - - char *comment; /* Comment or NULL. */ - - - } beacon[MAX_BEACONS]; - -}; - - -#define MIN_IP_PORT_NUMBER 1024 -#define MAX_IP_PORT_NUMBER 49151 - - -#define DEFAULT_AGWPE_PORT 8000 /* Like everyone else. */ -#define DEFAULT_KISS_PORT 8001 /* Above plus 1. */ - - -#define DEFAULT_NULLMODEM "COM3" /* should be equiv. to /dev/ttyS2 on Cygwin */ - - - - -extern void config_init (char *fname, struct audio_s *p_modem, - struct digi_config_s *digi_config, - struct tt_config_s *p_tt_config, - struct igate_config_s *p_igate_config, - struct misc_config_s *misc_config); - - - -#endif /* CONFIG_H */ - -/* end config.h */ - - diff --git a/data/CMakeLists.txt b/data/CMakeLists.txt new file mode 100644 index 00000000..7972cc23 --- /dev/null +++ b/data/CMakeLists.txt @@ -0,0 +1,41 @@ +# +# Update: 1 May 2023 (still 1.7 dev version) +# +# The original intention was to allow an easy way to download the most +# recent versions of some files. +# +# "update-data" would only work once. +# +# These locations are no longer being maintained: +# http://www.aprs.org/aprs11/tocalls.txt -- 14 Dec 2021 +# http://www.aprs.org/symbols/symbols-new.txt -- 17 Mar 2021 +# http://www.aprs.org/symbols/symbolsX.txt -- 25 Nov 2015 +# so there is no reason to provide a capability grab the latest version. +# +# Rather than fixing an obsolete capability, it will just be removed. +# +# The destination field is often used to identify the manufacturer/model. +# These are not hardcoded into Dire Wolf. Instead they are read from +# a file called tocalls.txt at application start up time. +# +# The original permanent symbols are built in but the "new" symbols, +# using overlays, are often updated. These are also read from files. +# + + +include(ExternalProject) + +set(TOCALLS_TXT "tocalls.txt") +set(SYMBOLS-NEW_TXT "symbols-new.txt") +set(SYMBOLSX_TXT "symbolsX.txt") +set(CUSTOM_BINARY_DATA_DIR "${CMAKE_BINARY_DIR}/data") + +# we can also move to a separate cmake file and use file(download) +# see conf/install_conf.cmake as example +file(COPY "${CUSTOM_DATA_DIR}/${TOCALLS_TXT}" DESTINATION "${CUSTOM_BINARY_DATA_DIR}") +file(COPY "${CUSTOM_DATA_DIR}/${SYMBOLS-NEW_TXT}" DESTINATION "${CUSTOM_BINARY_DATA_DIR}") +file(COPY "${CUSTOM_DATA_DIR}/${SYMBOLSX_TXT}" DESTINATION "${CUSTOM_BINARY_DATA_DIR}") + +install(FILES "${CUSTOM_BINARY_DATA_DIR}/${TOCALLS_TXT}" DESTINATION ${INSTALL_DATA_DIR}) +install(FILES "${CUSTOM_BINARY_DATA_DIR}/${SYMBOLS-NEW_TXT}" DESTINATION ${INSTALL_DATA_DIR}) +install(FILES "${CUSTOM_BINARY_DATA_DIR}/${SYMBOLSX_TXT}" DESTINATION ${INSTALL_DATA_DIR}) diff --git a/symbols-new.txt b/data/symbols-new.txt similarity index 70% rename from symbols-new.txt rename to data/symbols-new.txt index be0a5589..aa6fc7d2 100644 --- a/symbols-new.txt +++ b/data/symbols-new.txt @@ -1,37 +1,55 @@ -APRS SYMBOL OVERLAY and EXTENSION TABLES in APRS 1.2 28 Aug 2014 ---------------------------------------------------------------------- +APRS SYMBOL OVERLAY and EXTENSION TABLES in APRS 1.2 17 Mar 2021 +------------------------------------------------------------------------ + +BACKGROUND: Since October 2007, overlay characters (36/symbol) are +allowed on all symbols. This allows thousands of uniquely specified +symbols instead of the original 188 (94 primary and 94 alternate). +But the master symbol document, http://aprs.org/symbols/symbolsX.txt, +only has one line per symbol. So this added overlay list below gives +us thousands of new symbol codes. + +17 Mar 21 Added L& for LORA Igate +24 Jun18: Updated CAR symbols +17 Jun18: Added several overlays for RAIL symbol +03 Apr17: Added Methane Hazard symbol "MH" +13 Feb17: Added Ez = Emergency Power (shelter), Cars: P> = Plugin + S> = Solar powered. Moved Ham club C- to Buildings Ch. + Added C- to house for combined renewables and added R% + Renewable to power plants + +18 Oct16: Added G,Y,R for Flood gauges + N for Normal.(on H2O symbol) + Added DIGIPEATERS +22 Mar16: Added A0 overlay circle for ALSTAR nodes and V0 for VOIP. + Combined echolink and IRLP. P& for PSKmail node. W& for + Wires-X (was W0 for WiresII). Ya for Yaesu C4FM repeaters + +Update 29 Oct 2015: Reorgainized list to Alphabetical Order. + + Added many new Balloons (due to lost DoD radar Blimp yesterday) + + Confirmed D^ for Drones was already in there since 2014 + + Added R^ type aircraft for remotely piloted + + Added S^ Solar Powered Aircraft + + Noticed all new category \= is availalbe. Had been shown ast + APRStt, but that was changed in 2009 to overlay BOX symbols. -BACKGROUND: This file addresses new additions proposals (OVERLAYS) -to the APRS symbol set after 1 October 2007. The master symbol -document remains on the www.aprs.org/symbols/symbolsX.txt page. - - -NOTE: There was confusion with different copies of this file on -different web pages and links. THIS file is now assumed to be the -CORRECT one. +UPDATES/REVISIONS/CORRECTIONS: +2014 Added numerous OpenAPRS symbol. Changed Da to DSTAR from Dutch + ARES. Added Subs to ships and lots of Aircraft overlays. +2013 Added ship overlay Jet Ski. Ham Club as C overlay on House, C- +2011 Added T and 2 overlays for TX 1 and 2 hop IGates + Added overlays to (;) Portables Added Radiation Detector (RH) +2010 Byonics requested (BY) and added #A to the table +2009 Added W0 for Yaesu WIRES and APRStt symbol to overlayed BOX (#A) +2008 Added RFID R=, Babystroller B], Radio#Y, skull&Xbones XH -UPDATES/REVISIONS/CORRECTIONS: -28 Aug 14 Added numerous OpenAPRS symbols see "(new Aug 2014)" -20 May 14 Changed Da to DSTAR (2700 of them) from Dutch Ares -19 May 14 Added Submarine&torpedo to ships and lots of Aircraft - search for "(new may 2014)" -07 Oct 13 Added new overlays to ships such as Jet Ski, Js - Added Ham Club symbol as a C overlay on House, C- -19 Sep 11 Added T and 2 overlays for TX 1 and 2 hop IGates - Added overlays to (;) portable, to show event types -23 Mar 11 Added Radiation Detector (RH) -20 Apr 10 Byonics requested (BY) -04 Jan 10 added #A to the table (correcting earlier omission) -12 Oct 09 Added W0 for Yaesu WIRES nodes -09 Apr 09 Changed APRStt symbol to overlayed BOX (#A) -21 Aug 08 Added RFID R=, Stroller B], Radios#Y, & skull&Xbones (XH) -27 Apr 08 Added some definitions of the numbered circle #0. -25 Mar 08 Added these new definitions of overlays: - -Original Alternate Symbol codes being modified for new Overlay Use: +DEPRICATION AND MAJOR REVISION: 25 Mar 08 Modified several Alternate +Symbol codes for expanded Overlays. The following alternate base +symbols were redefined so that the basic symbol could take on dozens +of unique overlay definitions: +\= - Had been undefined +\0 - Several overlays for the numbered Circle \A - (BOX symbol) APRStt(DTMF), RFID users, XO (OLPC) \' - Was Crash Site. Now expanded to be INCIDENT sites \% - is an overlayed Powerplant. See definitions below @@ -41,16 +59,17 @@ Original Alternate Symbol codes being modified for new Overlay Use: \u - Overlay Trucks. "Tu" is a tanker. "Gu" is a gas truck, etc \< - Advisories may now have overlays \8 - Nodes with overlays. "G8" would be 802.11G -\[ - \[ is wall cloud, but overlays are humans. S[ is a skier. -\h - Buildings. \h is a Ham store, "Hh" is Home Depot, etc. +\[ - \[ was wall cloud, but overlays are humans. S[ is a skier. +\h - Was Ham store, Now Overlays are buildings "Hh" Home Depot, etc. + -Previous edition was 4 Oct 2007. +4 Oct 2007. ORIGINAL EXPANSION to OVERLAYS ON ALL SYMBOLS In April 2007, a proposal to expand the use of overlay bytes for the extension of the APRS symbol set was added to the draft APRS1.2 addendum web page. The following document addresses that proposal: -www.aprs.org/symbols/symbols-overlays.txt +http://aprs.org/symbols/symbols-overlays.txt For details on Upgrading your symbol set, please see the background information on Symbols prepared by Stephen Smith, WA8LMF: @@ -80,8 +99,9 @@ small subset of alternate symbols. Those original overlayable alternate symbols were labeled with a "#" and called "numbered" symbols. (UIview requires "No." in the symbols.ini file) -STATUS OF OVERLAYS 1 OCTOBER 2007: the APRS symbol set only had a -few remaining unused symbol codes that had not yet been defined: +STATUS OF OVERLAYS 1 OCTOBER 2007: the APRS symbol set was limited +to about 94 symbols and only had a few remaining unused symbol +codes that had not yet been defined: OF THE 94 Primary Symbols. The following were available: 10 symbols (/0 - /9) that mostly look like billiard balls now @@ -93,7 +113,7 @@ OF THE 94 Alternate Symbols. The following were available: 8 series \1 through \8 that can support 36 overlays each 3 reserved series. -ADDITIONAL OVERLAY PROPOSAL: But any of the other 79 alternate +BASIS FOR OVERLAY EXPANSION: But any of the other 79 alternate symbols could all have multiple (36) overlays if they can make sense with the existing underlying basic symbol that we have been using for that basic alternate symbol. That is, any new definition of a @@ -114,20 +134,28 @@ letting that define a new graphic just for that combination. The following tables will attempt to keep track of these and any other useful generic applications of overlay characters. +AMPLIFIED some existing ALTERNATE SYMBOL Overlays: (Aug 2014) change Flooding #W to include Avalanche, Mudslide/Landslide -change \' to crash & incident sites -change \D to DEPOT family -change overlayed car to generic with (1-9 overlays) +Update #' name to crash & incident sites +Update \D (was available) to DEPOT family +change overlayed car to generic Vehicle with (1-9 overlays) + +ADVISORIES: #< (new expansion possibilities) +/< = motorcycle +\< = Advisory (single gale flag) AIRCRAFT /^ = LARGE Aircraft \^ = top-view originally intended to point in direction of flight +A^ = Autonomous (2015) D^ = Drone (new may 2014) -E^ = Enemy aircraft (too bad I cant use the original Hostile) +E^ = Electric aircraft (2015) H^ = Hovercraft (new may 2014) J^ = JET (new may 2014) M^ = Missle (new may 2014) P^ = Prop (new Aug 2014) +R^ = Remotely Piloted (new 2015) +S^ = Solar Powered (new 2015) V^ = Vertical takeoff (new may 2014) X^ = Experimental (new Aug 2014) @@ -138,6 +166,72 @@ U$ = US dollars L$ = Brittish Pound Y$ = Japanese Yen +ARRL or DIAMOND: #a +/a = Ambulance +Aa = ARES +Da = DSTAR (had been ARES Dutch) +Ga = RSGB Radio Society of Great Brittan +Ra = RACES +Sa = SATERN Salvation Army +Wa = WinLink +Ya = C4FM Yaesu repeaters + +BALLOONS and lighter than air #O (All new Oct 2015) +/O = Original Balloon (think Ham balloon) +\O = ROCKET (amateur)(2007) +BO = Blimp (2015) +MO = Manned Balloon (2015) +TO = Teathered (2015) +CO = Constant Pressure - Long duration (2015) +RO = Rocket bearing Balloon (Rockoon) (2015) +WO = World-round balloon (2018) + +BOX SYMBOL: #A (and other system inputted symbols) +/A = Aid station +\A = numbered box +9A = Mobile DTMF user +7A = HT DTMF user +HA = House DTMF user +EA = Echolink DTMF report +IA = IRLP DTMF report +RA = RFID report +AA = AllStar DTMF report +DA = D-Star report +XA = OLPC Laptop XO +etc + +BUILDINGS: #h +/h = Hospital +\h = Ham Store ** <= now used for HAMFESTS +Ch = Club (ham radio) +Eh = Electronics Store +Fh = HamFest (new Aug 2014) +Hh = Hardware Store etc.. + +CARS: #> (Vehicles) +/> = normal car (side view) +\> = Top view and symbol POINTS in direction of travel +#> = Reserve overlays 1-9 for numbered cars (new Aug 2014) +3> = Model 3 (Tesla) +B> = BEV - Battery EV(was E for electric) +D> = DIY - Do it yourself +E> = Ethanol (was electric) +F> = Fuelcell or hydrogen +H> = Hybrid +L> = Leaf +P> = PHEV - Plugin-hybrid +S> = Solar powered +T> = Tesla (temporary) +V> = Volt (temporary) +X> = Model X + +CIVIL DEFENSE or TRIANGLE: #c +/c = Incident Command Post +\c = Civil Defense +Dc = Decontamination (new Aug 2014) +Rc = RACES +Sc = SATERN mobile canteen + DEPOT /D = was originally undefined \D = was drizzle (moved to ' ovlyD) @@ -149,39 +243,56 @@ BD = Bus Depot (new Aug 2014) LD = LIght Rail or Subway (new Aug 2014) SD = Seaport Depot (new Aug 2014) +DIGIPEATERS +/# - Generic digipeater +1# - WIDE1-1 digipeater +A# - Alternate input (i.e. 144.990MHz) digipeater +E# - Emergency powered (assumed full normal digi) +I# - I-gate equipped digipeater +L# - WIDEn-N with path length trapping +P# - PacComm +S# - SSn-N digipeater (includes WIDEn-N) +X# - eXperimental digipeater +V# - Viscous https://github.com/PhirePhly/aprx/blob/master/ViscousDigipeater.README +W# - WIDEn-N, SSn-N and Trapping + EMERGENCY: #! /! = Police/Sheriff, etc \! = Emergency! E! = ELT or EPIRB (new Aug 2014) V! = Volcanic Eruption or Lava (new Aug 2014) -POWER PLANT: #% -/% = DX cluster <= the original primary table definition -C% = Coal -E% = Emergency (new Aug 2014) -G% = Geothermal -H% = Hydroelectric -N% = Nuclear -P% = Portable (new Aug 2014) -S% = Solar -T% = Turbine -W% = Wind +EYEBALL (EVENT) and VISIBILITY #E +/E = Eyeball for special live events +\E = (existing smoke) the symbol with no overlay +HE = (H overlay) Haze +SE = (S overlay) Smoke +BE = (B overlay) Blowing Snow was \B +DE = (D overlay) blowing Dust or sand was \b +FE = (F overlay) Fog was \{ GATEWAYS: #& /& = HF Gateway <= the original primary table definition I& = Igate Generic (please use more specific overlay) +L& - Lora Igate R& = Receive only IGate (do not send msgs back to RF) +P& = PSKmail node T& = TX igate with path set to 1 hop only) +W& = WIRES-X as opposed to W0 for WiresII 2& = TX igate with path set to 2 hops (not generally good idea) -INCIDENT SITES: #' -/' = Small Aircraft (original primary symbol) -\' = Airplane Crash Site <= the original alternate deifinition -A' = Automobile crash site -H' = Hazardous incident -M' = Multi-Vehicle crash site -P' = Pileup -T' = Truck wreck +GPS devices: #\ +/\ = Triangle DF primary symbol +\\ = was undefined alternate symbol +A\ = Avmap G5 * <= Recommend special symbol + +HAZARDS: #H +/H = hotel +\H = Haze +MH = Methane Hazard (new Apr 2017) +RH = Radiation detector (new mar 2011) +WH = Hazardous Waste +XH = Skull&Crossbones HUMAN SYMBOL: #[ /[ = Human @@ -194,21 +305,32 @@ H[ = Hiker HOUSE: #- /- = House \- = (was HF) -5- = 50 Hz mains power -6- = 60 Hz mains power -B- = Backup Battery Power -C- = Club, as in Ham club -E- = Emergency power +5- = 50 Hz if non standard +6- = 60 Hz if non standard +B- = Battery or off grid +C- = Combined alternatives +E- = Emergency power (grid down) G- = Geothermal H- = Hydro powered O- = Operator Present -S- = Solar Powered -W- = Wind powered +S- = Solar Power +W- = Wind power + +INCIDENT SITES: #' +/' = Small Aircraft (original primary symbol) +\' = Airplane Crash Site <= the original alternate deifinition +A' = Automobile crash site +H' = Hazardous incident +M' = Multi-Vehicle crash site +P' = Pileup +T' = Truck wreck NUMBERED CIRCLES: #0 +A0 = Allstar Node (A0) E0 = Echolink Node (E0) I0 = IRLP repeater (I0) S0 = Staging Area (S0) +V0 = Echolink and IRLP (VOIP) W0 = WIRES (Yaesu VOIP) NETWORK NODES: #8 @@ -223,48 +345,38 @@ I; = Islands on the air S; = Summits on the air W; = WOTA -ADVISORIES: #< (new expansion possibilities) -/< = motorcycle -\< = Advisory (single gale flag) +POWER and ENERGY: #% +/% = DX cluster <= the original primary table definition +C% = Coal +E% = Emergency (new Aug 2014) +G% = Gas Turbine +H% = Hydroelectric +N% = Nuclear +P% = Portable (new Aug 2014) +R% = Renewable (hydrogen etc fuels) +S% = Solar +T% = Thermal (geo) +W% = Wind -CARS: #> (Vehicles) -/> = normal car (side view) -\> = Top view and symbol POINTS in direction of travel -#> = Reserve overlays 1-9 for numbered cars (new Aug 2014) -E> = Electric -H> = Hybrid -S> = Solar powered -V> = GM Volt +RAIL Symbols: #= +/= = generic train (use steam engine shape for quick recognition) +\= = tbd (use same symbol for now) +B= = Bus-rail/trolley/streetcar/guiderail +C= = Commuter +D= = Diesel +E= = Electric +F= = Freight +G= = Gondola +H= = High Speed Rail (& Hyperloop?) +I= = Inclined Rail +L= = eLevated +M= = Monorail +P= = Passenger +S= = Steam +T= = Terminal (station) +U= = sUbway (& Hyperloop?) +X= = eXcursion -BOX SYMBOL: #A (and other system inputted symbols) -/A = Aid station -\A = numbered box -9A = Mobile DTMF user -7A = HT DTMF user -HA = House DTMF user -EA = Echolink DTMF report -IA = IRLP DTMF report -RA = RFID report -AA = AllStar DTMF report -DA = D-Star report -XA = OLPC Laptop XO -etc - -EYEBALL and VISIBILITY #E -/E = Eyeball for special live events -\E = (existing smoke) the symbol with no overlay -HE = (H overlay) Haze -SE = (S overlay) Smoke -BE = (B overlay) Blowing Snow was \B -DE = (D overlay) blowing Dust or sand was \b -FE = (F overlay) Fog was \{ - -HAZARDS: #H -/H = hotel -\H = Haze -RH = Radiation detector (new mar 2011) -WH = Hazardous Waste -XH = Skull&Crossbones RESTAURANTS: #R \R = Restaurant (generic) @@ -282,35 +394,6 @@ IY = Icom KY = Kenwood * <= Recommend special symbol YY = Yaesu/Standard* <= Recommend special symbol -GPS devices: #\ -/\ = Triangle DF primary symbol -\\ = was undefined alternate symbol -A\ = Avmap G5 * <= Recommend special symbol - -ARRL or DIAMOND: #a -/a = Ambulance -Aa = ARES -Da = DSTAR (had been ARES Dutch) -Ga = RSGB Radio Society of Great Brittan -Ra = RACES -Sa = SATERN Salvation Army -Wa = WinLink - -CIVIL DEFENSE or TRIANGLE: #c -/c = Incident Command Post -\c = Civil Defense -Dc = Decontamination (new Aug 2014) -Rc = RACES -Sc = SATERN mobile canteen - -BUILDINGS: #h -/h = Hospital -\h = Ham Store ** <= now used for HAMFESTS -Fh = HamFest (new Aug 2014) -Hh = Home Dept etc.. -Mh = Morgue -Ch = Clinic -Th = Triage SPECIAL VEHICLES: #k /k = truck @@ -318,6 +401,15 @@ SPECIAL VEHICLES: #k 4k = 4x4 Ak = ATV (all terrain vehicle) +SHELTERS: #z +/z = was available +\z = overlayed shelter +Cz = Clinic (new Aug 2014) +Ez = Emergency Power +Gz = Government building (new Aug 2014) +Mz = Morgue (new Aug 2014) +Tz = Triage (new Aug 2014) + SHIPS: #s /s = Power boat (ship) side view \s = Overlay Boat (Top view) @@ -341,17 +433,28 @@ Ws = Wing-in-Ground effect (or Hovercraft) Xs = Passenger (paX)(ferry) Ys = Sailing (large ship) - TRUCKS: #u /u = Truck (18 wheeler) \u = truck with overlay -Bu = Buldozer/construction (new Aug 2014) +Bu = Buldozer/construction/Backhoe (new Aug 2014) Gu = Gas Pu = Plow or SnowPlow (new Aug 2014) Tu = Tanker Cu = Chlorine Tanker Hu = Hazardous +WATER #w +/w = Water Station or other H2O +\w = flooding (or Avalanche/slides) +Aw = Avalanche +Gw = Green Flood Gauge +Mw = Mud slide +Nw = Normal flood gauge (blue) +Rw = Red flood gauge +Sw = Snow Blockage +Yw = Yellow flood gauge + + Anyone can use any overlay on any of the overlayable symbols for any special purpose. We are not trying to document all possible such diff --git a/symbolsX.txt b/data/symbolsX.txt similarity index 94% rename from symbolsX.txt rename to data/symbolsX.txt index f97adff6..2b54b15d 100644 --- a/symbolsX.txt +++ b/data/symbolsX.txt @@ -1,4 +1,4 @@ -APRS SYMBOLS (Icons) 28 Aug 2014 +APRS SYMBOLS (Icons) 25 Nov 2015 ----------------------------------------------------------------------- WB4APR @@ -28,6 +28,9 @@ http://aprs.org/symbols/symbols-background.txt UPDATE CHRONOLOGY: +25 Nov 15: Found APRStt symbol poorly documented Was shown as "\=". + But has been \A BOX symbol with variety of overlays +23 Jun 15: Changed Aircraft to SSID-11 and Human to SSID-7 28 Aug 14: Added notation on newly availble BASE codes (begun in 2007) Old WX versions of these: Bb{*:DFegJp were moved to ovlays Expanded #w Flooding to include Avalanches, Mud/Landslides @@ -178,7 +181,7 @@ for the stand-alone trackers described above. /$ BE PHONE \$ OEO Bank or ATM (green box) /% BF DX CLUSTER \% OFO Power Plant with overlay /& BG HF GATEway \& OG# I=Igte R=RX T=1hopTX 2=2hopTX -/' BH Small AIRCRAFT (SSID = 7) \' OHO Crash (& now Incident sites) +/' BH Small AIRCRAFT (SSID-11) \' OHO Crash (& now Incident sites) /( BI Mobile Satellite Station \( OIO CLOUDY (other clouds w ovrly) /) BJ Wheelchair (handicapped) \) OJO Firenet MEO, MODIS Earth Obs. /* BK SnowMobile \* OK AVAIL (SNOW moved to ` ovly S) @@ -203,9 +206,9 @@ for the stand-alone trackers described above. /9 P9 TBD (as mobiles at events)\9 A9 Gas Station (blue pump) /: MR FIRE \: NR AVAIL (Hail ==> ` ovly H) /; MS Campground (Portable ops) \; NSO Park/Picnic + overlay events -/< MT Motorcycle (SSID =10) \< NTO ADVISORY (one WX flag) -/= MU RAILROAD ENGINE \= NUO APRStt Touchtone (DTMF users) -/> MV CAR (SSID = 9) \> NV# OVERLAYED CARs & Vehicles +/< MT Motorcycle (SSID-10) \< NTO ADVISORY (one WX flag) +/= MU RAILROAD ENGINE \= NUO avail. symbol overlay group +/> MV CAR (SSID-9) \> NV# OVERLAYED CARs & Vehicles /? MW SERVER for Files \? NW INFO Kiosk (Blue box with ?) /@ MX HC FUTURE predict (dot) \@ NX HURICANE/Trop-Storm /A PA Aid Station \A AA# overlayBOX DTMF & RFID & XO @@ -222,19 +225,19 @@ for the stand-alone trackers described above. /L PL PC user (Jan 03) \L AL Lighthouse /M PM MacAPRS \M AMO MARS (A=Army,N=Navy,F=AF) /N PN NTS Station \N AN Navigation Buoy -/O PO BALLOON (SSID =11) \O AO Overlay Balloon (Rocket = \O) +/O PO BALLOON (SSID-11) \O AO Overlay Balloon (Rocket = \O) /P PP Police \P AP Parking /Q PQ TBD \Q AQ QUAKE -/R PR REC. VEHICLE (SSID =13) \R ARO Restaurant +/R PR REC. VEHICLE (SSID-13) \R ARO Restaurant /S PS SHUTTLE \S AS Satellite/Pacsat /T PT SSTV \T AT Thunderstorm -/U PU BUS (SSID = 2) \U AU SUNNY +/U PU BUS (SSID-2) \U AU SUNNY /V PV ATV \V AV VORTAC Nav Aid /W PW National WX Service Site \W AW# # NWS site (NWS options) -/X PX HELO (SSID = 6) \X AX Pharmacy Rx (Apothicary) -/Y PY YACHT (sail) (SSID = 5) \Y AYO Radios and devices +/X PX HELO (SSID-6) \X AX Pharmacy Rx (Apothicary) +/Y PY YACHT (sail) (SSID-5) \Y AYO Radios and devices /Z PZ WinAPRS \Z AZ AVAIL -/[ HS Human/Person (HT) \[ DSO W.Cloud (& humans w Ovrly) +/[ HS Human/Person (SSID-7) \[ DSO W.Cloud (& humans w Ovrly) /\ HT TRIANGLE(DF station) \\ DTO New overlayable GPS symbol /] HU MAIL/PostOffice(was PBBS) \] DU AVAIL /^ HV LARGE AIRCRAFT \^ DV# other Aircraft ovrlys (2014) @@ -243,17 +246,17 @@ for the stand-alone trackers described above. /$ XYZ LOWER CASE SYMBOL TABLE \$ XYZ SECONDARY SYMBOL TABLE (\) -- --- ------------------------ -- --- -------------------------- -/a LA AMBULANCE (SSID = 1) \a SA#O ARRL,ARES,WinLINK,Dstar, etc -/b LB BIKE (SSID = 4) \b SB AVAIL(Blwng Dst/Snd => E ovly) +/a LA AMBULANCE (SSID-1) \a SA#O ARRL,ARES,WinLINK,Dstar, etc +/b LB BIKE (SSID-4) \b SB AVAIL(Blwng Dst/Snd => E ovly) /c LC Incident Command Post \c SC#O CD triangle RACES/SATERN/etc /d LD Fire dept \d SD DX spot by callsign /e LE HORSE (equestrian) \e SE Sleet (& future ovrly codes) -/f LF FIRE TRUCK (SSID = 3) \f SF Funnel Cloud +/f LF FIRE TRUCK (SSID-3) \f SF Funnel Cloud /g LG Glider \g SG Gale Flags /h LH HOSPITAL \h SHO Store. or HAMFST Hh=HAM store /i LI IOTA (islands on the air) \i SI# BOX or points of Interest /j LJ JEEP (SSID-12) \j SJ WorkZone (Steam Shovel) -/k LK TRUCK (SSID = 14) \k SKO Special Vehicle SUV,ATV,4x4 +/k LK TRUCK (SSID-14) \k SKO Special Vehicle SUV,ATV,4x4 /l LL Laptop (Jan 03) (Feb 07) \l SL Areas (box,circles,etc) /m LM Mic-E Repeater \m SM Value Sign (3 digit display) /n LN Node (black bulls-eye) \n SN# OVERLAY TRIANGLE @@ -264,7 +267,7 @@ for the stand-alone trackers described above. /s LS SHIP (pwr boat) (SSID-8) \s SS# OVERLAY SHIP/boats /t LT TRUCK STOP \t ST Tornado /u LU TRUCK (18 wheeler) \u SU# OVERLAYED TRUCK -/v LV VAN (SSID = 15) \v SV# OVERLAYED Van +/v LV VAN (SSID-15) \v SV# OVERLAYED Van /w LW WATER station \w SWO Flooding (Avalanches/Slides) /x LX xAPRS (Unix) \x SX Wreck or Obstruction ->X<- /y LY YAGI @ QTH \y SY Skywarn diff --git a/data/tocalls.txt b/data/tocalls.txt new file mode 100644 index 00000000..169c9868 --- /dev/null +++ b/data/tocalls.txt @@ -0,0 +1,326 @@ + +APRS TO-CALL VERSION NUMBERS 14 Dec 2021 +--------------------------------------------------------------------- + WB4APR + + +07 Jun 23 Added APK005 for Kenwood TH-D75 +14 Dec 21 Added APATAR ATA-R APRS Digipeater by TA7W/OH2UDS and TA6AEU +26 Sep 21 Added APRRDZ EPS32 https://github.com/dl9rdz/rdz_ttgo_sonde +18 Sep 21 Added APCSS for AMSAT Cubesat Simulator https://cubesatsim.org +16 Sep 21 Added APY05D for Yaesu FT5D series +04 Sep 21 APLOxx LoRa KISS TNC/Tracker https://github.com/SQ9MDD/TTGO-T-Beam-LoRa-APRS +24 Aug 21 Added APLSxx SARIMESH http://www.sarimesh.net +22 Aug 21 Added APE2Ax for VA3NNW's Email-2-APRS ap +30 Jun 21 Added APCNxx for carNET by DG5OAW +14 Jun 21 Added APN2xx for NOSaprs JNOS 2.0 - VE4KLM +24 Apr 21 Added APMPAD for DF1JSL's WXBot clone and extension +20 Apr 21 Added APLCxx for APRScube by DL3DCW +19 Apr 21 Added APVMxx for DRCC-DVM Voice (Digital Radio China Club) +13 Apr 21 Added APIxxx for all Dstar ICOMS (APRS via DPRS) +23 MAr 20 Added APW9xx For 9A9Y Weather Tracker +16 Feb 21 Added API970 for I com 9700 + +2020 Added APHBLx,APIZCI,APLGxx,APLTxx,APNVxx,APY300,APESPG,APESPW + APGDTx,APOSWx,APOSBx,APBT62,APCLUB,APMQxx +2019 Added APTPNx,APJ8xx,APBSDx,APNKMX,APAT51,APMGxx,APTCMA, + APATxx,APQTHx,APLIGx +2018 added APRARX,APELKx,APGBLN,APBKxx,APERSx,APTCHE +2017 Added APHWxx,APDVxx,APPICO,APBMxx,APP6xx,APTAxx,APOCSG,APCSMS, + APPMxx,APOFF,APDTMF,APRSON,APDIGI,APSAT,APTBxx,APIExx, + APSFxx +2016 added APYSxx,APINxx,APNICx,APTKPT,APK004,APFPRS,APCDS0,APDNOx +2015 Added APSTPO,APAND1,APDRxx,APZ247,APHTxx,APMTxx,APZMAJ + APB2MF,APR2MF,APAVT5 + + + + +In APRS, the AX.25 Destination address is not used for packet +routing as is normally done in AX.25. So APRS uses it for two +things. The initial APxxxx is used as a group identifier to make +APRS packets instanantly recognizable on shared channels. Most +applicaitons ignore all non APRS packets. The remaining 4 xxxx +bytes of the field are available to indicate the software version +number or application. The following applications have requested +a TOCALL number series: + +Authors with similar alphabetic requirements are encouraged to share +their address space with other software. Work out agreements amongst +yourselves and keep me informed. + + + + + APn 3rd digit is a number + AP1WWX TAPR T-238+ WX station + AP1MAJ Martyn M1MAJ DeLorme inReach Tracker + AP4Rxy APRS4R software interface + APnnnD Painter Engineering uSmartDigi D-Gate DSTAR Gateway + APnnnU Painter Engineering uSmartDigi Digipeater + APA APAFxx AFilter. + APAGxx AGATE + APAGWx SV2AGW's AGWtracker + APALxx Alinco DR-620/635 internal TNC digis. "Hachi" ,JF1AJE + APAXxx AFilterX. + APAHxx AHub + APAND1 APRSdroid (pre-release) http://aprsdroid.org/ + APAMxx Altus Metrum GPS trackers + APATAR ATA-R APRS Digipeater by TA7W/OH2UDS and TA6AEU + APAT8x for Anytone. 81 for 878 HT + APAT51 for Anytone AT-D578UV APRS mobile radio + APAVT5 SainSonic AP510 which is a 1watt tracker + APAWxx AGWPE + APB APBxxx Beacons or Rabbit TCPIP micros? + APB2MF DL2MF - MF2APRS Radiosonde for balloons + APBLxx BigRedBee BeeLine + APBLO MOdel Rocketry K7RKT + APBKxx PY5BK Bravo Tracker in Brazil + APBPQx John G8BPQ Digipeater/IGate + APBMxx BrandMeister DMR Server for R3ABM + APBSDx HamBSD https://hambsd.org/ + APBT62 BTech DMR 6x2 + APC APCxxx Cellular applications + APCBBx VE7UDP Blackberry Applications + APCDS0 Leon Lessing ZS6LMG's cell tracker + APCLEY EYTraker GPRS/GSM tracker by ZS6EY + APCLEZ Telit EZ10 GSM application ZS6CEY + APCLUB Brazil APRS network + APCLWX EYWeather GPRS/GSM WX station by ZS6EY + APCNxx for carNET by DG5OAW + APCSMS for Cosmos (used for sending commands @USNA) + APCSS for AMSAT cubesats https://cubesatsim.org + APCWP8 John GM7HHB, WinphoneAPRS + APCYxx Cybiko applications + APD APD4xx UP4DAR platform + APDDxx DV-RPTR Modem and Control Center Software + APDFxx Automatic DF units + APDGxx D-Star Gateways by G4KLX ircDDB + APDHxx WinDV (DUTCH*Star DV Node for Windows) + APDInn DIXPRS - Bela, HA5DI + APDIGI Used by PSAT2 to indicate the digi is ON + APDIGI digi ON for PSAT2 and QIKCOM-2 + APDKxx KI4LKF g2_ircddb Dstar gateway software + APDNOx APRSduino by DO3SWW + APDOxx ON8JL Standalone DStar Node + APDPRS D-Star originated posits + APDRxx APRSdroid Android App http://aprsdroid.org/ + APDSXX SP9UOB for dsDigi and ds-tracker + APDTxx APRStouch Tone (DTMF) + APDTMF digi off mode on QIKCOM2 and DTMF ON + APDUxx U2APRS by JA7UDE + APDVxx OE6PLD's SSTV with APRS status exchange + APDWxx DireWolf, WB2OSZ + APE APExxx Telemetry devices + APE2Ax VA3NNW's Email-2-APRS ap + APECAN Pecan Pico APRS Balloon Tracker + APELKx WB8ELK balloons + APERXQ Experimental tracker by PE1RXQ + APERSx Runner tracking by Jason,KG7YKZ + APESPG ESP SmartBeacon APRS-IS Client + APESPW ESP Weather Station APRS-IS Client + APF APFxxx Firenet + APFGxx Flood Gage (KP4DJT) + APFIxx for APRS.FI OH7LZB, Hessu + APFPRS for FreeDV by Jeroen PE1RXQ + APG APGxxx Gates, etc + APGOxx for AA3NJ PDA application + APGBLN for NW5W's GoBalloon + APGDTx for VK4FAST's Graphic Data Terminal + APH APHKxx for LA1BR tracker/digipeater + APHAXn SM2APRS by PY2UEP + APHBLx for DMR Gateway by Eric - KF7EEL + APHTxx HMTracker by IU0AAC + APHWxx for use in "HamWAN + API API282 for ICOM IC-2820 + API31 for ICOM ID-31 + API410 for ICOM ID-4100 + API51 for ICOM ID-51 + API510 for ICOM ID-5100 + API710 for ICOM IC-7100 + API80 for ICOM IC-80 + API880 for ICOM ID-880 + API910 for ICOM IC-9100 + API92 for ICOM IC-92 + API970 for ICOM 9700 + APICQx for ICQ + APICxx HA9MCQ's Pic IGate + APIExx W7KMV's PiAPRS system + APINxx PinPoint by AB0WV + APIZCI hymTR IZCI Tracker by TA7W/OH2UDS and TA6AEU + APJ APJ8xx Jordan / KN4CRD JS8Call application + APJAxx JavAPRS + APJExx JeAPRS + APJIxx jAPRSIgate + APJSxx javAPRSSrvr + APJYnn KA2DDO Yet another APRS system + APK APK0xx Kenwood TH-D7's + APK003 Kenwood TH-D72 + APK004 Kenwood TH-D74 + APK005 Kenwood TH-D75 + APK1xx Kenwood D700's + APK102 Kenwood D710 + APKRAM KRAMstuff.com - Mark. G7LEU + APL APLCxx APRScube by DL3DCW + APLGxx LoRa Gateway/Digipeater OE5BPA + APLIGx LightAPRS - TA2MUN and TA9OHC + APLOxx LoRa KISS TNC/Tracker + APLQRU Charlie - QRU Server + APLMxx WA0TQG transceiver controller + APLSxx SARIMESH ( http://www.sarimesh.net ) + APLTxx LoRa Tracker - OE5BPA + APM APMxxx MacAPRS, + APMGxx PiCrumbs and MiniGate - Alex, AB0TJ + APMIxx SQ3PLX http://microsat.com.pl/ + APMPAD DF1JSL's WXBot clone and extension + APMQxx Ham Radio of Things WB2OSZ + APMTxx LZ1PPL for tracker + APN APNxxx Network nodes, digis, etc + APN2xx NOSaprs for JNOS 2.0 - VE4KLM + APN3xx Kantronics KPC-3 rom versions + APN9xx Kantronics KPC-9612 Roms + APNAxx WB6ZSU's APRServe + APNDxx DIGI_NED + APNICx SQ5EKU http://sq5eku.blogspot.com/ + APNK01 Kenwood D700 (APK101) type + APNK80 KAM version 8.0 + APNKMP KAM+ + APNKMX KAM-XL + APNMxx MJF TNC roms + APNPxx Paccom TNC roms + APNTxx SV2AGW's TNT tnc as a digi + APNUxx UIdigi + APNVxx SQ8L's VP digi and Nodes + APNXxx TNC-X (K6DBG) + APNWxx SQ3FYK.com WX/Digi and SQ3PLX http://microsat.com.pl/ + APO APRSpoint + APOFF Used by PSAT and PSAT2 to indicate the digi is OFF + APOLUx for OSCAR satellites for AMSAT-LU by LU9DO + APOAxx OpenAPRS - Greg Carter + APOCSG For N0AGI's APRS to POCSAG project + APOD1w Open Track with 1 wire WX + APOSBx openSPOT3 by HA2NON at sharkrf.com + APOSWx openSPOT2 + APOTxx Open Track + APOU2k Open Track for Ultimeter + APOZxx www.KissOZ.dk Tracker. OZ1EKD and OZ7HVO + APP APP6xx for APRSlib + APPICx DB1NTO' PicoAPRS + APPMxx DL1MX's RTL-SDR pytohon Igate + APPTxx KetaiTracker by JF6LZE, Takeki (msg capable) + APQ APQxxx Earthquake data + APQTHx W8WJB's QTH.app + APR APR8xx APRSdos versions 800+ + APR2MF DL2MF - MF2APRS Radiosonde WX reporting + APRARX VK5QI's radiosonde tracking + APRDxx APRSdata, APRSdr + APRGxx aprsg igate software, OH2GVE + APRHH2 HamHud 2 + APRKxx APRStk + APRNOW W5GGW ipad application + APRRTx RPC electronics + APRS Generic, (obsolete. Digis should use APNxxx instead) + APRSON Used by PSAT to indicate the DIGI is ON + APRXxx >40 APRSmax + APRXxx <39 for OH2MQK's igate + APRTLM used in MIM's and Mic-lites, etc + APRtfc APRStraffic + APRSTx APRStt (Touch tone) + APS APSxxx APRS+SA, etc + APSARx ZL4FOX's SARTRACK + APSAT digi ON for QIKCOM-1 + APSCxx aprsc APRS-IS core server (OH7LZB, OH2MQK) + APSFxx F5OPV embedded devices - was APZ40 + APSK63 APRS Messenger -over-PSK63 + APSK25 APRS Messenger GMSK-250 + APSMSx Paul Dufresne's SMSGTE - SMS Gateway + APSTMx for W7QO's Balloon trackers + APSTPO for N0AGI Satellite Tracking and Operations + APT APT2xx Tiny Track II + APT3xx Tiny Track III + APTAxx K4ATM's tiny track + APTBxx TinyAPRS by BG5HHP Was APTAxx till Sep 2017 + APTCHE PU3IKE in Brazil TcheTracker/Tcheduino + APTCMA CAPI tracker - PU1CMA Brazil + APTIGR TigerTrack + APTKPT TrackPoint N0LP + APTPNx TARPN Packet Node Tracker by KN4ORB http://tarpn.net/ + APTTxx Tiny Track + APTWxx Byons WXTrac + APTVxx for ATV/APRN and SSTV applications + APU APU1xx UIview 16 bit applications + APU2xx UIview 32 bit apps + APU3xx UIview terminal program + APUDRx NW Digital Radio's UDR (APRS/Dstar) + APV APVxxx Voice over Internet applications + APVMxx DRCC-DVM Digital Voice (Digital Radio China Club) + APVRxx for IRLP + APVLxx for I-LINK + APVExx for ECHO link + APW APWxxx WinAPRS, etc + APW9xx 9A9Y Weather Tracker + APWAxx APRSISCE Android version + APWSxx DF4IAN's WS2300 WX station + APWMxx APRSISCE KJ4ERJ + APWWxx APRSISCE win32 version + APX APXnnn Xastir + APXRnn Xrouter + APY APYxxx Yaesu Radios + APY008 Yaesu VX-8 series + APY01D Yaesu FT1D series + APY02D Yaesu FT2D series + APY03D Yaesu FT3D series + APY05D Yaesu FT5D series + APY100 Yaesu FTM-100D series + APY300 Yaesu FTM-300D series + APY350 Yaesu FTM-350 series + APY400 Yaesu FTM-400D series + APZ APZxxx Experimental + APZ200 old versions of JNOS + APZ247 for UPRS NR0Q + APZ0xx Xastir (old versions. See APX) + APZMAJ Martyn M1MAJ DeLorme inReach Tracker + APZMDM github/codec2_talkie - product code not registered + APZMDR for HaMDR trackers - hessu * hes.iki.fi] + APZPAD Smart Palm + APZTKP TrackPoint, Nick N0LP (Balloon tracking)(depricated) + APZWIT MAP27 radio (Mountain Rescue) EI7IG + APZWKR GM1WKR NetSked application + + + + + + +REGISTERED TOCALL ALTNETS: +-------------------------- + +ALTNETS are uses of the AX-25 tocall to distinguish specialized +traffic that may be flowing on the APRS-IS, but that are not intended +to be part of normal APRS distribution to all normal APRS software +operating in normal (default) modes. Proper APRS software that +honors this design are supposed to IGNORE all ALTNETS unless the +particular operator has selected an ALTNET to monitor for. + +An example is when testing; an author may want to transmit objects +all over his map for on-air testing, but does not want these to +clutter everyone's maps or databases. He could use the ALTNET of +"TEST" and client APRS software that respects the ALTNET concept +should ignore these packets. + +An ALTNET is defined to be ANY AX.25 TOCALL that is NOT one of the +normal APRS TOCALL's. The normal TOCALL's that APRS is supposed to +process are: ALL, BEACON, CQ, QST, GPSxxx and of course APxxxx. + +The following is a list of ALTNETS that may be of interest to other +users. This list is by no means complete, since ANY combination of +characters other than APxxxx are considered an ALTNET. But this list +can give consisntecy to ALTNETS that may be using the global APRS-IS +and need some special recognition. Here are some ideas: + + + + SATERN - Salvation Army Altnet + AFMARS - Airforce Mars + AMARS - Army Mars + \ No newline at end of file diff --git a/debian/README.Debian b/debian/README.Debian new file mode 100644 index 00000000..853f55f0 --- /dev/null +++ b/debian/README.Debian @@ -0,0 +1,5 @@ +In order to start direwolf as a service the configuration file +/etc/direwolf.conf needs to exist. Otherwise attempting to start the service +returns an 'Assertion failed' error. An example configuration file which may be +used as a model can be found in +/usr/share/doc/direwolf/examples/direwolf.conf.gz diff --git a/debian/changelog b/debian/changelog new file mode 120000 index 00000000..cf547089 --- /dev/null +++ b/debian/changelog @@ -0,0 +1 @@ +../CHANGES.md \ No newline at end of file diff --git a/debian/compat b/debian/compat new file mode 100644 index 00000000..9a037142 --- /dev/null +++ b/debian/compat @@ -0,0 +1 @@ +10 \ No newline at end of file diff --git a/debian/control b/debian/control new file mode 100644 index 00000000..106663b5 --- /dev/null +++ b/debian/control @@ -0,0 +1,30 @@ +Source: direwolf +Maintainer: Debian Hamradio Maintainers +Uploaders: Iain R. Learmonth +Section: hamradio +Priority: optional +Build-Depends: debhelper (>= 9), + libasound2-dev, + libgps-dev, + libhamlib-dev, + dh-systemd +Standards-Version: 4.1.0 +Vcs-Browser: https://anonscm.debian.org/cgit/pkg-hamradio/direwolf.git/ +Vcs-Git: https://anonscm.debian.org/git/pkg-hamradio/direwolf.git +Homepage: https://github.com/wb2osz/direwolf + +Package: direwolf +Architecture: alpha amd64 arm64 armel armhf i386 mipsel ppc64el sh4 x32 +Depends: ${shlibs:Depends}, + ${misc:Depends}, + adduser, + libhamlib2 +Suggests: gpsd, libhamlib-utils +Breaks: direwolf-docs (<< 1.1-1) +Replaces: direwolf-docs (<< 1.1-1) +Description: Soundcard TNC for APRS + Dire Wolf is a software "soundcard" modem/TNC and APRS encoder/decoder. It can + be used stand-alone to receive APRS messages, as a digipeater, APRStt gateway, + or Internet Gateway (IGate). It can also be used as a virtual TNC for other + applications such as APRSIS32, UI-View32, Xastir, APRS-TW, YAAC, UISS, Linux + AX25, SARTrack, and many others. \ No newline at end of file diff --git a/debian/copyright b/debian/copyright new file mode 100644 index 00000000..b546bf71 --- /dev/null +++ b/debian/copyright @@ -0,0 +1,176 @@ +Format: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ +Upstream-Name: direwolf +Files-Excluded: doc/*.pdf +Source: https://github.com/wb2osz/direwolf +Comment: + The files in misc/ are copied directly from the Cygwin source code. These are + listed here as dual licensed as they are both part of the Cygwin distribution + and originally part of BSD. See misc/README-dire-wolf.txt for more information. + . + Please see ftp-master's comments on this here: + https://lists.debian.org/debian-hams/2014/09/msg00063.html + https://lists.debian.org/debian-hams/2014/10/msg00003.html + +Files: * +Copyright: (C) 2011-2014 John Langner WB2OSZ +License: GPL-2+ + +Files: geotranz/* +Copyright: National Geospatial-Intelligence Agency +License: Permissive-NGA + +Files: regex/* +Copyright: (C) 2002, 2003, 2005 Free Software Foundation, Inc. +License: LGPL-2.1+ + +Files: misc/strcasestr.c +Copyright: + (C) 1990, 1993 The Regents of the University of California + (C) RedHat +License: BSD-4-clause or GPL-2+ + +Files: misc/strtok_r.c misc/strsep.c +Copyright: + (C) 1988 Regents of the University of California + (C) RedHat +License: BSD-3-clause or GPL-2+ + +Files: debian/* +Copyright: (C) 2014 Iain R. Learmonth +License: GPL-2+ + +License: BSD-3-clause + Redistribution and use in source and binary forms, with or without + modification, are permitted provided that the following conditions + are met: + . + 1. Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + . + 2. Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. + . + 3. Neither the name of the University nor the names of its contributors + may be used to endorse or promote products derived from this software + without specific prior written permission. + . + THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND + ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE + FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + SUCH DAMAGE. + +License: BSD-4-clause + Redistribution and use in source and binary forms, with or without + modification, are permitted provided that the following conditions + are met: + . + 1. Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + . + 2. Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. + . + 3. All advertising materials mentioning features or use of this software + must display the following acknowledgement: + This product includes software developed by the University of + California, Berkeley and its contributors. + . + 4. Neither the name of the University nor the names of its contributors + may be used to endorse or promote products derived from this software + without specific prior written permission. + . + THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND + ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE + FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + SUCH DAMAGE. + +License: GPL-2+ + This program 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 2 of the License, or + (at your option) any later version. + . + This program 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 this program. If not, see . + . + On Debian systems, a copy of the full license text is available in + /usr/share/common-licenses/GPL-2. + +License: LGPL-2.1+ + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + . + This library 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 + Lesser General Public License for more details. + . + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + . + On Debian systems, a copy of the full license text is available in + /usr/share/common-licenses/LGPL-2.1. + +License: Permissive-NGA + 1. The GEOTRANS source code ("the software") is provided free of charge by the + National Geospatial-Intelligence Agency (NGA) of the United States Department + of Defense. Although NGA makes no copyright claim under Title 17 U.S.C., NGA + claims copyrights in the source code under other legal regimes. NGA hereby + grants to each user of the software a license to use and distribute the + software, and develop derivative works. + . + 2. NGA requests that products developed using the software credit the source of + the software with the following statement, "The product was developed using + GEOTRANS, a product of the National Geospatial-Intelligence Agency (NGA) and + U.S. Army Engineering Research and Development Center." Do not use the name + GEOTRANS for any derived work. + . + 3. Warranty Disclaimer: The software was developed to meet only the internal + requirements of the National Geospatial-Intelligence Agency (NGA). The software + is provided "as is," and no warranty, express or implied, including but not + limited to the implied warranties of merchantability and fitness for particular + purpose or arising by statute or otherwise in law or from a course of dealing + or usage in trade, is made by NGA as to the accuracy and functioning of the + software. + . + 4. NGA and its personnel are not required to provide technical support or + general assistance with respect to public use of the software. Government + customers may contact NGA. + . + 5. Neither NGA nor its personnel will be liable for any claims, losses, or + damages arising from or connected with the use of the software. The user agrees + to hold harmless the United States National Geospatial-Intelligence Agency + (NGA). The user's sole and exclusive remedy is to stop using the software. + . + 6. Please be advised that pursuant to the United States Code, 10 U.S.C. 425, + the name of the National Geospatial-Intelligence Agency, the initials "NGA", + the seal of the National Geospatial-Intelligence Agency, or any colorable + imitation thereof shall not be used to imply approval, endorsement, or + authorization of a product without prior written permission from United States + Secretary of Defense. Do not create the impression that NGA, the Secretary of + Defense or the Director of National Intelligence has endorsed any product + derived from GEOTRANS. \ No newline at end of file diff --git a/debian/direwolf.postinst b/debian/direwolf.postinst new file mode 100644 index 00000000..e42b9f83 --- /dev/null +++ b/debian/direwolf.postinst @@ -0,0 +1,33 @@ +#!/bin/sh + +set -e + +. /usr/share/debconf/confmodule + +add_group_if_missing() { + if ! getent group direwolf >/dev/null; then + addgroup --system --force-badname direwolf || true + fi +} + +add_user_if_missing() { + if ! id -u direwolf > /dev/null 2>&1; then + mkdir -m 02750 -p /var/lib/direwolf + adduser --system --home /var/lib/direwolf \ + --disabled-password \ + --force-badname direwolf \ + --ingroup direwolf + adduser direwolf dialout + chown direwolf:direwolf /var/lib/direwolf + fi +} + +add_group_if_missing +add_user_if_missing + +db_stop + +#DEBHELPER# + +exit 0 + diff --git a/debian/direwolf.postrm b/debian/direwolf.postrm new file mode 100644 index 00000000..886af3d2 --- /dev/null +++ b/debian/direwolf.postrm @@ -0,0 +1,19 @@ +#!/bin/sh + +set -e + +case "$1" in + purge) + rm -rf /var/lib/direwolf/ + ;; + remove|upgrade|failed-upgrade|abort-install|abort-upgrade|disappear) + ;; + *) + echo "postrm called with unknown argument \`$1'" >&2 + exit 1 +esac + +#DEBHELPER# + +exit 0 + diff --git a/debian/rules b/debian/rules new file mode 100644 index 00000000..b8c22228 --- /dev/null +++ b/debian/rules @@ -0,0 +1,7 @@ +#!/usr/bin/make -f + +%: + dh $@ --parallel + +override_dh_auto_configure: + dh_auto_configure -- -DFORCE_SSE=1 diff --git a/debian/source/format b/debian/source/format new file mode 100644 index 00000000..46ebe026 --- /dev/null +++ b/debian/source/format @@ -0,0 +1 @@ +3.0 (quilt) \ No newline at end of file diff --git a/decode_aprs.h b/decode_aprs.h deleted file mode 100644 index 78752c29..00000000 --- a/decode_aprs.h +++ /dev/null @@ -1,106 +0,0 @@ - -/* decode_aprs.h */ - - -#ifndef DECODE_APRS_H - -#define DECODE_APRS_H 1 - - - -#ifndef G_UNKNOWN -#include "latlong.h" -#endif - -#ifndef AX25_MAX_ADDR_LEN -#include "ax25_pad.h" -#endif - -#ifndef APRSTT_LOC_DESC_LEN -#include "aprs_tt.h" -#endif - -typedef struct decode_aprs_s { - - char g_src[AX25_MAX_ADDR_LEN]; - - char g_msg_type[60]; /* Message type. Telemetry descriptions get pretty long. */ - - char g_symbol_table; /* The Symbol Table Identifier character selects one */ - /* of the two Symbol Tables, or it may be used as */ - /* single-character (alpha or numeric) overlay, as follows: */ - - /* / Primary Symbol Table (mostly stations) */ - - /* \ Alternate Symbol Table (mostly Objects) */ - - /* 0-9 Numeric overlay. Symbol from Alternate Symbol */ - /* Table (uncompressed lat/long data format) */ - - /* a-j Numeric overlay. Symbol from Alternate */ - /* Symbol Table (compressed lat/long data */ - /* format only). i.e. a-j maps to 0-9 */ - - /* A-Z Alpha overlay. Symbol from Alternate Symbol Table */ - - - char g_symbol_code; /* Where the Symbol Table Identifier is 0-9 or A-Z (or a-j */ - /* with compressed position data only), the symbol comes from */ - /* the Alternate Symbol Table, and is overlaid with the */ - /* identifier (as a single digit or a capital letter). */ - - char g_aprstt_loc[APRSTT_LOC_DESC_LEN]; /* APRStt location from !DAO! */ - - double g_lat, g_lon; /* Location, degrees. Negative for South or West. */ - /* Set to G_UNKNOWN if missing or error. */ - - char g_maidenhead[9]; /* 4 or 6 (or 8?) character maidenhead locator. */ - - char g_name[20]; /* Object or item name. */ - - float g_speed; /* Speed in MPH. */ - - float g_course; /* 0 = North, 90 = East, etc. */ - - int g_power; /* Transmitter power in watts. */ - - int g_height; /* Antenna height above average terrain, feet. */ - - int g_gain; /* Antenna gain in dB. */ - - char g_directivity[10]; /* Direction of max signal strength */ - - float g_range; /* Precomputed radio range in miles. */ - - float g_altitude; /* Feet above median sea level. */ - - char g_mfr[80]; /* Manufacturer or application. */ - - char g_mic_e_status[30]; /* MIC-E message. */ - - double g_freq; /* Frequency, MHz */ - - float g_tone; /* CTCSS tone, Hz, one fractional digit */ - - int g_dcs; /* Digital coded squelch, print as 3 octal digits. */ - - int g_offset; /* Transmit offset, KHz */ - - char g_weather[500]; /* Weather. Can get quite long. Rethink max size. */ - - char g_telemetry[256]; /* Telemetry data. Rethink max size. */ - - char g_comment[256]; /* Comment. */ - -} decode_aprs_t; - - - - - -extern void decode_aprs (decode_aprs_t *A, packet_t pp); - -extern void decode_aprs_print (decode_aprs_t *A); - - -#endif \ No newline at end of file diff --git a/demod.c b/demod.c deleted file mode 100644 index abcb6f8b..00000000 --- a/demod.c +++ /dev/null @@ -1,570 +0,0 @@ -// -// This file is part of Dire Wolf, an amateur radio packet TNC. -// -// Copyright (C) 2011,2012,2013 John Langner, WB2OSZ -// -// This program 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 2 of the License, or -// (at your option) any later version. -// -// This program 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 this program. If not, see . -// - - -// #define DEBUG1 1 /* display debugging info */ - -// #define DEBUG3 1 /* print carrier detect changes. */ - -// #define DEBUG4 1 /* capture AFSK demodulator output to log files */ - -// #define DEBUG5 1 /* capture 9600 output to log files */ - - -/*------------------------------------------------------------------ - * - * Module: demod.c - * - * Purpose: Common entry point for multiple types of demodulators. - * - * Input: Audio samples from either a file or the "sound card." - * - * Outputs: Calls hdlc_rec_bit() for each bit demodulated. - * - *---------------------------------------------------------------*/ - - -#include -#include -#include -#include -#include -#include -#include -#include - -#include "direwolf.h" -#include "audio.h" -#include "demod.h" -#include "tune.h" -#include "fsk_demod_state.h" -#include "fsk_gen_filter.h" -#include "fsk_fast_filter.h" -#include "hdlc_rec.h" -#include "textcolor.h" -#include "demod_9600.h" -#include "demod_afsk.h" - - - -// Properties of the radio channels. - -static struct audio_s modem; - -// Current state of all the decoders. - -static struct demodulator_state_s demodulator_state[MAX_CHANS][MAX_SUBCHANS]; - - -#define UPSAMPLE 2 - -static int sample_sum[MAX_CHANS][MAX_SUBCHANS]; -static int sample_count[MAX_CHANS][MAX_SUBCHANS]; - - -/*------------------------------------------------------------------ - * - * Name: demod_init - * - * Purpose: Initialize the demodulator(s) used for reception. - * - * Inputs: pa - Pointer to modem_s structure with - * various parameters for the modem(s). - * - * Returns: 0 for success, -1 for failure. - * - * - * Bugs: This doesn't do much error checking so don't give it - * anything crazy. - * - *----------------------------------------------------------------*/ - -int demod_init (struct audio_s *pa) -{ - int j; - int chan; /* Loop index over number of radio channels. */ - int subchan; /* for each modem for channel. */ - char profile; - //float fc; - - struct demodulator_state_s *D; - - -/* - * Save parameters for later use. - */ - memcpy (&modem, pa, sizeof(modem)); - - for (chan = 0; chan < modem.num_channels; chan++) { - - assert (chan >= 0 && chan < MAX_CHANS); - - switch (modem.modem_type[chan]) { - - case AFSK: -/* - * Pick a good default demodulator if none specified. - */ - if (strlen(modem.profiles[chan]) == 0) { - - if (modem.baud[chan] < 600) { - - /* This has been optimized for 300 baud. */ - - strcpy (modem.profiles[chan], "D"); - if (modem.samples_per_sec > 40000) { - modem.decimate[chan] = 3; - } - } - else { -#if __arm__ - /* We probably don't have a lot of CPU power available. */ - - if (modem.baud[chan] == FFF_BAUD && - modem.mark_freq[chan] == FFF_MARK_FREQ && - modem.space_freq[chan] == FFF_SPACE_FREQ && - modem.samples_per_sec == FFF_SAMPLES_PER_SEC) { - - modem.profiles[chan][0] = FFF_PROFILE; - modem.profiles[chan][1] = '\0'; - } - else { - strcpy (modem.profiles[chan], "A"); - } -#else - strcpy (modem.profiles[chan], "C"); -#endif - } - } - - if (modem.decimate[chan] == 0) modem.decimate[chan] = 1; - - text_color_set(DW_COLOR_DEBUG); - dw_printf ("Channel %d: %d baud, AFSK %d & %d Hz, %s, %d sample rate", - chan, modem.baud[chan], - modem.mark_freq[chan], modem.space_freq[chan], - modem.profiles[chan], - modem.samples_per_sec); - if (modem.decimate[chan] != 1) - dw_printf (" / %d", modem.decimate[chan]); - dw_printf (".\n"); - - if (strlen(modem.profiles[chan]) > 1) { - -/* - * Multiple profiles, usually for 1200 baud. - */ - assert (modem.num_subchan[chan] == strlen(modem.profiles[chan])); - - for (subchan = 0; subchan < modem.num_subchan[chan]; subchan++) { - - int mark, space; - assert (subchan >= 0 && subchan < MAX_SUBCHANS); - D = &demodulator_state[chan][subchan]; - - profile = modem.profiles[chan][subchan]; - mark = modem.mark_freq[chan]; - space = modem.space_freq[chan]; - - if (modem.num_subchan[chan] != 1) { - text_color_set(DW_COLOR_DEBUG); - dw_printf (" %d.%d: %c %d & %d\n", chan, subchan, profile, mark, space); - } - - demod_afsk_init (modem.samples_per_sec / modem.decimate[chan], modem.baud[chan], - mark, space, - profile, - D); - } - } - else { -/* - * Possibly multiple frequency pairs. - */ - - assert (modem.num_freq[chan] == modem.num_subchan[chan]); - assert (strlen(modem.profiles[chan]) == 1); - - for (subchan = 0; subchan < modem.num_freq[chan]; subchan++) { - - int mark, space, k; - assert (subchan >= 0 && subchan < MAX_SUBCHANS); - D = &demodulator_state[chan][subchan]; - - profile = modem.profiles[chan][0]; - - k = subchan * modem.offset[chan] - ((modem.num_subchan[chan] - 1) * modem.offset[chan]) / 2; - mark = modem.mark_freq[chan] + k; - space = modem.space_freq[chan] + k; - - if (modem.num_subchan[chan] != 1) { - text_color_set(DW_COLOR_DEBUG); - dw_printf (" %d.%d: %c %d & %d\n", chan, subchan, profile, mark, space); - } - - demod_afsk_init (modem.samples_per_sec / modem.decimate[chan], modem.baud[chan], - mark, space, - profile, - D); - - } /* for subchan */ - } - break; - - default: - - text_color_set(DW_COLOR_DEBUG); - dw_printf ("Channel %d: %d baud, %d sample rate x %d.\n", - chan, modem.baud[chan], - modem.samples_per_sec, UPSAMPLE); - - subchan = 0; - D = &demodulator_state[chan][subchan]; - - demod_9600_init (UPSAMPLE * modem.samples_per_sec, modem.baud[chan], D); - - break; - - } /* switch on modulation type. */ - - } /* for chan ... */ - - - - for (chan=0; chan= 0 && subchan < MAX_SUBCHANS); - - sample_sum[chan][subchan] = 0; - sample_count[chan][subchan] = subchan; /* stagger */ - - D = &demodulator_state[chan][subchan]; - -/* For collecting input signal level. */ - - D->lev_period = modem.samples_per_sec * 0.100; // Samples in 0.100 seconds. - - } - } - - return (0); - -} /* end demod_init */ - - - -/*------------------------------------------------------------------ - * - * Name: demod_get_sample - * - * Purpose: Get one audio sample fromt the sound input source. - * - * Returns: -32768 .. 32767 for a valid audio sample. - * 256*256 for end of file or other error. - * - * Global In: modem.bits_per_sample - So we know whether to - * read 1 or 2 bytes from audio stream. - * - * Description: Grab 1 or two btyes depending on data source. - * - * When processing stereo, the caller will call this - * at twice the normal rate to obtain alternating left - * and right samples. - * - *----------------------------------------------------------------*/ - -#define FSK_READ_ERR (256*256) - - -__attribute__((hot)) -int demod_get_sample (void) -{ - int x1, x2; - signed short sam; /* short to force sign extention. */ - - - assert (modem.bits_per_sample == 8 || modem.bits_per_sample == 16); - - - if (modem.bits_per_sample == 8) { - - x1 = audio_get(); - if (x1 < 0) return(FSK_READ_ERR); - - assert (x1 >= 0 && x1 <= 255); - - /* Scale 0..255 into -32k..+32k */ - - sam = (x1 - 128) * 256; - - } - else { - x1 = audio_get(); /* lower byte first */ - if (x1 < 0) return(FSK_READ_ERR); - - x2 = audio_get(); - if (x2 < 0) return(FSK_READ_ERR); - - assert (x1 >= 0 && x1 <= 255); - assert (x2 >= 0 && x2 <= 255); - - sam = ( x2 << 8 ) | x1; - } - - return (sam); -} - - -/*------------------------------------------------------------------- - * - * Name: demod_process_sample - * - * Purpose: (1) Demodulate the AFSK signal. - * (2) Recover clock and data. - * - * Inputs: chan - Audio channel. 0 for left, 1 for right. - * subchan - modem of the channel. - * sam - One sample of audio. - * Should be in range of -32768 .. 32767. - * - * Returns: None - * - * Descripion: We start off with two bandpass filters tuned to - * the given frequencies. In the case of VHF packet - * radio, this would be 1200 and 2200 Hz. - * - * The bandpass filter amplitudes are compared to - * obtain the demodulated signal. - * - * We also have a digital phase locked loop (PLL) - * to recover the clock and pick out data bits at - * the proper rate. - * - * For each recovered data bit, we call: - * - * hdlc_rec (channel, demodulated_bit); - * - * to decode HDLC frames from the stream of bits. - * - * Future: This could be generalized by passing in the name - * of the function to be called for each bit recovered - * from the demodulator. For now, it's simply hard-coded. - * - *--------------------------------------------------------------------*/ - - -__attribute__((hot)) -void demod_process_sample (int chan, int subchan, int sam) -{ - float fsam, abs_fsam; - int k; - - -#if DEBUG4 - static FILE *demod_log_fp = NULL; - static int seq = 0; /* for log file name */ -#endif - - int j; - int demod_data; - struct demodulator_state_s *D; - - assert (chan >= 0 && chan < MAX_CHANS); - assert (subchan >= 0 && subchan < MAX_SUBCHANS); - - D = &demodulator_state[chan][subchan]; - - -#if 1 /* TODO: common level detection. */ - - /* Scale to nice number, TODO: range -1.0 to +1.0, not 2. */ - - fsam = sam / 16384.0; - -/* - * Accumulate measure of the input signal level. - */ - abs_fsam = fsam >= 0 ? fsam : -fsam; - - if (abs_fsam > D->lev_peak_acc) { - D->lev_peak_acc = abs_fsam; - } - D->lev_sum_acc += abs_fsam; - - D->lev_count++; - if (D->lev_count >= D->lev_period) { - D->lev_prev_peak = D->lev_last_peak; - D->lev_last_peak = D->lev_peak_acc; - D->lev_peak_acc = 0; - - D->lev_prev_ave = D->lev_last_ave; - D->lev_last_ave = D->lev_sum_acc / D->lev_count; - D->lev_sum_acc = 0; - - D->lev_count = 0; - } - -#endif - -/* - * Select decoder based on modulation type. - */ - - switch (modem.modem_type[chan]) { - - case AFSK: - - if (modem.decimate[chan] > 1) { - - sample_sum[chan][subchan] += sam; - sample_count[chan][subchan]++; - if (sample_count[chan][subchan] >= modem.decimate[chan]) { - demod_afsk_process_sample (chan, subchan, sample_sum[chan][subchan] / modem.decimate[chan], D); - sample_sum[chan][subchan] = 0; - sample_count[chan][subchan] = 0; - } - } - else { - demod_afsk_process_sample (chan, subchan, sam, D); - } - break; - - default: - -#define ZEROSTUFF 1 - - -#if ZEROSTUFF - /* Literature says this is better if followed */ - /* by appropriate low pass filter. */ - /* So far, both are same in tests with different */ - /* optimal low pass filter parameters. */ - - for (k=1; k= 0 && chan < MAX_CHANS); - assert (subchan >= 0 && subchan < MAX_SUBCHANS); - - D = &demodulator_state[chan][subchan]; - - dw_printf ("%d\n", (int)((D->lev_last_peak + D->lev_prev_peak)*50)); - - - - //dw_printf ("Peak= %.2f, %.2f Ave= %.2f, %.2f AGC M= %.2f / %.2f S= %.2f / %.2f\n", - // D->lev_last_peak, D->lev_prev_peak, D->lev_last_ave, D->lev_prev_ave, - // D->m_peak, D->m_valley, D->s_peak, D->s_valley); - -} -#endif - -/* Resulting scale is 0 to almost 100. */ -/* Cranking up the input level produces no more than 97 or 98. */ -/* We currently produce a message when this goes over 90. */ - -int demod_get_audio_level (int chan, int subchan) -{ - struct demodulator_state_s *D; - - - assert (chan >= 0 && chan < MAX_CHANS); - assert (subchan >= 0 && subchan < MAX_SUBCHANS); - - D = &demodulator_state[chan][subchan]; - - return ( (int) ((D->lev_last_peak + D->lev_prev_peak) * 50 ) ); -} - - -/* end demod.c */ diff --git a/demod_9600.c b/demod_9600.c deleted file mode 100644 index eef4e155..00000000 --- a/demod_9600.c +++ /dev/null @@ -1,463 +0,0 @@ -// -// This file is part of Dire Wolf, an amateur radio packet TNC. -// -// Copyright (C) 2011,2012,2013 John Langner, WB2OSZ -// -// This program 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 2 of the License, or -// (at your option) any later version. -// -// This program 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 this program. If not, see . -// - - -// #define DEBUG5 1 /* capture 9600 output to log files */ - - -/*------------------------------------------------------------------ - * - * Module: demod_9600.c - * - * Purpose: Demodulator for scrambled baseband encoding. - * - * Input: Audio samples from either a file or the "sound card." - * - * Outputs: Calls hdlc_rec_bit() for each bit demodulated. - * - *---------------------------------------------------------------*/ - -#include -#include -#include -#include -#include -#include -#include -#include - -#include "direwolf.h" -#include "tune.h" -#include "fsk_demod_state.h" -#include "hdlc_rec.h" -#include "demod_9600.h" -#include "textcolor.h" -#include "dsp.h" - - -/* Add sample to buffer and shift the rest down. */ - -__attribute__((hot)) -static inline void push_sample (float val, float *buff, int size) -{ - int j; - - // TODO: memmove any faster? - for (j = size - 1; j >= 1; j--) { - buff[j] = buff[j-1]; - } - buff[0] = val; -} - - -/* FIR filter kernel. */ - -__attribute__((hot)) -static inline float convolve (const float *data, const float *filter, int filter_size) -{ - float sum = 0; - int j; - - for (j=0; j= *ppeak) { - *ppeak = in * fast_attack + *ppeak * (1. - fast_attack); - } - else { - *ppeak = in * slow_decay + *ppeak * (1. - slow_decay); - } - - if (in <= *pvalley) { - *pvalley = in * fast_attack + *pvalley * (1. - fast_attack); - } - else { - *pvalley = in * slow_decay + *pvalley * (1. - slow_decay); - } - - if (*ppeak > *pvalley) { - return ((in - 0.5 * (*ppeak + *pvalley)) / (*ppeak - *pvalley)); - } - return (0.0); -} - - -/*------------------------------------------------------------------ - * - * Name: demod_9600_init - * - * Purpose: Initialize the 9600 baud demodulator. - * - * Inputs: samples_per_sec - Number of samples per second. - * Might be upsampled in hopes of - * reducing the PLL jitter. - * - * baud - Data rate in bits per second. - * - * D - Address of demodulator state. - * - * Returns: None - * - *----------------------------------------------------------------*/ - -void demod_9600_init (int samples_per_sec, int baud, struct demodulator_state_s *D) -{ - float fc; - - memset (D, 0, sizeof(struct demodulator_state_s)); - - //dw_printf ("demod_9600_init(rate=%d, baud=%d, D ptr)\n", samples_per_sec, baud); - - D->pll_step_per_sample = - (int) round(TICKS_PER_PLL_CYCLE * (double) baud / (double)samples_per_sec); - - D->filter_len_bits = 72 * 9600.0 / (44100.0 * 2.0); - D->lp_filter_size = (int) (( D->filter_len_bits * (float)samples_per_sec / baud) + 0.5); -#if TUNE_LP_FILTER_SIZE - D->lp_filter_size = TUNE_LP_FILTER_SIZE; -#endif - - D->lpf_baud = 0.59; -#ifdef TUNE_LPF_BAUD - D->lpf_baud = TUNE_LPF_BAUD; -#endif - - D->agc_fast_attack = 0.080; -#ifdef TUNE_AGC_FAST - D->agc_fast_attack = TUNE_AGC_FAST; -#endif - - D->agc_slow_decay = 0.00012; -#ifdef TUNE_AGC_SLOW - D->agc_slow_decay = TUNE_AGC_SLOW; -#endif - - D->pll_locked_inertia = 0.88; - D->pll_searching_inertia = 0.67; - -#if defined(TUNE_PLL_LOCKED) && defined(TUNE_PLL_SEARCHING) - D->pll_locked_inertia = TUNE_PLL_LOCKED; - D->pll_searching_inertia = TUNE_PLL_SEARCHING; -#endif - - fc = (float)baud * D->lpf_baud / (float)samples_per_sec; - - //dw_printf ("demod_9600_init: call gen_lowpass(fc=%.2f, , size=%d, )\n", fc, D->lp_filter_size); - - gen_lowpass (fc, D->lp_filter, D->lp_filter_size, BP_WINDOW_HAMMING); - -} /* end fsk_demod_init */ - - - -/*------------------------------------------------------------------- - * - * Name: demod_9600_process_sample - * - * Purpose: (1) Filter & slice the signal. - * (2) Descramble it. - * (2) Recover clock and data. - * - * Inputs: chan - Audio channel. 0 for left, 1 for right. - * - * sam - One sample of audio. - * Should be in range of -32768 .. 32767. - * - * Returns: None - * - * Descripion: "9600 baud" packet is FSK for an FM voice transceiver. - * By the time it gets here, it's really a baseband signal. - * At one extreme, we could have a 4800 Hz square wave. - * A the other extreme, we could go a considerable number - * of bit times without any transitions. - * - * The trick is to extract the digital data which has - * been distorted by going thru voice transceivers not - * intended to pass this sort of "audio" signal. - * - * Data is "scrambled" to reduce the amount of DC bias. - * The data stream must be unscrambled at the receiving end. - * - * We also have a digital phase locked loop (PLL) - * to recover the clock and pick out data bits at - * the proper rate. - * - * For each recovered data bit, we call: - * - * hdlc_rec (channel, demodulated_bit); - * - * to decode HDLC frames from the stream of bits. - * - * Future: This could be generalized by passing in the name - * of the function to be called for each bit recovered - * from the demodulator. For now, it's simply hard-coded. - * - * References: 9600 Baud Packet Radio Modem Design - * http://www.amsat.org/amsat/articles/g3ruh/109.html - * - * The KD2BD 9600 Baud Modem - * http://www.amsat.org/amsat/articles/kd2bd/9k6modem/ - * - * 9600 Baud Packet Handbook - * ftp://ftp.tapr.org/general/9600baud/96man2x0.txt - * - * - * TODO: This works in a simulated environment but it has not yet - * been successfully tested for interoperability with - * other systems over the air. - * That's why it is not mentioned in documentation. - * - * The signal from the radio speaker does NOT have - * enough bandwidth and the waveform is hopelessly distorted. - * It will be necessary to obtain a signal right after - * the discriminator of the receiver. - * It will probably also be necessary to tap directly into - * the modulator, bypassing the microphone amplifier. - * - *--------------------------------------------------------------------*/ - - -__attribute__((hot)) -void demod_9600_process_sample (int chan, int sam, struct demodulator_state_s *D) -{ - - float fsam; - float abs_fsam; - float amp; - float demod_out; - -#if DEBUG5 - static FILE *demod_log_fp = NULL; - static int seq = 0; /* for log file name */ -#endif - - int j; - int subchan = 0; - int demod_data; /* Still scrambled. */ - static int descram; /* Data bit de-scrambled. */ - - - assert (chan >= 0 && chan < MAX_CHANS); - assert (subchan >= 0 && subchan < MAX_SUBCHANS); - - -/* - * Filters use last 'filter_size' samples. - * - * First push the older samples down. - * - * Finally, put the most recent at the beginning. - * - * Future project? Rather than shifting the samples, - * it might be faster to add another variable to keep - * track of the most recent sample and change the - * indexing in the later loops that multipy and add. - */ - - /* Scale to nice number, range -1.0 to +1.0. */ - - fsam = sam / 32768.0; - - push_sample (fsam, D->raw_cb, D->lp_filter_size); - -/* - * Low pass filter to reduce noise yet pass the data. - */ - - amp = convolve (D->raw_cb, D->lp_filter, D->lp_filter_size); - -/* - * The input level can vary greatly. - * More importantly, there could be a DC bias which we need to remove. - * - * Normalize the signal with automatic gain control (AGC). - * This works by looking at the minimum and maximum signal peaks - * and scaling the results to be roughly in the -1.0 to +1.0 range. - */ - - demod_out = 2.0 * agc (amp, D->agc_fast_attack, D->agc_slow_decay, &(D->m_peak), &(D->m_valley)); - -//dw_printf ("peak=%.2f valley=%.2f amp=%.2f norm=%.2f\n", D->m_peak, D->m_valley, amp, norm); - - /* Throw in a little Hysteresis??? */ - /* (Not to be confused with Hysteria.) */ - - if (demod_out > 0.01) { - demod_data = 1; - } - else if (demod_out < -0.01) { - demod_data = 0; - } - else { - demod_data = D->prev_demod_data; - } - - -/* - * Next, a PLL is used to sample near the centers of the data bits. - * - * D->data_clock_pll is a SIGNED 32 bit variable. - * When it overflows from a large positive value to a negative value, we - * sample a data bit from the demodulated signal. - * - * Ideally, the the demodulated signal transitions should be near - * zero we we sample mid way between the transitions. - * - * Nudge the PLL by removing some small fraction from the value of - * data_clock_pll, pushing it closer to zero. - * - * This adjustment will never change the sign so it won't cause - * any erratic data bit sampling. - * - * If we adjust it too quickly, the clock will have too much jitter. - * If we adjust it too slowly, it will take too long to lock on to a new signal. - * - * I don't think the optimal value will depend on the audio sample rate - * because this happens for each transition from the demodulator. - * - * This was optimized for 1200 baud AFSK. There might be some opportunity - * for improvement here. - */ - D->prev_d_c_pll = D->data_clock_pll; - D->data_clock_pll += D->pll_step_per_sample; - - if (D->data_clock_pll < 0 && D->prev_d_c_pll > 0) { - - /* Overflow. */ - -/* - * At this point, we need to descramble the data as - * in hardware based designs by G3RUH and K9NG. - * - * http://www.amsat.org/amsat/articles/g3ruh/109/fig03.gif - */ - - //assert (modem.modem_type[chan] == SCRAMBLE); - - //if (modem.modem_type[chan] == SCRAMBLE) { - - -// TODO: This needs to be rearranged to allow attempted "fixing" -// of corrupted bits later. We need to store the original -// received bits and do the descrambling after attempted -// repairs. However, we also need to descramble now to -// detect the flag sequences. - - - descram = descramble (demod_data, &(D->lfsr)); -#if SLICENDICE - // TODO: Needs more thought. - // Does it even make sense to remember demod_out in this case? - // We would need to do the re-thresholding before descrambling. - //hdlc_rec_bit_sam (chan, subchan, descram, descram ? 1.0 : -1.0); -#else - -// TODO: raw received bit and true later. - - hdlc_rec_bit (chan, subchan, descram, 0, D->lfsr); - -#endif - - //D->prev_descram = descram; - //} - //else { - /* Baseband signal for completeness - not in common use. */ -#if SLICENDICE - //hdlc_rec_bit_sam (chan, subchan, demod_data, demod_data ? 1.0 : -1.0); -#else - //hdlc_rec_bit (chan, subchan, demod_data); -#endif - //} - } - - if (demod_data != D->prev_demod_data) { - - // Note: Test for this demodulator, not overall for channel. - - if (hdlc_rec_data_detect_1 (chan, subchan)) { - D->data_clock_pll = (int)(D->data_clock_pll * D->pll_locked_inertia); - } - else { - D->data_clock_pll = (int)(D->data_clock_pll * D->pll_searching_inertia); - } - } - - -#if DEBUG5 - - //if (chan == 0) { - if (hdlc_rec_data_detect_1 (chan,subchan)) { - - char fname[30]; - - - if (demod_log_fp == NULL) { - seq++; - sprintf (fname, "demod96/%04d.csv", seq); - if (seq == 1) mkdir ("demod96" -#ifndef __WIN32__ - , 0777 -#endif - ); - - demod_log_fp = fopen (fname, "w"); - text_color_set(DW_COLOR_DEBUG); - dw_printf ("Starting 9600 decoder log file %s\n", fname); - fprintf (demod_log_fp, "Audio, Peak, Valley, Demod, SData, Descram, Clock\n"); - } - fprintf (demod_log_fp, "%.3f, %.3f, %.3f, %.3f, %.2f, %.2f, %.2f\n", - 0.5 * fsam + 3.5, - 0.5 * D->m_peak + 3.5, - 0.5 * D->m_valley + 3.5, - 0.5 * demod_out + 2.0, - demod_data ? 1.35 : 1.0, - descram ? .9 : .55, - (D->data_clock_pll & 0x80000000) ? .1 : .45); - } - else { - if (demod_log_fp != NULL) { - fclose (demod_log_fp); - demod_log_fp = NULL; - } - } - //} - -#endif - - -/* - * Remember demodulator output (pre-descrambling) so we can compare next time - * for the DPLL sync. - */ - D->prev_demod_data = demod_data; - -} /* end demod_9600_process_sample */ - - - -/* end demod_9600.c */ diff --git a/demod_9600.h b/demod_9600.h deleted file mode 100644 index 39bbcb89..00000000 --- a/demod_9600.h +++ /dev/null @@ -1,21 +0,0 @@ - - -/* demod_9600.h */ - -void demod_9600_init (int samples_per_sec, int baud, struct demodulator_state_s *D); - -void demod_9600_process_sample (int chan, int sam, struct demodulator_state_s *D); - - - - -/* Undo data scrambling for 9600 baud. */ - -static inline int descramble (int in, int *state) -{ - int out; - - out = (in ^ (*state >> 16) ^ (*state >> 11)) & 1; - *state = (*state << 1) | (in & 1); - return (out); -} diff --git a/demod_afsk.c b/demod_afsk.c deleted file mode 100644 index f80306a3..00000000 --- a/demod_afsk.c +++ /dev/null @@ -1,972 +0,0 @@ -// -// This file is part of Dire Wolf, an amateur radio packet TNC. -// -// Copyright (C) 2011,2012,2013,2014 John Langner, WB2OSZ -// -// This program 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 2 of the License, or -// (at your option) any later version. -// -// This program 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 this program. If not, see . -// - - -// #define DEBUG1 1 /* display debugging info */ - -// #define DEBUG3 1 /* print carrier detect changes. */ - -// #define DEBUG4 1 /* capture AFSK demodulator output to log files */ - -// #define DEBUG5 1 /* capture 9600 output to log files */ - - -/*------------------------------------------------------------------ - * - * Module: demod_afsk.c - * - * Purpose: Demodulator for Audio Frequency Shift Keying (AFSK). - * - * Input: Audio samples from either a file or the "sound card." - * - * Outputs: Calls hdlc_rec_bit() for each bit demodulated. - * - *---------------------------------------------------------------*/ - - - -#include -#include -#include -#include -#include -#include -#include -#include - -#include "direwolf.h" -#include "audio.h" -//#include "fsk_demod.h" -//#include "gen_tone.h" -#include "tune.h" -#include "fsk_demod_state.h" -#include "fsk_gen_filter.h" -#include "hdlc_rec.h" -#include "textcolor.h" -#include "demod_afsk.h" -#include "dsp.h" - -#define MIN(a,b) ((a)<(b)?(a):(b)) -#define MAX(a,b) ((a)>(b)?(a):(b)) - - - - -/* Quick approximation to sqrt(x*x+y*y) */ -/* No benefit for regular PC. */ -/* Should help with microcomputer platform. */ - - -__attribute__((hot)) -static inline float z (float x, float y) -{ - x = fabsf(x); - y = fabsf(y); - - if (x > y) { - return (x * .941246 + y * .41); - } - else { - return (y * .941246 + x * .41); - } -} - -/* Add sample to buffer and shift the rest down. */ - -__attribute__((hot)) -static inline void push_sample (float val, float *buff, int size) -{ - memmove(buff+1,buff,(size-1)*sizeof(float)); - buff[0] = val; -} - - -/* FIR filter kernel. */ - -__attribute__((hot)) -static inline float convolve (const float *data, const float *filter, int filter_size) -{ - float sum = 0; - int j; - - for (j=0; j= *ppeak) { - *ppeak = in * fast_attack + *ppeak * (1. - fast_attack); - } - else { - *ppeak = in * slow_decay + *ppeak * (1. - slow_decay); - } - - if (in <= *pvalley) { - *pvalley = in * fast_attack + *pvalley * (1. - fast_attack); - } - else { - *pvalley = in * slow_decay + *pvalley * (1. - slow_decay); - } - - if (*ppeak > *pvalley) { - return ((in - 0.5 * (*ppeak + *pvalley)) / (*ppeak - *pvalley)); - } - return (0.0); -} - - - -/*------------------------------------------------------------------ - * - * Name: demod_afsk_init - * - * Purpose: Initialization for an AFSK demodulator. - * Select appropriate parameters and set up filters. - * - * Inputs: samples_per_sec - * baud - * mark_freq - * space_freq - * - * D - Pointer to demodulator state for given channel. - * - * Outputs: D->ms_filter_size - * D->m_sin_table[] - * D->m_cos_table[] - * D->s_sin_table[] - * D->s_cos_table[] - * - * Returns: None. - * - * Bugs: This doesn't do much error checking so don't give it - * anything crazy. - * - *----------------------------------------------------------------*/ - -void demod_afsk_init (int samples_per_sec, int baud, int mark_freq, - int space_freq, char profile, struct demodulator_state_s *D) -{ - - int j; - - memset (D, 0, sizeof(struct demodulator_state_s)); - -#if DEBUG1 - dw_printf ("demod_afsk_init (rate=%d, baud=%d, mark=%d, space=%d, profile=%c\n", - samples_per_sec, baud, mark_freq, space_freq, profile); -#endif - -#ifdef TUNE_PROFILE - profile = TUNE_PROFILE; -#endif - - if (toupper(profile) == 'F') { - - if (baud != DEFAULT_BAUD || - mark_freq != DEFAULT_MARK_FREQ || - space_freq!= DEFAULT_SPACE_FREQ || - samples_per_sec != DEFAULT_SAMPLES_PER_SEC) { - - text_color_set(DW_COLOR_INFO); - dw_printf ("Note: Decoder 'F' works only for %d baud, %d/%d tones, %d samples/sec.\n", - DEFAULT_BAUD, DEFAULT_MARK_FREQ, DEFAULT_SPACE_FREQ, DEFAULT_SAMPLES_PER_SEC); - dw_printf ("Using Decoder 'A' instead.\n"); - profile = 'A'; - } - } - - if (profile == 'a' || profile == 'A' || profile == 'f' || profile == 'F') { - - /* Original. 52 taps, truncated bandpass, IIR lowpass */ - /* 'F' is the fast version for low end processors. */ - /* It is a special case that works only for a particular */ - /* baud rate, tone pair, and sampling rate. */ - - D->filter_len_bits = 1.415; /* 52 @ 44100, 1200 */ - D->bp_window = BP_WINDOW_TRUNCATED; - D->lpf_use_fir = 0; - D->lpf_iir = 0.195; - D->lpf_baud = 0; - D->agc_fast_attack = 0.250; - D->agc_slow_decay = 0.00012; - D->hysteresis = 0.005; - D->pll_locked_inertia = 0.700; - D->pll_searching_inertia = 0.580; - } - else if (profile == 'b' || profile == 'B') { - - /* Original bandpass. Use FIR lowpass instead. */ - - D->filter_len_bits = 1.415; /* 52 @ 44100, 1200 */ - D->bp_window = BP_WINDOW_TRUNCATED; - D->lpf_use_fir = 1; - D->lpf_iir = 0; - D->lpf_baud = 1.09; - D->agc_fast_attack = 0.370; - D->agc_slow_decay = 0.00014; - D->hysteresis = 0.003; - D->pll_locked_inertia = 0.620; - D->pll_searching_inertia = 0.350; - } - else if (profile == 'c' || profile == 'C') { - - /* Cosine window, 76 taps for bandpass, FIR lowpass. */ - - D->filter_len_bits = 2.068; /* 76 @ 44100, 1200 */ - D->bp_window = BP_WINDOW_COSINE; - D->lpf_use_fir = 1; - D->lpf_iir = 0; - D->lpf_baud = 1.09; - D->agc_fast_attack = 0.495; - D->agc_slow_decay = 0.00022; - D->hysteresis = 0.005; - D->pll_locked_inertia = 0.620; - D->pll_searching_inertia = 0.350; - } - else if (profile == 'd' || profile == 'D') { - - /* Prefilter, Cosine window, FIR lowpass. Tweeked for 300 baud. */ - - D->use_prefilter = 1; /* first, a bandpass filter. */ - D->prefilter_baud = 0.87; /* Cosine window. */ - D->filter_len_bits = 1.857; /* 91 @ 44100/3, 300 */ - D->bp_window = BP_WINDOW_COSINE; - D->lpf_use_fir = 1; - D->lpf_iir = 0; - D->lpf_baud = 1.10; - D->agc_fast_attack = 0.495; - D->agc_slow_decay = 0.00022; - D->hysteresis = 0.027; - D->pll_locked_inertia = 0.620; - D->pll_searching_inertia = 0.350; - } - else { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Invalid filter profile = %c\n", profile); - exit (1); - } - - -#if defined(TUNE_AGC_FAST) && defined(TUNE_AGC_SLOW) - D->agc_fast_attack = TUNE_AGC_FAST; - D->agc_slow_decay = TUNE_AGC_SLOW; -#endif -#ifdef TUNE_HYST - D->hysteresis = TUNE_HYST; -#endif -#if defined(TUNE_PLL_LOCKED) && defined(TUNE_PLL_SEARCHING) - D->pll_locked_inertia = TUNE_PLL_LOCKED; - D->pll_searching_inertia = TUNE_PLL_SEARCHING; -#endif -#ifdef TUNE_LPF_BAUD - D->lpf_baud = TUNE_LPF_BAUD; -#endif -#ifdef TUNE_PRE_BAUD - D->prefilter_baud = TUNE_PRE_BAUD; -#endif - -/* - * Calculate constants used for timing. - * The audio sample rate must be at least a few times the data rate. - */ - - D->pll_step_per_sample = (int) round((TICKS_PER_PLL_CYCLE * (double)baud) / ((double)samples_per_sec)); - - -/* - * My initial guess at length of filter was about one bit time. - * By trial and error, the optimal value was found to somewhat longer. - * This was optimized for 44,100 sample rate, 1200 baud, 1200/2200 Hz. - * More experimentation is needed for other situations. - */ - - D->ms_filter_size = (int) round( D->filter_len_bits * (float)samples_per_sec / (float)baud ); - -/* Experiment with other sizes. */ - -#if defined(TUNE_MS_FILTER_SIZE) - D->ms_filter_size = TUNE_MS_FILTER_SIZE; -#endif - D->lp_filter_size = D->ms_filter_size; - - assert (D->ms_filter_size >= 4); - - if (D->ms_filter_size > MAX_FILTER_SIZE) - { - text_color_set (DW_COLOR_ERROR); - dw_printf ("Calculated filter size of %d is too large.\n", D->ms_filter_size); - dw_printf ("Decrease the audio sample rate or increase the baud rate or\n"); - dw_printf ("recompile the application with MAX_FILTER_SIZE larger than %d.\n", - MAX_FILTER_SIZE); - exit (1); - } - - -/* - * For narrow AFSK (e.g. 200 Hz shift), it might be beneficial to - * have a bandpass filter before the mark/space detector. - * For now, make it the same number of taps for simplicity. - */ - - if (D->use_prefilter) { - float f1, f2; - - f1 = MIN(mark_freq,space_freq) - D->prefilter_baud * baud; - f2 = MAX(mark_freq,space_freq) + D->prefilter_baud * baud; -#if 0 - text_color_set(DW_COLOR_DEBUG); - dw_printf ("Generating prefilter %.0f to %.0f Hz.\n", f1, f2); -#endif - f1 = f1 / (float)samples_per_sec; - f2 = f2 / (float)samples_per_sec; - - //gen_bandpass (f1, f2, D->pre_filter, D->ms_filter_size, BP_WINDOW_HAMMING); - //gen_bandpass (f1, f2, D->pre_filter, D->ms_filter_size, BP_WINDOW_BLACKMAN); - gen_bandpass (f1, f2, D->pre_filter, D->ms_filter_size, BP_WINDOW_COSINE); - } - -/* - * Filters for detecting mark and space tones. - */ -#if DEBUG1 - text_color_set(DW_COLOR_DEBUG); - dw_printf ("%s: \n", __FILE__); - dw_printf ("%d baud, %d samples_per_sec\n", baud, samples_per_sec); - dw_printf ("AFSK %d & %d Hz\n", mark_freq, space_freq); - dw_printf ("spll_step_per_sample = %d = 0x%08x\n", D->pll_step_per_sample, D->pll_step_per_sample); - dw_printf ("D->ms_filter_size = %d = 0x%08x\n", D->ms_filter_size, D->ms_filter_size); - dw_printf ("\n"); - dw_printf ("Mark\n"); - dw_printf (" j shape M sin M cos \n"); -#endif - - for (j=0; jms_filter_size; j++) { - float am; - float center; - float shape = 1; /* Shape is an attempt to smooth out the */ - /* abrupt edges in hopes of reducing */ - /* overshoot and ringing. */ - /* My first thought was to use a cosine shape. */ - /* Should investigate Hamming and Blackman */ - /* windows mentioned in the literature. */ - /* http://en.wikipedia.org/wiki/Window_function */ - - center = 0.5 * (D->ms_filter_size - 1); - am = ((float)(j - center) / (float)samples_per_sec) * ((float)mark_freq) * (2 * M_PI); - - shape = window (D->bp_window, D->ms_filter_size, j); - - D->m_sin_table[j] = sin(am) * shape; - D->m_cos_table[j] = cos(am) * shape; - -#if DEBUG1 - dw_printf ("%6d %6.2f %6.2f %6.2f\n", j, shape, D->m_sin_table[j], D->m_cos_table[j]) ; -#endif - } - - -#if DEBUG1 - text_color_set(DW_COLOR_DEBUG); - - dw_printf ("Space\n"); - dw_printf (" j shape S sin S cos\n"); -#endif - for (j=0; jms_filter_size; j++) { - float as; - float center; - float shape = 1; - - center = 0.5 * (D->ms_filter_size - 1); - as = ((float)(j - center) / (float)samples_per_sec) * ((float)space_freq) * (2 * M_PI); - - shape = window (D->bp_window, D->ms_filter_size, j); - - D->s_sin_table[j] = sin(as) * shape; - D->s_cos_table[j] = cos(as) * shape; - -#if DEBUG1 - dw_printf ("%6d %6.2f %6.2f %6.2f\n", j, shape, D->s_sin_table[j], D->s_cos_table[j] ) ; -#endif - } - - -/* Do we want to normalize for unity gain? */ - - -/* - * Now the lowpass filter. - * I thought we'd want a cutoff of about 0.5 the baud rate - * but it turns out about 1.1x is better. Still investigating... - */ - - if (D->lpf_use_fir) { - float fc; - fc = baud * D->lpf_baud / (float)samples_per_sec; - gen_lowpass (fc, D->lp_filter, D->lp_filter_size, BP_WINDOW_TRUNCATED); - } - -/* - * A non-whole number of cycles results in a DC bias. - * Let's see if it helps to take it out. - * Actually makes things worse: 20 fewer decoded. - * Might want to try again after EXPERIMENTC. - */ - -#if 0 -#ifndef AVOID_FLOATING_POINT - -failed experiment - - dc_bias = 0; - for (j=0; jms_filter_size; j++) { - dc_bias += D->m_sin_table[j]; - } - for (j=0; jms_filter_size; j++) { - D->m_sin_table[j] -= dc_bias / D->ms_filter_size; - } - - dc_bias = 0; - for (j=0; jms_filter_size; j++) { - dc_bias += D->m_cos_table[j]; - } - for (j=0; jms_filter_size; j++) { - D->m_cos_table[j] -= dc_bias / D->ms_filter_size; - } - - - dc_bias = 0; - for (j=0; jms_filter_size; j++) { - dc_bias += D->s_sin_table[j]; - } - for (j=0; jms_filter_size; j++) { - D->s_sin_table[j] -= dc_bias / D->ms_filter_size; - } - - dc_bias = 0; - for (j=0; jms_filter_size; j++) { - dc_bias += D->s_cos_table[j]; - } - for (j=0; jms_filter_size; j++) { - D->s_cos_table[j] -= dc_bias / D->ms_filter_size; - } - -#endif -#endif - -} /* fsk_gen_filter */ - - -#if GEN_FFF - - - -// Properties of the radio channels. - -static struct audio_s modem; - - -// Filters will be stored here. - -static struct demodulator_state_s ds; - - -#define SPARSE 3 - - -static void emit_macro (char *name, int size, float *coeff) -{ - int i; - - dw_printf ("#define %s(x) \\\n", name); - - for (i=SPARSE/2; i= 0 && chan < MAX_CHANS); - assert (subchan >= 0 && subchan < MAX_SUBCHANS); - - - - - -/* - * Filters use last 'filter_size' samples. - * - * First push the older samples down. - * - * Finally, put the most recent at the beginning. - * - * Future project? Can we do better than shifting each time? - */ - - /* Scale to nice number, TODO: range -1.0 to +1.0, not 2. */ - - fsam = sam / 16384.0; - -/* - * Accumulate measure of the input signal level. - */ - abs_fsam = fsam >= 0 ? fsam : -fsam; - -// TODO: move to common code - - if (abs_fsam > D->lev_peak_acc) { - D->lev_peak_acc = abs_fsam; - } - D->lev_sum_acc += abs_fsam; - - D->lev_count++; - if (D->lev_count >= D->lev_period) { - D->lev_prev_peak = D->lev_last_peak; - D->lev_last_peak = D->lev_peak_acc; - D->lev_peak_acc = 0; - - D->lev_prev_ave = D->lev_last_ave; - D->lev_last_ave = D->lev_sum_acc / D->lev_count; - D->lev_sum_acc = 0; - - D->lev_count = 0; - } - -/* - * Optional bandpass filter before the mark/space discriminator. - */ - - if (D->use_prefilter) { - float cleaner; - - push_sample (fsam, D->raw_cb, D->ms_filter_size); - cleaner = convolve (D->raw_cb, D->pre_filter, D->ms_filter_size); - push_sample (cleaner, D->ms_in_cb, D->ms_filter_size); - } - else { - push_sample (fsam, D->ms_in_cb, D->ms_filter_size); - } - -/* - * Next we have bandpass filters for the mark and space tones. - * - * This takes a lot of computation. - * It's not a problem on a typical (Intel x86 based) PC. - * Dire Wolf takes only about 2 or 3% of the CPU time. - * - * It might be too much for a little microcomputer to handle. - * - * Here we have an optimized case for the default values. - */ - - - -// TODO: How do we test for profile F here? - - if (0) { - //if (toupper(modem.profiles[chan][subchan]) == toupper(FFF_PROFILE)) { - - /* ========== Faster for default values on slower processors. ========== */ - - m_sum1 = CALC_M_SUM1(D->ms_in_cb); - m_sum2 = CALC_M_SUM2(D->ms_in_cb); - m_amp = z(m_sum1,m_sum2); - - s_sum1 = CALC_S_SUM1(D->ms_in_cb); - s_sum2 = CALC_S_SUM2(D->ms_in_cb); - s_amp = z(s_sum1,s_sum2); - } - else { - - /* ========== General case to handle all situations. ========== */ - -/* - * find amplitude of "Mark" tone. - */ - m_sum1 = convolve (D->ms_in_cb, D->m_sin_table, D->ms_filter_size); - m_sum2 = convolve (D->ms_in_cb, D->m_cos_table, D->ms_filter_size); - - m_amp = sqrtf(m_sum1 * m_sum1 + m_sum2 * m_sum2); - -/* - * Find amplitude of "Space" tone. - */ - s_sum1 = convolve (D->ms_in_cb, D->s_sin_table, D->ms_filter_size); - s_sum2 = convolve (D->ms_in_cb, D->s_cos_table, D->ms_filter_size); - - s_amp = sqrtf(s_sum1 * s_sum1 + s_sum2 * s_sum2); - - /* ========== End of general case. ========== */ - } - - -/* - * Apply some low pass filtering BEFORE the AGC to remove - * overshoot, ringing, and other bad stuff. - * - * A simple IIR filter is faster but FIR produces better results. - * - * It is a balancing act between removing high frequency components - * from the tone dectection while letting the data thru. - */ - - if (D->lpf_use_fir) { - - push_sample (m_amp, D->m_amp_cb, D->lp_filter_size); - m_amp = convolve (D->m_amp_cb, D->lp_filter, D->lp_filter_size); - - push_sample (s_amp, D->s_amp_cb, D->lp_filter_size); - s_amp = convolve (D->s_amp_cb, D->lp_filter, D->lp_filter_size); - } - else { - - /* Original, but faster, IIR. */ - - m_amp = D->lpf_iir * m_amp + (1.0 - D->lpf_iir) * D->m_amp_prev; - D->m_amp_prev = m_amp; - - s_amp = D->lpf_iir * s_amp + (1.0 - D->lpf_iir) * D->s_amp_prev; - D->s_amp_prev = s_amp; - } - -/* - * Which tone is stronger? - * - * Under real conditions, we find that the higher tone has a - * considerably smaller amplitude due to the passband characteristics - * of the transmitter and receiver. To make matters worse, it - * varies considerably from one station to another. - * - * The two filters have different amounts of DC bias. - * - * Try to compensate for this by normalizing them separately with automatic gain - * control (AGC). This works by looking at the minimum and maximum outputs - * for each filter and scaling the results to be roughly in the -0.5 to +0.5 range. - */ - - /* Fast attack and slow decay. */ - /* Numbers were obtained by trial and error from actual */ - /* recorded less-than-optimal signals. */ - - /* See agc.c and fsk_demod_agc.h for more information. */ - - m_norm = agc (m_amp, D->agc_fast_attack, D->agc_slow_decay, &(D->m_peak), &(D->m_valley)); - s_norm = agc (s_amp, D->agc_fast_attack, D->agc_slow_decay, &(D->s_peak), &(D->s_valley)); - - /* Demodulator output is difference between response from two filters. */ - /* AGC should generally keep this around -1 to +1 range. */ - - demod_out = m_norm - s_norm; - -/* Try adding some Hysteresis. */ -/* (Not to be confused with Hysteria.) */ - - if (demod_out > D->hysteresis) { - demod_data = 1; - } - else if (demod_out < (- (D->hysteresis))) { - demod_data = 0; - } - else { - demod_data = D->prev_demod_data; - } - - -/* - * Finally, a PLL is used to sample near the centers of the data bits. - * - * D->data_clock_pll is a SIGNED 32 bit variable. - * When it overflows from a large positive value to a negative value, we - * sample a data bit from the demodulated signal. - * - * Ideally, the the demodulated signal transitions should be near - * zero we we sample mid way between the transitions. - * - * Nudge the PLL by removing some small fraction from the value of - * data_clock_pll, pushing it closer to zero. - * - * This adjustment will never change the sign so it won't cause - * any erratic data bit sampling. - * - * If we adjust it too quickly, the clock will have too much jitter. - * If we adjust it too slowly, it will take too long to lock on to a new signal. - * - * Be a little more agressive about adjusting the PLL - * phase when searching for a signal. Don't change it as much when - * locked on to a signal. - * - * I don't think the optimal value will depend on the audio sample rate - * because this happens for each transition from the demodulator. - */ - D->prev_d_c_pll = D->data_clock_pll; - D->data_clock_pll += D->pll_step_per_sample; - - //text_color_set(DW_COLOR_DEBUG); - // dw_printf ("prev = %lx, new data clock pll = %lx\n" D->prev_d_c_pll, D->data_clock_pll); - - if (D->data_clock_pll < 0 && D->prev_d_c_pll > 0) { - - /* Overflow. */ -#if SLICENDICE - hdlc_rec_bit_sam (chan, subchan, demod_data, demod_out); -#else - hdlc_rec_bit (chan, subchan, demod_data, 0, -1); -#endif - } - - if (demod_data != D->prev_demod_data) { - - // Note: Test for this demodulator, not overall for channel. - - if (hdlc_rec_data_detect_1 (chan, subchan)) { - D->data_clock_pll = (int)(D->data_clock_pll * D->pll_locked_inertia); - } - else { - D->data_clock_pll = (int)(D->data_clock_pll * D->pll_searching_inertia); - } - } - - -#if DEBUG4 - - if (chan == 0) { - if (hdlc_rec_data_detect_1 (chan, subchan)) { - char fname[30]; - - - if (demod_log_fp == NULL) { - seq++; - sprintf (fname, "demod/%04d.csv", seq); - if (seq == 1) mkdir ("demod", 0777); - - demod_log_fp = fopen (fname, "w"); - text_color_set(DW_COLOR_DEBUG); - dw_printf ("Starting demodulator log file %s\n", fname); - fprintf (demod_log_fp, "Audio, Mark, Space, Demod, Data, Clock\n"); - } - fprintf (demod_log_fp, "%.3f, %.3f, %.3f, %.3f, %.2f, %.2f\n", fsam + 3.5, m_norm + 2, s_norm + 2, - (m_norm - s_norm) / 2 + 1.5, - demod_data ? .9 : .55, - (D->data_clock_pll & 0x80000000) ? .1 : .45); - } - else { - if (demod_log_fp != NULL) { - fclose (demod_log_fp); - demod_log_fp = NULL; - } - } - } - -#endif - - -/* - * Remember demodulator output so we can compare next time. - */ - D->prev_demod_data = demod_data; - - -} /* end demod_afsk_process_sample */ - -#endif /* GEN_FFF */ - - -#if 0 - -/*------------------------------------------------------------------- - * - * Name: fsk_demod_print_agc - * - * Purpose: Print information about input signal amplitude. - * This will be useful for adjusting transmitter audio levels. - * We also want to avoid having an input level so high - * that the A/D converter "clips" the signal. - * - * - * Inputs: chan - Audio channel. 0 for left, 1 for right. - * - * Returns: None - * - * Descripion: Not sure what to use for final form. - * For now display the AGC peaks for both tones. - * This will be called at the end of a frame. - * - * Future: Come up with a sensible scale and add command line option. - * Probably makes more sense to return a single number - * and let the caller print it. - * Just an experiment for now. - * - *--------------------------------------------------------------------*/ - -#if 0 -void fsk_demod_print_agc (int chan, int subchan) -{ - - struct demodulator_state_s *D; - - - assert (chan >= 0 && chan < MAX_CHANS); - assert (subchan >= 0 && subchan < MAX_SUBCHANS); - - D = &demodulator_state[chan][subchan]; - - dw_printf ("%d\n", (int)((D->lev_last_peak + D->lev_prev_peak)*50)); - - - - //dw_printf ("Peak= %.2f, %.2f Ave= %.2f, %.2f AGC M= %.2f / %.2f S= %.2f / %.2f\n", - // D->lev_last_peak, D->lev_prev_peak, D->lev_last_ave, D->lev_prev_ave, - // D->m_peak, D->m_valley, D->s_peak, D->s_valley); - -} -#endif - -/* Resulting scale is 0 to almost 100. */ -/* Cranking up the input level produces no more than 97 or 98. */ -/* We currently produce a message when this goes over 90. */ - -int fsk_demod_get_audio_level (int chan, int subchan) -{ - struct demodulator_state_s *D; - - - assert (chan >= 0 && chan < MAX_CHANS); - assert (subchan >= 0 && subchan < MAX_SUBCHANS); - - D = &demodulator_state[chan][subchan]; - - return ( (int) ((D->lev_last_peak + D->lev_prev_peak) * 50 ) ); -} - - - - -#endif /* 0 */ - -/* end demod_afsk.c */ diff --git a/direwolf-block-diagram.png b/direwolf-block-diagram.png new file mode 100644 index 00000000..ad339b7e Binary files /dev/null and b/direwolf-block-diagram.png differ diff --git a/direwolf.c b/direwolf.c deleted file mode 100644 index a106ef51..00000000 --- a/direwolf.c +++ /dev/null @@ -1,987 +0,0 @@ -// -// This file is part of Dire Wolf, an amateur radio packet TNC. -// -// Copyright (C) 2011, 2012, 2013, 2014 John Langner, WB2OSZ -// -// This program 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 2 of the License, or -// (at your option) any later version. -// -// This program 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 this program. If not, see . -// - - -/*------------------------------------------------------------------ - * - * Module: direwolf.c - * - * Purpose: Main program for "Dire Wolf" which includes: - * - * AFSK modem using the "sound card." - * AX.25 encoder/decoder. - * APRS data encoder / decoder. - * APRS digipeater. - * KISS TNC emulator. - * APRStt (touch tone input) gateway - * Internet Gateway (IGate) - * - * - *---------------------------------------------------------------*/ - -#include -#include -#include -#include -#include -#include -#include -#include - -#if __WIN32__ -#else -#include -#include -#include -#include -#ifdef __OpenBSD__ -#include -#else -#include -#endif -#include -#include -#include -#endif - - -#define DIREWOLF_C 1 - -#include "direwolf.h" -#include "version.h" -#include "audio.h" -#include "config.h" -#include "multi_modem.h" -#include "demod.h" -#include "hdlc_rec.h" -#include "hdlc_rec2.h" -#include "ax25_pad.h" -#include "decode_aprs.h" -#include "textcolor.h" -#include "server.h" -#include "kiss.h" -#include "kissnet.h" -#include "nmea.h" -#include "gen_tone.h" -#include "digipeater.h" -#include "tq.h" -#include "xmit.h" -#include "ptt.h" -#include "beacon.h" -#include "ax25_pad.h" -#include "redecode.h" -#include "dtmf.h" -#include "aprs_tt.h" -#include "tt_user.h" -#include "igate.h" -#include "symbols.h" -#include "dwgps.h" -#include "nmea.h" -#include "log.h" - - -//static int idx_decoded = 0; - -#if __WIN32__ -static BOOL cleanup_win (int); -#else -static void cleanup_linux (int); -#endif - -static void usage (char **argv); - -#if __SSE__ - -static void __cpuid(int cpuinfo[4], int infotype){ - __asm__ __volatile__ ( - "cpuid": - "=a" (cpuinfo[0]), - "=b" (cpuinfo[1]), - "=c" (cpuinfo[2]), - "=d" (cpuinfo[3]) : - "a" (infotype) - ); -} - -#endif - - -/*------------------------------------------------------------------- - * - * Name: main - * - * Purpose: Main program for packet radio virtual TNC. - * - * Inputs: Command line arguments. - * See usage message for details. - * - * Outputs: Decoded information is written to stdout. - * - * A socket and pseudo terminal are created for - * for communication with other applications. - * - *--------------------------------------------------------------------*/ - -static struct audio_s modem; - -static int d_u_opt = 0; /* "-d u" command line option to print UTF-8 also in hexadecimal. */ -static int d_p_opt = 0; /* "-d p" option for dumping packets over radio. */ - -static struct misc_config_s misc_config; - - -int main (int argc, char *argv[]) -{ - int err; - int eof; - int j; - char config_file[100]; - int xmit_calibrate_option = 0; - int enable_pseudo_terminal = 0; - struct digi_config_s digi_config; - struct tt_config_s tt_config; - struct igate_config_s igate_config; - int r_opt = 0, n_opt = 0, b_opt = 0, B_opt = 0, D_opt = 0; /* Command line options. */ - char l_opt[80]; - char input_file[80]; - - int t_opt = 1; /* Text color option. */ - int d_k_opt = 0; /* "-d k" option for serial port KISS. Can be repeated for more detail. */ - int d_n_opt = 0; /* "-d n" option for Network KISS. Can be repeated for more detail. */ - int d_t_opt = 0; /* "-d t" option for Tracker. Can be repeated for more detail. */ - - - - strcpy(l_opt, ""); - - -#if __WIN32__ - -// Select UTF-8 code page for console output. -// http://msdn.microsoft.com/en-us/library/windows/desktop/ms686036(v=vs.85).aspx -// This is the default I see for windows terminal: -// >chcp -// Active code page: 437 - - //Restore on exit? oldcp = GetConsoleOutputCP(); - SetConsoleOutputCP(CP_UTF8); - -#elif __CYGWIN__ - -/* - * Without this, the ISO Latin 1 characters are displayed as gray boxes. - */ - //setenv ("LANG", "C.ISO-8859-1", 1); -#else - -/* - * Default on Raspian & Ubuntu Linux is fine. Don't know about others. - * - * Should we look at LANG environment variable and issue a warning - * if it doesn't look something like en_US.UTF-8 ? - */ - -#endif - -/* - * Pre-scan the command line options for the text color option. - * We need to set this before any text output. - */ - - t_opt = 1; /* 1 = normal, 0 = no text colors. */ - for (j=1; j= 1) { - __cpuid (cpuinfo, 1); - //dw_printf ("debug: cpuinfo = %x, %x, %x, %x\n", cpuinfo[0], cpuinfo[1], cpuinfo[2], cpuinfo[3]); - if ( ! ( cpuinfo[3] & (1 << 25))) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("------------------------------------------------------------------\n"); - dw_printf ("This version requires a minimum of a Pentium 3 or equivalent.\n"); - dw_printf ("If you are seeing this message, you are probably using a computer\n"); - dw_printf ("from the previous century. See comments in Makefile.win for\n"); - dw_printf ("information on how you can recompile it for use with your antique.\n"); - dw_printf ("------------------------------------------------------------------\n"); - } - } - text_color_set(DW_COLOR_INFO); -#endif - -/* - * This has not been very well tested in 64 bit mode. - */ - -#if 0 - if (sizeof(int) != 4 || sizeof(long) != 4 || sizeof(char *) != 4) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("------------------------------------------------------------------\n"); - dw_printf ("This might not work properly when compiled for a 64 bit target.\n"); - dw_printf ("It is recommended that you rebuild it with gcc -m32 option.\n"); - dw_printf ("------------------------------------------------------------------\n"); - } -#endif - -/* - * Default location of configuration file is current directory. - * Can be overridden by -c command line option. - * TODO: Automatically search other places. - */ - - strcpy (config_file, "direwolf.conf"); - -/* - * Look at command line options. - * So far, the only one is the configuration file location. - */ - - strcpy (input_file, ""); - while (1) { - int this_option_optind = optind ? optind : 1; - int option_index = 0; - int c; - char *p; - static struct option long_options[] = { - {"future1", 1, 0, 0}, - {"future2", 0, 0, 0}, - {"future3", 1, 0, 'c'}, - {0, 0, 0, 0} - }; - - /* ':' following option character means arg is required. */ - - c = getopt_long(argc, argv, "B:D:c:pxr:b:n:d:t:Ul:", - long_options, &option_index); - if (c == -1) - break; - - switch (c) { - - case 0: /* possible future use */ - text_color_set(DW_COLOR_DEBUG); - dw_printf("option %s", long_options[option_index].name); - if (optarg) { - dw_printf(" with arg %s", optarg); - } - dw_printf("\n"); - break; - - - case 'c': /* -c for configuration file name */ - - strcpy (config_file, optarg); - break; - -#if __WIN32__ -#else - case 'p': /* -p enable pseudo terminal */ - - /* We want this to be off by default because it hangs */ - /* eventually when nothing is reading from other side. */ - - enable_pseudo_terminal = 1; - break; -#endif - - case 'B': /* -B baud rate and modem properties. */ - - B_opt = atoi(optarg); - if (B_opt < 100 || B_opt > 10000) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Use a more reasonable data baud rate in range of 100 - 10000.\n"); - exit (EXIT_FAILURE); - } - break; - - case 'D': /* -D decrease AFSK demodulator sample rate */ - - D_opt = atoi(optarg); - if (D_opt < 1 || D_opt > 8) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Crazy value of -D. \n"); - exit (EXIT_FAILURE); - } - break; - - case 'x': /* -x for transmit calibration tones. */ - - xmit_calibrate_option = 1; - break; - - case 'r': /* -r audio samples/sec. e.g. 44100 */ - - r_opt = atoi(optarg); - if (r_opt < MIN_SAMPLES_PER_SEC || r_opt > MAX_SAMPLES_PER_SEC) - { - text_color_set(DW_COLOR_ERROR); - dw_printf("-r option, audio samples/sec, is out of range.\n"); - r_opt = 0; - } - break; - - case 'n': /* -n number of audio channels. 1 or 2. */ - - n_opt = atoi(optarg); - if (n_opt < 1 || n_opt > MAX_CHANS) - { - text_color_set(DW_COLOR_ERROR); - dw_printf("-n option, number of audio channels, is out of range.\n"); - n_opt = 0; - } - break; - - case 'b': /* -b bits per sample. 8 or 16. */ - - b_opt = atoi(optarg); - if (b_opt != 8 && b_opt != 16) - { - text_color_set(DW_COLOR_ERROR); - dw_printf("-b option, bits per sample, must be 8 or 16.\n"); - b_opt = 0; - } - break; - - case '?': - - /* Unknown option message was already printed. */ - usage (argv); - break; - - case 'd': /* Set debug option. */ - - /* New in 1.1. Can combine multiple such as "-d pkk" */ - - for (p=optarg; *p!='\0'; p++) { - switch (*p) { - - case 'a': server_set_debug(1); break; - - case 'k': d_k_opt++; kiss_serial_set_debug (d_k_opt); break; - case 'n': d_n_opt++; kiss_net_set_debug (d_n_opt); break; - - case 'u': d_u_opt = 1; break; - - // separate out gps & waypoints. - - case 't': d_t_opt++; beacon_tracker_set_debug (d_t_opt); break; - - case 'w': nmea_set_debug (1); break; // not documented yet. - case 'p': d_p_opt = 1; break; // TODO: packet dump for xmit side. - default: break; - } - } - break; - - case 't': /* Was handled earlier. */ - break; - - - case 'U': /* Print UTF-8 test and exit. */ - - dw_printf ("\n UTF-8 test string: ma%c%cana %c%c F%c%c%c%ce\n\n", - 0xc3, 0xb1, - 0xc2, 0xb0, - 0xc3, 0xbc, 0xc3, 0x9f); - - exit (0); - break; - - case 'l': /* -l for log file directory name */ - - strncpy (l_opt, optarg, sizeof(l_opt)-1); - break; - - default: - - /* Should not be here. */ - text_color_set(DW_COLOR_DEBUG); - dw_printf("?? getopt returned character code 0%o ??\n", c); - usage (argv); - } - } /* end while(1) for options */ - - if (optind < argc) - { - - if (optind < argc - 1) - { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Warning: File(s) beyond the first are ignored.\n"); - } - - strcpy (input_file, argv[optind]); - - } - -/* - * Get all types of configuration settings from configuration file. - * - * Possibly override some by command line options. - */ - - symbols_init (); - - config_init (config_file, &modem, &digi_config, &tt_config, &igate_config, &misc_config); - - if (r_opt != 0) { - modem.samples_per_sec = r_opt; - } - if (n_opt != 0) { - modem.num_channels = n_opt; - } - if (b_opt != 0) { - modem.bits_per_sample = b_opt; - } - if (B_opt != 0) { - modem.baud[0] = B_opt; - - if (modem.baud[0] < 600) { - modem.modem_type[0] = AFSK; - modem.mark_freq[0] = 1600; - modem.space_freq[0] = 1800; - modem.decimate[0] = 3; - } - else if (modem.baud[0] > 2400) { - modem.modem_type[0] = SCRAMBLE; - modem.mark_freq[0] = 0; - modem.space_freq[0] = 0; - } - else { - modem.modem_type[0] = AFSK; - modem.mark_freq[0] = 1200; - modem.space_freq[0] = 2200; - } - } - - if (D_opt != 0) { - // Don't document. This will change. - modem.decimate[0] = D_opt; - } - - if (strlen(l_opt) > 0) { - strncpy (misc_config.logdir, l_opt, sizeof(misc_config.logdir)-1); - } - - misc_config.enable_kiss_pt = enable_pseudo_terminal; - - if (strlen(input_file) > 0) { - strcpy (modem.adevice_in, input_file); - } - -/* - * Open the audio source - * - soundcard - * - stdin - * - UDP - * Files not supported at this time. - * Can always "cat" the file and pipe it into stdin. - */ - - err = audio_open (&modem); - if (err < 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Pointless to continue without audio device.\n"); - SLEEP_SEC(5); - exit (1); - } - -/* - * Initialize the AFSK demodulator and HDLC decoder. - */ - multi_modem_init (&modem); - -/* - * Initialize the touch tone decoder & APRStt gateway. - */ - dtmf_init (modem.samples_per_sec); - aprs_tt_init (&tt_config); - tt_user_init (&tt_config); - -/* - * Should there be an option for audio output level? - * Note: This is not the same as a volume control you would see on the screen. - * It is the range of the digital sound representation. -*/ - gen_tone_init (&modem, 100); - - assert (modem.bits_per_sample == 8 || modem.bits_per_sample == 16); - assert (modem.num_channels == 1 || modem.num_channels == 2); - assert (modem.samples_per_sec >= MIN_SAMPLES_PER_SEC && modem.samples_per_sec <= MAX_SAMPLES_PER_SEC); - -/* - * Initialize the transmit queue. - */ - - xmit_init (&modem, d_p_opt); - -/* - * If -x option specified, transmit alternating tones for transmitter - * audio level adjustment, up to 1 minute then quit. - * TODO: enhance for more than one channel. - */ - - if (xmit_calibrate_option) { - - int max_duration = 60; /* seconds */ - int n = modem.baud[0] * max_duration; - int chan = 0; - - text_color_set(DW_COLOR_INFO); - dw_printf ("\nSending transmit calibration tones. Press control-C to terminate.\n"); - - ptt_set (chan, 1); - while (n-- > 0) { - - tone_gen_put_bit (chan, n & 1); - - } - ptt_set (chan, 0); - exit (0); - } - -/* - * Initialize the digipeater and IGate functions. - */ - digipeater_init (&digi_config); - igate_init (&igate_config, &digi_config); - -/* - * Provide the AGW & KISS socket interfaces for use by a client application. - */ - server_init (&misc_config); - kissnet_init (&misc_config); - -/* - * Create a pseudo terminal and KISS TNC emulator. - */ - kiss_init (&misc_config); - -/* - * Open port for communication with GPS. - */ - nmea_init (&misc_config); - -/* - * Create thread for trying to salvage frames with bad FCS. - */ - redecode_init (); - -/* - * Enable beaconing. - */ - beacon_init (&misc_config, &digi_config); - - - log_init(misc_config.logdir); - -/* - * Get sound samples and decode them. - * Use hot attribute for all functions called for every audio sample. - * TODO: separate function with __attribute__((hot)) - */ - eof = 0; - while ( ! eof) - { - - int audio_sample; - int c; - char tt; - - for (c=0; c= 256 * 256) - eof = 1; - - multi_modem_process_sample(c,audio_sample); - - - /* Previously, the DTMF decoder was always active. */ - /* It took very little CPU time and the thinking was that an */ - /* attached application might be interested in this even when */ - /* the APRStt gateway was not being used. */ - /* Unfortunately it resulted in too many false detections of */ - /* touch tones when hearing other types of digital communications */ - /* on HF. Starting in version 1.0, the DTMF decoder is active */ - /* only when the APRStt gateway is configured. */ - - if (tt_config.obj_xmit_header[0] != '\0') { - tt = dtmf_sample (c, audio_sample/16384.); - if (tt != ' ') { - aprs_tt_button (c, tt); - } - } - } - - /* When a complete frame is accumulated, */ - /* process_rec_frame, below, is called. */ - - } - - exit (EXIT_SUCCESS); -} - - -/*------------------------------------------------------------------- - * - * Name: app_process_rec_frame - * - * Purpose: This is called when we receive a frame with a valid - * FCS and acceptable size. - * - * Inputs: chan - Audio channel number, 0 or 1. - * subchan - Which modem caught it. - * Special case -1 for APRStt gateway. - * pp - Packet handle. - * alevel - Audio level, range of 0 - 100. - * (Special case, use negative to skip - * display of audio level line. - * Use -2 to indicate DTMF message.) - * retries - Level of bit correction used. - * spectrum - Display of how well multiple decoders did. - * - * - * Description: Print decoded packet. - * Optionally send to another application. - * - *--------------------------------------------------------------------*/ - - -void app_process_rec_packet (int chan, int subchan, packet_t pp, int alevel, retry_t retries, char *spectrum) -{ - - char stemp[500]; - unsigned char *pinfo; - int info_len; - char heard[AX25_MAX_ADDR_LEN]; - //int j; - int h; - - assert (chan >= 0 && chan < MAX_CHANS); - assert (subchan >= -1 && subchan < MAX_SUBCHANS); - assert (pp != NULL); // 1.1J+ - - - ax25_format_addrs (pp, stemp); - - info_len = ax25_get_info (pp, &pinfo); - - /* Print so we can see what is going on. */ - - /* Display audio input level. */ - /* Who are we hearing? Original station or digipeater. */ - - if (ax25_get_num_addr(pp) == 0) { - /* Not AX.25. No station to display below. */ - h = -1; - strcpy (heard, ""); - } - else { - h = ax25_get_heard(pp); - ax25_get_addr_with_ssid(pp, h, heard); - } - - if (alevel >= 0) { - - text_color_set(DW_COLOR_DEBUG); - dw_printf ("\n"); - //idx_decoded++; - //dw_printf ("DECODED[%d] " , idx_decoded); - - if (h != -1 && h != AX25_SOURCE) { - dw_printf ("Digipeater "); - } - - /* As suggested by KJ4ERJ, if we are receiving from */ - /* WIDEn-0, it is quite likely (but not guaranteed), that */ - /* we are actually hearing the preceding station in the path. */ - - if (h >= AX25_REPEATER_2 && - strncmp(heard, "WIDE", 4) == 0 && - isdigit(heard[4]) && - heard[5] == '\0') { - - char probably_really[AX25_MAX_ADDR_LEN]; - - ax25_get_addr_with_ssid(pp, h-1, probably_really); - dw_printf ("%s (probably %s) audio level = %d [%s] %s\n", heard, probably_really, alevel, retry_text[(int)retries], spectrum); - } - else { - dw_printf ("%s audio level = %d [%s] %s\n", heard, alevel, retry_text[(int)retries], spectrum); - } - - /* Cranking up the input currently produces */ - /* no more than 97. Issue a warning before we */ - /* reach this saturation point. */ - - if (alevel > 90) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Audio input level is too high. Reduce so most stations are around 50.\n"); - } - } - - - -// Display non-APRS packets in a different color. - -// Display subchannel only when multiple modems configured for channel. - -// -1 for APRStt DTMF decoder. - - if (subchan == -1) { - text_color_set(DW_COLOR_REC); - dw_printf ("[%d.dtmf] ", chan); - } - else { - if (ax25_is_aprs(pp)) { - text_color_set(DW_COLOR_REC); - } - else { - text_color_set(DW_COLOR_DEBUG); - } - if (modem.num_subchan[chan] > 1) { - dw_printf ("[%d.%d] ", chan, subchan); - } - else { - dw_printf ("[%d] ", chan); - } - } - - dw_printf ("%s", stemp); /* stations followed by : */ - - // for APRS we generally want to display non-ASCII to see UTF-8. - // for other, probably want to restrict to ASCII only because we are - // more likely to have compressed data than UTF-8 text. - - // TODO: Might want to use d_u_opt for transmitted frames too. - - ax25_safe_print ((char *)pinfo, info_len, ( ! ax25_is_aprs(pp)) && ( ! d_u_opt) ); - dw_printf ("\n"); - -// Also display in pure ASCII if non-ASCII characters and "-d u" option specified. - - if (d_u_opt) { - - unsigned char *p; - int n = 0; - - for (p = pinfo; *p != '\0'; p++) { - if (*p >= 0x80) n++; - } - - if (n > 0) { - text_color_set(DW_COLOR_DEBUG); - ax25_safe_print ((char *)pinfo, info_len, 1); - dw_printf ("\n"); - } - } - -/* Optional hex dump of packet. */ - - if (d_p_opt) { - - text_color_set(DW_COLOR_DEBUG); - dw_printf ("------\n"); - ax25_hex_dump (pp); - dw_printf ("------\n"); - } - - -/* Decode the contents of APRS frames and display in human-readable form. */ - - if (ax25_is_aprs(pp)) { - - decode_aprs_t A; - - decode_aprs (&A, pp); - - //Print it all out in human readable format. - - decode_aprs_print (&A); - - // Send to log file. - - log_write (chan, &A, pp, alevel, retries); - - // Convert to NMEA waypoint sentence. - - if (A.g_lat != G_UNKNOWN && A.g_lon != G_UNKNOWN) { - nmea_send_waypoint (strlen(A.g_name) > 0 ? A.g_name : A.g_src, - A.g_lat, A.g_lon, A.g_symbol_table, A.g_symbol_code, - DW_FEET_TO_METERS(A.g_altitude), A.g_course, DW_MPH_TO_KNOTS(A.g_speed), - A.g_comment); - } - } - - -/* Send to another application if connected. */ - - int flen; - unsigned char fbuf[AX25_MAX_PACKET_LEN]; - - flen = ax25_pack(pp, fbuf); - - server_send_rec_packet (chan, pp, fbuf, flen); - kissnet_send_rec_packet (chan, fbuf, flen); - kiss_send_rec_packet (chan, fbuf, flen); - -/* Send to Internet server if option is enabled. */ -/* Consider only those with correct CRC. */ - - if (ax25_is_aprs(pp) && retries == RETRY_NONE) { - igate_send_rec_packet (chan, pp); - } - -/* Send out a regenerated copy. Applies to all types, not just APRS. */ - - digi_regen (chan, pp); - - -/* Note that packet can be modified in place so this is the last thing we should do with it. */ -/* Again, use only those with correct CRC. */ -/* We don't want to spread corrupted data! */ -/* Single bit change appears to be safe from observations so far but be cautious. */ - - if (ax25_is_aprs(pp) && retries == RETRY_NONE) { - digipeater (chan, pp); - } - - - ax25_delete (pp); - -} /* end app_process_rec_packet */ - - -/* Process control C and window close events. */ - -#if __WIN32__ - -static BOOL cleanup_win (int ctrltype) -{ - if (ctrltype == CTRL_C_EVENT || ctrltype == CTRL_CLOSE_EVENT) { - text_color_set(DW_COLOR_INFO); - dw_printf ("\nQRT\n"); - log_term (); - ptt_term (); - dwgps_term (); - SLEEP_SEC(1); - ExitProcess (0); - } - return (TRUE); -} - - -#else - -static void cleanup_linux (int x) -{ - text_color_set(DW_COLOR_INFO); - dw_printf ("\nQRT\n"); - log_term (); - ptt_term (); - dwgps_term (); - SLEEP_SEC(1); - exit(0); -} - -#endif - - - -static void usage (char **argv) -{ - text_color_set(DW_COLOR_ERROR); - - dw_printf ("\n"); - dw_printf ("Dire Wolf version %d.%d\n", MAJOR_VERSION, MINOR_VERSION); - dw_printf ("\n"); - dw_printf ("Usage: direwolf [options]\n"); - dw_printf ("Options:\n"); - dw_printf (" -c fname Configuration file name.\n"); - dw_printf (" -l logdir Directory name for log files. Use . for current.\n"); - - dw_printf (" -r n Audio sample rate, per sec.\n"); - dw_printf (" -n n Number of audio channels, 1 or 2.\n"); - dw_printf (" -b n Bits per audio sample, 8 or 16.\n"); - dw_printf (" -B n Data rate in bits/sec. Standard values are 300, 1200, 9600.\n"); - dw_printf (" If < 600, AFSK tones are set to 1600 & 1800.\n"); - dw_printf (" If > 2400, K9NG/G3RUH style encoding is used.\n"); - dw_printf (" Otherwise, AFSK tones are set to 1200 & 2200.\n"); - - dw_printf (" -d Debug options:\n"); - dw_printf (" a a = AGWPE network protocol client.\n"); - dw_printf (" k k = KISS serial port client.\n"); - dw_printf (" n n = KISS network client.\n"); - dw_printf (" u u = Display non-ASCII text in hexadecimal.\n"); - dw_printf (" p p = dump Packets in hexadecimal.\n"); - dw_printf (" t t = gps Tracker.\n"); - - dw_printf (" -t n Text colors. 1=normal, 0=disabled.\n"); - -#if __WIN32__ -#else - dw_printf (" -p Enable pseudo terminal for KISS protocol.\n"); -#endif - dw_printf (" -x Send Xmit level calibration tones.\n"); - dw_printf (" -U Print UTF-8 test string and exit.\n"); - dw_printf ("\n"); - -#if __WIN32__ -#else - dw_printf ("Complete documentation can be found in /usr/local/share/doc/direwolf.\n"); -#endif - exit (EXIT_FAILURE); -} - - - -/* end direwolf.c */ diff --git a/direwolf.conf b/direwolf.conf deleted file mode 100644 index bb6ab41f..00000000 --- a/direwolf.conf +++ /dev/null @@ -1,516 +0,0 @@ -############################################################# -# # -# Configuration file for Dire Wolf # -# # -############################################################# -# -# Consult the User Guide for more details on configuration options. -# -# -# These are the most likely settings you might change: -# -# (1) MYCALL - call sign and SSID for your station. -# -# Look for lines starting with MYCALL and -# change NOCALL to your own. -# -# -# (2) PBEACON - enable position beaconing. -# -# Look for lines starting with PBEACON and -# modify for your call, location, etc. -# -# -# (3) DIGIPEATER - configure digipeating rules. -# -# Look for lines starting with DIGIPEATER. -# Most people will probably use the given example. -# Just remove the "#" from the start of the line -# to enable it. -# -# -# (4) IGSERVER, IGLOGIN - IGate server and login -# -# Configure an IGate client to relay messages between -# radio and internet servers. -# -# -# The default location is "direwolf.conf" in the current working directory. -# On Linux, the user's home directory will also be searched. -# An alternate configuration file location can be specified with the "-c" command line option. -# -# As you probably guessed by now, # indicates a comment line. -# -# Remove the # at the beginning of a line if you want to use a sample -# configuration that is currently commented out. -# -# Commands are a keyword followed by parameters. -# -# Command key words are case insensitive. i.e. upper and lower case are equivalent. -# -# Command parameters are generally case sensitive. i.e. upper and lower case are different. -# -# Example: The next two are equivalent -# -# PTT /dev/ttyS0 RTS -# ptt /dev/ttyS0 RTS -# -# But this not equivalent because device names are case sensitive. -# -# PTT /dev/TTYs0 RTS -# - - -############################################################# -# # -# AUDIO DEVICE PROPERTIES # -# # -############################################################# - -# -# Many people will simply use the default sound device. -# Some might want to use an alternative device by chosing it here. -# -# When the Windows version starts up, it displays something like -# this with the available sound devices and capabilities: -# -# Available audio input devices for receive (*=selected): -# 0: Microphone (Realtek High Defini -# 1: Microphone (Bluetooth SCO Audio -# 2: Microphone (Bluetooth AV Audio) -# 3: Microphone (USB PnP Sound Devic -# Available audio output devices for transmit (*=selected): -# 0: Speakers (Realtek High Definiti -# 1: Speakers (Bluetooth SCO Audio) -# 2: Realtek Digital Output (Realtek -# 3: Realtek Digital Output(Optical) -# 4: Speakers (Bluetooth AV Audio) -# 5: Speakers (USB PnP Sound Device) - -# Example: To use the USB Audio, use a command like this with -# the input and output device numbers. (Remove the # comment character.) - -#ADEVICE 3 5 - -# The position in the list can change when devices (e.g. USB) are added and removed. -# You can also specify devices by using part of the name. -# Here is an example of specifying the USB Audio device. -# This is case-sensitive. Upper and lower case are not treated the same. - -#ADEVICE USB - - -# Linux ALSA is complicated. See User Guide for discussion. -# To use something other than the default, generally use plughw -# and a card number reported by "arecord -l" command. Examples: - -# ADEVICE plughw:CARD=Device,DEV=0 -# ADEVICE plughw:1,0 - -# Starting with version 1.0, you can also use "-" or "stdin" to -# pipe stdout from some other application such as a software defined -# radio. You can also specify "UDP:" and an optional port for input. -# Something different must be specified for output. - -# ADEVICE - plughw:1,0 -# ADEVICE UDP:7355 default - - -# -# This is the sound card audio sample rate. -# The default is 44100. Other standard values are 22050 or 11025. -# -# Change this only if your computer can't keep up. -# A lower rate means lower CPU demands but performance will be degraded. -# - -ARATE 44100 - - -# -# Number of audio channels. 1 or 2. -# If you specify 2, it is possible to attach two different transceivers -# and receive from both simultaneously. -# - -ACHANNELS 1 - -# Use this instead if you want to use two transceivers. - -#ACHANNELS 2 - - -############################################################# -# # -# CHANNEL 0 PROPERTIES # -# # -############################################################# - -CHANNEL 0 - -# -# The following will apply to the first or only channel. -# When two channels are used, this is the left audio channel. -# - - -# -# Station identifier for this channel. -# Multiple channels can have the same or different names. -# -# It can be up to 6 letters and digits with an optional ssid. -# The APRS specification requires that it be upper case. -# -# Example (don't use this unless you are me): MYCALL WB2OSZ-5 -# - -MYCALL NOCALL - - - -# -# VHF FM operation normally uses 1200 baud data with AFSK tones of 1200 and 2200 Hz. -# - -MODEM 1200 1200 2200 - -# -# 200 Hz shift is normally used for 300 baud HF SSB operation. -# -# Note that if you change the tones here, you will need to adjust -# your tuning dial accordingly to get the same transmitted frequencies. -# -# In the second example, we have 7 demodulators spaced 30 Hz apart -# to capture signals that are off frequency. -# If you run out of CPU power, drop the audio sample rate down to 22050. - -#MODEM 300 1600 1800 -#MODEM 300 1600 1800 7 30 - -# -# 9600 baud doesn't use AFSK so no tones are listed. -# - -#MODEM 9600 - - -# -# If not using a VOX circuit, the transmitter Push to Talk (PTT) -# control is usually wired to a serial port with a suitable interface circuit. -# DON'T connect it directly! -# -# For the PTT command, specify the device and either RTS or DTR. -# RTS or DTR may be preceded by "-" to invert the signal. -# - -#PTT COM1 RTS -#PTT COM1 -DTR -#PTT /dev/ttyUSB0 RTS - -# -# On Linux, you can also use general purpose I/O pins if -# your system is configured for user access to them. -# This would apply mostly to microprocessor boards, not a regular PC. -# See separate Raspberry Pi document for more details. -# The number may be preceded by "-" to invert the signal. -# - -#PTT GPIO 25 - - -# -# After turning on transmitter, send "flag" characters for -# TXDELAY * 10 milliseconds for transmitter to stabilize before -# sending data. 300 milliseconds is a good default. -# - -TXDELAY 30 - -# -# Keep transmitting for TXTAIL * 10 milliseconds after sending -# the data. This is needed to avoid dropping PTT too soon and -# chopping of the end of the data because we don't have -# precise control of when the sound will actually get out. -# - -TXTAIL 10 - - -############################################################# -# # -# CHANNEL 1 PROPERTIES # -# # -############################################################# - -CHANNEL 1 - -# -# The following will apply to the second (right) channel if ACHANNELS is 2. -# - -# -# The two radio channels can have the same or different station identifiers. -# -# -# Example (don't use this unless you are me): MYCALL WB2OSZ-5 -# - -MYCALL NOCALL - -MODEM 1200 1200 2200 - -# -# For this example, we use the same serial port for both -# transmitters. RTS for channel 0 and DTR for channel 1. -# - -#PTT COM1 DTR - -TXDELAY 30 -TXTAIL 10 - - - -############################################################# -# # -# VIRTUAL TNC SERVER PROPERTIES # -# # -############################################################# - -# -# Dire Wolf acts as a virtual TNC and can communicate with -# two different protocols: -# - the "AGW TCPIP Socket Interface" - default port 8000 -# - KISS TNC via serial port -# - KISS protocol over TCP socket - default port 8001 -# -# See descriptions of AGWPORT, KISSPORT, and NULLMODEM in the -# User Guide for more details. -# - -AGWPORT 8000 -KISSPORT 8001 - -# -# Some applications are designed to operate with only a physical -# TNC attached to a serial port. For these, we provide a virtual serial -# port ("pseudo terminal" in Linux) that appears to be connected to a TNC. -# -# Linux: -# Linux applications can often specify "/tmp/kisstnc" -# for the serial port name. Behind the scenes, Dire Wolf -# creates a pseudo terminal. Unfortunately we can't specify the name -# and we wouldn't want to reconfigure the application each time. -# To get around this, /tmp/kisstnc is a symbolic link to the -# non-constant pseudo terminal name. -# -# Use the -p command line option to enable this feature. -# -# Windows: -# -# Microsoft Windows applications need a serial port -# name like COM1, COM2, COM3, or COM4. -# -# Take a look at the User Guide for instructions to set up -# two virtual serial ports named COM3 and COM4 connected by -# a null modem. -# -# Using the default configuration, Dire Wolf will connect to -# COM3 and the client application will use COM4. -# -# Uncomment following line to use this feature. - -#NULLMODEM COM3 - - -# -# It is sometimes possible to recover frames with a bad FCS. -# -# 0 [NONE] - Don't try to repair. -# 1 [SINGLE] - Attempt to fix single bit error. (default) -# 2 [DOUBLE] - Also attempt to fix two adjacent bits. -# ... see User Guide for more values and in-depth discussion. -# - -FIX_BITS 1 - -# -############################################################# -# # -# BEACONING PROPERTIES # -# # -############################################################# - - -# -# Beaconing is configured with these two commands: -# -# PBEACON - for a position report (usually yourself) -# OBEACON - for an object report (usually some other entity) -# -# Each has a series of keywords and values for options. -# See User Guide for details. -# -# Example: -# -# This results in a broadcast once every 10 minutes. -# Every half hour, it can travel via two digipeater hops. -# The others are kept local. -# - -#PBEACON delay=00:10 every=0:30 overlay=S symbol="digi" lat=42^37.14N long=071^20.83W power=50 height=20 gain=4 comment="Chelmsford MA" via=WIDE1-1,WIDE2-1 - -#PBEACON delay=00:15 every=30 overlay=S symbol="digi" lat=42^37.14N long=071^20.83W power=50 height=20 gain=4 comment="Chelmsford MA" via=WIDE1-1,WIDE2-1 -#PBEACON delay=10:15 every=30 overlay=S symbol="digi" lat=42^37.14N long=071^20.83W power=50 height=20 gain=4 comment="Chelmsford MA" -#PBEACON delay=20:15 every=30 overlay=S symbol="digi" lat=42^37.14N long=071^20.83W power=50 height=20 gain=4 comment="Chelmsford MA" - -# With UTM coordinates instead of latitude and longitude. - -#PBEACON delay=00:15 every=10 overlay=S symbol="digi" zone=19T easting=306130 northing=4726010 - -# -# Modify this for your particular situation before removing -# the # comment character from the beginning of the lines above. -# - - -############################################################# -# # -# DIGIPEATER PROPERTIES # -# # -############################################################# - -# -# For most common situations, use something like this by removing -# the "#" from the beginning of the line below. -# - -#DIGIPEAT 0 0 ^WIDE[3-7]-[1-7]$|^TEST$ ^WIDE[12]-[12]$ TRACE - -# See User Guide for more explanation of what this means and how -# it can be customized for your particular needs. - - -############################################################# -# # -# INTERNET GATEWAY # -# # -############################################################# - -# First you need to specify the name of a Tier 2 server. -# The current preferred way is to use one of these regional rotate addresses: - -# noam.aprs2.net - for North America -# soam.aprs2.net - for South America -# euro.aprs2.net - for Europe and Africa -# asia.aprs2.net - for Asia -# aunz.aprs2.net - for Oceania - -#IGSERVER noam.aprs2.net - -# You also need to specify your login name and passcode. -# Contact the author if you can't figure out how to generate the passcode. - -#IGLOGIN WB2OSZ-5 123456 - -# That's all you need for a receive only IGate which relays -# messages from the local radio channel to the global servers. - -# Some might want to send an IGate client position directly to a server -# without sending it over the air and relying on someone else to -# forward it to an IGate server. This is done by using sendto=IG rather -# than a radio channel number. Overlay R for receive only, T for two way. - -#PBEACON sendto=IG delay=0:30 every=60:00 symbol="igate" overlay=R lat=42^37.14N long=071^20.83W -#PBEACON sendto=IG delay=0:30 every=60:00 symbol="igate" overlay=T lat=42^37.14N long=071^20.83W - - -# To relay messages from the Internet to radio, you need to add -# one more option with the transmit channel number and a VIA path. - -#IGTXVIA 0 WIDE1-1 - -# You might want to apply a filter for what packets will be obtained from the server. -# Read about filters here: http://www.aprs2.net/wiki/pmwiki.php/Main/FilterGuide -# Example: - -#IGFILTER m/50 - -# Finally, we don't want to flood the radio channel. -# The IGate function will limit the number of packets transmitted -# during 1 minute and 5 minute intervals. If a limit would -# be exceeded, the packet is dropped and message is displayed in red. - -IGTXLIMIT 6 10 - - -############################################################# -# # -# APRStt GATEWAY # -# # -############################################################# - -# -# Dire Wolf can receive DTMF (commonly known as Touch Tone) -# messages and convert them to packet objects. -# -# See separate "APRStt-Implementation-Notes" document for details. -# - -# -# Sample gateway configuration based on: -# -# http://www.aprs.org/aprstt/aprstt-coding24.txt -# http://www.aprs.org/aprs-jamboree-2013.html -# - -# Define specific points. - -TTPOINT B01 37^55.37N 81^7.86W -TTPOINT B7495088 42.605237 -71.34456 -TTPOINT B934 42.605237 -71.34456 - -TTPOINT B901 42.661279 -71.364452 -TTPOINT B902 42.660411 -71.364419 -TTPOINT B903 42.659046 -71.364452 -TTPOINT B904 42.657578 -71.364602 - - -# For location at given bearing and distance from starting point. - -TTVECTOR B5bbbddd 37^55.37N 81^7.86W 0.01 mi - -# For location specified by x, y coordinates. - -TTGRID Byyyxxx 37^50.00N 81^00.00W 37^59.99N 81^09.99W - -# UTM location for Lowell-Dracut-Tyngsborough State Forest. - -TTUTM B6xxxyyy 19T 10 300000 4720000 - - - -# Location for the corral. - -TTCORRAL 37^55.50N 81^7.00W 0^0.02N - -# Compact messages - Fixed locations xx and object yyy where -# Object numbers 100 - 199 = bicycle -# Object numbers 200 - 299 = fire truck -# Others = dog - -TTMACRO xx1yy B9xx*AB166*AA2B4C5B3B0A1yy -TTMACRO xx2yy B9xx*AB170*AA3C4C7C3B0A2yy -TTMACRO xxyyy B9xx*AB180*AA3A6C4A0Ayyy - -TTMACRO z Cz - -# Transmit object reports on channel 0 with this header. - -#TTOBJ 0 WB2OSZ-5>APDW10 - -# Advertise gateway position with beacon. - -# OBEACON DELAY=0:15 EVERY=10:00 VIA=WIDE1-1 OBJNAME=WB2OSZ-tt SYMBOL=APRStt LAT=42^37.14N LONG=71^20.83W COMMENT="APRStt Gateway" - - diff --git a/direwolf.desktop b/direwolf.desktop deleted file mode 100644 index bfc0eb41..00000000 --- a/direwolf.desktop +++ /dev/null @@ -1,10 +0,0 @@ -[Desktop Entry] -Type=Application -Exec=lxterminal -t "Dire Wolf" -e "/usr/local/bin/direwolf" -Name=Dire Wolf -Comment=APRS Soundcard TNC -Icon=/usr/share/direwolf/dw-icon.png -Path=/home/pi -#Terminal=true -Categories=HamRadio -Keywords=Ham Radio;APRS;Soundcard TNC;KISS;AGWPE;AX.25 \ No newline at end of file diff --git a/direwolf.h b/direwolf.h deleted file mode 100644 index b7ce2419..00000000 --- a/direwolf.h +++ /dev/null @@ -1,57 +0,0 @@ - -#ifndef DIREWOLF_H -#define DIREWOLF_H 1 - - -/* - * Maximum number of radio channels. - */ - -#define MAX_CHANS 2 - -/* - * Maximum number of modems per channel. - * I called them "subchannels" (in the code) because - * it is short and unambiguous. - * Nothing magic about the number. Could be larger - * but CPU demands might be overwhelming. - */ - -#define MAX_SUBCHANS 9 - - -#if __WIN32__ -#include -#define SLEEP_SEC(n) Sleep((n)*1000) -#define SLEEP_MS(n) Sleep(n) -#else -#define SLEEP_SEC(n) sleep(n) -#define SLEEP_MS(n) usleep((n)*1000) -#endif - - -#if __WIN32__ -#define PTW32_STATIC_LIB -#include "pthreads/pthread.h" -#else -#include -#endif - - -/* Not sure where to put these. */ - -/* Prefix with DW_ because /usr/include/gps.h uses a couple of these names. */ - - -#define DW_METERS_TO_FEET(x) ((x) == G_UNKNOWN ? G_UNKNOWN : (x) * 3.2808399) -#define DW_FEET_TO_METERS(x) ((x) == G_UNKNOWN ? G_UNKNOWN : (x) * 0.3048) -#define DW_KM_TO_MILES(x) ((x) == G_UNKNOWN ? G_UNKNOWN : (x) * 0.621371192) - -#define DW_KNOTS_TO_MPH(x) ((x) == G_UNKNOWN ? G_UNKNOWN : (x) * 1.15077945) -#define DW_KNOTS_TO_METERS_PER_SEC(x) ((x) == G_UNKNOWN ? G_UNKNOWN : (x) * 0.51444444444) -#define DW_MPH_TO_KNOTS(x) ((x) == G_UNKNOWN ? G_UNKNOWN : (x) * 0.868976) -#define DW_MPH_TO_METERS_PER_SEC(x) ((x) == G_UNKNOWN ? G_UNKNOWN : (x) * 0.44704) - -#define DW_MBAR_TO_INHG(x) ((x) == G_UNKNOWN ? G_UNKNOWN : (x) * 0.0295333727) - -#endif /* ifndef DIREWOLF_H */ \ No newline at end of file diff --git a/doc/2400-4800-PSK-for-APRS-Packet-Radio.pdf b/doc/2400-4800-PSK-for-APRS-Packet-Radio.pdf new file mode 100644 index 00000000..4efd364b Binary files /dev/null and b/doc/2400-4800-PSK-for-APRS-Packet-Radio.pdf differ diff --git a/doc/A-Better-APRS-Packet-Demodulator-Part-1-1200-baud.pdf b/doc/A-Better-APRS-Packet-Demodulator-Part-1-1200-baud.pdf new file mode 100644 index 00000000..20c43a7c Binary files /dev/null and b/doc/A-Better-APRS-Packet-Demodulator-Part-1-1200-baud.pdf differ diff --git a/doc/A-Better-APRS-Packet-Demodulator-Part-2-9600-baud.pdf b/doc/A-Better-APRS-Packet-Demodulator-Part-2-9600-baud.pdf new file mode 100644 index 00000000..966ea52d Binary files /dev/null and b/doc/A-Better-APRS-Packet-Demodulator-Part-2-9600-baud.pdf differ diff --git a/doc/A-Closer-Look-at-the-WA8LMF-TNC-Test-CD.pdf b/doc/A-Closer-Look-at-the-WA8LMF-TNC-Test-CD.pdf new file mode 100644 index 00000000..85fafb30 Binary files /dev/null and b/doc/A-Closer-Look-at-the-WA8LMF-TNC-Test-CD.pdf differ diff --git a/doc/AIS-Reception.pdf b/doc/AIS-Reception.pdf new file mode 100644 index 00000000..c868d7ce Binary files /dev/null and b/doc/AIS-Reception.pdf differ diff --git a/doc/APRS-Telemetry-Toolkit.pdf b/doc/APRS-Telemetry-Toolkit.pdf new file mode 100644 index 00000000..b88f8f40 Binary files /dev/null and b/doc/APRS-Telemetry-Toolkit.pdf differ diff --git a/doc/APRStt-Implementation-Notes.pdf b/doc/APRStt-Implementation-Notes.pdf new file mode 100644 index 00000000..3e6b8fb0 Binary files /dev/null and b/doc/APRStt-Implementation-Notes.pdf differ diff --git a/doc/APRStt-Listening-Example.pdf b/doc/APRStt-Listening-Example.pdf new file mode 100644 index 00000000..84e07c40 Binary files /dev/null and b/doc/APRStt-Listening-Example.pdf differ diff --git a/doc/APRStt-interface-for-SARTrack.pdf b/doc/APRStt-interface-for-SARTrack.pdf new file mode 100644 index 00000000..cdee1aec Binary files /dev/null and b/doc/APRStt-interface-for-SARTrack.pdf differ diff --git a/doc/AX25_plus_FEC_equals_FX25.pdf b/doc/AX25_plus_FEC_equals_FX25.pdf new file mode 100644 index 00000000..3113a1bc Binary files /dev/null and b/doc/AX25_plus_FEC_equals_FX25.pdf differ diff --git a/doc/Bluetooth-KISS-TNC.pdf b/doc/Bluetooth-KISS-TNC.pdf new file mode 100644 index 00000000..6969334f Binary files /dev/null and b/doc/Bluetooth-KISS-TNC.pdf differ diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt new file mode 100644 index 00000000..d8b6343f --- /dev/null +++ b/doc/CMakeLists.txt @@ -0,0 +1,21 @@ + +install(FILES "${CUSTOM_DOC_DIR}/README.md" DESTINATION ${INSTALL_DOC_DIR}) +install(FILES "${CUSTOM_DOC_DIR}/2400-4800-PSK-for-APRS-Packet-Radio.pdf" DESTINATION ${INSTALL_DOC_DIR}) +install(FILES "${CUSTOM_DOC_DIR}/A-Better-APRS-Packet-Demodulator-Part-1-1200-baud.pdf" DESTINATION ${INSTALL_DOC_DIR}) +install(FILES "${CUSTOM_DOC_DIR}/A-Better-APRS-Packet-Demodulator-Part-2-9600-baud.pdf" DESTINATION ${INSTALL_DOC_DIR}) +install(FILES "${CUSTOM_DOC_DIR}/A-Closer-Look-at-the-WA8LMF-TNC-Test-CD.pdf" DESTINATION ${INSTALL_DOC_DIR}) +install(FILES "${CUSTOM_DOC_DIR}/AIS-Reception.pdf" DESTINATION ${INSTALL_DOC_DIR}) +install(FILES "${CUSTOM_DOC_DIR}/APRS-Telemetry-Toolkit.pdf" DESTINATION ${INSTALL_DOC_DIR}) +install(FILES "${CUSTOM_DOC_DIR}/APRStt-Implementation-Notes.pdf" DESTINATION ${INSTALL_DOC_DIR}) +install(FILES "${CUSTOM_DOC_DIR}/APRStt-interface-for-SARTrack.pdf" DESTINATION ${INSTALL_DOC_DIR}) +install(FILES "${CUSTOM_DOC_DIR}/APRStt-Listening-Example.pdf" DESTINATION ${INSTALL_DOC_DIR}) +install(FILES "${CUSTOM_DOC_DIR}/AX25_plus_FEC_equals_FX25.pdf" DESTINATION ${INSTALL_DOC_DIR}) +install(FILES "${CUSTOM_DOC_DIR}/Bluetooth-KISS-TNC.pdf" DESTINATION ${INSTALL_DOC_DIR}) +install(FILES "${CUSTOM_DOC_DIR}/Going-beyond-9600-baud.pdf" DESTINATION ${INSTALL_DOC_DIR}) +install(FILES "${CUSTOM_DOC_DIR}/Raspberry-Pi-APRS.pdf" DESTINATION ${INSTALL_DOC_DIR}) +install(FILES "${CUSTOM_DOC_DIR}/Raspberry-Pi-APRS-Tracker.pdf" DESTINATION ${INSTALL_DOC_DIR}) +install(FILES "${CUSTOM_DOC_DIR}/Raspberry-Pi-SDR-IGate.pdf" DESTINATION ${INSTALL_DOC_DIR}) +install(FILES "${CUSTOM_DOC_DIR}/Successful-APRS-IGate-Operation.pdf" DESTINATION ${INSTALL_DOC_DIR}) +install(FILES "${CUSTOM_DOC_DIR}/User-Guide.pdf" DESTINATION ${INSTALL_DOC_DIR}) +install(FILES "${CUSTOM_DOC_DIR}/WA8LMF-TNC-Test-CD-Results.pdf" DESTINATION ${INSTALL_DOC_DIR}) +install(FILES "${CUSTOM_DOC_DIR}/Why-is-9600-only-twice-as-fast-as-1200.pdf" DESTINATION ${INSTALL_DOC_DIR}) diff --git a/doc/Going-beyond-9600-baud.pdf b/doc/Going-beyond-9600-baud.pdf new file mode 100644 index 00000000..18e0aa6b Binary files /dev/null and b/doc/Going-beyond-9600-baud.pdf differ diff --git a/doc/README.md b/doc/README.md new file mode 100644 index 00000000..9f44684e --- /dev/null +++ b/doc/README.md @@ -0,0 +1,178 @@ +# Documentation for Dire Wolf # + +Click on the document name to view in your web browser or the link following to download the PDF file. + + +## Slide Show ## + +Brief summary of packet radio / APRS history and the capbilities of Dire Wolf. + +[Power Point presentation](https://github.com/wb2osz/direwolf-presentation) -- Why not give a talk at a local club meeting? + +## Essential Reading ## + +- [**User Guide**](User-Guide.pdf) [ [*download*](../../../raw/master/doc/User-Guide.pdf) ] + + This is your primary source of information about installation, operation, and configuration. + +- [**Raspberry Pi APRS**](Raspberry-Pi-APRS.pdf) [ [*download*](../../../raw/master/doc/Raspberry-Pi-APRS.pdf) ] + + The Raspberry Pi has some special considerations that + make it different from other generic Linux systems. + Start here if using the Raspberry Pi, Beaglebone Black, cubieboard2, or similar single board computers. + + +## Application Notes ## + +These dive into more detail for specialized topics or typical usage scenarios. + + + +- [**AX.25 + FEC = FX.25**](AX25_plus_FEC_equals_FX25.pdf) [ [*download*](../../../raw/dev/doc/AX25_plus_FEC_equals_FX25.pdf) ] + + What can you do if your radio signal isn’t quite strong enough to get through reliably? Move to higher ground? Get a better antenna? More power? Use very narrow bandwidth and very slow data? + + Sometimes those are not options. Another way to improve communication reliability is to add redundant information so the message will still get through even if small parts are missing. FX.25 adds forward error correction (FEC) which maintaining complete compatibility with older equipment. + + +- [**AX.25 Throughput: Why is 9600 bps Packet Radio only twice as fast as 1200?**](Why-is-9600-only-twice-as-fast-as-1200.pdf) [ [*download*](../../../raw/dev/doc/Why-is-9600-only-twice-as-fast-as-1200.pdf) ] + + Simply switching to a higher data rate will probably result in great disappointment. You might expect it to be 8 times faster but it can turn out to be only twice as fast. + + In this document, we look at why a large increase in data bit rate can produce a much smaller increase in throughput. We will explore techniques that can be used to make large improvements and drastically speed up large data transfer. + + + + +- [**Successful APRS IGate Operation**](Successful-APRS-IGate-Operation.pdf) [ [*download*](../../../raw/dev/doc/Successful-APRS-IGate-Operation.pdf) ] + + + Dire Wolf can serve as a gateway between the APRS radio network and APRS-IS servers on the Internet. + + This explains how it all works, proper configuration, and troubleshooting. + +- [**Bluetooth KISS TNC**](Bluetooth-KISS-TNC.pdf) [ [*download*](../../../raw/master/doc/Bluetooth-KISS-TNC.pdf) ] + + Eliminate the cable between your TNC and application. Use Bluetooth instead. + +- [**APRStt Implementation Notes**](APRStt-Implementation-Notes.pdf) [ [*download*](../../../raw/master/doc/APRStt-Implementation-Notes.pdf) ] + + Very few hams have portable equipment for APRS but nearly everyone has a handheld radio that can send DTMF tones. APRStt allows a user, equipped with only DTMF (commonly known as Touch Tone) generation capability, to enter information into the global APRS data network. + This document explains how the APRStt concept was implemented in the Dire Wolf application. + +- [**APRStt Interface for SARTrack**](APRStt-interface-for-SARTrack.pdf) [ [*download*](../../../raw/master/doc/APRStt-interface-for-SARTrack.pdf) ] + + This example illustrates how APRStt can be integrated with other applications such as SARTrack, APRSISCE/32, YAAC, or Xastir. + +- [**APRStt Listening Example**](APRStt-Listening-Example.pdf) [ [*download*](../../../raw/master/doc/APRStt-Listening-Example.pdf) ] + + + WB4APR described a useful application for the [QIKCOM-2 Satallite Transponder](http://www.tapr.org/pipermail/aprssig/2015-November/045035.html). + + Don’t have your own QIKCOM-2 Satellite Transponder? No Problem. You can do the same thing with an ordinary computer and the APRStt gateway built into Dire Wolf. Here’s how. + +- [**Raspberry Pi APRS Tracker**](Raspberry-Pi-APRS-Tracker.pdf) [ [*download*](../../../raw/master/doc/Raspberry-Pi-APRS-Tracker.pdf) ] + + Build a tracking device which transmits position from a GPS receiver. + +- [**Raspberry Pi SDR IGate**](Raspberry-Pi-SDR-IGate.pdf) [ [*download*](../../../raw/master/doc/Raspberry-Pi-SDR-IGate.pdf) ] + + It's easy to build a receive-only APRS Internet Gateway (IGate) with only a Raspberry Pi and a software defined radio (RTL-SDR) dongle. Here’s how. + +- [**APRS Telemetry Toolkit**](APRS-Telemetry-Toolkit.pdf) [ [*download*](../../../raw/master/doc/APRS-Telemetry-Toolkit.pdf) ] + + Describes scripts and methods to generate telemetry. + Includes a complete example of attaching an analog to + digital converter to a Raspberry Pi and transmitting + a measured voltage. + + + +- [**2400 & 4800 bps PSK for APRS / Packet Radio**](2400-4800-PSK-for-APRS-Packet-Radio.pdf) [ [*download*](../../../raw/master/doc/2400-4800-PSK-for-APRS-Packet-Radio.pdf) ] + + + Double or quadruple your data rate by sending multiple bits at the same time. + +- [**Going beyond 9600 baud**](Going-beyond-9600-baud.pdf) [ [*download*](../../../raw/master/doc/Going-beyond-9600-baud.pdf) ] + + + Why stop at 9600 baud? Go faster if your soundcard and radio can handle it. + +- [**AIS Reception**](AIS-Reception.pdf) [ [*download*](../../../raw/dev/doc/AIS-Reception.pdf) ] + + + AIS is an international tracking system for ships. Messages can contain position, speed, course, name, destination, status, vessel dimensions, and many other types of information. Learn how to receive these signals with an ordindary ham transceiver and display the ship locations with APRS applications or [OpenCPN](https://opencpn.org). + +- **[EAS to APRS message converter](https://github.com/wb2osz/eas2aprs)** + + + The [U.S. National Weather Service](https://www.weather.gov/nwr/) (NWS) operates more than 1,000 VHF FM radio stations that continuously transmit weather information. These stations also transmit special warnings about severe weather, disasters (natural & manmade), and public safety. + + Alerts are sent in a digital form known as Emergency Alert System (EAS) Specific Area Message Encoding (SAME). [You can hear a sample here](https://en.wikipedia.org/wiki/Specific_Area_Message_Encoding). + + It is possible to buy radios that decode these messages but what fun is that? We are ham radio operators so we want to build our own from stuff that we already have sitting around. + + +## Miscellaneous ## + +- **[Ham Radio of Things (HRoT)](https://github.com/wb2osz/hrot)** + + + Now that billions of computers and mobile phones (which are handheld computers) are all connected by the Internet, the large growth is expected from the “Internet of Things.†What is a “thing?†It could be a temperature sensor, garage door opener, motion detector, flood water level, smoke alarm, antenna rotator, coffee maker, lights, home thermostat, …, just about anything you might want to monitor or control. + + There have been other occasional mentions of merging Ham Radio with the Internet of Things but only ad hoc incompatible narrowly focused applications. Here is a proposal for a standardized more flexible method so different systems can communicate with each other. + +- [**A Better APRS Packet Demodulator, part 1, 1200 baud**](A-Better-APRS-Packet-Demodulator-Part-1-1200-baud.pdf) [ [*download*](../../../raw/master/doc/A-Better-APRS-Packet-Demodulator-Part-1-1200-baud.pdf) ] + + Sometimes it's a little mystifying why an +APRS / AX.25 Packet TNC will decode some signals +and not others. A weak signal, buried in static, +might be fine while a nice strong clean sounding +signal is not decoded. Here we will take a brief +look at what could cause this perplexing situation +and a couple things that can be done about it. + + + +- [**A Better APRS Packet Demodulator, part 2, 9600 baud**](A-Better-APRS-Packet-Demodulator-Part-2-9600-baud.pdf) [ [*download*](../../../raw/master/doc/A-Better-APRS-Packet-Demodulator-Part-2-9600-baud.pdf) ] + + In the first part of this series we discussed 1200 baud audio frequency shift keying (AFSK). The mismatch + between FM transmitter pre-emphasis and the + receiver de-emphasis will + cause the amplitudes of the two tones to be different. + This makes it more difficult to demodulate them accurately. + 9600 baud operation is an entirely different animal. ... + +- [**WA8LMF TNC Test CD Results a.k.a. Battle of the TNCs**](WA8LMF-TNC-Test-CD-Results.pdf) [ [*download*](../../../raw/master/doc/WA8LMF-TNC-Test-CD-Results.pdf) ] + + How can we compare how well the TNCs perform under real world conditions? + The de facto standard of measurement is the number of packets decoded from [WA8LMF’s TNC Test CD](http://wa8lmf.net/TNCtest/index.htm). + Many have published the number of packets they have been able to decode from this test. Here they are, all gathered in one place, for your reading pleasure. + +- [**A Closer Look at the WA8LMF TNC Test CD**](A-Closer-Look-at-the-WA8LMF-TNC-Test-CD.pdf) [ [*download*](../../../raw/master/doc/A-Closer-Look-at-the-WA8LMF-TNC-Test-CD.pdf) ] + + Here, we take a closer look at some of the frames on the TNC Test CD in hopes of gaining some insights into why some are easily decoded and others are more difficult. + There are a lot of ugly signals out there. Many can be improved by decreasing the transmit volume. Others are just plain weird and you have to wonder how they are being generated. + + +## Additional Documentation for Dire Wolf Software TNC # + + +When there was little documentation, it was all added to the source code repository [https://github.com/wb2osz/direwolf/tree/master/doc](https://github.com/wb2osz/direwolf/tree/master/doc) + +The growing number of documentation files and revisions are making the source code repository very large which means long download times. Additional documentation, not tied to a specific release, is now being added to [https://github.com/wb2osz/direwolf-doc](https://github.com/wb2osz/direwolf-doc) + +## Questions? Experiences to share? ## + +Here are some good places to ask questions and share your experiences: + +- [Dire Wolf Software TNC](https://groups.io/g/direwolf) + +- [Raspberry Pi 4 Ham Radio](https://groups.io/g/RaspberryPi-4-HamRadio) + +- [linuxham](https://groups.io/g/linuxham) + +- [TAPR aprssig](http://www.tapr.org/pipermail/aprssig/) + + +The github "issues" section is for reporting software defects and enhancement requests. It is NOT a place to ask questions or have general discussions. Please use one of the locations above. diff --git a/doc/Raspberry-Pi-APRS-Tracker.pdf b/doc/Raspberry-Pi-APRS-Tracker.pdf new file mode 100644 index 00000000..c0c8c0be Binary files /dev/null and b/doc/Raspberry-Pi-APRS-Tracker.pdf differ diff --git a/doc/Raspberry-Pi-APRS.pdf b/doc/Raspberry-Pi-APRS.pdf new file mode 100644 index 00000000..344c3de6 Binary files /dev/null and b/doc/Raspberry-Pi-APRS.pdf differ diff --git a/doc/Raspberry-Pi-SDR-IGate.pdf b/doc/Raspberry-Pi-SDR-IGate.pdf new file mode 100644 index 00000000..b4c84f18 Binary files /dev/null and b/doc/Raspberry-Pi-SDR-IGate.pdf differ diff --git a/doc/Successful-APRS-IGate-Operation.pdf b/doc/Successful-APRS-IGate-Operation.pdf new file mode 100644 index 00000000..9a51ef58 Binary files /dev/null and b/doc/Successful-APRS-IGate-Operation.pdf differ diff --git a/doc/User-Guide.pdf b/doc/User-Guide.pdf new file mode 100644 index 00000000..319f882f Binary files /dev/null and b/doc/User-Guide.pdf differ diff --git a/doc/WA8LMF-TNC-Test-CD-Results.pdf b/doc/WA8LMF-TNC-Test-CD-Results.pdf new file mode 100644 index 00000000..d9af1a3f Binary files /dev/null and b/doc/WA8LMF-TNC-Test-CD-Results.pdf differ diff --git a/doc/Why-is-9600-only-twice-as-fast-as-1200.pdf b/doc/Why-is-9600-only-twice-as-fast-as-1200.pdf new file mode 100644 index 00000000..829aa648 Binary files /dev/null and b/doc/Why-is-9600-only-twice-as-fast-as-1200.pdf differ diff --git a/dsp.h b/dsp.h deleted file mode 100644 index 1f5aaa52..00000000 --- a/dsp.h +++ /dev/null @@ -1,10 +0,0 @@ - -/* dsp.h */ - -// TODO: put prefixes on these names. - -float window (bp_window_t type, int size, int j); - -void gen_lowpass (float fc, float *lp_filter, int filter_size, bp_window_t wtype); - -void gen_bandpass (float f1, float f2, float *bp_filter, int filter_size, bp_window_t wtype); \ No newline at end of file diff --git a/dtmf.c b/dtmf.c deleted file mode 100644 index e0f73094..00000000 --- a/dtmf.c +++ /dev/null @@ -1,411 +0,0 @@ -// -// This file is part of Dire Wolf, an amateur radio packet TNC. -// -// Copyright (C) 2013 John Langner, WB2OSZ -// -// This program 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 2 of the License, or -// (at your option) any later version. -// -// This program 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 this program. If not, see . -// - -/*------------------------------------------------------------------ - * - * Module: dtmf.c - * - * Purpose: Decoder for DTMF, commonly known as "touch tones." - * - * Description: This uses the Goertzel Algorithm for tone detection. - * - * References: http://eetimes.com/design/embedded/4024443/The-Goertzel-Algorithm - * http://www.ti.com/ww/cn/uprogram/share/ppt/c5000/17dtmf_v13.ppt - * - *---------------------------------------------------------------*/ - - -#include -#include -#include -#include - -#include "direwolf.h" -#include "dtmf.h" - - -// Define for unit test. -//#define DTMF_TEST 1 - - -#if DTMF_TEST -#define TIMEOUT_SEC 1 /* short for unit test below. */ -#define DEBUG 1 -#else -#define TIMEOUT_SEC 5 /* for normal operation. */ -#endif - - -#define NUM_TONES 8 -static int const dtmf_tones[NUM_TONES] = { 697, 770, 852, 941, 1209, 1336, 1477, 1633 }; - -/* - * Current state of the decoding. - */ - -static struct { - int sample_rate; /* Samples per sec. Typ. 44100, 8000, etc. */ - int block_size; /* Number of samples to process in one block. */ - float coef[NUM_TONES]; - - struct { /* Separate for each audio channel. */ - - int n; /* Samples processed in this block. */ - float Q1[NUM_TONES]; - float Q2[NUM_TONES]; - char prev_dec; - char debounced; - char prev_debounced; - int timeout; - } C[MAX_CHANS]; -} D; - - - - -/*------------------------------------------------------------------ - * - * Name: dtmf_init - * - * Purpose: Initialize the DTMF decoder. - * This should be called once at application start up time. - * - * Inputs: sample_rate - Audio sample frequency, typically - * 44100, 22050, 8000, etc. - * - * Returns: None. - * - *----------------------------------------------------------------*/ - -void dtmf_init (int sample_rate) -{ - int j; /* Loop over all tones frequencies. */ - int c; /* Loop over all audio channels. */ - -/* - * Processing block size. - * Larger = narrower bandwidth, slower response. - */ - D.sample_rate = sample_rate; - D.block_size = (205 * sample_rate) / 8000; - -#if DEBUG - dw_printf (" freq k coef \n"); -#endif - for (j=0; j 0 && D.coef[j] < 2.0); -#if DEBUG - dw_printf ("%8d %5.1f %8.5f \n", dtmf_tones[j], k, D.coef[j]); -#endif - } - - for (c=0; c THRESHOLD * ( output[1] + output[2] + output[3])) row = 0; - else if (output[1] > THRESHOLD * (output[0] + output[2] + output[3])) row = 1; - else if (output[2] > THRESHOLD * (output[0] + output[1] + output[3])) row = 2; - else if (output[3] > THRESHOLD * (output[0] + output[1] + output[2] )) row = 3; - else row = -1; - - if (output[4] > THRESHOLD * ( output[5] + output[6] + output[7])) col = 0; - else if (output[5] > THRESHOLD * (output[4] + output[6] + output[7])) col = 1; - else if (output[6] > THRESHOLD * (output[4] + output[5] + output[7])) col = 2; - else if (output[7] > THRESHOLD * (output[4] + output[5] + output[6] )) col = 3; - else col = -1; - - for (i=0; i= 0 && col >= 0) { - decoded = rc2char[row*4+col]; - } - else { - decoded = '.'; - } - -// Consider valid only if we get same twice in a row. - - if (decoded == D.C[c].prev_dec) { - D.C[c].debounced = decoded; - /* Reset timeout timer. */ - if (decoded != ' ') { - D.C[c].timeout = ((TIMEOUT_SEC) * D.sample_rate) / D.block_size; - } - } - D.C[c].prev_dec = decoded; - -// Return only new button pushes. -// Also report timeout after period of inactivity. - - ret = '.'; - if (D.C[c].debounced != D.C[c].prev_debounced) { - if (D.C[c].debounced != ' ') { - ret = D.C[c].debounced; - } - } - if (ret == '.') { - if (D.C[c].timeout > 0) { - D.C[c].timeout--; - if (D.C[c].timeout == 0) { - ret = '$'; - } - } - } - D.C[c].prev_debounced = D.C[c].debounced; - -#if DEBUG - dw_printf (" dec=%c, deb=%c, ret=%c \n", - decoded, D.C[c].debounced, ret); -#endif - return (ret); - } - - return (' '); -} - - -/*------------------------------------------------------------------ - * - * Name: main - * - * Purpose: Unit test for functions above. - * - *----------------------------------------------------------------*/ - - -#if DTMF_TEST - -push_button (char button, int ms) -{ - static float phasea = 0; - static float phaseb = 0; - float fa, fb; - int i; - float input; - char x; - static char result[100]; - static int result_len = 0; - - - switch (button) { - case '1': fa = dtmf_tones[0]; fb = dtmf_tones[4]; break; - case '2': fa = dtmf_tones[0]; fb = dtmf_tones[5]; break; - case '3': fa = dtmf_tones[0]; fb = dtmf_tones[6]; break; - case 'A': fa = dtmf_tones[0]; fb = dtmf_tones[7]; break; - case '4': fa = dtmf_tones[1]; fb = dtmf_tones[4]; break; - case '5': fa = dtmf_tones[1]; fb = dtmf_tones[5]; break; - case '6': fa = dtmf_tones[1]; fb = dtmf_tones[6]; break; - case 'B': fa = dtmf_tones[1]; fb = dtmf_tones[7]; break; - case '7': fa = dtmf_tones[2]; fb = dtmf_tones[4]; break; - case '8': fa = dtmf_tones[2]; fb = dtmf_tones[5]; break; - case '9': fa = dtmf_tones[2]; fb = dtmf_tones[6]; break; - case 'C': fa = dtmf_tones[2]; fb = dtmf_tones[7]; break; - case '*': fa = dtmf_tones[3]; fb = dtmf_tones[4]; break; - case '0': fa = dtmf_tones[3]; fb = dtmf_tones[5]; break; - case '#': fa = dtmf_tones[3]; fb = dtmf_tones[6]; break; - case 'D': fa = dtmf_tones[3]; fb = dtmf_tones[7]; break; - case '?': - - if (strcmp(result, "123A456B789C*0#D123$789$") == 0) { - dw_printf ("\nSuccess!\n"); - } - else { - dw_printf ("\n *** TEST FAILED ***\n"); - dw_printf ("\"%s\"\n", result); - } - break; - - default: fa = 0; fb = 0; - } - - for (i = 0; i < (ms*D.sample_rate)/1000; i++) { - - input = sin(phasea) + sin(phaseb); - phasea += 2 * M_PI * fa / D.sample_rate; - phaseb += 2 * M_PI * fb / D.sample_rate; - - /* Make sure it is insensitive to signal amplitude. */ - - x = dtmf_sample (0, input); - //x = dtmf_sample (0, input * 1000); - //x = dtmf_sample (0, input * 0.001); - - if (x != ' ' && x != '.') { - result[result_len] = x; - result_len++; - result[result_len] = '\0'; - } - } -} - -main () -{ - - dtmf_init(44100); - - dw_printf ("\nFirst, check all button tone pairs. \n\n"); - /* Max auto dialing rate is 10 per second. */ - - push_button ('1', 50); push_button (' ', 50); - push_button ('2', 50); push_button (' ', 50); - push_button ('3', 50); push_button (' ', 50); - push_button ('A', 50); push_button (' ', 50); - - push_button ('4', 50); push_button (' ', 50); - push_button ('5', 50); push_button (' ', 50); - push_button ('6', 50); push_button (' ', 50); - push_button ('B', 50); push_button (' ', 50); - - push_button ('7', 50); push_button (' ', 50); - push_button ('8', 50); push_button (' ', 50); - push_button ('9', 50); push_button (' ', 50); - push_button ('C', 50); push_button (' ', 50); - - push_button ('*', 50); push_button (' ', 50); - push_button ('0', 50); push_button (' ', 50); - push_button ('#', 50); push_button (' ', 50); - push_button ('D', 50); push_button (' ', 50); - - dw_printf ("\nShould reject very short pulses.\n\n"); - - push_button ('1', 20); push_button (' ', 50); - push_button ('1', 20); push_button (' ', 50); - push_button ('1', 20); push_button (' ', 50); - push_button ('1', 20); push_button (' ', 50); - push_button ('1', 20); push_button (' ', 50); - - dw_printf ("\nTest timeout after inactivity.\n\n"); - /* For this test we use 1 second. */ - /* In practice, it will probably more like 10 or 20. */ - - push_button ('1', 250); push_button (' ', 500); - push_button ('2', 250); push_button (' ', 500); - push_button ('3', 250); push_button (' ', 1200); - - push_button ('7', 250); push_button (' ', 500); - push_button ('8', 250); push_button (' ', 500); - push_button ('9', 250); push_button (' ', 1200); - - /* Check for expected results. */ - - push_button ('?', 0); - -} /* end main */ - -#endif - -/* end dtmf.c */ - diff --git a/dtmf.h b/dtmf.h deleted file mode 100644 index 5c3c584c..00000000 --- a/dtmf.h +++ /dev/null @@ -1,10 +0,0 @@ -/* dtmf.h */ - - -void dtmf_init (int sample_rate); - -char dtmf_sample (int c, float input); - - -/* end dtmf.h */ - diff --git a/dw-icon.rc b/dw-icon.rc deleted file mode 100644 index ce34b403..00000000 --- a/dw-icon.rc +++ /dev/null @@ -1 +0,0 @@ -MAINICON ICON "dw-icon.ico" \ No newline at end of file diff --git a/dw-start.sh b/dw-start.sh deleted file mode 100644 index b4829b4f..00000000 --- a/dw-start.sh +++ /dev/null @@ -1,77 +0,0 @@ -#!/bin/bash - -# -# Run this from crontab periodically to start up -# Dire Wolf automatically. -# -# I prefer this method instead of putting something -# in ~/.config/autostart. That would start an application -# only when the desktop first starts up. -# -# This method will restart the application if it -# crashes or stops for any other reason. -# -# This script has some specifics the Raspberry Pi. -# Some adjustments might be needed for other Linux variations. -# -# First wait a little while in case we just rebooted -# and the desktop hasn't started up yet. -# - -sleep 30 - -# -# Nothing to do if it is already running. -# - -a=`ps -ef | grep direwolf | grep -v grep` -if [ "$a" != "" ] -then - #date >> /tmp/dw-start.log - #echo "Already running." >> /tmp/dw-start.log - exit -fi - -# -# In my case, the Raspberry Pi is not connected to a monitor. -# I access it remotely using VNC as described here: -# http://learn.adafruit.com/adafruit-raspberry-pi-lesson-7-remote-control-with-vnc -# -# If VNC server is running, use its display number. -# Otherwise default to :0. -# - -date >> /tmp/dw-start.log - -export DISPLAY=":0" - -v=`ps -ef | grep Xtightvnc | grep -v grep` -if [ "$v" != "" ] -then - d=`echo "$v" | sed 's/.*tightvnc *\(:[0-9]\).*/\1/'` - export DISPLAY="$d" -fi - -echo "DISPLAY=$DISPLAY" >> /tmp/dw-start.log - -echo "Start up application." >> /tmp/dw-start.log - -# -# Adjust for your particular situation: gnome-terminal, xterm, etc. -# - -if [ -x /usr/bin/lxterminal ] -then - /usr/bin/lxterminal -t "Dire Wolf" -e "/usr/local/bin/direwolf" & -elif [ -x /usr/bin/xterm ] -then - /usr/bin/xterm -bg white -fg black -e /usr/local/bin/direwolf & -elif [ -x /usr/bin/x-terminal-emulator ] -then - /usr/bin/x-terminal-emulator -e /usr/local/bin/direwolf & -else - echo "Did not find an X terminal emulator." -fi - -echo "-----------------------" >> /tmp/dw-start.log - diff --git a/dwgps.c b/dwgps.c deleted file mode 100644 index 8f7533a4..00000000 --- a/dwgps.c +++ /dev/null @@ -1,419 +0,0 @@ -// -// This file is part of Dire Wolf, an amateur radio packet TNC. -// -// Copyright (C) 2013, 2014 John Langner, WB2OSZ -// -// This program 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 2 of the License, or -// (at your option) any later version. -// -// This program 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 this program. If not, see . -// - - -/*------------------------------------------------------------------ - * - * Module: dwgps.c - * - * Purpose: Interface to location data, i.e. GPS receiver. - * - * Description: Tracker beacons need to know the current location. - * At this time, I can't think of any other reason why - * we would need this information. - * - * For Linux, we use gpsd and libgps. - * This has the extra benefit that the system clock can - * be set from the GPS signal. - * - * Not yet implemented for Windows. Not sure how yet. - * The Windows location API is new in Windows 7. - * At the end of 2013, about 1/3 of Windows users are - * still using XP so that still needs to be supported. - * - * Reference: - * - *---------------------------------------------------------------*/ - -#if TEST -#define ENABLE_GPS 1 -#endif - - -#include -#include -#include -#include -#include -#include -#include - -#if __WIN32__ -#include -#else -#if ENABLE_GPS -#include - -#if GPSD_API_MAJOR_VERSION != 5 -#error libgps API version might be incompatible. -#endif - -#endif -#endif - -#include "direwolf.h" -#include "textcolor.h" -#include "dwgps.h" - - -/* Was init successful? */ - -static enum { INIT_NOT_YET, INIT_SUCCESS, INIT_FAILED } init_status = INIT_NOT_YET; - -#if __WIN32__ -#include -#else -#if ENABLE_GPS - -static struct gps_data_t gpsdata; - -#endif -#endif - - -/*------------------------------------------------------------------- - * - * Name: dwgps_init - * - * Purpose: Intialize the GPS interface. - * - * Inputs: none. - * - * Returns: 0 = success - * -1 = failure - * - * Description: For Linux, this maps into gps_open. - * Not yet implemented for Windows. - * - *--------------------------------------------------------------------*/ - -int dwgps_init (void) -{ - -#if __WIN32__ - -/* - * Windows version. Not implemented yet. - */ - - text_color_set(DW_COLOR_ERROR); - dw_printf ("GPS interface not yet available in Windows version.\n"); - init_status = INIT_FAILED; - return (-1); - -#elif ENABLE_GPS - - int err; - -#if USE_GPS_SHM - -/* - * Linux - Shared memory interface to gpsd. - * - * I wanted to use this method because it is simpler and more efficient. - * - * The current version of gpsd, supplied with Raspian, is 3.6 from back in - * May 2012, is missing support for the shared memory interface. - * https://github.com/raspberrypi/linux/issues/523 - * - * I tried to download a newer source and build with shared memory support - * but ran into a couple other issues. - * - * sudo apt-get install libncurses5-dev - * sudo apt-get install scons - * cd ~ - * wget http://download-mirror.savannah.gnu.org/releases/gpsd/gpsd-3.11.tar.gz - * tar xfz gpsd-3.11.tar.gz - * cd gpsd-3.11 - * scons prefix=/usr libdir=lib/arm-linux-gnueabihf shm_export=True python=False - * sudo scons udev-install - * - * For now, we will use the socket interface. - * Maybe get back to this again someday. - */ - - err = gps_open (GPSD_SHARED_MEMORY, NULL, &gpsdata); - if (err != 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Unable to connect to GPSD shared memory interface, status=%d.\n", err); - if (err == NL_NOHOST) { - // I don't think this is right but we are not using it anyhow. - dw_printf ("Shared memory interface is not enabled in libgps.\n"); - dw_printf ("Download the gpsd source and build with 'shm_export=True' option.\n"); - } - else { - dw_printf ("%s\n", gps_errstr(errno)); - } - init_status = INIT_FAILED; - return (-1); - } - init_status = INIT_SUCCESS; - return (0); - -#else - -/* - * Linux - Socket interface to gpsd. - */ - - err = gps_open ("localhost", DEFAULT_GPSD_PORT, &gpsdata); - if (err != 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Unable to connect to GPSD stream, status%d.\n", err); - dw_printf ("%s\n", gps_errstr(errno)); - init_status = INIT_FAILED; - return (-1); - } - - gps_stream(&gpsdata, WATCH_ENABLE | WATCH_JSON, NULL); - - init_status = INIT_SUCCESS; - return (0); - -#endif - -#else /* end ENABLE_GPS */ - - text_color_set(DW_COLOR_ERROR); - dw_printf ("GPS interface not enabled in this version.\n"); - dw_printf ("See documentation on how to rebuild with ENABLE_GPS.\n"); - init_status = INIT_FAILED; - return (-1); - -#endif - -} /* end dwgps_init */ - - - -/*------------------------------------------------------------------- - * - * Name: dwgps_read - * - * Purpose: Obtain current location from GPS receiver. - * - * Outputs: *plat - Latitude. - * *plon - Longitude. - * *pspeed - Speed, knots. - * *pcourse - Course over ground, degrees. - * *palt - Altitude, meters. - * - * Returns: -1 = error - * 0 = location currently not available (no fix) - * 2 = 2D fix, lat/lon, speed, and course are set. - * 3 - 3D fix, altitude is also set. - * - *--------------------------------------------------------------------*/ - -int dwgps_read (double *plat, double *plon, float *pspeed, float *pcourse, float *palt) -{ -#if __WIN32__ - - text_color_set(DW_COLOR_ERROR); - dw_printf ("Internal error, dwgps_read, shouldn't be here.\n"); - return (-1); - -#elif ENABLE_GPS - - int err; - - if (init_status != INIT_SUCCESS) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Internal error, dwgps_read without successful init.\n"); - return (-1); - } - -#if USE_GPS_SHM - -/* - * Shared memory version. - */ - - err = gps_read (&gpsdata); - -#if DEBUG - dw_printf ("gps_read returns %d bytes\n", err); -#endif - -#else - -/* - * Socket version. - */ - - // Wait for up to 1000 milliseconds. - // This should only happen in the beaconing thread so - // I'm not worried about other functions hanging. - - if (gps_waiting(&gpsdata, 1000)) { - - err = gps_read (&gpsdata); - } - else { - gps_stream(&gpsdata, WATCH_ENABLE | WATCH_JSON, NULL); - sleep (1); - } - -#endif - - if (err > 0) { - /* Data is available. */ - - if (gpsdata.status >= STATUS_FIX && gpsdata.fix.mode >= MODE_2D) { - - *plat = gpsdata.fix.latitude; - *plon = gpsdata.fix.longitude; - *pcourse = gpsdata.fix.track; - *pspeed = MPS_TO_KNOTS * gpsdata.fix.speed; /* libgps uses meters/sec */ - - if (gpsdata.fix.mode >= MODE_3D) { - *palt = gpsdata.fix.altitude; - return (3); - } - return (2); - } - - /* No fix. Probably temporary condition. */ - return (0); - } - else if (err == 0) { - - /* No data available at the present time. */ - return (0); - } - else { - - /* More serious error. */ - return (-1); - } -#else - - text_color_set(DW_COLOR_ERROR); - dw_printf ("Internal error, dwgps_read, shouldn't be here.\n"); - return (-1); -#endif - -} /* end dwgps_read */ - - -/*------------------------------------------------------------------- - * - * Name: dwgps_term - * - * Purpose: Shut down GPS interface before exiting from application. - * - * Inputs: none. - * - * Returns: none. - * - *--------------------------------------------------------------------*/ - -void dwgps_term (void) { - -#if __WIN32__ - -#elif ENABLE_GPS - - if (init_status == INIT_SUCCESS) { - -#ifndef USE_GPS_SHM - gps_stream(&gpsdata, WATCH_DISABLE, NULL); -#endif - gps_close (&gpsdata); - } -#else - -#endif - -} /* end dwgps_term */ - - - - -/*------------------------------------------------------------------- - * - * Name: main - * - * Purpose: Simple unit test for other functions in this file. - * - * Description: Compile with -DTEST option. - * - * gcc -DTEST dwgps.c textcolor.c -lgps - * ./a.out - * - *--------------------------------------------------------------------*/ - -#if TEST - -int main (int argc, char *argv[]) -{ - -#if __WIN32__ - - printf ("Not in win32 version yet.\n"); - -#elif ENABLE_GPS - int err; - int fix; - double lat; - double lon; - float speed; - float course; - float alt; - - err = dwgps_init (); - - if (err != 0) exit(1); - - while (1) { - fix = dwgps_read (&lat, &lon, &speed, &course, &alt) ; - switch (fix) { - case 3: - case 2: - dw_printf ("%.6f %.6f", lat, lon); - dw_printf (" %.1f knots %.0f degrees", speed, course); - if (fix==3) dw_printf (" altitude = %.1f meters", alt); - dw_printf ("\n"); - break; - case 0: - dw_printf ("location currently not available.\n"); - break; - default: - dw_printf ("ERROR getting GPS information.\n"); - } - sleep (3); - } - - -#else - - printf ("Test: Shouldn't be here.\n"); -#endif - -} /* end main */ - - -#endif - - - -/* end dwgps.c */ - - - diff --git a/dwgps.h b/dwgps.h deleted file mode 100644 index 90aa342d..00000000 --- a/dwgps.h +++ /dev/null @@ -1,15 +0,0 @@ - -/* dwgps.h */ - - -int dwgps_init (void); - -int dwgps_read (double *plat, double *plon, float *pspeed, float *pcourse, float *palt); - -void dwgps_term (void); - - -/* end dwgps.h */ - - - diff --git a/LICENSE-other.txt b/external/LICENSE similarity index 100% rename from LICENSE-other.txt rename to external/LICENSE diff --git a/external/geotranz/CMakeLists.txt b/external/geotranz/CMakeLists.txt new file mode 100644 index 00000000..576d8b82 --- /dev/null +++ b/external/geotranz/CMakeLists.txt @@ -0,0 +1,17 @@ +# UTM, USNG, MGRS conversions + +set(GEOTRANZ_LIBRARIES geotranz CACHE INTERNAL "geotranz") + +list(APPEND geotranz_SOURCES + error_string.c + mgrs.c + polarst.c + tranmerc.c + ups.c + usng.c + utm.c + ) + +add_library(geotranz STATIC + ${geotranz_SOURCES} + ) diff --git a/external/geotranz/README-FIRST.txt b/external/geotranz/README-FIRST.txt new file mode 100644 index 00000000..602f1144 --- /dev/null +++ b/external/geotranz/README-FIRST.txt @@ -0,0 +1,5 @@ + +This directory contains a subset of geotrans 2.4.2 from + +https://github.com/smanders/geotranz + diff --git a/external/geotranz/error_string.c b/external/geotranz/error_string.c new file mode 100644 index 00000000..d9301887 --- /dev/null +++ b/external/geotranz/error_string.c @@ -0,0 +1,131 @@ + +#include +#include + +#include "utm.h" +#include "mgrs.h" +#include "usng.h" + +#include "error_string.h" + + +// Convert error codes to text. +// Note that the code is a bit mask so it is possible to have multiple messages. +// Caller should probably provide space for a couple hundred characters to be safe. + + +static const struct { + long mask; + char *msg; +} utm_err [] = { + + { UTM_NO_ERROR, "No errors occurred in function" }, + { UTM_LAT_ERROR, "Latitude outside of valid range (-80.5 to 84.5 degrees)" }, + { UTM_LON_ERROR, "Longitude outside of valid range (-180 to 360 degrees)" }, + { UTM_EASTING_ERROR, "Easting outside of valid range (100,000 to 900,000 meters)" }, + { UTM_NORTHING_ERROR, "Northing outside of valid range (0 to 10,000,000 meters)" }, + { UTM_ZONE_ERROR, "Zone outside of valid range (1 to 60)" }, + { UTM_HEMISPHERE_ERROR, "Invalid hemisphere ('N' or 'S')" }, + { UTM_ZONE_OVERRIDE_ERROR,"Zone outside of valid range (1 to 60) and within 1 of 'natural' zone" }, + { UTM_A_ERROR, "Semi-major axis less than or equal to zero" }, + { UTM_INV_F_ERROR, "Inverse flattening outside of valid range (250 to 350)" }, + { 0, NULL } }; + + +static const struct { + long mask; + char *msg; +} mgrs_err [] = { + + { MGRS_NO_ERROR, "No errors occurred in function" }, + { MGRS_LAT_ERROR, "Latitude outside of valid range (-90 to 90 degrees)" }, + { MGRS_LON_ERROR, "Longitude outside of valid range (-180 to 360 degrees)" }, + { MGRS_STRING_ERROR, "An MGRS string error: string too long, too short, or badly formed" }, + { MGRS_PRECISION_ERROR, "The precision must be between 0 and 5 inclusive." }, + { MGRS_A_ERROR, "Inverse flattening outside of valid range (250 to 350)" }, + { MGRS_INV_F_ERROR, "Invalid hemisphere ('N' or 'S')" }, + { MGRS_EASTING_ERROR, "Easting outside of valid range (100,000 to 900,000 meters for UTM) (0 to 4,000,000 meters for UPS)" }, + { MGRS_NORTHING_ERROR, "Northing outside of valid range (0 to 10,000,000 meters for UTM) (0 to 4,000,000 meters for UPS)" }, + { MGRS_ZONE_ERROR, "Zone outside of valid range (1 to 60)" }, + { MGRS_HEMISPHERE_ERROR, "Invalid hemisphere ('N' or 'S')" }, + { MGRS_LAT_WARNING, "Latitude warning ???" }, + { 0, NULL } }; + + +static const struct { + long mask; + char *msg; +} usng_err [] = { + + { USNG_NO_ERROR, "No errors occurred in function" }, + { USNG_LAT_ERROR, "Latitude outside of valid range (-90 to 90 degrees)" }, + { USNG_LON_ERROR, "Longitude outside of valid range (-180 to 360 degrees)" }, + { USNG_STRING_ERROR, "A USNG string error: string too long, too short, or badly formed" }, + { USNG_PRECISION_ERROR, "The precision must be between 0 and 5 inclusive." }, + { USNG_A_ERROR, "Inverse flattening outside of valid range (250 to 350)" }, + { USNG_INV_F_ERROR, "Invalid hemisphere ('N' or 'S')" }, + { USNG_EASTING_ERROR, "Easting outside of valid range (100,000 to 900,000 meters for UTM) (0 to 4,000,000 meters for UPS)" }, + { USNG_NORTHING_ERROR, "Northing outside of valid range (0 to 10,000,000 meters for UTM) (0 to 4,000,000 meters for UPS)" }, + { USNG_ZONE_ERROR, "Zone outside of valid range (1 to 60)" }, + { USNG_HEMISPHERE_ERROR, "Invalid hemisphere ('N' or 'S')" }, + { USNG_LAT_WARNING, "Latitude warning ???" }, + { 0, NULL } }; + + + +void utm_error_string (long err, char *str) +{ + int n; + + strcpy (str, ""); + + for (n = 1; utm_err[n].mask != 0; n++) { + if (err & utm_err[n].mask) { + if (strlen(str) > 0) strcat(str, "\n"); + strcat (str, utm_err[n].msg); + } + } + + if (strlen(str) == 0) { + strcpy (str, utm_err[0].msg); + } +} + +void mgrs_error_string (long err, char *str) +{ + int n; + + strcpy (str, ""); + + for (n = 1; mgrs_err[n].mask != 0; n++) { + if (err & mgrs_err[n].mask) { + if (strlen(str) > 0) strcat(str, "\n"); + strcat (str, mgrs_err[n].msg); + } + } + + if (strlen(str) == 0) { + strcpy (str, mgrs_err[0].msg); + } +} + + +void usng_error_string (long err, char *str) +{ + int n; + + strcpy (str, ""); + + for (n = 1; usng_err[n].mask != 0; n++) { + if (err & usng_err[n].mask) { + if (strlen(str) > 0) strcat(str, "\n"); + strcat (str, usng_err[n].msg); + } + } + + if (strlen(str) == 0) { + strcpy (str, usng_err[0].msg); + } +} + + diff --git a/external/geotranz/error_string.h b/external/geotranz/error_string.h new file mode 100644 index 00000000..43e591d8 --- /dev/null +++ b/external/geotranz/error_string.h @@ -0,0 +1,7 @@ + + +void utm_error_string (long err, char *str); + +void mgrs_error_string (long err, char *str); + +void usng_error_string (long err, char *str); diff --git a/external/geotranz/mgrs.c b/external/geotranz/mgrs.c new file mode 100644 index 00000000..84454abb --- /dev/null +++ b/external/geotranz/mgrs.c @@ -0,0 +1,1347 @@ +/***************************************************************************/ +/* RSC IDENTIFIER: MGRS + * + * ABSTRACT + * + * This component converts between geodetic coordinates (latitude and + * longitude) and Military Grid Reference System (MGRS) coordinates. + * + * ERROR HANDLING + * + * This component checks parameters for valid values. If an invalid value + * is found, the error code is combined with the current error code using + * the bitwise or. This combining allows multiple error codes to be + * returned. The possible error codes are: + * + * MGRS_NO_ERROR : No errors occurred in function + * MGRS_LAT_ERROR : Latitude outside of valid range + * (-90 to 90 degrees) + * MGRS_LON_ERROR : Longitude outside of valid range + * (-180 to 360 degrees) + * MGRS_STR_ERROR : An MGRS string error: string too long, + * too short, or badly formed + * MGRS_PRECISION_ERROR : The precision must be between 0 and 5 + * inclusive. + * MGRS_A_ERROR : Semi-major axis less than or equal to zero + * MGRS_INV_F_ERROR : Inverse flattening outside of valid range + * (250 to 350) + * MGRS_EASTING_ERROR : Easting outside of valid range + * (100,000 to 900,000 meters for UTM) + * (0 to 4,000,000 meters for UPS) + * MGRS_NORTHING_ERROR : Northing outside of valid range + * (0 to 10,000,000 meters for UTM) + * (0 to 4,000,000 meters for UPS) + * MGRS_ZONE_ERROR : Zone outside of valid range (1 to 60) + * MGRS_HEMISPHERE_ERROR : Invalid hemisphere ('N' or 'S') + * + * REUSE NOTES + * + * MGRS is intended for reuse by any application that does conversions + * between geodetic coordinates and MGRS coordinates. + * + * REFERENCES + * + * Further information on MGRS can be found in the Reuse Manual. + * + * MGRS originated from : U.S. Army Topographic Engineering Center + * Geospatial Information Division + * 7701 Telegraph Road + * Alexandria, VA 22310-3864 + * + * LICENSES + * + * None apply to this component. + * + * RESTRICTIONS + * + * + * ENVIRONMENT + * + * MGRS was tested and certified in the following environments: + * + * 1. Solaris 2.5 with GCC version 2.8.1 + * 2. Windows 95 with MS Visual C++ version 6 + * + * MODIFICATIONS + * + * Date Description + * ---- ----------- + * 16-11-94 Original Code + * 15-09-99 Reengineered upper layers + * 02-05-03 Corrected latitude band bug in GRID_UTM + * 08-20-03 Reengineered lower layers + */ + + +/***************************************************************************/ +/* + * INCLUDES + */ +#include +#include +#include +#include +#include "ups.h" +#include "utm.h" +#include "mgrs.h" + +/* + * ctype.h - Standard C character handling library + * math.h - Standard C math library + * stdio.h - Standard C input/output library + * string.h - Standard C string handling library + * ups.h - Universal Polar Stereographic (UPS) projection + * utm.h - Universal Transverse Mercator (UTM) projection + * mgrs.h - function prototype error checking + */ + + +/***************************************************************************/ +/* + * GLOBAL DECLARATIONS + */ +#define DEG_TO_RAD 0.017453292519943295 /* PI/180 */ +#define RAD_TO_DEG 57.29577951308232087 /* 180/PI */ +#define LETTER_A 0 /* ARRAY INDEX FOR LETTER A */ +#define LETTER_B 1 /* ARRAY INDEX FOR LETTER B */ +#define LETTER_C 2 /* ARRAY INDEX FOR LETTER C */ +#define LETTER_D 3 /* ARRAY INDEX FOR LETTER D */ +#define LETTER_E 4 /* ARRAY INDEX FOR LETTER E */ +#define LETTER_F 5 /* ARRAY INDEX FOR LETTER F */ +#define LETTER_G 6 /* ARRAY INDEX FOR LETTER G */ +#define LETTER_H 7 /* ARRAY INDEX FOR LETTER H */ +#define LETTER_I 8 /* ARRAY INDEX FOR LETTER I */ +#define LETTER_J 9 /* ARRAY INDEX FOR LETTER J */ +#define LETTER_K 10 /* ARRAY INDEX FOR LETTER K */ +#define LETTER_L 11 /* ARRAY INDEX FOR LETTER L */ +#define LETTER_M 12 /* ARRAY INDEX FOR LETTER M */ +#define LETTER_N 13 /* ARRAY INDEX FOR LETTER N */ +#define LETTER_O 14 /* ARRAY INDEX FOR LETTER O */ +#define LETTER_P 15 /* ARRAY INDEX FOR LETTER P */ +#define LETTER_Q 16 /* ARRAY INDEX FOR LETTER Q */ +#define LETTER_R 17 /* ARRAY INDEX FOR LETTER R */ +#define LETTER_S 18 /* ARRAY INDEX FOR LETTER S */ +#define LETTER_T 19 /* ARRAY INDEX FOR LETTER T */ +#define LETTER_U 20 /* ARRAY INDEX FOR LETTER U */ +#define LETTER_V 21 /* ARRAY INDEX FOR LETTER V */ +#define LETTER_W 22 /* ARRAY INDEX FOR LETTER W */ +#define LETTER_X 23 /* ARRAY INDEX FOR LETTER X */ +#define LETTER_Y 24 /* ARRAY INDEX FOR LETTER Y */ +#define LETTER_Z 25 /* ARRAY INDEX FOR LETTER Z */ +#define MGRS_LETTERS 3 /* NUMBER OF LETTERS IN MGRS */ +#define ONEHT 100000.e0 /* ONE HUNDRED THOUSAND */ +#define TWOMIL 2000000.e0 /* TWO MILLION */ +#define TRUE 1 /* CONSTANT VALUE FOR TRUE VALUE */ +#define FALSE 0 /* CONSTANT VALUE FOR FALSE VALUE */ +#define PI 3.14159265358979323e0 /* PI */ +#define PI_OVER_2 (PI / 2.0e0) + +#define MIN_EASTING 100000 +#define MAX_EASTING 900000 +#define MIN_NORTHING 0 +#define MAX_NORTHING 10000000 +#define MAX_PRECISION 5 /* Maximum precision of easting & northing */ +#define MIN_UTM_LAT ( (-80 * PI) / 180.0 ) /* -80 degrees in radians */ +#define MAX_UTM_LAT ( (84 * PI) / 180.0 ) /* 84 degrees in radians */ + +#define MIN_EAST_NORTH 0 +#define MAX_EAST_NORTH 4000000 + + +/* Ellipsoid parameters, default to WGS 84 */ +double MGRS_a = 6378137.0; /* Semi-major axis of ellipsoid in meters */ +double MGRS_f = 1 / 298.257223563; /* Flattening of ellipsoid */ +char MGRS_Ellipsoid_Code[3] = {'W','E',0}; + + +/* + * CLARKE_1866 : Ellipsoid code for CLARKE_1866 + * CLARKE_1880 : Ellipsoid code for CLARKE_1880 + * BESSEL_1841 : Ellipsoid code for BESSEL_1841 + * BESSEL_1841_NAMIBIA : Ellipsoid code for BESSEL 1841 (NAMIBIA) + */ +const char* CLARKE_1866 = "CC"; +const char* CLARKE_1880 = "CD"; +const char* BESSEL_1841 = "BR"; +const char* BESSEL_1841_NAMIBIA = "BN"; + + +typedef struct Latitude_Band_Value +{ + long letter; /* letter representing latitude band */ + double min_northing; /* minimum northing for latitude band */ + double north; /* upper latitude for latitude band */ + double south; /* lower latitude for latitude band */ + double northing_offset; /* latitude band northing offset */ +} Latitude_Band; + +static const Latitude_Band Latitude_Band_Table[20] = + {{LETTER_C, 1100000.0, -72.0, -80.5, 0.0}, + {LETTER_D, 2000000.0, -64.0, -72.0, 2000000.0}, + {LETTER_E, 2800000.0, -56.0, -64.0, 2000000.0}, + {LETTER_F, 3700000.0, -48.0, -56.0, 2000000.0}, + {LETTER_G, 4600000.0, -40.0, -48.0, 4000000.0}, + {LETTER_H, 5500000.0, -32.0, -40.0, 4000000.0}, + {LETTER_J, 6400000.0, -24.0, -32.0, 6000000.0}, + {LETTER_K, 7300000.0, -16.0, -24.0, 6000000.0}, + {LETTER_L, 8200000.0, -8.0, -16.0, 8000000.0}, + {LETTER_M, 9100000.0, 0.0, -8.0, 8000000.0}, + {LETTER_N, 0.0, 8.0, 0.0, 0.0}, + {LETTER_P, 800000.0, 16.0, 8.0, 0.0}, + {LETTER_Q, 1700000.0, 24.0, 16.0, 0.0}, + {LETTER_R, 2600000.0, 32.0, 24.0, 2000000.0}, + {LETTER_S, 3500000.0, 40.0, 32.0, 2000000.0}, + {LETTER_T, 4400000.0, 48.0, 40.0, 4000000.0}, + {LETTER_U, 5300000.0, 56.0, 48.0, 4000000.0}, + {LETTER_V, 6200000.0, 64.0, 56.0, 6000000.0}, + {LETTER_W, 7000000.0, 72.0, 64.0, 6000000.0}, + {LETTER_X, 7900000.0, 84.5, 72.0, 6000000.0}}; + + +typedef struct UPS_Constant_Value +{ + long letter; /* letter representing latitude band */ + long ltr2_low_value; /* 2nd letter range - low number */ + long ltr2_high_value; /* 2nd letter range - high number */ + long ltr3_high_value; /* 3rd letter range - high number (UPS) */ + double false_easting; /* False easting based on 2nd letter */ + double false_northing; /* False northing based on 3rd letter */ +} UPS_Constant; + +static const UPS_Constant UPS_Constant_Table[4] = + {{LETTER_A, LETTER_J, LETTER_Z, LETTER_Z, 800000.0, 800000.0}, + {LETTER_B, LETTER_A, LETTER_R, LETTER_Z, 2000000.0, 800000.0}, + {LETTER_Y, LETTER_J, LETTER_Z, LETTER_P, 800000.0, 1300000.0}, + {LETTER_Z, LETTER_A, LETTER_J, LETTER_P, 2000000.0, 1300000.0}}; + +/***************************************************************************/ +/* + * FUNCTIONS + */ + +long Get_Latitude_Band_Min_Northing(long letter, double* min_northing, double* northing_offset) +/* + * The function Get_Latitude_Band_Min_Northing receives a latitude band letter + * and uses the Latitude_Band_Table to determine the minimum northing and northing offset + * for that latitude band letter. + * + * letter : Latitude band letter (input) + * min_northing : Minimum northing for that letter (output) + */ +{ /* Get_Latitude_Band_Min_Northing */ + long error_code = MGRS_NO_ERROR; + + if ((letter >= LETTER_C) && (letter <= LETTER_H)) + { + *min_northing = Latitude_Band_Table[letter-2].min_northing; + *northing_offset = Latitude_Band_Table[letter-2].northing_offset; + } + else if ((letter >= LETTER_J) && (letter <= LETTER_N)) + { + *min_northing = Latitude_Band_Table[letter-3].min_northing; + *northing_offset = Latitude_Band_Table[letter-3].northing_offset; + } + else if ((letter >= LETTER_P) && (letter <= LETTER_X)) + { + *min_northing = Latitude_Band_Table[letter-4].min_northing; + *northing_offset = Latitude_Band_Table[letter-4].northing_offset; + } + else + error_code |= MGRS_STRING_ERROR; + + return error_code; +} /* Get_Latitude_Band_Min_Northing */ + + +long Get_Latitude_Range(long letter, double* north, double* south) +/* + * The function Get_Latitude_Range receives a latitude band letter + * and uses the Latitude_Band_Table to determine the latitude band + * boundaries for that latitude band letter. + * + * letter : Latitude band letter (input) + * north : Northern latitude boundary for that letter (output) + * north : Southern latitude boundary for that letter (output) + */ +{ /* Get_Latitude_Range */ + long error_code = MGRS_NO_ERROR; + + if ((letter >= LETTER_C) && (letter <= LETTER_H)) + { + *north = Latitude_Band_Table[letter-2].north * DEG_TO_RAD; + *south = Latitude_Band_Table[letter-2].south * DEG_TO_RAD; + } + else if ((letter >= LETTER_J) && (letter <= LETTER_N)) + { + *north = Latitude_Band_Table[letter-3].north * DEG_TO_RAD; + *south = Latitude_Band_Table[letter-3].south * DEG_TO_RAD; + } + else if ((letter >= LETTER_P) && (letter <= LETTER_X)) + { + *north = Latitude_Band_Table[letter-4].north * DEG_TO_RAD; + *south = Latitude_Band_Table[letter-4].south * DEG_TO_RAD; + } + else + error_code |= MGRS_STRING_ERROR; + + return error_code; +} /* Get_Latitude_Range */ + + +long Get_Latitude_Letter(double latitude, int* letter) +/* + * The function Get_Latitude_Letter receives a latitude value + * and uses the Latitude_Band_Table to determine the latitude band + * letter for that latitude. + * + * latitude : Latitude (input) + * letter : Latitude band letter (output) + */ +{ /* Get_Latitude_Letter */ + double temp = 0.0; + long error_code = MGRS_NO_ERROR; + double lat_deg = latitude * RAD_TO_DEG; + + if (lat_deg >= 72 && lat_deg < 84.5) + *letter = LETTER_X; + else if (lat_deg > -80.5 && lat_deg < 72) + { + temp = ((latitude + (80.0 * DEG_TO_RAD)) / (8.0 * DEG_TO_RAD)) + 1.0e-12; + *letter = Latitude_Band_Table[(int)temp].letter; + } + else + error_code |= MGRS_LAT_ERROR; + + return error_code; +} /* Get_Latitude_Letter */ + + +long Check_Zone(char* MGRS, long* zone_exists) +/* + * The function Check_Zone receives an MGRS coordinate string. + * If a zone is given, TRUE is returned. Otherwise, FALSE + * is returned. + * + * MGRS : MGRS coordinate string (input) + * zone_exists : TRUE if a zone is given, + * FALSE if a zone is not given (output) + */ +{ /* Check_Zone */ + int i = 0; + int j = 0; + int num_digits = 0; + long error_code = MGRS_NO_ERROR; + + /* skip any leading blanks */ + while (MGRS[i] == ' ') + i++; + j = i; + while (isdigit(MGRS[i])) + i++; + num_digits = i - j; + if (num_digits <= 2) + if (num_digits > 0) + *zone_exists = TRUE; + else + *zone_exists = FALSE; + else + error_code |= MGRS_STRING_ERROR; + + return error_code; +} /* Check_Zone */ + + +long Round_MGRS (double value) +/* + * The function Round_MGRS rounds the input value to the + * nearest integer, using the standard engineering rule. + * The rounded integer value is then returned. + * + * value : Value to be rounded (input) + */ +{ /* Round_MGRS */ + double ivalue; + long ival; + double fraction = modf (value, &ivalue); + ival = (long)(ivalue); + if ((fraction > 0.5) || ((fraction == 0.5) && (ival%2 == 1))) + ival++; + return (ival); +} /* Round_MGRS */ + + +long Make_MGRS_String (char* MGRS, + long Zone, + int Letters[MGRS_LETTERS], + double Easting, + double Northing, + long Precision) +/* + * The function Make_MGRS_String constructs an MGRS string + * from its component parts. + * + * MGRS : MGRS coordinate string (output) + * Zone : UTM Zone (input) + * Letters : MGRS coordinate string letters (input) + * Easting : Easting value (input) + * Northing : Northing value (input) + * Precision : Precision level of MGRS string (input) + */ +{ /* Make_MGRS_String */ + long i; + long j; + double divisor; + long east; + long north; + char alphabet[] = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"; + long error_code = MGRS_NO_ERROR; + + i = 0; + if (Zone) + i = sprintf (MGRS+i,"%2.2ld",Zone); + else + strcpy(MGRS, " "); // 2 spaces - Should i be set to 2? + + for (j=0;j<3;j++) + MGRS[i++] = alphabet[Letters[j]]; + divisor = pow (10.0, (5 - Precision)); + Easting = fmod (Easting, 100000.0); + if (Easting >= 99999.5) + Easting = 99999.0; + east = (long)(Easting/divisor); + i += sprintf (MGRS+i, "%*.*ld", (int)Precision, (int)Precision, east); + Northing = fmod (Northing, 100000.0); + if (Northing >= 99999.5) + Northing = 99999.0; + north = (long)(Northing/divisor); + i += sprintf (MGRS+i, "%*.*ld", (int)Precision, (int)Precision, north); + return (error_code); +} /* Make_MGRS_String */ + + +long Break_MGRS_String (char* MGRS, + long* Zone, + long Letters[MGRS_LETTERS], + double* Easting, + double* Northing, + long* Precision) +/* + * The function Break_MGRS_String breaks down an MGRS + * coordinate string into its component parts. + * + * MGRS : MGRS coordinate string (input) + * Zone : UTM Zone (output) + * Letters : MGRS coordinate string letters (output) + * Easting : Easting value (output) + * Northing : Northing value (output) + * Precision : Precision level of MGRS string (output) + */ +{ /* Break_MGRS_String */ + long num_digits; + long num_letters; + long i = 0; + long j = 0; + long error_code = MGRS_NO_ERROR; + + while (MGRS[i] == ' ') + i++; /* skip any leading blanks */ + j = i; + while (isdigit(MGRS[i])) + i++; + num_digits = i - j; + if (num_digits <= 2) + if (num_digits > 0) + { + char zone_string[3]; + /* get zone */ + strncpy (zone_string, MGRS+j, 2); + zone_string[2] = 0; + sscanf (zone_string, "%ld", Zone); + if ((*Zone < 1) || (*Zone > 60)) + error_code |= MGRS_STRING_ERROR; + } + else + *Zone = 0; + else + error_code |= MGRS_STRING_ERROR; + j = i; + + while (isalpha(MGRS[i])) + i++; + num_letters = i - j; + if (num_letters == 3) + { + /* get letters */ + Letters[0] = (toupper(MGRS[j]) - (long)'A'); + if ((Letters[0] == LETTER_I) || (Letters[0] == LETTER_O)) + error_code |= MGRS_STRING_ERROR; + Letters[1] = (toupper(MGRS[j+1]) - (long)'A'); + if ((Letters[1] == LETTER_I) || (Letters[1] == LETTER_O)) + error_code |= MGRS_STRING_ERROR; + Letters[2] = (toupper(MGRS[j+2]) - (long)'A'); + if ((Letters[2] == LETTER_I) || (Letters[2] == LETTER_O)) + error_code |= MGRS_STRING_ERROR; + } + else + error_code |= MGRS_STRING_ERROR; + j = i; + while (isdigit(MGRS[i])) + i++; + num_digits = i - j; + if ((num_digits <= 10) && (num_digits%2 == 0)) + { + long n; + char east_string[6]; + char north_string[6]; + long east; + long north; + double multiplier; + /* get easting & northing */ + n = num_digits/2; + *Precision = n; + if (n > 0) + { + strncpy (east_string, MGRS+j, n); + east_string[n] = 0; + sscanf (east_string, "%ld", &east); + strncpy (north_string, MGRS+j+n, n); + north_string[n] = 0; + sscanf (north_string, "%ld", &north); + multiplier = pow (10.0, 5 - n); + *Easting = east * multiplier; + *Northing = north * multiplier; + } + else + { + *Easting = 0.0; + *Northing = 0.0; + } + } + else + error_code |= MGRS_STRING_ERROR; + + return (error_code); +} /* Break_MGRS_String */ + + +void Get_Grid_Values (long zone, + long* ltr2_low_value, + long* ltr2_high_value, + double *pattern_offset) +/* + * The function getGridValues sets the letter range used for + * the 2nd letter in the MGRS coordinate string, based on the set + * number of the utm zone. It also sets the pattern offset using a + * value of A for the second letter of the grid square, based on + * the grid pattern and set number of the utm zone. + * + * zone : Zone number (input) + * ltr2_low_value : 2nd letter low number (output) + * ltr2_high_value : 2nd letter high number (output) + * pattern_offset : Pattern offset (output) + */ +{ /* BEGIN Get_Grid_Values */ + long set_number; /* Set number (1-6) based on UTM zone number */ + long aa_pattern; /* Pattern based on ellipsoid code */ + + set_number = zone % 6; + + if (!set_number) + set_number = 6; + + if (!strcmp(MGRS_Ellipsoid_Code,CLARKE_1866) || !strcmp(MGRS_Ellipsoid_Code, CLARKE_1880) || + !strcmp(MGRS_Ellipsoid_Code,BESSEL_1841) || !strcmp(MGRS_Ellipsoid_Code,BESSEL_1841_NAMIBIA)) + aa_pattern = FALSE; + else + aa_pattern = TRUE; + + if ((set_number == 1) || (set_number == 4)) + { + *ltr2_low_value = LETTER_A; + *ltr2_high_value = LETTER_H; + } + else if ((set_number == 2) || (set_number == 5)) + { + *ltr2_low_value = LETTER_J; + *ltr2_high_value = LETTER_R; + } + else if ((set_number == 3) || (set_number == 6)) + { + *ltr2_low_value = LETTER_S; + *ltr2_high_value = LETTER_Z; + } + + /* False northing at A for second letter of grid square */ + if (aa_pattern) + { + if ((set_number % 2) == 0) + *pattern_offset = 500000.0; + else + *pattern_offset = 0.0; + } + else + { + if ((set_number % 2) == 0) + *pattern_offset = 1500000.0; + else + *pattern_offset = 1000000.00; + } +} /* END OF Get_Grid_Values */ + + +long UTM_To_MGRS (long Zone, + char Hemisphere, + double Longitude, + double Latitude, + double Easting, + double Northing, + long Precision, + char *MGRS) +/* + * The function UTM_To_MGRS calculates an MGRS coordinate string + * based on the zone, latitude, easting and northing. + * + * Zone : Zone number (input) + * Hemisphere: Hemisphere (input) + * Longitude : Longitude in radians (input) + * Latitude : Latitude in radians (input) + * Easting : Easting (input) + * Northing : Northing (input) + * Precision : Precision (input) + * MGRS : MGRS coordinate string (output) + */ +{ /* BEGIN UTM_To_MGRS */ + double pattern_offset; /* Northing offset for 3rd letter */ + double grid_easting; /* Easting used to derive 2nd letter of MGRS */ + double grid_northing; /* Northing used to derive 3rd letter of MGRS */ + long ltr2_low_value; /* 2nd letter range - low number */ + long ltr2_high_value; /* 2nd letter range - high number */ + int letters[MGRS_LETTERS]; /* Number location of 3 letters in alphabet */ + double divisor; + double rounded_easting; + long temp_error_code = MGRS_NO_ERROR; + long error_code = MGRS_NO_ERROR; + + divisor = pow (10.0, (5 - Precision)); + rounded_easting = Round_MGRS (Easting/divisor) * divisor; + + /* Special check for rounding to (truncated) eastern edge of zone 31V */ + if ((Zone == 31) && (((Latitude >= 56.0 * DEG_TO_RAD) && (Latitude < 64.0 * DEG_TO_RAD)) && ((Longitude >= 3.0 * DEG_TO_RAD) || (rounded_easting >= 500000.0)))) + { /* Reconvert to UTM zone 32 */ + Set_UTM_Parameters (MGRS_a, MGRS_f, 32); + temp_error_code = Convert_Geodetic_To_UTM (Latitude, Longitude, &Zone, &Hemisphere, &Easting, &Northing); + if(temp_error_code) + { + if(temp_error_code & UTM_LAT_ERROR) + error_code |= MGRS_LAT_ERROR; + if(temp_error_code & UTM_LON_ERROR) + error_code |= MGRS_LON_ERROR; + if(temp_error_code & UTM_ZONE_OVERRIDE_ERROR) + error_code |= MGRS_ZONE_ERROR; + if(temp_error_code & UTM_EASTING_ERROR) + error_code |= MGRS_EASTING_ERROR; + if(temp_error_code & UTM_NORTHING_ERROR) + error_code |= MGRS_NORTHING_ERROR; + + return error_code; + } + else + /* Round easting value using new easting */ + Easting = Round_MGRS (Easting/divisor) * divisor; + } + else + Easting = rounded_easting; + + /* Round northing values */ + Northing = Round_MGRS (Northing/divisor) * divisor; + + if( Latitude <= 0.0 && Northing == 1.0e7) + { + Latitude = 0.0; + Northing = 0.0; + } + + Get_Grid_Values(Zone, <r2_low_value, <r2_high_value, &pattern_offset); + + error_code = Get_Latitude_Letter(Latitude, &letters[0]); + + if (!error_code) + { + grid_northing = Northing; + + while (grid_northing >= TWOMIL) + { + grid_northing = grid_northing - TWOMIL; + } + grid_northing = grid_northing + pattern_offset; + if(grid_northing >= TWOMIL) + grid_northing = grid_northing - TWOMIL; + + letters[2] = (long)(grid_northing / ONEHT); + if (letters[2] > LETTER_H) + letters[2] = letters[2] + 1; + + if (letters[2] > LETTER_N) + letters[2] = letters[2] + 1; + + grid_easting = Easting; + if (((letters[0] == LETTER_V) && (Zone == 31)) && (grid_easting == 500000.0)) + grid_easting = grid_easting - 1.0; /* SUBTRACT 1 METER */ + + letters[1] = ltr2_low_value + ((long)(grid_easting / ONEHT) -1); + if ((ltr2_low_value == LETTER_J) && (letters[1] > LETTER_N)) + letters[1] = letters[1] + 1; + + Make_MGRS_String (MGRS, Zone, letters, grid_easting, Northing, Precision); + } + return error_code; +} /* END UTM_To_MGRS */ + + +long Set_MGRS_Parameters (double a, + double f, + char *Ellipsoid_Code) +/* + * The function SET_MGRS_PARAMETERS receives the ellipsoid parameters and sets + * the corresponding state variables. If any errors occur, the error code(s) + * are returned by the function, otherwise MGRS_NO_ERROR is returned. + * + * a : Semi-major axis of ellipsoid in meters (input) + * f : Flattening of ellipsoid (input) + * Ellipsoid_Code : 2-letter code for ellipsoid (input) + */ +{ /* Set_MGRS_Parameters */ + + double inv_f = 1 / f; + long Error_Code = MGRS_NO_ERROR; + + if (a <= 0.0) + { /* Semi-major axis must be greater than zero */ + Error_Code |= MGRS_A_ERROR; + } + if ((inv_f < 250) || (inv_f > 350)) + { /* Inverse flattening must be between 250 and 350 */ + Error_Code |= MGRS_INV_F_ERROR; + } + if (!Error_Code) + { /* no errors */ + MGRS_a = a; + MGRS_f = f; + strcpy (MGRS_Ellipsoid_Code, Ellipsoid_Code); + } + return (Error_Code); +} /* Set_MGRS_Parameters */ + + +void Get_MGRS_Parameters (double *a, + double *f, + char* Ellipsoid_Code) +/* + * The function Get_MGRS_Parameters returns the current ellipsoid + * parameters. + * + * a : Semi-major axis of ellipsoid, in meters (output) + * f : Flattening of ellipsoid (output) + * Ellipsoid_Code : 2-letter code for ellipsoid (output) + */ +{ /* Get_MGRS_Parameters */ + *a = MGRS_a; + *f = MGRS_f; + strcpy (Ellipsoid_Code, MGRS_Ellipsoid_Code); + return; +} /* Get_MGRS_Parameters */ + + +long Convert_Geodetic_To_MGRS (double Latitude, + double Longitude, + long Precision, + char* MGRS) +/* + * The function Convert_Geodetic_To_MGRS converts Geodetic (latitude and + * longitude) coordinates to an MGRS coordinate string, according to the + * current ellipsoid parameters. If any errors occur, the error code(s) + * are returned by the function, otherwise MGRS_NO_ERROR is returned. + * + * Latitude : Latitude in radians (input) + * Longitude : Longitude in radians (input) + * Precision : Precision level of MGRS string (input) + * MGRS : MGRS coordinate string (output) + * + */ +{ /* Convert_Geodetic_To_MGRS */ + long zone; + char hemisphere; + double easting; + double northing; + long temp_error_code = MGRS_NO_ERROR; + long error_code = MGRS_NO_ERROR; + + if ((Latitude < -PI_OVER_2) || (Latitude > PI_OVER_2)) + { /* Latitude out of range */ + error_code |= MGRS_LAT_ERROR; + } + if ((Longitude < -PI) || (Longitude > (2*PI))) + { /* Longitude out of range */ + error_code |= MGRS_LON_ERROR; + } + if ((Precision < 0) || (Precision > MAX_PRECISION)) + error_code |= MGRS_PRECISION_ERROR; + if (!error_code) + { + if ((Latitude < MIN_UTM_LAT) || (Latitude > MAX_UTM_LAT)) + { + temp_error_code = Set_UPS_Parameters (MGRS_a, MGRS_f); + if(!temp_error_code) + { + temp_error_code = Convert_Geodetic_To_UPS (Latitude, Longitude, &hemisphere, &easting, &northing); + if(!temp_error_code) + { + error_code |= Convert_UPS_To_MGRS (hemisphere, easting, northing, Precision, MGRS); + } + else + { + if(temp_error_code & UPS_LAT_ERROR) + error_code |= MGRS_LAT_ERROR; + if(temp_error_code & UPS_LON_ERROR) + error_code |= MGRS_LON_ERROR; + } + } + else + { + if(temp_error_code & UPS_A_ERROR) + error_code |= MGRS_A_ERROR; + if(temp_error_code & UPS_INV_F_ERROR) + error_code |= MGRS_INV_F_ERROR; + } + } + else + { + temp_error_code = Set_UTM_Parameters (MGRS_a, MGRS_f, 0); + if(!temp_error_code) + { + temp_error_code = Convert_Geodetic_To_UTM (Latitude, Longitude, &zone, &hemisphere, &easting, &northing); + if(!temp_error_code) + error_code |= UTM_To_MGRS (zone, hemisphere, Longitude, Latitude, easting, northing, Precision, MGRS); + else + { + if(temp_error_code & UTM_LAT_ERROR) + error_code |= MGRS_LAT_ERROR; + if(temp_error_code & UTM_LON_ERROR) + error_code |= MGRS_LON_ERROR; + if(temp_error_code & UTM_ZONE_OVERRIDE_ERROR) + error_code |= MGRS_ZONE_ERROR; + if(temp_error_code & UTM_EASTING_ERROR) + error_code |= MGRS_EASTING_ERROR; + if(temp_error_code & UTM_NORTHING_ERROR) + error_code |= MGRS_NORTHING_ERROR; + } + } + else + { + if(temp_error_code & UTM_A_ERROR) + error_code |= MGRS_A_ERROR; + if(temp_error_code & UTM_INV_F_ERROR) + error_code |= MGRS_INV_F_ERROR; + if(temp_error_code & UTM_ZONE_OVERRIDE_ERROR) + error_code |= MGRS_ZONE_ERROR; + } + } + } + return (error_code); +} /* Convert_Geodetic_To_MGRS */ + + +long Convert_MGRS_To_Geodetic (char* MGRS, + double *Latitude, + double *Longitude) +/* + * The function Convert_MGRS_To_Geodetic converts an MGRS coordinate string + * to Geodetic (latitude and longitude) coordinates + * according to the current ellipsoid parameters. If any errors occur, + * the error code(s) are returned by the function, otherwise UTM_NO_ERROR + * is returned. + * + * MGRS : MGRS coordinate string (input) + * Latitude : Latitude in radians (output) + * Longitude : Longitude in radians (output) + * + */ +{ /* Convert_MGRS_To_Geodetic */ + long zone; + char hemisphere = '?'; + double easting; + double northing; + long zone_exists; + long temp_error_code = MGRS_NO_ERROR; + long error_code = MGRS_NO_ERROR; + + error_code = Check_Zone(MGRS, &zone_exists); + if (!error_code) + { + if (zone_exists) + { + error_code |= Convert_MGRS_To_UTM (MGRS, &zone, &hemisphere, &easting, &northing); + if(!error_code || (error_code & MGRS_LAT_WARNING)) + { + temp_error_code = Set_UTM_Parameters (MGRS_a, MGRS_f, 0); + if(!temp_error_code) + { + temp_error_code = Convert_UTM_To_Geodetic (zone, hemisphere, easting, northing, Latitude, Longitude); + if(temp_error_code) + { + if((temp_error_code & UTM_ZONE_ERROR) || (temp_error_code & UTM_HEMISPHERE_ERROR)) + error_code |= MGRS_STRING_ERROR; + if(temp_error_code & UTM_EASTING_ERROR) + error_code |= MGRS_EASTING_ERROR; + if(temp_error_code & UTM_NORTHING_ERROR) + error_code |= MGRS_NORTHING_ERROR; + } + } + else + { + if(temp_error_code & UTM_A_ERROR) + error_code |= MGRS_A_ERROR; + if(temp_error_code & UTM_INV_F_ERROR) + error_code |= MGRS_INV_F_ERROR; + if(temp_error_code & UTM_ZONE_OVERRIDE_ERROR) + error_code |= MGRS_ZONE_ERROR; + } + } + } + else + { + error_code |= Convert_MGRS_To_UPS (MGRS, &hemisphere, &easting, &northing); + if(!error_code) + { + temp_error_code = Set_UPS_Parameters (MGRS_a, MGRS_f); + if(!temp_error_code) + { + temp_error_code = Convert_UPS_To_Geodetic (hemisphere, easting, northing, Latitude, Longitude); + if(temp_error_code) + { + if(temp_error_code & UPS_HEMISPHERE_ERROR) + error_code |= MGRS_STRING_ERROR; + if(temp_error_code & UPS_EASTING_ERROR) + error_code |= MGRS_EASTING_ERROR; + if(temp_error_code & UPS_LAT_ERROR) + error_code |= MGRS_NORTHING_ERROR; + } + } + else + { + if(temp_error_code & UPS_A_ERROR) + error_code |= MGRS_A_ERROR; + if(temp_error_code & UPS_INV_F_ERROR) + error_code |= MGRS_INV_F_ERROR; + } + } + } + } + return (error_code); +} /* END OF Convert_MGRS_To_Geodetic */ + + +long Convert_UTM_To_MGRS (long Zone, + char Hemisphere, + double Easting, + double Northing, + long Precision, + char* MGRS) +/* + * The function Convert_UTM_To_MGRS converts UTM (zone, easting, and + * northing) coordinates to an MGRS coordinate string, according to the + * current ellipsoid parameters. If any errors occur, the error code(s) + * are returned by the function, otherwise MGRS_NO_ERROR is returned. + * + * Zone : UTM zone (input) + * Hemisphere : North or South hemisphere (input) + * Easting : Easting (X) in meters (input) + * Northing : Northing (Y) in meters (input) + * Precision : Precision level of MGRS string (input) + * MGRS : MGRS coordinate string (output) + */ +{ /* Convert_UTM_To_MGRS */ + double latitude; /* Latitude of UTM point */ + double longitude; /* Longitude of UTM point */ + long utm_error_code = MGRS_NO_ERROR; + long error_code = MGRS_NO_ERROR; + + if ((Zone < 1) || (Zone > 60)) + error_code |= MGRS_ZONE_ERROR; + if ((Hemisphere != 'S') && (Hemisphere != 'N')) + error_code |= MGRS_HEMISPHERE_ERROR; + if ((Easting < MIN_EASTING) || (Easting > MAX_EASTING)) + error_code |= MGRS_EASTING_ERROR; + if ((Northing < MIN_NORTHING) || (Northing > MAX_NORTHING)) + error_code |= MGRS_NORTHING_ERROR; + if ((Precision < 0) || (Precision > MAX_PRECISION)) + error_code |= MGRS_PRECISION_ERROR; + if (!error_code) + { + Set_UTM_Parameters (MGRS_a, MGRS_f, 0); + utm_error_code = Convert_UTM_To_Geodetic (Zone, Hemisphere, Easting, Northing, &latitude, &longitude); + if(utm_error_code) + { + if((utm_error_code & UTM_ZONE_ERROR) || (utm_error_code & UTM_HEMISPHERE_ERROR)) + error_code |= MGRS_STRING_ERROR; + if(utm_error_code & UTM_EASTING_ERROR) + error_code |= MGRS_EASTING_ERROR; + if(utm_error_code & UTM_NORTHING_ERROR) + error_code |= MGRS_NORTHING_ERROR; + } + + error_code = UTM_To_MGRS (Zone, Hemisphere, longitude, latitude, Easting, Northing, Precision, MGRS); + } + return (error_code); +} /* Convert_UTM_To_MGRS */ + + +long Convert_MGRS_To_UTM (char *MGRS, + long *Zone, + char *Hemisphere, + double *Easting, + double *Northing) +/* + * The function Convert_MGRS_To_UTM converts an MGRS coordinate string + * to UTM projection (zone, hemisphere, easting and northing) coordinates + * according to the current ellipsoid parameters. If any errors occur, + * the error code(s) are returned by the function, otherwise UTM_NO_ERROR + * is returned. + * + * MGRS : MGRS coordinate string (input) + * Zone : UTM zone (output) + * Hemisphere : North or South hemisphere (output) + * Easting : Easting (X) in meters (output) + * Northing : Northing (Y) in meters (output) + */ +{ /* Convert_MGRS_To_UTM */ + double min_northing; + double northing_offset; + long ltr2_low_value; + long ltr2_high_value; + double pattern_offset; + double upper_lat_limit; /* North latitude limits based on 1st letter */ + double lower_lat_limit; /* South latitude limits based on 1st letter */ + double grid_easting; /* Easting for 100,000 meter grid square */ + double grid_northing; /* Northing for 100,000 meter grid square */ + long letters[MGRS_LETTERS]; + long in_precision; + double latitude = 0.0; + double longitude = 0.0; + double divisor = 1.0; + long utm_error_code = MGRS_NO_ERROR; + long error_code = MGRS_NO_ERROR; + + error_code = Break_MGRS_String (MGRS, Zone, letters, Easting, Northing, &in_precision); + if (!*Zone) + error_code |= MGRS_STRING_ERROR; + else + { + if (!error_code) + { + if ((letters[0] == LETTER_X) && ((*Zone == 32) || (*Zone == 34) || (*Zone == 36))) + error_code |= MGRS_STRING_ERROR; + else + { + if (letters[0] < LETTER_N) + *Hemisphere = 'S'; + else + *Hemisphere = 'N'; + + Get_Grid_Values(*Zone, <r2_low_value, <r2_high_value, &pattern_offset); + + /* Check that the second letter of the MGRS string is within + * the range of valid second letter values + * Also check that the third letter is valid */ + if ((letters[1] < ltr2_low_value) || (letters[1] > ltr2_high_value) || (letters[2] > LETTER_V)) + error_code |= MGRS_STRING_ERROR; + + if (!error_code) + { + double row_letter_northing = (double)(letters[2]) * ONEHT; + grid_easting = (double)((letters[1]) - ltr2_low_value + 1) * ONEHT; + if ((ltr2_low_value == LETTER_J) && (letters[1] > LETTER_O)) + grid_easting = grid_easting - ONEHT; + + if (letters[2] > LETTER_O) + row_letter_northing = row_letter_northing - ONEHT; + + if (letters[2] > LETTER_I) + row_letter_northing = row_letter_northing - ONEHT; + + if (row_letter_northing >= TWOMIL) + row_letter_northing = row_letter_northing - TWOMIL; + + error_code = Get_Latitude_Band_Min_Northing(letters[0], &min_northing, &northing_offset); + if (!error_code) + { + grid_northing = row_letter_northing - pattern_offset; + if(grid_northing < 0) + grid_northing += TWOMIL; + + grid_northing += northing_offset; + + if(grid_northing < min_northing) + grid_northing += TWOMIL; + + *Easting = grid_easting + *Easting; + *Northing = grid_northing + *Northing; + + /* check that point is within Zone Letter bounds */ + utm_error_code = Set_UTM_Parameters(MGRS_a,MGRS_f,0); + if (!utm_error_code) + { + utm_error_code = Convert_UTM_To_Geodetic(*Zone,*Hemisphere,*Easting,*Northing,&latitude,&longitude); + if (!utm_error_code) + { + divisor = pow (10.0, in_precision); + error_code = Get_Latitude_Range(letters[0], &upper_lat_limit, &lower_lat_limit); + if (!error_code) + { + if (!(((lower_lat_limit - DEG_TO_RAD/divisor) <= latitude) && (latitude <= (upper_lat_limit + DEG_TO_RAD/divisor)))) + error_code |= MGRS_LAT_WARNING; + } + } + else + { + if((utm_error_code & UTM_ZONE_ERROR) || (utm_error_code & UTM_HEMISPHERE_ERROR)) + error_code |= MGRS_STRING_ERROR; + if(utm_error_code & UTM_EASTING_ERROR) + error_code |= MGRS_EASTING_ERROR; + if(utm_error_code & UTM_NORTHING_ERROR) + error_code |= MGRS_NORTHING_ERROR; + } + } + else + { + if(utm_error_code & UTM_A_ERROR) + error_code |= MGRS_A_ERROR; + if(utm_error_code & UTM_INV_F_ERROR) + error_code |= MGRS_INV_F_ERROR; + if(utm_error_code & UTM_ZONE_OVERRIDE_ERROR) + error_code |= MGRS_ZONE_ERROR; + } + } + } + } + } + } + return (error_code); +} /* Convert_MGRS_To_UTM */ + + +long Convert_UPS_To_MGRS (char Hemisphere, + double Easting, + double Northing, + long Precision, + char* MGRS) +/* + * The function Convert_UPS_To_MGRS converts UPS (hemisphere, easting, + * and northing) coordinates to an MGRS coordinate string according to + * the current ellipsoid parameters. If any errors occur, the error + * code(s) are returned by the function, otherwise UPS_NO_ERROR is + * returned. + * + * Hemisphere : Hemisphere either 'N' or 'S' (input) + * Easting : Easting/X in meters (input) + * Northing : Northing/Y in meters (input) + * Precision : Precision level of MGRS string (input) + * MGRS : MGRS coordinate string (output) + */ +{ /* Convert_UPS_To_MGRS */ + double false_easting; /* False easting for 2nd letter */ + double false_northing; /* False northing for 3rd letter */ + double grid_easting; /* Easting used to derive 2nd letter of MGRS */ + double grid_northing; /* Northing used to derive 3rd letter of MGRS */ + long ltr2_low_value; /* 2nd letter range - low number */ + int letters[MGRS_LETTERS]; /* Number location of 3 letters in alphabet */ + double divisor; + int index = 0; + long error_code = MGRS_NO_ERROR; + + if ((Hemisphere != 'N') && (Hemisphere != 'S')) + error_code |= MGRS_HEMISPHERE_ERROR; + if ((Easting < MIN_EAST_NORTH) || (Easting > MAX_EAST_NORTH)) + error_code |= MGRS_EASTING_ERROR; + if ((Northing < MIN_EAST_NORTH) || (Northing > MAX_EAST_NORTH)) + error_code |= MGRS_NORTHING_ERROR; + if ((Precision < 0) || (Precision > MAX_PRECISION)) + error_code |= MGRS_PRECISION_ERROR; + if (!error_code) + { + divisor = pow (10.0, (5 - Precision)); + Easting = Round_MGRS (Easting/divisor) * divisor; + Northing = Round_MGRS (Northing/divisor) * divisor; + + if (Hemisphere == 'N') + { + if (Easting >= TWOMIL) + letters[0] = LETTER_Z; + else + letters[0] = LETTER_Y; + + index = letters[0] - 22; + ltr2_low_value = UPS_Constant_Table[index].ltr2_low_value; + false_easting = UPS_Constant_Table[index].false_easting; + false_northing = UPS_Constant_Table[index].false_northing; + } + else + { + if (Easting >= TWOMIL) + letters[0] = LETTER_B; + else + letters[0] = LETTER_A; + + ltr2_low_value = UPS_Constant_Table[letters[0]].ltr2_low_value; + false_easting = UPS_Constant_Table[letters[0]].false_easting; + false_northing = UPS_Constant_Table[letters[0]].false_northing; + } + + grid_northing = Northing; + grid_northing = grid_northing - false_northing; + letters[2] = (long)(grid_northing / ONEHT); + + if (letters[2] > LETTER_H) + letters[2] = letters[2] + 1; + + if (letters[2] > LETTER_N) + letters[2] = letters[2] + 1; + + grid_easting = Easting; + grid_easting = grid_easting - false_easting; + letters[1] = ltr2_low_value + ((long)(grid_easting / ONEHT)); + + if (Easting < TWOMIL) + { + if (letters[1] > LETTER_L) + letters[1] = letters[1] + 3; + + if (letters[1] > LETTER_U) + letters[1] = letters[1] + 2; + } + else + { + if (letters[1] > LETTER_C) + letters[1] = letters[1] + 2; + + if (letters[1] > LETTER_H) + letters[1] = letters[1] + 1; + + if (letters[1] > LETTER_L) + letters[1] = letters[1] + 3; + } + + Make_MGRS_String (MGRS, 0, letters, Easting, Northing, Precision); + } + return (error_code); +} /* Convert_UPS_To_MGRS */ + + +long Convert_MGRS_To_UPS ( char *MGRS, + char *Hemisphere, + double *Easting, + double *Northing) +/* + * The function Convert_MGRS_To_UPS converts an MGRS coordinate string + * to UPS (hemisphere, easting, and northing) coordinates, according + * to the current ellipsoid parameters. If any errors occur, the error + * code(s) are returned by the function, otherwide UPS_NO_ERROR is returned. + * + * MGRS : MGRS coordinate string (input) + * Hemisphere : Hemisphere either 'N' or 'S' (output) + * Easting : Easting/X in meters (output) + * Northing : Northing/Y in meters (output) + */ +{ /* Convert_MGRS_To_UPS */ + long ltr2_high_value; /* 2nd letter range - high number */ + long ltr3_high_value; /* 3rd letter range - high number (UPS) */ + long ltr2_low_value; /* 2nd letter range - low number */ + double false_easting; /* False easting for 2nd letter */ + double false_northing; /* False northing for 3rd letter */ + double grid_easting; /* easting for 100,000 meter grid square */ + double grid_northing; /* northing for 100,000 meter grid square */ + long zone = 0; + long letters[MGRS_LETTERS]; + long in_precision = 0; + int index = 0; + long error_code = MGRS_NO_ERROR; + + error_code = Break_MGRS_String (MGRS, &zone, letters, Easting, Northing, &in_precision); + if (zone) + error_code |= MGRS_STRING_ERROR; + else + { + if (!error_code) + { + if (letters[0] >= LETTER_Y) + { + *Hemisphere = 'N'; + + index = letters[0] - 22; + ltr2_low_value = UPS_Constant_Table[index].ltr2_low_value; + ltr2_high_value = UPS_Constant_Table[index].ltr2_high_value; + ltr3_high_value = UPS_Constant_Table[index].ltr3_high_value; + false_easting = UPS_Constant_Table[index].false_easting; + false_northing = UPS_Constant_Table[index].false_northing; + } + else + { + *Hemisphere = 'S'; + + ltr2_low_value = UPS_Constant_Table[letters[0]].ltr2_low_value; + ltr2_high_value = UPS_Constant_Table[letters[0]].ltr2_high_value; + ltr3_high_value = UPS_Constant_Table[letters[0]].ltr3_high_value; + false_easting = UPS_Constant_Table[letters[0]].false_easting; + false_northing = UPS_Constant_Table[letters[0]].false_northing; + } + + /* Check that the second letter of the MGRS string is within + * the range of valid second letter values + * Also check that the third letter is valid */ + if ((letters[1] < ltr2_low_value) || (letters[1] > ltr2_high_value) || + ((letters[1] == LETTER_D) || (letters[1] == LETTER_E) || + (letters[1] == LETTER_M) || (letters[1] == LETTER_N) || + (letters[1] == LETTER_V) || (letters[1] == LETTER_W)) || + (letters[2] > ltr3_high_value)) + error_code |= MGRS_STRING_ERROR; + + if (!error_code) + { + grid_northing = (double)letters[2] * ONEHT + false_northing; + if (letters[2] > LETTER_I) + grid_northing = grid_northing - ONEHT; + + if (letters[2] > LETTER_O) + grid_northing = grid_northing - ONEHT; + + grid_easting = (double)((letters[1]) - ltr2_low_value) * ONEHT + false_easting; + if (ltr2_low_value != LETTER_A) + { + if (letters[1] > LETTER_L) + grid_easting = grid_easting - 300000.0; + + if (letters[1] > LETTER_U) + grid_easting = grid_easting - 200000.0; + } + else + { + if (letters[1] > LETTER_C) + grid_easting = grid_easting - 200000.0; + + if (letters[1] > LETTER_I) + grid_easting = grid_easting - ONEHT; + + if (letters[1] > LETTER_L) + grid_easting = grid_easting - 300000.0; + } + + *Easting = grid_easting + *Easting; + *Northing = grid_northing + *Northing; + } + } + } + return (error_code); +} /* Convert_MGRS_To_UPS */ + + + diff --git a/external/geotranz/mgrs.h b/external/geotranz/mgrs.h new file mode 100644 index 00000000..bd0453a1 --- /dev/null +++ b/external/geotranz/mgrs.h @@ -0,0 +1,253 @@ +#ifndef MGRS_H + #define MGRS_H + +/***************************************************************************/ +/* RSC IDENTIFIER: MGRS + * + * ABSTRACT + * + * This component converts between geodetic coordinates (latitude and + * longitude) and Military Grid Reference System (MGRS) coordinates. + * + * ERROR HANDLING + * + * This component checks parameters for valid values. If an invalid value + * is found, the error code is combined with the current error code using + * the bitwise or. This combining allows multiple error codes to be + * returned. The possible error codes are: + * + * MGRS_NO_ERROR : No errors occurred in function + * MGRS_LAT_ERROR : Latitude outside of valid range + * (-90 to 90 degrees) + * MGRS_LON_ERROR : Longitude outside of valid range + * (-180 to 360 degrees) + * MGRS_STR_ERROR : An MGRS string error: string too long, + * too short, or badly formed + * MGRS_PRECISION_ERROR : The precision must be between 0 and 5 + * inclusive. + * MGRS_A_ERROR : Semi-major axis less than or equal to zero + * MGRS_INV_F_ERROR : Inverse flattening outside of valid range + * (250 to 350) + * MGRS_EASTING_ERROR : Easting outside of valid range + * (100,000 to 900,000 meters for UTM) + * (0 to 4,000,000 meters for UPS) + * MGRS_NORTHING_ERROR : Northing outside of valid range + * (0 to 10,000,000 meters for UTM) + * (0 to 4,000,000 meters for UPS) + * MGRS_ZONE_ERROR : Zone outside of valid range (1 to 60) + * MGRS_HEMISPHERE_ERROR : Invalid hemisphere ('N' or 'S') + * + * REUSE NOTES + * + * MGRS is intended for reuse by any application that does conversions + * between geodetic coordinates and MGRS coordinates. + * + * REFERENCES + * + * Further information on MGRS can be found in the Reuse Manual. + * + * MGRS originated from : U.S. Army Topographic Engineering Center + * Geospatial Information Division + * 7701 Telegraph Road + * Alexandria, VA 22310-3864 + * + * LICENSES + * + * None apply to this component. + * + * RESTRICTIONS + * + * + * ENVIRONMENT + * + * MGRS was tested and certified in the following environments: + * + * 1. Solaris 2.5 with GCC version 2.8.1 + * 2. Windows 95 with MS Visual C++ version 6 + * + * MODIFICATIONS + * + * Date Description + * ---- ----------- + * 16-11-94 Original Code + * 15-09-99 Reengineered upper layers + * + */ + + +/***************************************************************************/ +/* + * DEFINES + */ + + #define MGRS_NO_ERROR 0x0000 + #define MGRS_LAT_ERROR 0x0001 + #define MGRS_LON_ERROR 0x0002 + #define MGRS_STRING_ERROR 0x0004 + #define MGRS_PRECISION_ERROR 0x0008 + #define MGRS_A_ERROR 0x0010 + #define MGRS_INV_F_ERROR 0x0020 + #define MGRS_EASTING_ERROR 0x0040 + #define MGRS_NORTHING_ERROR 0x0080 + #define MGRS_ZONE_ERROR 0x0100 + #define MGRS_HEMISPHERE_ERROR 0x0200 + #define MGRS_LAT_WARNING 0x0400 + + +/***************************************************************************/ +/* + * FUNCTION PROTOTYPES + */ + +/* ensure proper linkage to c++ programs */ + #ifdef __cplusplus +extern "C" { + #endif + + + long Set_MGRS_Parameters(double a, + double f, + char *Ellipsoid_Code); +/* + * The function Set_MGRS_Parameters receives the ellipsoid parameters and sets + * the corresponding state variables. If any errors occur, the error code(s) + * are returned by the function, otherwise MGRS_NO_ERROR is returned. + * + * a : Semi-major axis of ellipsoid in meters (input) + * f : Flattening of ellipsoid (input) + * Ellipsoid_Code : 2-letter code for ellipsoid (input) + */ + + + void Get_MGRS_Parameters(double *a, + double *f, + char *Ellipsoid_Code); +/* + * The function Get_MGRS_Parameters returns the current ellipsoid + * parameters. + * + * a : Semi-major axis of ellipsoid, in meters (output) + * f : Flattening of ellipsoid (output) + * Ellipsoid_Code : 2-letter code for ellipsoid (output) + */ + + + long Convert_Geodetic_To_MGRS (double Latitude, + double Longitude, + long Precision, + char *MGRS); +/* + * The function Convert_Geodetic_To_MGRS converts geodetic (latitude and + * longitude) coordinates to an MGRS coordinate string, according to the + * current ellipsoid parameters. If any errors occur, the error code(s) + * are returned by the function, otherwise MGRS_NO_ERROR is returned. + * + * Latitude : Latitude in radians (input) + * Longitude : Longitude in radians (input) + * Precision : Precision level of MGRS string (input) + * MGRS : MGRS coordinate string (output) + * + */ + + + long Convert_MGRS_To_Geodetic (char *MGRS, + double *Latitude, + double *Longitude); +/* + * This function converts an MGRS coordinate string to Geodetic (latitude + * and longitude in radians) coordinates. If any errors occur, the error + * code(s) are returned by the function, otherwise MGRS_NO_ERROR is returned. + * + * MGRS : MGRS coordinate string (input) + * Latitude : Latitude in radians (output) + * Longitude : Longitude in radians (output) + * + */ + + + long Convert_UTM_To_MGRS (long Zone, + char Hemisphere, + double Easting, + double Northing, + long Precision, + char *MGRS); +/* + * The function Convert_UTM_To_MGRS converts UTM (zone, easting, and + * northing) coordinates to an MGRS coordinate string, according to the + * current ellipsoid parameters. If any errors occur, the error code(s) + * are returned by the function, otherwise MGRS_NO_ERROR is returned. + * + * Zone : UTM zone (input) + * Hemisphere : North or South hemisphere (input) + * Easting : Easting (X) in meters (input) + * Northing : Northing (Y) in meters (input) + * Precision : Precision level of MGRS string (input) + * MGRS : MGRS coordinate string (output) + */ + + + long Convert_MGRS_To_UTM (char *MGRS, + long *Zone, + char *Hemisphere, + double *Easting, + double *Northing); +/* + * The function Convert_MGRS_To_UTM converts an MGRS coordinate string + * to UTM projection (zone, hemisphere, easting and northing) coordinates + * according to the current ellipsoid parameters. If any errors occur, + * the error code(s) are returned by the function, otherwise UTM_NO_ERROR + * is returned. + * + * MGRS : MGRS coordinate string (input) + * Zone : UTM zone (output) + * Hemisphere : North or South hemisphere (output) + * Easting : Easting (X) in meters (output) + * Northing : Northing (Y) in meters (output) + */ + + + + long Convert_UPS_To_MGRS ( char Hemisphere, + double Easting, + double Northing, + long Precision, + char *MGRS); + +/* + * The function Convert_UPS_To_MGRS converts UPS (hemisphere, easting, + * and northing) coordinates to an MGRS coordinate string according to + * the current ellipsoid parameters. If any errors occur, the error + * code(s) are returned by the function, otherwise UPS_NO_ERROR is + * returned. + * + * Hemisphere : Hemisphere either 'N' or 'S' (input) + * Easting : Easting/X in meters (input) + * Northing : Northing/Y in meters (input) + * Precision : Precision level of MGRS string (input) + * MGRS : MGRS coordinate string (output) + */ + + + long Convert_MGRS_To_UPS ( char *MGRS, + char *Hemisphere, + double *Easting, + double *Northing); +/* + * The function Convert_MGRS_To_UPS converts an MGRS coordinate string + * to UPS (hemisphere, easting, and northing) coordinates, according + * to the current ellipsoid parameters. If any errors occur, the error + * code(s) are returned by the function, otherwise UPS_NO_ERROR is returned. + * + * MGRS : MGRS coordinate string (input) + * Hemisphere : Hemisphere either 'N' or 'S' (output) + * Easting : Easting/X in meters (output) + * Northing : Northing/Y in meters (output) + */ + + + + #ifdef __cplusplus +} + #endif + +#endif /* MGRS_H */ diff --git a/external/geotranz/polarst.c b/external/geotranz/polarst.c new file mode 100644 index 00000000..d32f9e84 --- /dev/null +++ b/external/geotranz/polarst.c @@ -0,0 +1,523 @@ +/***************************************************************************/ +/* RSC IDENTIFIER: POLAR STEREOGRAPHIC + * + * + * ABSTRACT + * + * This component provides conversions between geodetic (latitude and + * longitude) coordinates and Polar Stereographic (easting and northing) + * coordinates. + * + * ERROR HANDLING + * + * This component checks parameters for valid values. If an invalid + * value is found the error code is combined with the current error code + * using the bitwise or. This combining allows multiple error codes to + * be returned. The possible error codes are: + * + * POLAR_NO_ERROR : No errors occurred in function + * POLAR_LAT_ERROR : Latitude outside of valid range + * (-90 to 90 degrees) + * POLAR_LON_ERROR : Longitude outside of valid range + * (-180 to 360 degrees) + * POLAR_ORIGIN_LAT_ERROR : Latitude of true scale outside of valid + * range (-90 to 90 degrees) + * POLAR_ORIGIN_LON_ERROR : Longitude down from pole outside of valid + * range (-180 to 360 degrees) + * POLAR_EASTING_ERROR : Easting outside of valid range, + * depending on ellipsoid and + * projection parameters + * POLAR_NORTHING_ERROR : Northing outside of valid range, + * depending on ellipsoid and + * projection parameters + * POLAR_RADIUS_ERROR : Coordinates too far from pole, + * depending on ellipsoid and + * projection parameters + * POLAR_A_ERROR : Semi-major axis less than or equal to zero + * POLAR_INV_F_ERROR : Inverse flattening outside of valid range + * (250 to 350) + * + * + * REUSE NOTES + * + * POLAR STEREOGRAPHIC is intended for reuse by any application that + * performs a Polar Stereographic projection. + * + * + * REFERENCES + * + * Further information on POLAR STEREOGRAPHIC can be found in the + * Reuse Manual. + * + * + * POLAR STEREOGRAPHIC originated from : + * U.S. Army Topographic Engineering Center + * Geospatial Information Division + * 7701 Telegraph Road + * Alexandria, VA 22310-3864 + * + * + * LICENSES + * + * None apply to this component. + * + * + * RESTRICTIONS + * + * POLAR STEREOGRAPHIC has no restrictions. + * + * + * ENVIRONMENT + * + * POLAR STEREOGRAPHIC was tested and certified in the following + * environments: + * + * 1. Solaris 2.5 with GCC, version 2.8.1 + * 2. Window 95 with MS Visual C++, version 6 + * + * + * MODIFICATIONS + * + * Date Description + * ---- ----------- + * 06-11-95 Original Code + * 03-01-97 Original Code + * + * + */ + + +/************************************************************************/ +/* + * INCLUDES + */ + +#include +#include "polarst.h" + +/* + * math.h - Standard C math library + * polarst.h - Is for prototype error checking + */ + + +/************************************************************************/ +/* DEFINES + * + */ + + +#define PI 3.14159265358979323e0 /* PI */ +#define PI_OVER_2 (PI / 2.0) +#define TWO_PI (2.0 * PI) +#define POLAR_POW(EsSin) pow((1.0 - EsSin) / (1.0 + EsSin), es_OVER_2) + +/************************************************************************/ +/* GLOBAL DECLARATIONS + * + */ + +const double PI_Over_4 = (PI / 4.0); + +/* Ellipsoid Parameters, default to WGS 84 */ +static double Polar_a = 6378137.0; /* Semi-major axis of ellipsoid in meters */ +static double Polar_f = 1 / 298.257223563; /* Flattening of ellipsoid */ +static double es = 0.08181919084262188000; /* Eccentricity of ellipsoid */ +static double es_OVER_2 = .040909595421311; /* es / 2.0 */ +static double Southern_Hemisphere = 0; /* Flag variable */ +static double tc = 1.0; +static double e4 = 1.0033565552493; +static double Polar_a_mc = 6378137.0; /* Polar_a * mc */ +static double two_Polar_a = 12756274.0; /* 2.0 * Polar_a */ + +/* Polar Stereographic projection Parameters */ +static double Polar_Origin_Lat = ((PI * 90) / 180); /* Latitude of origin in radians */ +static double Polar_Origin_Long = 0.0; /* Longitude of origin in radians */ +static double Polar_False_Easting = 0.0; /* False easting in meters */ +static double Polar_False_Northing = 0.0; /* False northing in meters */ + +/* Maximum variance for easting and northing values for WGS 84. */ +static double Polar_Delta_Easting = 12713601.0; +static double Polar_Delta_Northing = 12713601.0; + +/* These state variables are for optimization purposes. The only function + * that should modify them is Set_Polar_Stereographic_Parameters. + */ + + +/************************************************************************/ +/* FUNCTIONS + * + */ + + +long Set_Polar_Stereographic_Parameters (double a, + double f, + double Latitude_of_True_Scale, + double Longitude_Down_from_Pole, + double False_Easting, + double False_Northing) + +{ /* BEGIN Set_Polar_Stereographic_Parameters */ +/* + * The function Set_Polar_Stereographic_Parameters receives the ellipsoid + * parameters and Polar Stereograpic projection parameters as inputs, and + * sets the corresponding state variables. If any errors occur, error + * code(s) are returned by the function, otherwise POLAR_NO_ERROR is returned. + * + * a : Semi-major axis of ellipsoid, in meters (input) + * f : Flattening of ellipsoid (input) + * Latitude_of_True_Scale : Latitude of true scale, in radians (input) + * Longitude_Down_from_Pole : Longitude down from pole, in radians (input) + * False_Easting : Easting (X) at center of projection, in meters (input) + * False_Northing : Northing (Y) at center of projection, in meters (input) + */ + + double es2; + double slat, clat; + double essin; + double one_PLUS_es, one_MINUS_es; + double pow_es; + double temp, temp_northing = 0; + double inv_f = 1 / f; + double mc; +// const double epsilon = 1.0e-2; + long Error_Code = POLAR_NO_ERROR; + + if (a <= 0.0) + { /* Semi-major axis must be greater than zero */ + Error_Code |= POLAR_A_ERROR; + } + if ((inv_f < 250) || (inv_f > 350)) + { /* Inverse flattening must be between 250 and 350 */ + Error_Code |= POLAR_INV_F_ERROR; + } + if ((Latitude_of_True_Scale < -PI_OVER_2) || (Latitude_of_True_Scale > PI_OVER_2)) + { /* Origin Latitude out of range */ + Error_Code |= POLAR_ORIGIN_LAT_ERROR; + } + if ((Longitude_Down_from_Pole < -PI) || (Longitude_Down_from_Pole > TWO_PI)) + { /* Origin Longitude out of range */ + Error_Code |= POLAR_ORIGIN_LON_ERROR; + } + + if (!Error_Code) + { /* no errors */ + + Polar_a = a; + two_Polar_a = 2.0 * Polar_a; + Polar_f = f; + + if (Longitude_Down_from_Pole > PI) + Longitude_Down_from_Pole -= TWO_PI; + if (Latitude_of_True_Scale < 0) + { + Southern_Hemisphere = 1; + Polar_Origin_Lat = -Latitude_of_True_Scale; + Polar_Origin_Long = -Longitude_Down_from_Pole; + } + else + { + Southern_Hemisphere = 0; + Polar_Origin_Lat = Latitude_of_True_Scale; + Polar_Origin_Long = Longitude_Down_from_Pole; + } + Polar_False_Easting = False_Easting; + Polar_False_Northing = False_Northing; + + es2 = 2 * Polar_f - Polar_f * Polar_f; + es = sqrt(es2); + es_OVER_2 = es / 2.0; + + if (fabs(fabs(Polar_Origin_Lat) - PI_OVER_2) > 1.0e-10) + { + slat = sin(Polar_Origin_Lat); + essin = es * slat; + pow_es = POLAR_POW(essin); + clat = cos(Polar_Origin_Lat); + mc = clat / sqrt(1.0 - essin * essin); + Polar_a_mc = Polar_a * mc; + tc = tan(PI_Over_4 - Polar_Origin_Lat / 2.0) / pow_es; + } + else + { + one_PLUS_es = 1.0 + es; + one_MINUS_es = 1.0 - es; + e4 = sqrt(pow(one_PLUS_es, one_PLUS_es) * pow(one_MINUS_es, one_MINUS_es)); + } + + /* Calculate Radius */ + Convert_Geodetic_To_Polar_Stereographic(0, Longitude_Down_from_Pole, + &temp, &temp_northing); + + Polar_Delta_Northing = temp_northing; + if(Polar_False_Northing) + Polar_Delta_Northing -= Polar_False_Northing; + if (Polar_Delta_Northing < 0) + Polar_Delta_Northing = -Polar_Delta_Northing; + Polar_Delta_Northing *= 1.01; + + Polar_Delta_Easting = Polar_Delta_Northing; + + /* Polar_Delta_Easting = temp_northing; + if(Polar_False_Easting) + Polar_Delta_Easting -= Polar_False_Easting; + if (Polar_Delta_Easting < 0) + Polar_Delta_Easting = -Polar_Delta_Easting; + Polar_Delta_Easting *= 1.01;*/ + } + + return (Error_Code); +} /* END OF Set_Polar_Stereographic_Parameters */ + + + +void Get_Polar_Stereographic_Parameters (double *a, + double *f, + double *Latitude_of_True_Scale, + double *Longitude_Down_from_Pole, + double *False_Easting, + double *False_Northing) + +{ /* BEGIN Get_Polar_Stereographic_Parameters */ +/* + * The function Get_Polar_Stereographic_Parameters returns the current + * ellipsoid parameters and Polar projection parameters. + * + * a : Semi-major axis of ellipsoid, in meters (output) + * f : Flattening of ellipsoid (output) + * Latitude_of_True_Scale : Latitude of true scale, in radians (output) + * Longitude_Down_from_Pole : Longitude down from pole, in radians (output) + * False_Easting : Easting (X) at center of projection, in meters (output) + * False_Northing : Northing (Y) at center of projection, in meters (output) + */ + + *a = Polar_a; + *f = Polar_f; + *Latitude_of_True_Scale = Polar_Origin_Lat; + *Longitude_Down_from_Pole = Polar_Origin_Long; + *False_Easting = Polar_False_Easting; + *False_Northing = Polar_False_Northing; + return; +} /* END OF Get_Polar_Stereographic_Parameters */ + + +long Convert_Geodetic_To_Polar_Stereographic (double Latitude, + double Longitude, + double *Easting, + double *Northing) + +{ /* BEGIN Convert_Geodetic_To_Polar_Stereographic */ + +/* + * The function Convert_Geodetic_To_Polar_Stereographic converts geodetic + * coordinates (latitude and longitude) to Polar Stereographic coordinates + * (easting and northing), according to the current ellipsoid + * and Polar Stereographic projection parameters. If any errors occur, error + * code(s) are returned by the function, otherwise POLAR_NO_ERROR is returned. + * + * Latitude : Latitude, in radians (input) + * Longitude : Longitude, in radians (input) + * Easting : Easting (X), in meters (output) + * Northing : Northing (Y), in meters (output) + */ + + double dlam; + double slat; + double essin; + double t; + double rho; + double pow_es; + long Error_Code = POLAR_NO_ERROR; + + if ((Latitude < -PI_OVER_2) || (Latitude > PI_OVER_2)) + { /* Latitude out of range */ + Error_Code |= POLAR_LAT_ERROR; + } + if ((Latitude < 0) && (Southern_Hemisphere == 0)) + { /* Latitude and Origin Latitude in different hemispheres */ + Error_Code |= POLAR_LAT_ERROR; + } + if ((Latitude > 0) && (Southern_Hemisphere == 1)) + { /* Latitude and Origin Latitude in different hemispheres */ + Error_Code |= POLAR_LAT_ERROR; + } + if ((Longitude < -PI) || (Longitude > TWO_PI)) + { /* Longitude out of range */ + Error_Code |= POLAR_LON_ERROR; + } + + + if (!Error_Code) + { /* no errors */ + + if (fabs(fabs(Latitude) - PI_OVER_2) < 1.0e-10) + { + *Easting = Polar_False_Easting; + *Northing = Polar_False_Northing; + } + else + { + if (Southern_Hemisphere != 0) + { + Longitude *= -1.0; + Latitude *= -1.0; + } + dlam = Longitude - Polar_Origin_Long; + if (dlam > PI) + { + dlam -= TWO_PI; + } + if (dlam < -PI) + { + dlam += TWO_PI; + } + slat = sin(Latitude); + essin = es * slat; + pow_es = POLAR_POW(essin); + t = tan(PI_Over_4 - Latitude / 2.0) / pow_es; + + if (fabs(fabs(Polar_Origin_Lat) - PI_OVER_2) > 1.0e-10) + rho = Polar_a_mc * t / tc; + else + rho = two_Polar_a * t / e4; + + + if (Southern_Hemisphere != 0) + { + *Easting = -(rho * sin(dlam) - Polar_False_Easting); + // *Easting *= -1.0; + *Northing = rho * cos(dlam) + Polar_False_Northing; + } + else + { + *Easting = rho * sin(dlam) + Polar_False_Easting; + *Northing = -rho * cos(dlam) + Polar_False_Northing; + } + + } + } + return (Error_Code); +} /* END OF Convert_Geodetic_To_Polar_Stereographic */ + + +long Convert_Polar_Stereographic_To_Geodetic (double Easting, + double Northing, + double *Latitude, + double *Longitude) + +{ /* BEGIN Convert_Polar_Stereographic_To_Geodetic */ +/* + * The function Convert_Polar_Stereographic_To_Geodetic converts Polar + * Stereographic coordinates (easting and northing) to geodetic + * coordinates (latitude and longitude) according to the current ellipsoid + * and Polar Stereographic projection Parameters. If any errors occur, the + * code(s) are returned by the function, otherwise POLAR_NO_ERROR + * is returned. + * + * Easting : Easting (X), in meters (input) + * Northing : Northing (Y), in meters (input) + * Latitude : Latitude, in radians (output) + * Longitude : Longitude, in radians (output) + * + */ + + double dy = 0, dx = 0; + double rho = 0; + double t; + double PHI, sin_PHI; + double tempPHI = 0.0; + double essin; + double pow_es; + double delta_radius; + long Error_Code = POLAR_NO_ERROR; + double min_easting = Polar_False_Easting - Polar_Delta_Easting; + double max_easting = Polar_False_Easting + Polar_Delta_Easting; + double min_northing = Polar_False_Northing - Polar_Delta_Northing; + double max_northing = Polar_False_Northing + Polar_Delta_Northing; + + if (Easting > max_easting || Easting < min_easting) + { /* Easting out of range */ + Error_Code |= POLAR_EASTING_ERROR; + } + if (Northing > max_northing || Northing < min_northing) + { /* Northing out of range */ + Error_Code |= POLAR_NORTHING_ERROR; + } + + if (!Error_Code) + { + dy = Northing - Polar_False_Northing; + dx = Easting - Polar_False_Easting; + + /* Radius of point with origin of false easting, false northing */ + rho = sqrt(dx * dx + dy * dy); + + delta_radius = sqrt(Polar_Delta_Easting * Polar_Delta_Easting + Polar_Delta_Northing * Polar_Delta_Northing); + + if(rho > delta_radius) + { /* Point is outside of projection area */ + Error_Code |= POLAR_RADIUS_ERROR; + } + + if (!Error_Code) + { /* no errors */ + if ((dy == 0.0) && (dx == 0.0)) + { + *Latitude = PI_OVER_2; + *Longitude = Polar_Origin_Long; + + } + else + { + if (Southern_Hemisphere != 0) + { + dy *= -1.0; + dx *= -1.0; + } + + if (fabs(fabs(Polar_Origin_Lat) - PI_OVER_2) > 1.0e-10) + t = rho * tc / (Polar_a_mc); + else + t = rho * e4 / (two_Polar_a); + PHI = PI_OVER_2 - 2.0 * atan(t); + while (fabs(PHI - tempPHI) > 1.0e-10) + { + tempPHI = PHI; + sin_PHI = sin(PHI); + essin = es * sin_PHI; + pow_es = POLAR_POW(essin); + PHI = PI_OVER_2 - 2.0 * atan(t * pow_es); + } + *Latitude = PHI; + *Longitude = Polar_Origin_Long + atan2(dx, -dy); + + if (*Longitude > PI) + *Longitude -= TWO_PI; + else if (*Longitude < -PI) + *Longitude += TWO_PI; + + + if (*Latitude > PI_OVER_2) /* force distorted values to 90, -90 degrees */ + *Latitude = PI_OVER_2; + else if (*Latitude < -PI_OVER_2) + *Latitude = -PI_OVER_2; + + if (*Longitude > PI) /* force distorted values to 180, -180 degrees */ + *Longitude = PI; + else if (*Longitude < -PI) + *Longitude = -PI; + + } + if (Southern_Hemisphere != 0) + { + *Latitude *= -1.0; + *Longitude *= -1.0; + } + } + } + return (Error_Code); +} /* END OF Convert_Polar_Stereographic_To_Geodetic */ + + + diff --git a/external/geotranz/polarst.h b/external/geotranz/polarst.h new file mode 100644 index 00000000..60b8aa00 --- /dev/null +++ b/external/geotranz/polarst.h @@ -0,0 +1,202 @@ +#ifndef POLARST_H + #define POLARST_H +/***************************************************************************/ +/* RSC IDENTIFIER: POLAR STEREOGRAPHIC + * + * + * ABSTRACT + * + * This component provides conversions between geodetic (latitude and + * longitude) coordinates and Polar Stereographic (easting and northing) + * coordinates. + * + * ERROR HANDLING + * + * This component checks parameters for valid values. If an invalid + * value is found the error code is combined with the current error code + * using the bitwise or. This combining allows multiple error codes to + * be returned. The possible error codes are: + * + * POLAR_NO_ERROR : No errors occurred in function + * POLAR_LAT_ERROR : Latitude outside of valid range + * (-90 to 90 degrees) + * POLAR_LON_ERROR : Longitude outside of valid range + * (-180 to 360 degrees) + * POLAR_ORIGIN_LAT_ERROR : Latitude of true scale outside of valid + * range (-90 to 90 degrees) + * POLAR_ORIGIN_LON_ERROR : Longitude down from pole outside of valid + * range (-180 to 360 degrees) + * POLAR_EASTING_ERROR : Easting outside of valid range, + * depending on ellipsoid and + * projection parameters + * POLAR_NORTHING_ERROR : Northing outside of valid range, + * depending on ellipsoid and + * projection parameters + * POLAR_RADIUS_ERROR : Coordinates too far from pole, + * depending on ellipsoid and + * projection parameters + * POLAR_A_ERROR : Semi-major axis less than or equal to zero + * POLAR_INV_F_ERROR : Inverse flattening outside of valid range + * (250 to 350) + * + * + * REUSE NOTES + * + * POLAR STEREOGRAPHIC is intended for reuse by any application that + * performs a Polar Stereographic projection. + * + * + * REFERENCES + * + * Further information on POLAR STEREOGRAPHIC can be found in the + * Reuse Manual. + * + * + * POLAR STEREOGRAPHIC originated from : + * U.S. Army Topographic Engineering Center + * Geospatial Information Division + * 7701 Telegraph Road + * Alexandria, VA 22310-3864 + * + * + * LICENSES + * + * None apply to this component. + * + * + * RESTRICTIONS + * + * POLAR STEREOGRAPHIC has no restrictions. + * + * + * ENVIRONMENT + * + * POLAR STEREOGRAPHIC was tested and certified in the following + * environments: + * + * 1. Solaris 2.5 with GCC, version 2.8.1 + * 2. Window 95 with MS Visual C++, version 6 + * + * + * MODIFICATIONS + * + * Date Description + * ---- ----------- + * 06-11-95 Original Code + * 03-01-97 Original Code + * + * + */ + + +/**********************************************************************/ +/* + * DEFINES + */ + + #define POLAR_NO_ERROR 0x0000 + #define POLAR_LAT_ERROR 0x0001 + #define POLAR_LON_ERROR 0x0002 + #define POLAR_ORIGIN_LAT_ERROR 0x0004 + #define POLAR_ORIGIN_LON_ERROR 0x0008 + #define POLAR_EASTING_ERROR 0x0010 + #define POLAR_NORTHING_ERROR 0x0020 + #define POLAR_A_ERROR 0x0040 + #define POLAR_INV_F_ERROR 0x0080 + #define POLAR_RADIUS_ERROR 0x0100 + +/**********************************************************************/ +/* + * FUNCTION PROTOTYPES + */ + +/* ensure proper linkage to c++ programs */ + #ifdef __cplusplus +extern "C" { + #endif + + long Set_Polar_Stereographic_Parameters (double a, + double f, + double Latitude_of_True_Scale, + double Longitude_Down_from_Pole, + double False_Easting, + double False_Northing); +/* + * The function Set_Polar_Stereographic_Parameters receives the ellipsoid + * parameters and Polar Stereograpic projection parameters as inputs, and + * sets the corresponding state variables. If any errors occur, error + * code(s) are returned by the function, otherwise POLAR_NO_ERROR is returned. + * + * a : Semi-major axis of ellipsoid, in meters (input) + * f : Flattening of ellipsoid (input) + * Latitude_of_True_Scale : Latitude of true scale, in radians (input) + * Longitude_Down_from_Pole : Longitude down from pole, in radians (input) + * False_Easting : Easting (X) at center of projection, in meters (input) + * False_Northing : Northing (Y) at center of projection, in meters (input) + */ + + + void Get_Polar_Stereographic_Parameters (double *a, + double *f, + double *Latitude_of_True_Scale, + double *Longitude_Down_from_Pole, + double *False_Easting, + double *False_Northing); +/* + * The function Get_Polar_Stereographic_Parameters returns the current + * ellipsoid parameters and Polar projection parameters. + * + * a : Semi-major axis of ellipsoid, in meters (output) + * f : Flattening of ellipsoid (output) + * Latitude_of_True_Scale : Latitude of true scale, in radians (output) + * Longitude_Down_from_Pole : Longitude down from pole, in radians (output) + * False_Easting : Easting (X) at center of projection, in meters (output) + * False_Northing : Northing (Y) at center of projection, in meters (output) + */ + + + long Convert_Geodetic_To_Polar_Stereographic (double Latitude, + double Longitude, + double *Easting, + double *Northing); +/* + * The function Convert_Geodetic_To_Polar_Stereographic converts geodetic + * coordinates (latitude and longitude) to Polar Stereographic coordinates + * (easting and northing), according to the current ellipsoid + * and Polar Stereographic projection parameters. If any errors occur, error + * code(s) are returned by the function, otherwise POLAR_NO_ERROR is returned. + * + * Latitude : Latitude, in radians (input) + * Longitude : Longitude, in radians (input) + * Easting : Easting (X), in meters (output) + * Northing : Northing (Y), in meters (output) + */ + + + + long Convert_Polar_Stereographic_To_Geodetic (double Easting, + double Northing, + double *Latitude, + double *Longitude); + +/* + * The function Convert_Polar_Stereographic_To_Geodetic converts Polar + * Stereographic coordinates (easting and northing) to geodetic + * coordinates (latitude and longitude) according to the current ellipsoid + * and Polar Stereographic projection Parameters. If any errors occur, the + * code(s) are returned by the function, otherwise POLAR_NO_ERROR + * is returned. + * + * Easting : Easting (X), in meters (input) + * Northing : Northing (Y), in meters (input) + * Latitude : Latitude, in radians (output) + * Longitude : Longitude, in radians (output) + * + */ + + #ifdef __cplusplus +} + #endif + +#endif /* POLARST_H */ + diff --git a/external/geotranz/readme.txt b/external/geotranz/readme.txt new file mode 100644 index 00000000..fd2488a1 --- /dev/null +++ b/external/geotranz/readme.txt @@ -0,0 +1,41 @@ +GEOTRANS 2.4.2 + +The GEOTRANS 2.4.2 software was developed and tested on Windows XP, Solaris 7, Red Hat Linux Professional 9, and SuSE Linux 9.3 platforms, and should function correctly on more recent versions of those operating systems. + +There are eight different GEOTRANS 2.4.2 distribution files - four for Windows, in zip format, and four for UNIX/Linux, in tar/gzip format: + +win_user.zip - Windows end-user's package +win_dev.zip - Windows developer's package +master.zip - master copy (everything) in zip format +mgrs.zip - MGRS & supporting projections in zip format + +unix_user.tgz - UNIX/Linux end-user's package +unix_dev.tgz - UNIX/Linux developer's package +master.tgz - master copy (everything) in tar/gzip format +mgrs.tgz - MGRS & supporting projections in tar/gzip + +The Windows packages omit the UNIX/Linux-specific directories, while the UNIX/Linux packages omit the Windows-specific directories. + +The end-user packages contain only executables, DLLs or shared object libraries, documentation, and supporting data. + +The developer packages also include source code, as well as makefiles, MS Visual C++ workspace and project files, and everything else necessary to build the libraries and executables. + +The master packages can be considered to be cross-platform developer packages. They both contain the union of the Windows and UNIX/Linux developer packages. Only their format is different. + +The MGRS packages contain only the source code for the MGRS, UTM, UPS, Transverse Mercator, and Polar Stereographic conversion modules, and are intended for developers who only want to do MGRS conversions. Their content is identical. Only their format is different. + +You should only need to copy one of these packages, depending on your platform and your intended usage. + +GEOTRANS Terms of Use: + +1. The GEOTRANS source code ("the software") is provided free of charge by the National Geospatial-Intelligence Agency (NGA) of the United States Department of Defense. Although NGA makes no copyright claim under Title 17 U.S.C., NGA claims copyrights in the source code under other legal regimes. NGA hereby grants to each user of the software a license to use and distribute the software, and develop derivative works. + +2. NGA requests that products developed using the software credit the source of the software with the following statement, "The product was developed using GEOTRANS, a product of the National Geospatial-Intelligence Agency (NGA) and U.S. Army Engineering Research and Development Center." Do not use the name GEOTRANS for any derived work. + +3. Warranty Disclaimer: The software was developed to meet only the internal requirements of the National Geospatial-Intelligence Agency (NGA). The software is provided "as is," and no warranty, express or implied, including but not limited to the implied warranties of merchantability and fitness for particular purpose or arising by statute or otherwise in law or from a course of dealing or usage in trade, is made by NGA as to the accuracy and functioning of the software. + +4. NGA and its personnel are not required to provide technical support or general assistance with respect to public use of the software. Government customers may contact NGA. + +5. Neither NGA nor its personnel will be liable for any claims, losses, or damages arising from or connected with the use of the software. The user agrees to hold harmless the United States National Geospatial-Intelligence Agency (NGA). The user's sole and exclusive remedy is to stop using the software. + +6. Please be advised that pursuant to the United States Code, 10 U.S.C. 425, the name of the National Geospatial-Intelligence Agency, the initials "NGA", the seal of the National Geospatial-Intelligence Agency, or any colorable imitation thereof shall not be used to imply approval, endorsement, or authorization of a product without prior written permission from United States Secretary of Defense. Do not create the impression that NGA, the Secretary of Defense or the Director of National Intelligence has endorsed any product derived from GEOTRANS. diff --git a/external/geotranz/releasenotes.txt b/external/geotranz/releasenotes.txt new file mode 100644 index 00000000..ab863a97 --- /dev/null +++ b/external/geotranz/releasenotes.txt @@ -0,0 +1,465 @@ +GEOTRANS Release Notes + +Release 2.0.2 - November 1999 + +1. The datum parameter file 3_param.dat was changed to correct an error in the +latitude bounds for the NAD 27 Canada datum. + +2. The MGRS module was changed to make the final latitude check on MGRS to UTM +conversions sensitive to the precision of the input MGRS coordinate string. The +lower the input precision, the more "slop" is allowed in the final check on the +latitude zone letter. This is to handle an issue raised by some F-16 pilots, +who truncate MGRS strings that they receive from the Army. This truncation can +put them on the wrong side of a latitude zone boundary, causing the truncated +MGRS string to be considered invalid. The correction causes truncated strings +to be considered valid if any part of the square which they denote lies within +the latitude zone specified by the third letter of the string. + +Release 2.0.3 - April 2000 + +1. Problems with the GEOTRANS file processing capability, including problems +reading coordinate system/projection parameters, and problems with some +coordinates being skipped. Note that spaces must separate individual coordinate +values. + +2. The Bonne projection module has been changed to return an error when the +Origin Latitude parameter is set to zero. In the next release, the Sinusoidal +projection will be used in this situation. + +3. Reported errors in certain cases of conversions between geodetic and MGRS +have been corrected. The error actually occurred in the formatting of the +geodetic output. + +4. The Equidistant Cylindrical projection parameter that was previously called +Origin Latitude has been renamed to Standard Parallel, which more correctly +reflects its role in the projection. The Origin Latitude for the Equidistant +Cylindrical projection is always zero (i.e., the Equator). Error messages and +documentation were updated accordingly. Note that the renaming of this +parameter is the only change to the external interface of the GEOTRANS Engine in +this release. + +5. An error in the method selection logic for datum transformations, in the +Datum module, has been corrected. This error caused the Molodensky method to be +used when transforming between the two 7-parameter datums (EUR-7 and OGB-7) and +WGS 84. + +6. The datum parameter file 3_param.dat was changed to correct the names of +several South American (S-42) datums. + +7. A leftover debug printf statement in the Geoid module was removed. + +8. Several multiple declaration errors that prevented the Motif GUI source code +from being compiled successfully using the Gnu g++ compiler were corrected. +Additional comments were added to the make file for the GEOTRANS application to +facilitate switching between Sun and Gnu compilers. + +9. Comments were also added to the make file for the GEOTRANS application +concerning locating the libXpm shared object library. This library, which +supports the use of X Window pixmaps, was moved to /usr/local/opt/xpm/lib under +Solaris 2.6. + +10. Documentation for the Local Cartesian module was corrected so that this +coordinate system is no longer referred to as a projection. + +11. The usage example in the GEOTRANS Engine Reuse Manual was corrected so that +it now compiles successfully. + +Release 2.1 - June 2000 + +1. The geoid separation file has been converted from text to binary form and +renamed to egm96.grd to better reflect its implementation of the Earth Gravity +Model 1996. The new binary file is less than half the size of the text file +(~4MB vs ~10MB), and is loaded much more quickly when GEOTRANS is started. + +2. Inverse flattening is now used as a primary ellipsoid parameter, along with +the semi-major axis, instead of the semi-minor axis. Previously, the inverse +flattening was computed from the semi-major and semi-minor axes. This is a more +correct approach and improves overall accuracy slightly. + +3. User-defined datums and ellipsoids can now be deleted. A user-defined +ellipsoid can only be deleted if it is not used by any user-defined datum. + +4. Additional datum and ellipsoid parameter functions have been added to the +external interface of the GEOTRANS Engine, for use by applications. + +5. For Windows, a GEOTRANS dynamically linked library (DLL) is now provided +which includes the GEOTRANS Engine and all of the DT&CC modules. A version of +the GEOTRANS application, geotrans2d.exe, which uses the DLL is also provided. +Similarly, for UNIX, a GEOTRANS shared object (.so) library is provided, along +with a version of the GEOTRANS application, geotrans2d, which uses the shared +object library. + +6. The Bonne projection now defaults to the Sinusoidal projection when the origin +latitude is zero. + +7. A "No Height" option has been added for Geodetic coordinates, as an alternative +to "Ellipsoid Height" and "Geoid/MSL Height". When "No Height" is selected on +input, the contents of the Height field is ignored. When "No Height" is selected +on output, no Height value is output. + +8. Three new projections have been added: Azimuthal Equidistant, (Oblique) Gnomonic, +and Oblique Mercator. The only difference between Gnomonic and Oblique Gnomonic +is the value of the original latitude parameter. + +9. The Windows and Motif GUIs have been updated to make the screen layouts more +consistent. Bidirectional conversion between the upper and lower panels is now +supported, using two Convert buttons (Upper-to-Lower and Lower-to-Upper). Error +values are shown separately for each panel. + +10. A bug in the MGRS module that occasionally caused 100km errors was corrected. +Easting and northing values greater than 99999.5 (i.e., less then 1/2m from the +eastern or northern boundary of a 100km square) were being set to zero, but not +moved into the adjacent 100km square. These values are now rounded to 99999. + +11. Documentation and on-line help has been updated to reflect all of the above +enhancements. + +Release 2.2 - September 2000 + +1. The datum code for WGS 72 has been corrected from "WGD" to "WGC". + +2. The default initial output coordinate system type has been changed from +Mercator to UTM. + +3. A bug in the Windows GUI that prevented degrees/minutes and decimal degrees +formats from being selected has been corrected. + +4. In the Windows GUI, the initial default value for inverse flattening and the +associated label in the Create Ellipsoid dialog box have been corrected. + +5. A bug in the Windows GUI that allowed multiple Geodetic Height type radio +buttons to be selected in the File Processing dialog box has been corrected. + +6. Diagrams showing MGRS grid zone, band, and 100,000m square layouts have been +added to the Users' Guide and the on-line help. + +7. An error in the implementation of Oblique Mercator has been corrected. + +8. Four new projections have been added: Ney's (Modified Lambert Conformal Conic), +Stereographic, British National Grid, and New Zealand Map Grid. + +9. A prototype Java GUI has been added which runs on both Windows and UNIX +platforms. It requires a Java run-time environment. To run it on a Windows +platform, go to the /geotrans2/win95 directory and double click on the file +geo_22.jar. To run it on a Solaris platform, cd to the /geotrans2/unix directory +and enter the command: make -f javamake. It may be necessary to edit the +javamake file to point to the location of the Java run-time environment on your +system. + +Release 2.2.1 - June 2001 + +1. Fixed problem(s) in Local Cartesian conversions. + +2. Corrected a rounding problem in MGRS coordinates when the output precision was +set coarser than 1m (10m, 100m, etc.), and the point being converted rounded to +the eastern or northern edge of a 100,000m square. An illegal MGRS string could +be produced, with an odd number of digits including a "1" followed by one or more +zeros. This was corrected by rounding the UTM easting or northing BEFORE +determining the correct 100,000m square. + +3. Corrected a very old error in the determination of the 100,000m square from a +UPS easting in the easternmost part of the south polar zone. + +4. Added more flexible support for delimiters in input files (commas, tabs, spaces) + +5. Corrected a problem in reporting invalid northing errors in UTM. + +6. Correct an example in the Polar Stereo reuse manual with Latitude of True Scale +erroneously set to 0.0. + +7. Removed an invalid Central Meridian line from the header of the Mollweide +example input file. + +8. Added a special F-16 Grid Reference System, a special version of MGRS. + +9. Allowed 90% CE, 90% LE, and 90% SE accuracy values for input coordinates to be +specified. These are used, along with datum transformation accuracy information, +in deriving the output coordinate accuracy values. + +10. Added a pull-down menu of coordinate sources, including GPS, maps, and digital +geospatial data which can be selected to automatically set input accuracy values. + +11. Improved the Java GUI to be fully functional, including support for file +processsing and improvements in its appearance. + +Release 2.2.2 - February 2002 + +1. Added two new datums from Amendment 1 to NIMA TR8350.2 (Jan 2001) to 3_param.dat file: + - Korean Geodetic Datum 1995 (KGS) + - SIRGAS, South America (SIR) + Corrected ellipsoid code errors in 3_param.dat file: + - Ellipsoid used with TIL datum changed from EA to EB, + - Ellipsoid used with IND-P datum changed from EA to EF. + +2. Corrected an "off-by-one" error in the datum index validity check function in +the GEOTRANS engine, which prevented the last datum in the pull-down list from being +used. The Java GUI reported this error, but the Windows and Motif GUIs did not. + +3. Processing of input coordinate files was made more flexible and forgiving: + - Case sensitivity of keywords and name strings was eliminated. + - Height values with geodetic coordinates were made optional, defaulting + to zero. + - Coordinate reference system names were made consistent with the GUI + pull-down menus. + - File processing error messages were improved. + +4. A warnings count was added to the file processing GUI. + + +5. Geodetic height fields are grayed out and the No Height selection is forced +whenever 3D conversion is not feasible. For 3D conversion to be feasible, Geodetic, +Geocentric, or Local Cartesian must be selected on both panels. For file processing, +the output Geodetic height field is grayed out and the No Height selection is forced +whenever the input coordinate reference system is not a 3D system. + +6. File header generation, using a modified version of the File Processing GUI, was +added. (Java GUI Only) + +7. Some results of the review of GEOTRANS by NIMA G&G were implemented: + - In the User’s Guide (and on-line help), the description of the use of 3-step + method, rather than Molodenski, in polar regions was reworded. + - In the User's Guide (and on-line help), the description of how to specify + Lambert Conformal Conic projection with one standard parallel was clarified. + - UTM zone fields were enabled independent of the state of the Override buttons, + with default values of zero, and the valid range of zone numbers (1-60) was + added to the zone field labels. + - In the Sources pull-down menus, the values for GPS PPS and GPS SPS were corrected + to be the same, reflecting the shutting off of GPS selective availability (SA). + - The words “Warning:” or “Error:”, as appropriate, were explicitly included in + all messages output by the GUIs. + +Release 2.2.3 - February 2003 + +There were no changes made to the external interfaces of the GEOTRANS libraries. + +1. The ellipsoid (ellipse.dat) and datum (3_param.dat) files were updated to correct +several typos. Dates were added to all ellipsoid names. + +2. A problem in the MGRS module (mgrs.c) was corrected. This problem occurred only +when converting from geodetic to MGRS coordinates that round to the centerline of zone +31V. This zone is “cut in half”, such that its centerline is also its eastern boundary. +Points that are rounded up (eastward) to this boundary are considered to lie in zone 32V. + +3. An error in the Local Cartesian module (loccart.c) was corrected to properly take +into account the longitude of the local Cartesian coordinate system origin in converting +between geocentric and local Cartesian coordinates. + +4. A possible problem in the Transverse Mercator module (tranmerc.c) concerning +projections at the poles was investigated. Points at the poles are projected when the +Transverse Mercator module is initialized in order to determine the range of valid inputs +for the inverse projection. The tangent of the latitude is calculated, which should be +infinite at the poles. Investigation determined that the tangent functions for both +Windows and Solaris actually return very large values in this case, which result in the +expected behavior. However, to avoid this problem on other platforms, the maximum valid +latitude for the Transverse Mercator projection was reduced from 90 to 89.99 degrees. + +5. A reported incompatibility between GEOTRANS 2.2.2 and version 4 of the Boeing +Autometric EDGE Viewer on Windows platforms was investigated. This version of the EDGE +Viewer includes the GEOTRANS 2.0.3 libraries. When the EDGE Viewer is installed, it +sets the GEOTRANS environment variables to reference the directory C:/Program Files/Autometric/EDGEViewer/Data/GeoTrans. This overrides the default setting in the +GEOTRANS application, causing it to look for its required data files in the EDGE Viewer +directory. The incompatibility arises from the fact that the Earth Gravity Model 1996 +geoid separation file was renamed and changed from text to binary form in GEOTRANS 2.1, +which reduced its size from 10MB to 4MB. When the newer binary file is not found in +the EDGE data directory, the GEOTRANS application fails to initialize successfully. +Placing a copy of the binary geoid separation file (egm96.grd) into the EDGE Viewer +data directory eliminates the problem. A recent update to the EDGE Viewer eliminates +the problem by using a more recent version of the GEOTRANS libraries. Therefore no +changes to the GEOTRANS software were necessary. + +6. The source data accuracy values for GPS PPS and SPS modes were updated from 10m +to 20m. + +7. The Linear (i.e., vertical) Error (LE) and Spherical Error (SE) fields are now +grayed out whenever a conversion is not three-dimensional. + +Release 2.2.4 - August 2003 + +There were no changes made to the external interfaces of the GEOTRANS libraries. + +1. Minor changes were made to source code to eliminate all compilation warnings. +These changes involved the Ellisoid module, the GEOTRANS engine, GEOTRANS application +Windows GUI, and GEOTRANS application support source code file. + +2. A bug in the MGRS module was corrected. This bug caused MGRS coordinates located +in small triangular areas north of 64S latitude, and south of the 2,900,000 northing +line, to fail to convert correctly to UTM. + +3. The MGRS module was corrected so that the MGRS "AL" 100,000m square pattern is used +with the Bessel 1841 Namibia (BN) ellipsoid. On-line help was corrected to be consistent +with this change. + +4. The MGRS module was updated to eliminate inconsistencies in the conversion of points +located on UTM zone and MGRS latitude band boundaries. + +5. The MGRS module was reorganized internally to improve the clarity and efficiency of +the source code. The external interface of the MGRS module was not changed. + +Release 2.2.4 - August 2003 + +There were no changes made to the external interfaces of the GEOTRANS libraries. + +1. Minor changes were made to source code to eliminate all compilation warnings. +These changes involved the Ellisoid module, the GEOTRANS engine, GEOTRANS application +Windows GUI, and GEOTRANS application support source code file. + +2. A bug in the MGRS module was corrected. This bug caused MGRS coordinates located +in small triangular areas north of 64S latitude, and south of the 2,900,000 northing +line, to fail to convert correctly to UTM. + +3. The MGRS module was corrected so that the MGRS "AL" 100,000m square pattern is used +with the Bessel 1841 Namibia (BN) ellipsoid. On-line help was corrected to be consistent +with this change. + +4. The MGRS module was updated to eliminate inconsistencies in the conversion of points +located on UTM zone and MGRS latitude band boundaries. + +5. The MGRS module was reorganized internally to improve the clarity and efficiency of +the source code. The external interface of the MGRS module was not changed. +Release 2.2.4 - August 2003 + +There were no changes made to the external interfaces of the GEOTRANS libraries. + +1. Minor changes were made to source code to eliminate all compilation warnings. +These changes involved the Ellisoid module, the GEOTRANS engine, GEOTRANS application +Windows GUI, and GEOTRANS application support source code file. + +2. A bug in the MGRS module was corrected. This bug caused MGRS coordinates located +in small triangular areas north of 64S latitude, and south of the 2,900,000 northing +line, to fail to convert correctly to UTM. + +3. The MGRS module was corrected so that the MGRS "AL" 100,000m square pattern is used +with the Bessel 1841 Namibia (BN) ellipsoid. On-line help was corrected to be consistent +with this change. + +4. The MGRS module was updated to eliminate inconsistencies in the conversion of points +located on UTM zone and MGRS latitude band boundaries. + +5. The MGRS module was reorganized internally to improve the clarity and efficiency of +the source code. The external interface of the MGRS module was not changed. + +Release 2.2.5 - June 2004 + +There were no changes made to the external interfaces of the GEOTRANS libraries. + +1. A minor correction was made in the Datum module, to correct an "off-by-one" error in the Valid_Datum function, which caused it to return a warning when the last 3-parameter datum was accessed. + +2. A minor correction was made in the Round_DMS function, in the common application GUI support software, which caused incorrect geodetic coordinate values to be displayed when converting to degrees with a precision of .0001. + +3 The 3-parameter datum file, 3_param.dat, was updated to reflect new parameter values for the MID (MIDWAY ASTRO 1961, Midway Is.) datum, which went into effect in June 2003. The longitude limits for the NAS-U (North American 1927, Greenland), the DAL (Dabola, Guinea) and the TRN (Astro Tern Island (Frig) 1961 datums were also corrected. + +Release 2.2.6 - June 2005 + +1. A minor correction was made in the Get_Geoid_Height function in the GEOID module, which does bilinear interpolation of EGM96 geoid separation values. The error caused the specified point to be shifted in longitude, mirrored around the east-west midline of the 15-minute grid cell that contains it. + +2. The 3-parameter datum file, 3_param.dat, was updated to correct the latitude and longitude limits for the DID (Deception Island), EUR-S (European 1950, Israel and Iraq), and KEG (Kerguelen Island) datums. + +3. A minor correction was made in the Convert_Orthographic_to_Geodetic function in the ORTHOGR module to use the two-argument arctangent function (atan2) rather than the single-argument arctangent function (atan). This avoids sign errors in results near the poles. + +4. A minor correction was made in the Convert_Albers_to_Geodetic function in the ALBERS module to avoid infinite loops when the iterative solution for latitude fails to converge. After 30 iterations, the function now returns an error status. + +5. Support was added for the Lambert Conformal Conic projection with one standard parallel. A new LAMBERT_1 module was added, and the LAMBERT_2 module was renamed (from LAMBERT) and reengineered to use the new LAMBERT_1 module. Backward compatibility was maintained at the DT&CC and GEOTRANS Engine levels. However, all existing functions that include "Lambert", rather than "Lambert1" or "Lambert2", in their names are now considered to be deprecated, and will be removed in a future update. + +6. The GEOTRANS application GUI was enhanced to help users avoid incompatible combinations of coordinate systems and datums by color coding the conversion buttons. Red indicates that the selected coordinate systems and datums are not compatible with one another, and that an error message will result from any attempted conversion operation. Yellow indicates that the selected datums have disjoint areas of validity, adn that a warning message will result from any attempted conversion operation. + +7. A correction was made to the Geodetic_Shift_WGS72_To_WGS84 and Geodetic_Shift_WGS72_To_WGS84 functions in the DATUM module to wrap longitude values across the 180 degree line and wrap latitude values over the poles. + +8. File processing examples in the online help, and in the /examples subdirectory, were improved to use more realistic coordinates, and additional examples were added. + +9. The GEOTRANS application GUI was enhanced to provide an option to display leading zeroes on output geodetic coordinate values, including degrees (three digits for longitude, two digits for latitude), minutes (two digits), and seconds (two digits). + +Release 2.3 - March 2006 + +1. The 3-parameter datum file, 3_param.dat, was updated to correct the latitude and longitude limits for DID (Deception Island), switching longitude order, and JOH (Johnston Island) datums. + +2. An “off-by-one” error in datum indexing in the JNI interface was corrected. + +3. Support for Red Hat Linux (Red Hat Professional 9.3 and later) and for SuSE Linux (SuSE Linux 9 and later) was added. + +4. A reported potential error in file name string underflow/overflow in the Ellipsoid, Datum, and Geoid modules was corrected. + +5. Support for multithreading was improved by adding mutual exclusion zones around code that opens and reads data files in the Ellipsoid, Datum, and Geoid modules. + +6. Support for three additional gravity-related height models was added, based on requirements from the US military services: +a. EGM96 with variable grid spacing and natural spline interpolation +b. EGM84 with 10 degree by 10 degree grid spacing and bilinear interpolation +c. EGM84 with 10 degree by 10 degree grid spacing and natural spline interpolation +These are in addition to EGM96 with 15-minute grid spacing and bilinear interpolation, which was previously supported. + +Release 2.4 - September 2006 + +1. The 3-parameter datum file, 3_param.dat, was updated to correct two spelling errors (Columbia -> Colombia, Phillipines -> Philippines). + +2. The 3-parameter datum file, 3_param.dat, was updated to adjust the limits for several local datums in the 3-parameter datum file (ADI-E, CAC, CAI, COA, HJO, ING-A, KEG, LCF, NDS, SAE, SAN-A, SAN-C, VOI, and VOR). + +3. All required ellipsoid, datum, and geoid data files to a /data subdirectory to eliminate the need for duplicate copies. + +4. Error reporting was improved when required ellipsoid, datum, and/or geoid data files cannot be located at initialization. + +5. In the Geoid module, problems were corrected in the interpolation of geoid separation values using a variable-resolution grid when converting to or from MSL-EGM96-VG-NS Height. + +6. In the MGRS module, a problem was corrected in rounding up to the equator when converting to MGRS. + +7. Support was added for the U.S. National Grid (USNG). + +8. Support was added for the Global Area Reference System (USNG). + +Release 2.4.1 - March 2007 + +1. Corrected two minor errors (6cm and 1cm) in the values contained in the EGM84 geoid +separation file. + +2. Improved error handling and reporting in the Transverse Mercator, UTM, and MGRS +modules at extreme northern and southern latitudes, for points that are more than 9 +degrees, but less than 400km, from the central meridian. + +3. Modified the US National Grid (USNG) module to truncate, rather than round, USNG +coordinates as required by the USNG specification. + +4. Corrected an error in the calculation of valid ranges for input easting and northing +coordinates in the Mercator module, and several other map projection modules. This +caused valid inputs to be rejected when extremely large (e.g., 20,000,000m) false easting +or false northing values were specified for those map projections. + +5. Improved error handling and reporting in the Lambert Conformal Conic modules in cases +of extremely small scale factor values. + +6. Corrected an error in the MGRS module that occurred when a point rounded up to the +eastern boundary of the non-standard zone 31V in the northern Atlantic, which is +considered to be part of zone 32V. + +Release 2.4.2 - August 2008 + +1. Corrected an error in the MGRS and USNG modules that incorrectly mapped 100,000m square +row letters to northing values in the northern portion of the X latitude band (northings > 9,000,000m). + +2. Revised the handling of warnings reported by the Transverse Mercator (TM) module for points +located more than 9 degrees from the central meridian, when the TM module is invoked by the UTM and +MGRS modules, so that UTM or MGRS error checking takes precedence. + +3. Added datum domain checks for those cases where no datum transformations are performed. +Previously, coordinates were not checked against the valid domain of the datum when the input datum +and output datum were identical. + +4. The default accuracy estimate values for DTED Level 1 and DTED Level 2 were updated to be consistent +with MIL-PRF-89020B, Performance Specification, Digital Terrain Elevation Data (DTED), 23 May 2000, replacing +the values from MIL-PRF-89020A, 19 Apr 1996. Default spherical accuracy estimate values for all relevant data +sources were updated to reflect a more accurate relationship to the corresponding circular (horizontal) +accuracy estimates. + +5. In the GEOTRANS application, added commands to save the current selections and options settings as +the defaults, and to reset the current selections and options settings from the defaults. + +6. In the GEOTRANS application, added capabilities to create and delete user-defined 7-parameter datums. + +7. Corrected a problem with the checking of input coordinates against the valid region for a local datum +when a longitude value greater than +180 degrees was entered. + +8. Corrected the valid regions for the PUK and NAR-E datums to use a range of longitudes that span the ++180/-180 degree line. + + + + + + diff --git a/external/geotranz/tranmerc.c b/external/geotranz/tranmerc.c new file mode 100644 index 00000000..893db7e3 --- /dev/null +++ b/external/geotranz/tranmerc.c @@ -0,0 +1,618 @@ +/***************************************************************************/ +/* RSC IDENTIFIER: TRANSVERSE MERCATOR + * + * ABSTRACT + * + * This component provides conversions between Geodetic coordinates + * (latitude and longitude) and Transverse Mercator projection coordinates + * (easting and northing). + * + * ERROR HANDLING + * + * This component checks parameters for valid values. If an invalid value + * is found the error code is combined with the current error code using + * the bitwise or. This combining allows multiple error codes to be + * returned. The possible error codes are: + * + * TRANMERC_NO_ERROR : No errors occurred in function + * TRANMERC_LAT_ERROR : Latitude outside of valid range + * (-90 to 90 degrees) + * TRANMERC_LON_ERROR : Longitude outside of valid range + * (-180 to 360 degrees, and within + * +/-90 of Central Meridian) + * TRANMERC_EASTING_ERROR : Easting outside of valid range + * (depending on ellipsoid and + * projection parameters) + * TRANMERC_NORTHING_ERROR : Northing outside of valid range + * (depending on ellipsoid and + * projection parameters) + * TRANMERC_ORIGIN_LAT_ERROR : Origin latitude outside of valid range + * (-90 to 90 degrees) + * TRANMERC_CENT_MER_ERROR : Central meridian outside of valid range + * (-180 to 360 degrees) + * TRANMERC_A_ERROR : Semi-major axis less than or equal to zero + * TRANMERC_INV_F_ERROR : Inverse flattening outside of valid range + * (250 to 350) + * TRANMERC_SCALE_FACTOR_ERROR : Scale factor outside of valid + * range (0.3 to 3.0) + * TM_LON_WARNING : Distortion will result if longitude is more + * than 9 degrees from the Central Meridian + * + * REUSE NOTES + * + * TRANSVERSE MERCATOR is intended for reuse by any application that + * performs a Transverse Mercator projection or its inverse. + * + * REFERENCES + * + * Further information on TRANSVERSE MERCATOR can be found in the + * Reuse Manual. + * + * TRANSVERSE MERCATOR originated from : + * U.S. Army Topographic Engineering Center + * Geospatial Information Division + * 7701 Telegraph Road + * Alexandria, VA 22310-3864 + * + * LICENSES + * + * None apply to this component. + * + * RESTRICTIONS + * + * TRANSVERSE MERCATOR has no restrictions. + * + * ENVIRONMENT + * + * TRANSVERSE MERCATOR was tested and certified in the following + * environments: + * + * 1. Solaris 2.5 with GCC, version 2.8.1 + * 2. Windows 95 with MS Visual C++, version 6 + * + * MODIFICATIONS + * + * Date Description + * ---- ----------- + * 10-02-97 Original Code + * 03-02-97 Re-engineered Code + * + */ + + +/***************************************************************************/ +/* + * INCLUDES + */ + +#include +#include "tranmerc.h" + +/* + * math.h - Standard C math library + * tranmerc.h - Is for prototype error checking + */ + + +/***************************************************************************/ +/* DEFINES + * + */ + +#define PI 3.14159265358979323e0 /* PI */ +#define PI_OVER_2 (PI/2.0e0) /* PI over 2 */ +#define MAX_LAT ((PI * 89.99)/180.0) /* 89.99 degrees in radians */ +#define MAX_DELTA_LONG ((PI * 90)/180.0) /* 90 degrees in radians */ +#define MIN_SCALE_FACTOR 0.3 +#define MAX_SCALE_FACTOR 3.0 + +#define SPHTMD(Latitude) ((double) (TranMerc_ap * Latitude \ + - TranMerc_bp * sin(2.e0 * Latitude) + TranMerc_cp * sin(4.e0 * Latitude) \ + - TranMerc_dp * sin(6.e0 * Latitude) + TranMerc_ep * sin(8.e0 * Latitude) ) ) + +#define SPHSN(Latitude) ((double) (TranMerc_a / sqrt( 1.e0 - TranMerc_es * \ + pow(sin(Latitude), 2)))) + +#define SPHSR(Latitude) ((double) (TranMerc_a * (1.e0 - TranMerc_es) / \ + pow(DENOM(Latitude), 3))) + +#define DENOM(Latitude) ((double) (sqrt(1.e0 - TranMerc_es * pow(sin(Latitude),2)))) + + +/**************************************************************************/ +/* GLOBAL DECLARATIONS + * + */ + +/* Ellipsoid Parameters, default to WGS 84 */ +static double TranMerc_a = 6378137.0; /* Semi-major axis of ellipsoid in meters */ +static double TranMerc_f = 1 / 298.257223563; /* Flattening of ellipsoid */ +static double TranMerc_es = 0.0066943799901413800; /* Eccentricity (0.08181919084262188000) squared */ +static double TranMerc_ebs = 0.0067394967565869; /* Second Eccentricity squared */ + +/* Transverse_Mercator projection Parameters */ +static double TranMerc_Origin_Lat = 0.0; /* Latitude of origin in radians */ +static double TranMerc_Origin_Long = 0.0; /* Longitude of origin in radians */ +static double TranMerc_False_Northing = 0.0; /* False northing in meters */ +static double TranMerc_False_Easting = 0.0; /* False easting in meters */ +static double TranMerc_Scale_Factor = 1.0; /* Scale factor */ + +/* Isometeric to geodetic latitude parameters, default to WGS 84 */ +static double TranMerc_ap = 6367449.1458008; +static double TranMerc_bp = 16038.508696861; +static double TranMerc_cp = 16.832613334334; +static double TranMerc_dp = 0.021984404273757; +static double TranMerc_ep = 3.1148371319283e-005; + +/* Maximum variance for easting and northing values for WGS 84. */ +static double TranMerc_Delta_Easting = 40000000.0; +static double TranMerc_Delta_Northing = 40000000.0; + +/* These state variables are for optimization purposes. The only function + * that should modify them is Set_Tranverse_Mercator_Parameters. */ + + +/************************************************************************/ +/* FUNCTIONS + * + */ + + +long Set_Transverse_Mercator_Parameters(double a, + double f, + double Origin_Latitude, + double Central_Meridian, + double False_Easting, + double False_Northing, + double Scale_Factor) + +{ /* BEGIN Set_Tranverse_Mercator_Parameters */ + /* + * The function Set_Tranverse_Mercator_Parameters receives the ellipsoid + * parameters and Tranverse Mercator projection parameters as inputs, and + * sets the corresponding state variables. If any errors occur, the error + * code(s) are returned by the function, otherwise TRANMERC_NO_ERROR is + * returned. + * + * a : Semi-major axis of ellipsoid, in meters (input) + * f : Flattening of ellipsoid (input) + * Origin_Latitude : Latitude in radians at the origin of the (input) + * projection + * Central_Meridian : Longitude in radians at the center of the (input) + * projection + * False_Easting : Easting/X at the center of the projection (input) + * False_Northing : Northing/Y at the center of the projection (input) + * Scale_Factor : Projection scale factor (input) + */ + + double tn; /* True Meridianal distance constant */ + double tn2; + double tn3; + double tn4; + double tn5; + double dummy_northing; + double TranMerc_b; /* Semi-minor axis of ellipsoid, in meters */ + double inv_f = 1 / f; + long Error_Code = TRANMERC_NO_ERROR; + + if (a <= 0.0) + { /* Semi-major axis must be greater than zero */ + Error_Code |= TRANMERC_A_ERROR; + } + if ((inv_f < 250) || (inv_f > 350)) + { /* Inverse flattening must be between 250 and 350 */ + Error_Code |= TRANMERC_INV_F_ERROR; + } + if ((Origin_Latitude < -PI_OVER_2) || (Origin_Latitude > PI_OVER_2)) + { /* origin latitude out of range */ + Error_Code |= TRANMERC_ORIGIN_LAT_ERROR; + } + if ((Central_Meridian < -PI) || (Central_Meridian > (2*PI))) + { /* origin longitude out of range */ + Error_Code |= TRANMERC_CENT_MER_ERROR; + } + if ((Scale_Factor < MIN_SCALE_FACTOR) || (Scale_Factor > MAX_SCALE_FACTOR)) + { + Error_Code |= TRANMERC_SCALE_FACTOR_ERROR; + } + if (!Error_Code) + { /* no errors */ + TranMerc_a = a; + TranMerc_f = f; + TranMerc_Origin_Lat = Origin_Latitude; + if (Central_Meridian > PI) + Central_Meridian -= (2*PI); + TranMerc_Origin_Long = Central_Meridian; + TranMerc_False_Northing = False_Northing; + TranMerc_False_Easting = False_Easting; + TranMerc_Scale_Factor = Scale_Factor; + + /* Eccentricity Squared */ + TranMerc_es = 2 * TranMerc_f - TranMerc_f * TranMerc_f; + /* Second Eccentricity Squared */ + TranMerc_ebs = (1 / (1 - TranMerc_es)) - 1; + + TranMerc_b = TranMerc_a * (1 - TranMerc_f); + /*True meridianal constants */ + tn = (TranMerc_a - TranMerc_b) / (TranMerc_a + TranMerc_b); + tn2 = tn * tn; + tn3 = tn2 * tn; + tn4 = tn3 * tn; + tn5 = tn4 * tn; + + TranMerc_ap = TranMerc_a * (1.e0 - tn + 5.e0 * (tn2 - tn3)/4.e0 + + 81.e0 * (tn4 - tn5)/64.e0 ); + TranMerc_bp = 3.e0 * TranMerc_a * (tn - tn2 + 7.e0 * (tn3 - tn4) + /8.e0 + 55.e0 * tn5/64.e0 )/2.e0; + TranMerc_cp = 15.e0 * TranMerc_a * (tn2 - tn3 + 3.e0 * (tn4 - tn5 )/4.e0) /16.0; + TranMerc_dp = 35.e0 * TranMerc_a * (tn3 - tn4 + 11.e0 * tn5 / 16.e0) / 48.e0; + TranMerc_ep = 315.e0 * TranMerc_a * (tn4 - tn5) / 512.e0; + Convert_Geodetic_To_Transverse_Mercator(MAX_LAT, + MAX_DELTA_LONG + Central_Meridian, + &TranMerc_Delta_Easting, + &TranMerc_Delta_Northing); + Convert_Geodetic_To_Transverse_Mercator(0, + MAX_DELTA_LONG + Central_Meridian, + &TranMerc_Delta_Easting, + &dummy_northing); + TranMerc_Delta_Northing++; + TranMerc_Delta_Easting++; + + } /* END OF if(!Error_Code) */ + return (Error_Code); +} /* END of Set_Transverse_Mercator_Parameters */ + + +void Get_Transverse_Mercator_Parameters(double *a, + double *f, + double *Origin_Latitude, + double *Central_Meridian, + double *False_Easting, + double *False_Northing, + double *Scale_Factor) + +{ /* BEGIN Get_Tranverse_Mercator_Parameters */ + /* + * The function Get_Transverse_Mercator_Parameters returns the current + * ellipsoid and Transverse Mercator projection parameters. + * + * a : Semi-major axis of ellipsoid, in meters (output) + * f : Flattening of ellipsoid (output) + * Origin_Latitude : Latitude in radians at the origin of the (output) + * projection + * Central_Meridian : Longitude in radians at the center of the (output) + * projection + * False_Easting : Easting/X at the center of the projection (output) + * False_Northing : Northing/Y at the center of the projection (output) + * Scale_Factor : Projection scale factor (output) + */ + + *a = TranMerc_a; + *f = TranMerc_f; + *Origin_Latitude = TranMerc_Origin_Lat; + *Central_Meridian = TranMerc_Origin_Long; + *False_Easting = TranMerc_False_Easting; + *False_Northing = TranMerc_False_Northing; + *Scale_Factor = TranMerc_Scale_Factor; + return; +} /* END OF Get_Tranverse_Mercator_Parameters */ + + + +long Convert_Geodetic_To_Transverse_Mercator (double Latitude, + double Longitude, + double *Easting, + double *Northing) + +{ /* BEGIN Convert_Geodetic_To_Transverse_Mercator */ + + /* + * The function Convert_Geodetic_To_Transverse_Mercator converts geodetic + * (latitude and longitude) coordinates to Transverse Mercator projection + * (easting and northing) coordinates, according to the current ellipsoid + * and Transverse Mercator projection coordinates. If any errors occur, the + * error code(s) are returned by the function, otherwise TRANMERC_NO_ERROR is + * returned. + * + * Latitude : Latitude in radians (input) + * Longitude : Longitude in radians (input) + * Easting : Easting/X in meters (output) + * Northing : Northing/Y in meters (output) + */ + + double c; /* Cosine of latitude */ + double c2; + double c3; + double c5; + double c7; + double dlam; /* Delta longitude - Difference in Longitude */ + double eta; /* constant - TranMerc_ebs *c *c */ + double eta2; + double eta3; + double eta4; + double s; /* Sine of latitude */ + double sn; /* Radius of curvature in the prime vertical */ + double t; /* Tangent of latitude */ + double tan2; + double tan3; + double tan4; + double tan5; + double tan6; + double t1; /* Term in coordinate conversion formula - GP to Y */ + double t2; /* Term in coordinate conversion formula - GP to Y */ + double t3; /* Term in coordinate conversion formula - GP to Y */ + double t4; /* Term in coordinate conversion formula - GP to Y */ + double t5; /* Term in coordinate conversion formula - GP to Y */ + double t6; /* Term in coordinate conversion formula - GP to Y */ + double t7; /* Term in coordinate conversion formula - GP to Y */ + double t8; /* Term in coordinate conversion formula - GP to Y */ + double t9; /* Term in coordinate conversion formula - GP to Y */ + double tmd; /* True Meridional distance */ + double tmdo; /* True Meridional distance for latitude of origin */ + long Error_Code = TRANMERC_NO_ERROR; + double temp_Origin; + double temp_Long; + + if ((Latitude < -MAX_LAT) || (Latitude > MAX_LAT)) + { /* Latitude out of range */ + Error_Code|= TRANMERC_LAT_ERROR; + } + if (Longitude > PI) + Longitude -= (2 * PI); + if ((Longitude < (TranMerc_Origin_Long - MAX_DELTA_LONG)) + || (Longitude > (TranMerc_Origin_Long + MAX_DELTA_LONG))) + { + if (Longitude < 0) + temp_Long = Longitude + 2 * PI; + else + temp_Long = Longitude; + if (TranMerc_Origin_Long < 0) + temp_Origin = TranMerc_Origin_Long + 2 * PI; + else + temp_Origin = TranMerc_Origin_Long; + if ((temp_Long < (temp_Origin - MAX_DELTA_LONG)) + || (temp_Long > (temp_Origin + MAX_DELTA_LONG))) + Error_Code|= TRANMERC_LON_ERROR; + } + if (!Error_Code) + { /* no errors */ + + /* + * Delta Longitude + */ + dlam = Longitude - TranMerc_Origin_Long; + + if (fabs(dlam) > (9.0 * PI / 180)) + { /* Distortion will result if Longitude is more than 9 degrees from the Central Meridian */ + Error_Code |= TRANMERC_LON_WARNING; + } + + if (dlam > PI) + dlam -= (2 * PI); + if (dlam < -PI) + dlam += (2 * PI); + if (fabs(dlam) < 2.e-10) + dlam = 0.0; + + s = sin(Latitude); + c = cos(Latitude); + c2 = c * c; + c3 = c2 * c; + c5 = c3 * c2; + c7 = c5 * c2; + t = tan (Latitude); + tan2 = t * t; + tan3 = tan2 * t; + tan4 = tan3 * t; + tan5 = tan4 * t; + tan6 = tan5 * t; + eta = TranMerc_ebs * c2; + eta2 = eta * eta; + eta3 = eta2 * eta; + eta4 = eta3 * eta; + + /* radius of curvature in prime vertical */ + sn = SPHSN(Latitude); + + /* True Meridianal Distances */ + tmd = SPHTMD(Latitude); + + /* Origin */ + tmdo = SPHTMD (TranMerc_Origin_Lat); + + /* northing */ + t1 = (tmd - tmdo) * TranMerc_Scale_Factor; + t2 = sn * s * c * TranMerc_Scale_Factor/ 2.e0; + t3 = sn * s * c3 * TranMerc_Scale_Factor * (5.e0 - tan2 + 9.e0 * eta + + 4.e0 * eta2) /24.e0; + + t4 = sn * s * c5 * TranMerc_Scale_Factor * (61.e0 - 58.e0 * tan2 + + tan4 + 270.e0 * eta - 330.e0 * tan2 * eta + 445.e0 * eta2 + + 324.e0 * eta3 -680.e0 * tan2 * eta2 + 88.e0 * eta4 + -600.e0 * tan2 * eta3 - 192.e0 * tan2 * eta4) / 720.e0; + + t5 = sn * s * c7 * TranMerc_Scale_Factor * (1385.e0 - 3111.e0 * + tan2 + 543.e0 * tan4 - tan6) / 40320.e0; + + *Northing = TranMerc_False_Northing + t1 + pow(dlam,2.e0) * t2 + + pow(dlam,4.e0) * t3 + pow(dlam,6.e0) * t4 + + pow(dlam,8.e0) * t5; + + /* Easting */ + t6 = sn * c * TranMerc_Scale_Factor; + t7 = sn * c3 * TranMerc_Scale_Factor * (1.e0 - tan2 + eta ) /6.e0; + t8 = sn * c5 * TranMerc_Scale_Factor * (5.e0 - 18.e0 * tan2 + tan4 + + 14.e0 * eta - 58.e0 * tan2 * eta + 13.e0 * eta2 + 4.e0 * eta3 + - 64.e0 * tan2 * eta2 - 24.e0 * tan2 * eta3 )/ 120.e0; + t9 = sn * c7 * TranMerc_Scale_Factor * ( 61.e0 - 479.e0 * tan2 + + 179.e0 * tan4 - tan6 ) /5040.e0; + + *Easting = TranMerc_False_Easting + dlam * t6 + pow(dlam,3.e0) * t7 + + pow(dlam,5.e0) * t8 + pow(dlam,7.e0) * t9; + } + return (Error_Code); +} /* END OF Convert_Geodetic_To_Transverse_Mercator */ + + +long Convert_Transverse_Mercator_To_Geodetic ( + double Easting, + double Northing, + double *Latitude, + double *Longitude) +{ /* BEGIN Convert_Transverse_Mercator_To_Geodetic */ + + /* + * The function Convert_Transverse_Mercator_To_Geodetic converts Transverse + * Mercator projection (easting and northing) coordinates to geodetic + * (latitude and longitude) coordinates, according to the current ellipsoid + * and Transverse Mercator projection parameters. If any errors occur, the + * error code(s) are returned by the function, otherwise TRANMERC_NO_ERROR is + * returned. + * + * Easting : Easting/X in meters (input) + * Northing : Northing/Y in meters (input) + * Latitude : Latitude in radians (output) + * Longitude : Longitude in radians (output) + */ + + double c; /* Cosine of latitude */ + double de; /* Delta easting - Difference in Easting (Easting-Fe) */ + double dlam; /* Delta longitude - Difference in Longitude */ + double eta; /* constant - TranMerc_ebs *c *c */ + double eta2; + double eta3; + double eta4; + double ftphi; /* Footpoint latitude */ + int i; /* Loop iterator */ + //double s; /* Sine of latitude */ + double sn; /* Radius of curvature in the prime vertical */ + double sr; /* Radius of curvature in the meridian */ + double t; /* Tangent of latitude */ + double tan2; + double tan4; + double t10; /* Term in coordinate conversion formula - GP to Y */ + double t11; /* Term in coordinate conversion formula - GP to Y */ + double t12; /* Term in coordinate conversion formula - GP to Y */ + double t13; /* Term in coordinate conversion formula - GP to Y */ + double t14; /* Term in coordinate conversion formula - GP to Y */ + double t15; /* Term in coordinate conversion formula - GP to Y */ + double t16; /* Term in coordinate conversion formula - GP to Y */ + double t17; /* Term in coordinate conversion formula - GP to Y */ + double tmd; /* True Meridional distance */ + double tmdo; /* True Meridional distance for latitude of origin */ + long Error_Code = TRANMERC_NO_ERROR; + + if ((Easting < (TranMerc_False_Easting - TranMerc_Delta_Easting)) + ||(Easting > (TranMerc_False_Easting + TranMerc_Delta_Easting))) + { /* Easting out of range */ + Error_Code |= TRANMERC_EASTING_ERROR; + } + if ((Northing < (TranMerc_False_Northing - TranMerc_Delta_Northing)) + || (Northing > (TranMerc_False_Northing + TranMerc_Delta_Northing))) + { /* Northing out of range */ + Error_Code |= TRANMERC_NORTHING_ERROR; + } + + if (!Error_Code) + { + /* True Meridional Distances for latitude of origin */ + tmdo = SPHTMD(TranMerc_Origin_Lat); + + /* Origin */ + tmd = tmdo + (Northing - TranMerc_False_Northing) / TranMerc_Scale_Factor; + + /* First Estimate */ + sr = SPHSR(0.e0); + ftphi = tmd/sr; + + for (i = 0; i < 5 ; i++) + { + t10 = SPHTMD (ftphi); + sr = SPHSR(ftphi); + ftphi = ftphi + (tmd - t10) / sr; + } + + /* Radius of Curvature in the meridian */ + sr = SPHSR(ftphi); + + /* Radius of Curvature in the meridian */ + sn = SPHSN(ftphi); + + /* Sine Cosine terms */ + //s = sin(ftphi); + c = cos(ftphi); + + /* Tangent Value */ + t = tan(ftphi); + tan2 = t * t; + tan4 = tan2 * tan2; + eta = TranMerc_ebs * pow(c,2); + eta2 = eta * eta; + eta3 = eta2 * eta; + eta4 = eta3 * eta; + de = Easting - TranMerc_False_Easting; + if (fabs(de) < 0.0001) + de = 0.0; + + /* Latitude */ + t10 = t / (2.e0 * sr * sn * pow(TranMerc_Scale_Factor, 2)); + t11 = t * (5.e0 + 3.e0 * tan2 + eta - 4.e0 * pow(eta,2) + - 9.e0 * tan2 * eta) / (24.e0 * sr * pow(sn,3) + * pow(TranMerc_Scale_Factor,4)); + t12 = t * (61.e0 + 90.e0 * tan2 + 46.e0 * eta + 45.E0 * tan4 + - 252.e0 * tan2 * eta - 3.e0 * eta2 + 100.e0 + * eta3 - 66.e0 * tan2 * eta2 - 90.e0 * tan4 + * eta + 88.e0 * eta4 + 225.e0 * tan4 * eta2 + + 84.e0 * tan2* eta3 - 192.e0 * tan2 * eta4) + / ( 720.e0 * sr * pow(sn,5) * pow(TranMerc_Scale_Factor, 6) ); + t13 = t * ( 1385.e0 + 3633.e0 * tan2 + 4095.e0 * tan4 + 1575.e0 + * pow(t,6))/ (40320.e0 * sr * pow(sn,7) * pow(TranMerc_Scale_Factor,8)); + *Latitude = ftphi - pow(de,2) * t10 + pow(de,4) * t11 - pow(de,6) * t12 + + pow(de,8) * t13; + + t14 = 1.e0 / (sn * c * TranMerc_Scale_Factor); + + t15 = (1.e0 + 2.e0 * tan2 + eta) / (6.e0 * pow(sn,3) * c * + pow(TranMerc_Scale_Factor,3)); + + t16 = (5.e0 + 6.e0 * eta + 28.e0 * tan2 - 3.e0 * eta2 + + 8.e0 * tan2 * eta + 24.e0 * tan4 - 4.e0 + * eta3 + 4.e0 * tan2 * eta2 + 24.e0 + * tan2 * eta3) / (120.e0 * pow(sn,5) * c + * pow(TranMerc_Scale_Factor,5)); + + t17 = (61.e0 + 662.e0 * tan2 + 1320.e0 * tan4 + 720.e0 + * pow(t,6)) / (5040.e0 * pow(sn,7) * c + * pow(TranMerc_Scale_Factor,7)); + + /* Difference in Longitude */ + dlam = de * t14 - pow(de,3) * t15 + pow(de,5) * t16 - pow(de,7) * t17; + + /* Longitude */ + (*Longitude) = TranMerc_Origin_Long + dlam; + + if((fabs)(*Latitude) > (90.0 * PI / 180.0)) + Error_Code |= TRANMERC_NORTHING_ERROR; + + if((*Longitude) > (PI)) + { + *Longitude -= (2 * PI); + if((fabs)(*Longitude) > PI) + Error_Code |= TRANMERC_EASTING_ERROR; + } + else if((*Longitude) < (-PI)) + { + *Longitude += (2 * PI); + if((fabs)(*Longitude) > PI) + Error_Code |= TRANMERC_EASTING_ERROR; + } + + if (fabs(dlam) > (9.0 * PI / 180) * cos(*Latitude)) + { /* Distortion will result if Longitude is more than 9 degrees from the Central Meridian at the equator */ + /* and decreases to 0 degrees at the poles */ + /* As you move towards the poles, distortion will become more significant */ + Error_Code |= TRANMERC_LON_WARNING; + } + } + return (Error_Code); +} /* END OF Convert_Transverse_Mercator_To_Geodetic */ diff --git a/external/geotranz/tranmerc.h b/external/geotranz/tranmerc.h new file mode 100644 index 00000000..5755ddd6 --- /dev/null +++ b/external/geotranz/tranmerc.h @@ -0,0 +1,209 @@ +#ifndef TRANMERC_H + #define TRANMERC_H + +/***************************************************************************/ +/* RSC IDENTIFIER: TRANSVERSE MERCATOR + * + * ABSTRACT + * + * This component provides conversions between Geodetic coordinates + * (latitude and longitude) and Transverse Mercator projection coordinates + * (easting and northing). + * + * ERROR HANDLING + * + * This component checks parameters for valid values. If an invalid value + * is found the error code is combined with the current error code using + * the bitwise or. This combining allows multiple error codes to be + * returned. The possible error codes are: + * + * TRANMERC_NO_ERROR : No errors occurred in function + * TRANMERC_LAT_ERROR : Latitude outside of valid range + * (-90 to 90 degrees) + * TRANMERC_LON_ERROR : Longitude outside of valid range + * (-180 to 360 degrees, and within + * +/-90 of Central Meridian) + * TRANMERC_EASTING_ERROR : Easting outside of valid range + * (depending on ellipsoid and + * projection parameters) + * TRANMERC_NORTHING_ERROR : Northing outside of valid range + * (depending on ellipsoid and + * projection parameters) + * TRANMERC_ORIGIN_LAT_ERROR : Origin latitude outside of valid range + * (-90 to 90 degrees) + * TRANMERC_CENT_MER_ERROR : Central meridian outside of valid range + * (-180 to 360 degrees) + * TRANMERC_A_ERROR : Semi-major axis less than or equal to zero + * TRANMERC_INV_F_ERROR : Inverse flattening outside of valid range + * (250 to 350) + * TRANMERC_SCALE_FACTOR_ERROR : Scale factor outside of valid + * range (0.3 to 3.0) + * TM_LON_WARNING : Distortion will result if longitude is more + * than 9 degrees from the Central Meridian + * + * REUSE NOTES + * + * TRANSVERSE MERCATOR is intended for reuse by any application that + * performs a Transverse Mercator projection or its inverse. + * + * REFERENCES + * + * Further information on TRANSVERSE MERCATOR can be found in the + * Reuse Manual. + * + * TRANSVERSE MERCATOR originated from : + * U.S. Army Topographic Engineering Center + * Geospatial Information Division + * 7701 Telegraph Road + * Alexandria, VA 22310-3864 + * + * LICENSES + * + * None apply to this component. + * + * RESTRICTIONS + * + * TRANSVERSE MERCATOR has no restrictions. + * + * ENVIRONMENT + * + * TRANSVERSE MERCATOR was tested and certified in the following + * environments: + * + * 1. Solaris 2.5 with GCC, version 2.8.1 + * 2. Windows 95 with MS Visual C++, version 6 + * + * MODIFICATIONS + * + * Date Description + * ---- ----------- + * 10-02-97 Original Code + * 03-02-97 Re-engineered Code + * + */ + + +/***************************************************************************/ +/* + * DEFINES + */ + + #define TRANMERC_NO_ERROR 0x0000 + #define TRANMERC_LAT_ERROR 0x0001 + #define TRANMERC_LON_ERROR 0x0002 + #define TRANMERC_EASTING_ERROR 0x0004 + #define TRANMERC_NORTHING_ERROR 0x0008 + #define TRANMERC_ORIGIN_LAT_ERROR 0x0010 + #define TRANMERC_CENT_MER_ERROR 0x0020 + #define TRANMERC_A_ERROR 0x0040 + #define TRANMERC_INV_F_ERROR 0x0080 + #define TRANMERC_SCALE_FACTOR_ERROR 0x0100 + #define TRANMERC_LON_WARNING 0x0200 + + +/***************************************************************************/ +/* + * FUNCTION PROTOTYPES + * for TRANMERC.C + */ + +/* ensure proper linkage to c++ programs */ + #ifdef __cplusplus +extern "C" { + #endif + + + long Set_Transverse_Mercator_Parameters(double a, + double f, + double Origin_Latitude, + double Central_Meridian, + double False_Easting, + double False_Northing, + double Scale_Factor); +/* + * The function Set_Tranverse_Mercator_Parameters receives the ellipsoid + * parameters and Tranverse Mercator projection parameters as inputs, and + * sets the corresponding state variables. If any errors occur, the error + * code(s) are returned by the function, otherwise TRANMERC_NO_ERROR is + * returned. + * + * a : Semi-major axis of ellipsoid, in meters (input) + * f : Flattening of ellipsoid (input) + * Origin_Latitude : Latitude in radians at the origin of the (input) + * projection + * Central_Meridian : Longitude in radians at the center of the (input) + * projection + * False_Easting : Easting/X at the center of the projection (input) + * False_Northing : Northing/Y at the center of the projection (input) + * Scale_Factor : Projection scale factor (input) + */ + + + void Get_Transverse_Mercator_Parameters(double *a, + double *f, + double *Origin_Latitude, + double *Central_Meridian, + double *False_Easting, + double *False_Northing, + double *Scale_Factor); +/* + * The function Get_Transverse_Mercator_Parameters returns the current + * ellipsoid and Transverse Mercator projection parameters. + * + * a : Semi-major axis of ellipsoid, in meters (output) + * f : Flattening of ellipsoid (output) + * Origin_Latitude : Latitude in radians at the origin of the (output) + * projection + * Central_Meridian : Longitude in radians at the center of the (output) + * projection + * False_Easting : Easting/X at the center of the projection (output) + * False_Northing : Northing/Y at the center of the projection (output) + * Scale_Factor : Projection scale factor (output) + */ + + + long Convert_Geodetic_To_Transverse_Mercator (double Latitude, + double Longitude, + double *Easting, + double *Northing); + +/* + * The function Convert_Geodetic_To_Transverse_Mercator converts geodetic + * (latitude and longitude) coordinates to Transverse Mercator projection + * (easting and northing) coordinates, according to the current ellipsoid + * and Transverse Mercator projection coordinates. If any errors occur, the + * error code(s) are returned by the function, otherwise TRANMERC_NO_ERROR is + * returned. + * + * Latitude : Latitude in radians (input) + * Longitude : Longitude in radians (input) + * Easting : Easting/X in meters (output) + * Northing : Northing/Y in meters (output) + */ + + + long Convert_Transverse_Mercator_To_Geodetic (double Easting, + double Northing, + double *Latitude, + double *Longitude); + +/* + * The function Convert_Transverse_Mercator_To_Geodetic converts Transverse + * Mercator projection (easting and northing) coordinates to geodetic + * (latitude and longitude) coordinates, according to the current ellipsoid + * and Transverse Mercator projection parameters. If any errors occur, the + * error code(s) are returned by the function, otherwise TRANMERC_NO_ERROR is + * returned. + * + * Easting : Easting/X in meters (input) + * Northing : Northing/Y in meters (input) + * Latitude : Latitude in radians (output) + * Longitude : Longitude in radians (output) + */ + + + #ifdef __cplusplus +} + #endif + +#endif /* TRANMERC_H */ diff --git a/external/geotranz/ups.c b/external/geotranz/ups.c new file mode 100644 index 00000000..f9975f2c --- /dev/null +++ b/external/geotranz/ups.c @@ -0,0 +1,302 @@ +/********************************************************************/ +/* RSC IDENTIFIER: UPS + * + * + * ABSTRACT + * + * This component provides conversions between geodetic (latitude + * and longitude) coordinates and Universal Polar Stereographic (UPS) + * projection (hemisphere, easting, and northing) coordinates. + * + * + * ERROR HANDLING + * + * This component checks parameters for valid values. If an + * invalid value is found the error code is combined with the + * current error code using the bitwise or. This combining allows + * multiple error codes to be returned. The possible error codes + * are: + * + * UPS_NO_ERROR : No errors occurred in function + * UPS_LAT_ERROR : Latitude outside of valid range + * (North Pole: 83.5 to 90, + * South Pole: -79.5 to -90) + * UPS_LON_ERROR : Longitude outside of valid range + * (-180 to 360 degrees) + * UPS_HEMISPHERE_ERROR : Invalid hemisphere ('N' or 'S') + * UPS_EASTING_ERROR : Easting outside of valid range, + * (0 to 4,000,000m) + * UPS_NORTHING_ERROR : Northing outside of valid range, + * (0 to 4,000,000m) + * UPS_A_ERROR : Semi-major axis less than or equal to zero + * UPS_INV_F_ERROR : Inverse flattening outside of valid range + * (250 to 350) + * + * + * REUSE NOTES + * + * UPS is intended for reuse by any application that performs a Universal + * Polar Stereographic (UPS) projection. + * + * + * REFERENCES + * + * Further information on UPS can be found in the Reuse Manual. + * + * UPS originated from : U.S. Army Topographic Engineering Center + * Geospatial Information Division + * 7701 Telegraph Road + * Alexandria, VA 22310-3864 + * + * + * LICENSES + * + * None apply to this component. + * + * + * RESTRICTIONS + * + * UPS has no restrictions. + * + * + * ENVIRONMENT + * + * UPS was tested and certified in the following environments: + * + * 1. Solaris 2.5 with GCC version 2.8.1 + * 2. Windows 95 with MS Visual C++ version 6 + * + * + * MODIFICATIONS + * + * Date Description + * ---- ----------- + * 06-11-95 Original Code + * 03-01-97 Original Code + * + * + */ + + +/************************************************************************/ +/* + * INCLUDES + */ + +#include +#include "polarst.h" +#include "ups.h" +/* + * math.h - Is needed to call the math functions. + * polar.h - Is used to convert polar stereographic coordinates + * ups.h - Defines the function prototypes for the ups module. + */ + + +/************************************************************************/ +/* GLOBAL DECLARATIONS + * + */ + +#define PI 3.14159265358979323e0 /* PI */ +#define PI_OVER (PI/2.0e0) /* PI over 2 */ +#define MAX_LAT ((PI * 90)/180.0) /* 90 degrees in radians */ +#define MAX_ORIGIN_LAT ((81.114528 * PI) / 180.0) +#define MIN_NORTH_LAT (83.5*PI/180.0) +#define MIN_SOUTH_LAT (-79.5*PI/180.0) +#define MIN_EAST_NORTH 0 +#define MAX_EAST_NORTH 4000000 + +/* Ellipsoid Parameters, default to WGS 84 */ +static double UPS_a = 6378137.0; /* Semi-major axis of ellipsoid in meters */ +static double UPS_f = 1 / 298.257223563; /* Flattening of ellipsoid */ +const double UPS_False_Easting = 2000000; +const double UPS_False_Northing = 2000000; +static double UPS_Origin_Latitude = MAX_ORIGIN_LAT; /*set default = North Hemisphere */ +static double UPS_Origin_Longitude = 0.0; + + +/************************************************************************/ +/* FUNCTIONS + * + */ + + +long Set_UPS_Parameters( double a, + double f) +{ +/* + * The function SET_UPS_PARAMETERS receives the ellipsoid parameters and sets + * the corresponding state variables. If any errors occur, the error code(s) + * are returned by the function, otherwise UPS_NO_ERROR is returned. + * + * a : Semi-major axis of ellipsoid in meters (input) + * f : Flattening of ellipsoid (input) + */ + + double inv_f = 1 / f; + long Error_Code = UPS_NO_ERROR; + + if (a <= 0.0) + { /* Semi-major axis must be greater than zero */ + Error_Code |= UPS_A_ERROR; + } + if ((inv_f < 250) || (inv_f > 350)) + { /* Inverse flattening must be between 250 and 350 */ + Error_Code |= UPS_INV_F_ERROR; + } + + if (!Error_Code) + { /* no errors */ + UPS_a = a; + UPS_f = f; + } + return (Error_Code); +} /* END of Set_UPS_Parameters */ + + +void Get_UPS_Parameters( double *a, + double *f) +{ +/* + * The function Get_UPS_Parameters returns the current ellipsoid parameters. + * + * a : Semi-major axis of ellipsoid, in meters (output) + * f : Flattening of ellipsoid (output) + */ + + *a = UPS_a; + *f = UPS_f; + return; +} /* END OF Get_UPS_Parameters */ + + +long Convert_Geodetic_To_UPS ( double Latitude, + double Longitude, + char *Hemisphere, + double *Easting, + double *Northing) +{ +/* + * The function Convert_Geodetic_To_UPS converts geodetic (latitude and + * longitude) coordinates to UPS (hemisphere, easting, and northing) + * coordinates, according to the current ellipsoid parameters. If any + * errors occur, the error code(s) are returned by the function, + * otherwide UPS_NO_ERROR is returned. + * + * Latitude : Latitude in radians (input) + * Longitude : Longitude in radians (input) + * Hemisphere : Hemisphere either 'N' or 'S' (output) + * Easting : Easting/X in meters (output) + * Northing : Northing/Y in meters (output) + */ + + double tempEasting, tempNorthing; + long Error_Code = UPS_NO_ERROR; + + if ((Latitude < -MAX_LAT) || (Latitude > MAX_LAT)) + { /* latitude out of range */ + Error_Code |= UPS_LAT_ERROR; + } + if ((Latitude < 0) && (Latitude > MIN_SOUTH_LAT)) + Error_Code |= UPS_LAT_ERROR; + if ((Latitude >= 0) && (Latitude < MIN_NORTH_LAT)) + Error_Code |= UPS_LAT_ERROR; + if ((Longitude < -PI) || (Longitude > (2 * PI))) + { /* slam out of range */ + Error_Code |= UPS_LON_ERROR; + } + + if (!Error_Code) + { /* no errors */ + if (Latitude < 0) + { + UPS_Origin_Latitude = -MAX_ORIGIN_LAT; + *Hemisphere = 'S'; + } + else + { + UPS_Origin_Latitude = MAX_ORIGIN_LAT; + *Hemisphere = 'N'; + } + + + Set_Polar_Stereographic_Parameters( UPS_a, + UPS_f, + UPS_Origin_Latitude, + UPS_Origin_Longitude, + UPS_False_Easting, + UPS_False_Northing); + + Convert_Geodetic_To_Polar_Stereographic(Latitude, + Longitude, + &tempEasting, + &tempNorthing); + + *Easting = tempEasting; + *Northing = tempNorthing; + } /* END of if(!Error_Code) */ + + return Error_Code; +} /* END OF Convert_Geodetic_To_UPS */ + + +long Convert_UPS_To_Geodetic(char Hemisphere, + double Easting, + double Northing, + double *Latitude, + double *Longitude) +{ +/* + * The function Convert_UPS_To_Geodetic converts UPS (hemisphere, easting, + * and northing) coordinates to geodetic (latitude and longitude) coordinates + * according to the current ellipsoid parameters. If any errors occur, the + * error code(s) are returned by the function, otherwise UPS_NO_ERROR is + * returned. + * + * Hemisphere : Hemisphere either 'N' or 'S' (input) + * Easting : Easting/X in meters (input) + * Northing : Northing/Y in meters (input) + * Latitude : Latitude in radians (output) + * Longitude : Longitude in radians (output) + */ + + long Error_Code = UPS_NO_ERROR; + + if ((Hemisphere != 'N') && (Hemisphere != 'S')) + Error_Code |= UPS_HEMISPHERE_ERROR; + if ((Easting < MIN_EAST_NORTH) || (Easting > MAX_EAST_NORTH)) + Error_Code |= UPS_EASTING_ERROR; + if ((Northing < MIN_EAST_NORTH) || (Northing > MAX_EAST_NORTH)) + Error_Code |= UPS_NORTHING_ERROR; + + if (Hemisphere =='N') + {UPS_Origin_Latitude = MAX_ORIGIN_LAT;} + if (Hemisphere =='S') + {UPS_Origin_Latitude = -MAX_ORIGIN_LAT;} + + if (!Error_Code) + { /* no errors */ + Set_Polar_Stereographic_Parameters( UPS_a, + UPS_f, + UPS_Origin_Latitude, + UPS_Origin_Longitude, + UPS_False_Easting, + UPS_False_Northing); + + + + Convert_Polar_Stereographic_To_Geodetic( Easting, + Northing, + Latitude, + Longitude); + + + if ((*Latitude < 0) && (*Latitude > MIN_SOUTH_LAT)) + Error_Code |= UPS_LAT_ERROR; + if ((*Latitude >= 0) && (*Latitude < MIN_NORTH_LAT)) + Error_Code |= UPS_LAT_ERROR; + } /* END OF if(!Error_Code) */ + return (Error_Code); +} /* END OF Convert_UPS_To_Geodetic */ + diff --git a/external/geotranz/ups.h b/external/geotranz/ups.h new file mode 100644 index 00000000..9f6c8172 --- /dev/null +++ b/external/geotranz/ups.h @@ -0,0 +1,175 @@ +#ifndef UPS_H + #define UPS_H +/********************************************************************/ +/* RSC IDENTIFIER: UPS + * + * + * ABSTRACT + * + * This component provides conversions between geodetic (latitude + * and longitude) coordinates and Universal Polar Stereographic (UPS) + * projection (hemisphere, easting, and northing) coordinates. + * + * + * ERROR HANDLING + * + * This component checks parameters for valid values. If an + * invalid value is found the error code is combined with the + * current error code using the bitwise or. This combining allows + * multiple error codes to be returned. The possible error codes + * are: + * + * UPS_NO_ERROR : No errors occurred in function + * UPS_LAT_ERROR : Latitude outside of valid range + * (North Pole: 83.5 to 90, + * South Pole: -79.5 to -90) + * UPS_LON_ERROR : Longitude outside of valid range + * (-180 to 360 degrees) + * UPS_HEMISPHERE_ERROR : Invalid hemisphere ('N' or 'S') + * UPS_EASTING_ERROR : Easting outside of valid range, + * (0 to 4,000,000m) + * UPS_NORTHING_ERROR : Northing outside of valid range, + * (0 to 4,000,000m) + * UPS_A_ERROR : Semi-major axis less than or equal to zero + * UPS_INV_F_ERROR : Inverse flattening outside of valid range + * (250 to 350) + * + * + * REUSE NOTES + * + * UPS is intended for reuse by any application that performs a Universal + * Polar Stereographic (UPS) projection. + * + * + * REFERENCES + * + * Further information on UPS can be found in the Reuse Manual. + * + * UPS originated from : U.S. Army Topographic Engineering Center + * Geospatial Information Division + * 7701 Telegraph Road + * Alexandria, VA 22310-3864 + * + * + * LICENSES + * + * None apply to this component. + * + * + * RESTRICTIONS + * + * UPS has no restrictions. + * + * + * ENVIRONMENT + * + * UPS was tested and certified in the following environments: + * + * 1. Solaris 2.5 with GCC version 2.8.1 + * 2. Windows 95 with MS Visual C++ version 6 + * + * + * MODIFICATIONS + * + * Date Description + * ---- ----------- + * 06-11-95 Original Code + * 03-01-97 Original Code + * + * + */ + + +/**********************************************************************/ +/* + * DEFINES + */ + + #define UPS_NO_ERROR 0x0000 + #define UPS_LAT_ERROR 0x0001 + #define UPS_LON_ERROR 0x0002 + #define UPS_HEMISPHERE_ERROR 0x0004 + #define UPS_EASTING_ERROR 0x0008 + #define UPS_NORTHING_ERROR 0x0010 + #define UPS_A_ERROR 0x0020 + #define UPS_INV_F_ERROR 0x0040 + + +/**********************************************************************/ +/* + * FUNCTION PROTOTYPES + * for UPS.C + */ + +/* ensure proper linkage to c++ programs */ + #ifdef __cplusplus +extern "C" { + #endif + + long Set_UPS_Parameters( double a, + double f); +/* + * The function SET_UPS_PARAMETERS receives the ellipsoid parameters and sets + * the corresponding state variables. If any errors occur, the error code(s) + * are returned by the function, otherwise UPS_NO_ERROR is returned. + * + * a : Semi-major axis of ellipsoid in meters (input) + * f : Flattening of ellipsoid (input) + */ + + + void Get_UPS_Parameters( double *a, + double *f); +/* + * The function Get_UPS_Parameters returns the current ellipsoid parameters. + * + * a : Semi-major axis of ellipsoid, in meters (output) + * f : Flattening of ellipsoid (output) + */ + + + long Convert_Geodetic_To_UPS ( double Latitude, + double Longitude, + char *Hemisphere, + double *Easting, + double *Northing); +/* + * The function Convert_Geodetic_To_UPS converts geodetic (latitude and + * longitude) coordinates to UPS (hemisphere, easting, and northing) + * coordinates, according to the current ellipsoid parameters. If any + * errors occur, the error code(s) are returned by the function, + * otherwide UPS_NO_ERROR is returned. + * + * Latitude : Latitude in radians (input) + * Longitude : Longitude in radians (input) + * Hemisphere : Hemisphere either 'N' or 'S' (output) + * Easting : Easting/X in meters (output) + * Northing : Northing/Y in meters (output) + */ + + + long Convert_UPS_To_Geodetic(char Hemisphere, + double Easting, + double Northing, + double *Latitude, + double *Longitude); + +/* + * The function Convert_UPS_To_Geodetic converts UPS (hemisphere, easting, + * and northing) coordinates to geodetic (latitude and longitude) coordinates + * according to the current ellipsoid parameters. If any errors occur, the + * error code(s) are returned by the function, otherwise UPS_NO_ERROR is + * returned. + * + * Hemisphere : Hemisphere either 'N' or 'S' (input) + * Easting : Easting/X in meters (input) + * Northing : Northing/Y in meters (input) + * Latitude : Latitude in radians (output) + * Longitude : Longitude in radians (output) + */ + + #ifdef __cplusplus +} + #endif + +#endif /* UPS_H */ diff --git a/external/geotranz/usng.c b/external/geotranz/usng.c new file mode 100644 index 00000000..fdd2fba7 --- /dev/null +++ b/external/geotranz/usng.c @@ -0,0 +1,1262 @@ +/***************************************************************************/ +/* RSC IDENTIFIER: USNG + * + * ABSTRACT + * + * This component converts between geodetic coordinates (latitude and + * longitude) and United States National Grid (USNG) coordinates. + * + * ERROR HANDLING + * + * This component checks parameters for valid values. If an invalid value + * is found, the error code is combined with the current error code using + * the bitwise or. This combining allows multiple error codes to be + * returned. The possible error codes are: + * + * USNG_NO_ERROR : No errors occurred in function + * USNG_LAT_ERROR : Latitude outside of valid range + * (-90 to 90 degrees) + * USNG_LON_ERROR : Longitude outside of valid range + * (-180 to 360 degrees) + * USNG_STR_ERROR : An USNG string error: string too long, + * too short, or badly formed + * USNG_PRECISION_ERROR : The precision must be between 0 and 5 + * inclusive. + * USNG_A_ERROR : Semi-major axis less than or equal to zero + * USNG_INV_F_ERROR : Inverse flattening outside of valid range + * (250 to 350) + * USNG_EASTING_ERROR : Easting outside of valid range + * (100,000 to 900,000 meters for UTM) + * (0 to 4,000,000 meters for UPS) + * USNG_NORTHING_ERROR : Northing outside of valid range + * (0 to 10,000,000 meters for UTM) + * (0 to 4,000,000 meters for UPS) + * USNG_ZONE_ERROR : Zone outside of valid range (1 to 60) + * USNG_HEMISPHERE_ERROR : Invalid hemisphere ('N' or 'S') + * + * REUSE NOTES + * + * USNG is intended for reuse by any application that does conversions + * between geodetic coordinates and USNG coordinates. + * + * REFERENCES + * + * Further information on USNG can be found in the Reuse Manual. + * + * USNG originated from : Federal Geographic Data Committee + * 590 National Center + * 12201 Sunrise Valley Drive + * Reston, VA 22092 + * + * LICENSES + * + * None apply to this component. + * + * RESTRICTIONS + * + * + * ENVIRONMENT + * + * USNG was tested and certified in the following environments: + * + * 1. Solaris 2.5 with GCC version 2.8.1 + * 2. Windows XP with MS Visual C++ version 6 + * + * MODIFICATIONS + * + * Date Description + * ---- ----------- + * 06-05-06 Original Code (cloned from MGRS) + */ + + +/***************************************************************************/ +/* + * INCLUDES + */ +#include +#include +#include +#include +#include "ups.h" +#include "utm.h" +#include "usng.h" + +/* + * ctype.h - Standard C character handling library + * math.h - Standard C math library + * stdio.h - Standard C input/output library + * string.h - Standard C string handling library + * ups.h - Universal Polar Stereographic (UPS) projection + * utm.h - Universal Transverse Mercator (UTM) projection + * usng.h - function prototype error checking + */ + + +/***************************************************************************/ +/* + * GLOBAL DECLARATIONS + */ +#define DEG_TO_RAD 0.017453292519943295 /* PI/180 */ +#define RAD_TO_DEG 57.29577951308232087 /* 180/PI */ +#define LETTER_A 0 /* ARRAY INDEX FOR LETTER A */ +#define LETTER_B 1 /* ARRAY INDEX FOR LETTER B */ +#define LETTER_C 2 /* ARRAY INDEX FOR LETTER C */ +#define LETTER_D 3 /* ARRAY INDEX FOR LETTER D */ +#define LETTER_E 4 /* ARRAY INDEX FOR LETTER E */ +#define LETTER_F 5 /* ARRAY INDEX FOR LETTER F */ +#define LETTER_G 6 /* ARRAY INDEX FOR LETTER G */ +#define LETTER_H 7 /* ARRAY INDEX FOR LETTER H */ +#define LETTER_I 8 /* ARRAY INDEX FOR LETTER I */ +#define LETTER_J 9 /* ARRAY INDEX FOR LETTER J */ +#define LETTER_K 10 /* ARRAY INDEX FOR LETTER K */ +#define LETTER_L 11 /* ARRAY INDEX FOR LETTER L */ +#define LETTER_M 12 /* ARRAY INDEX FOR LETTER M */ +#define LETTER_N 13 /* ARRAY INDEX FOR LETTER N */ +#define LETTER_O 14 /* ARRAY INDEX FOR LETTER O */ +#define LETTER_P 15 /* ARRAY INDEX FOR LETTER P */ +#define LETTER_Q 16 /* ARRAY INDEX FOR LETTER Q */ +#define LETTER_R 17 /* ARRAY INDEX FOR LETTER R */ +#define LETTER_S 18 /* ARRAY INDEX FOR LETTER S */ +#define LETTER_T 19 /* ARRAY INDEX FOR LETTER T */ +#define LETTER_U 20 /* ARRAY INDEX FOR LETTER U */ +#define LETTER_V 21 /* ARRAY INDEX FOR LETTER V */ +#define LETTER_W 22 /* ARRAY INDEX FOR LETTER W */ +#define LETTER_X 23 /* ARRAY INDEX FOR LETTER X */ +#define LETTER_Y 24 /* ARRAY INDEX FOR LETTER Y */ +#define LETTER_Z 25 /* ARRAY INDEX FOR LETTER Z */ +#define USNG_LETTERS 3 /* NUMBER OF LETTERS IN USNG */ +#define ONEHT 100000.e0 /* ONE HUNDRED THOUSAND */ +#define TWOMIL 2000000.e0 /* TWO MILLION */ +#define TRUE 1 /* CONSTANT VALUE FOR TRUE VALUE */ +#define FALSE 0 /* CONSTANT VALUE FOR FALSE VALUE */ +#define PI 3.14159265358979323e0 /* PI */ +#define PI_OVER_2 (PI / 2.0e0) + +#define MIN_EASTING 100000 +#define MAX_EASTING 900000 +#define MIN_NORTHING 0 +#define MAX_NORTHING 10000000 +#define MAX_PRECISION 5 /* Maximum precision of easting & northing */ +#define MIN_UTM_LAT ( (-80 * PI) / 180.0 ) /* -80 degrees in radians */ +#define MAX_UTM_LAT ( (84 * PI) / 180.0 ) /* 84 degrees in radians */ + +#define MIN_EAST_NORTH 0 +#define MAX_EAST_NORTH 4000000 + + +/* Ellipsoid parameters, default to WGS 84 */ +double USNG_a = 6378137.0; /* Semi-major axis of ellipsoid in meters */ +double USNG_f = 1 / 298.257223563; /* Flattening of ellipsoid */ +double USNG_recpf = 298.257223563; +char USNG_Ellipsoid_Code[3] = {'W','E',0}; + + +typedef struct Latitude_Band_Value +{ + long letter; /* letter representing latitude band */ + double min_northing; /* minimum northing for latitude band */ + double north; /* upper latitude for latitude band */ + double south; /* lower latitude for latitude band */ + double northing_offset; /* latitude band northing offset */ +} Latitude_Band; + +static const Latitude_Band Latitude_Band_Table[20] = + {{LETTER_C, 1100000.0, -72.0, -80.5, 0.0}, + {LETTER_D, 2000000.0, -64.0, -72.0, 2000000.0}, + {LETTER_E, 2800000.0, -56.0, -64.0, 2000000.0}, + {LETTER_F, 3700000.0, -48.0, -56.0, 2000000.0}, + {LETTER_G, 4600000.0, -40.0, -48.0, 4000000.0}, + {LETTER_H, 5500000.0, -32.0, -40.0, 4000000.0}, + {LETTER_J, 6400000.0, -24.0, -32.0, 6000000.0}, + {LETTER_K, 7300000.0, -16.0, -24.0, 6000000.0}, + {LETTER_L, 8200000.0, -8.0, -16.0, 8000000.0}, + {LETTER_M, 9100000.0, 0.0, -8.0, 8000000.0}, + {LETTER_N, 0.0, 8.0, 0.0, 0.0}, + {LETTER_P, 800000.0, 16.0, 8.0, 0.0}, + {LETTER_Q, 1700000.0, 24.0, 16.0, 0.0}, + {LETTER_R, 2600000.0, 32.0, 24.0, 2000000.0}, + {LETTER_S, 3500000.0, 40.0, 32.0, 2000000.0}, + {LETTER_T, 4400000.0, 48.0, 40.0, 4000000.0}, + {LETTER_U, 5300000.0, 56.0, 48.0, 4000000.0}, + {LETTER_V, 6200000.0, 64.0, 56.0, 6000000.0}, + {LETTER_W, 7000000.0, 72.0, 64.0, 6000000.0}, + {LETTER_X, 7900000.0, 84.5, 72.0, 6000000.0}}; + + +typedef struct UPS_Constant_Value +{ + long letter; /* letter representing latitude band */ + long ltr2_low_value; /* 2nd letter range - low number */ + long ltr2_high_value; /* 2nd letter range - high number */ + long ltr3_high_value; /* 3rd letter range - high number (UPS) */ + double false_easting; /* False easting based on 2nd letter */ + double false_northing; /* False northing based on 3rd letter */ +} UPS_Constant; + +static const UPS_Constant UPS_Constant_Table[4] = + {{LETTER_A, LETTER_J, LETTER_Z, LETTER_Z, 800000.0, 800000.0}, + {LETTER_B, LETTER_A, LETTER_R, LETTER_Z, 2000000.0, 800000.0}, + {LETTER_Y, LETTER_J, LETTER_Z, LETTER_P, 800000.0, 1300000.0}, + {LETTER_Z, LETTER_A, LETTER_J, LETTER_P, 2000000.0, 1300000.0}}; + +/***************************************************************************/ +/* + * FUNCTIONS + */ + +long USNG_Get_Latitude_Band_Min_Northing(long letter, double* min_northing, double* northing_offset) +/* + * The function USNG_Get_Latitude_Band_Min_Northing receives a latitude band letter + * and uses the Latitude_Band_Table to determine the minimum northing and northing offset + * for that latitude band letter. + * + * letter : Latitude band letter (input) + * min_northing : Minimum northing for that letter (output) + */ +{ /* USNG_Get_Latitude_Band_Min_Northing */ + long error_code = USNG_NO_ERROR; + + if ((letter >= LETTER_C) && (letter <= LETTER_H)) + { + *min_northing = Latitude_Band_Table[letter-2].min_northing; + *northing_offset = Latitude_Band_Table[letter-2].northing_offset; + } + else if ((letter >= LETTER_J) && (letter <= LETTER_N)) + { + *min_northing = Latitude_Band_Table[letter-3].min_northing; + *northing_offset = Latitude_Band_Table[letter-3].northing_offset; + } + else if ((letter >= LETTER_P) && (letter <= LETTER_X)) + { + *min_northing = Latitude_Band_Table[letter-4].min_northing; + *northing_offset = Latitude_Band_Table[letter-4].northing_offset; + } + else + error_code |= USNG_STRING_ERROR; + + return error_code; +} /* USNG_Get_Latitude_Band_Min_Northing */ + + +long USNG_Get_Latitude_Range(long letter, double* north, double* south) +/* + * The function USNG_Get_Latitude_Range receives a latitude band letter + * and uses the Latitude_Band_Table to determine the latitude band + * boundaries for that latitude band letter. + * + * letter : Latitude band letter (input) + * north : Northern latitude boundary for that letter (output) + * north : Southern latitude boundary for that letter (output) + */ +{ /* USNG_Get_Latitude_Range */ + long error_code = USNG_NO_ERROR; + + if ((letter >= LETTER_C) && (letter <= LETTER_H)) + { + *north = Latitude_Band_Table[letter-2].north * DEG_TO_RAD; + *south = Latitude_Band_Table[letter-2].south * DEG_TO_RAD; + } + else if ((letter >= LETTER_J) && (letter <= LETTER_N)) + { + *north = Latitude_Band_Table[letter-3].north * DEG_TO_RAD; + *south = Latitude_Band_Table[letter-3].south * DEG_TO_RAD; + } + else if ((letter >= LETTER_P) && (letter <= LETTER_X)) + { + *north = Latitude_Band_Table[letter-4].north * DEG_TO_RAD; + *south = Latitude_Band_Table[letter-4].south * DEG_TO_RAD; + } + else + error_code |= USNG_STRING_ERROR; + + return error_code; +} /* USNG_Get_Latitude_Range */ + + +long USNG_Get_Latitude_Letter(double latitude, int* letter) +/* + * The function USNG_Get_Latitude_Letter receives a latitude value + * and uses the Latitude_Band_Table to determine the latitude band + * letter for that latitude. + * + * latitude : Latitude (input) + * letter : Latitude band letter (output) + */ +{ /* USNG_Get_Latitude_Letter */ + double temp = 0.0; + long error_code = USNG_NO_ERROR; + double lat_deg = latitude * RAD_TO_DEG; + + if (lat_deg >= 72 && lat_deg < 84.5) + *letter = LETTER_X; + else if (lat_deg > -80.5 && lat_deg < 72) + { + temp = ((latitude + (80.0 * DEG_TO_RAD)) / (8.0 * DEG_TO_RAD)) + 1.0e-12; + *letter = Latitude_Band_Table[(int)temp].letter; + } + else + error_code |= USNG_LAT_ERROR; + + return error_code; +} /* USNG_Get_Latitude_Letter */ + + +long USNG_Check_Zone(char* USNG, long* zone_exists) +/* + * The function USNG_Check_Zone receives a USNG coordinate string. + * If a zone is given, TRUE is returned. Otherwise, FALSE + * is returned. + * + * USNG : USNG coordinate string (input) + * zone_exists : TRUE if a zone is given, + * FALSE if a zone is not given (output) + */ +{ /* USNG_Check_Zone */ + int i = 0; + int j = 0; + int num_digits = 0; + long error_code = USNG_NO_ERROR; + + /* skip any leading blanks */ + while (USNG[i] == ' ') + i++; + j = i; + while (isdigit(USNG[i])) + i++; + num_digits = i - j; + if (num_digits <= 2) + if (num_digits > 0) + *zone_exists = TRUE; + else + *zone_exists = FALSE; + else + error_code |= USNG_STRING_ERROR; + + return error_code; +} /* USNG_Check_Zone */ + + +long Make_USNG_String (char* USNG, + long Zone, + int Letters[USNG_LETTERS], + double Easting, + double Northing, + long Precision) +/* + * The function Make_USNG_String constructs a USNG string + * from its component parts. + * + * USNG : USNG coordinate string (output) + * Zone : UTM Zone (input) + * Letters : USNG coordinate string letters (input) + * Easting : Easting value (input) + * Northing : Northing value (input) + * Precision : Precision level of USNG string (input) + */ +{ /* Make_USNG_String */ + long i; + long j; + double divisor; + long east; + long north; + char alphabet[] = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"; + long error_code = USNG_NO_ERROR; + + i = 0; + if (Zone) + i = sprintf (USNG+i,"%2.2ld",Zone); + else + strcpy(USNG, " "); // 2 spaces - Should i be set to 2? + + for (j=0;j<3;j++) + USNG[i++] = alphabet[Letters[j]]; + divisor = pow (10.0, (5 - Precision)); + Easting = fmod (Easting, 100000.0); + if (Easting >= 99999.5) + Easting = 99999.0; + east = (long)(Easting/divisor); + i += sprintf (USNG+i, "%*.*ld", (int)Precision, (int)Precision, east); + Northing = fmod (Northing, 100000.0); + if (Northing >= 99999.5) + Northing = 99999.0; + north = (long)(Northing/divisor); + i += sprintf (USNG+i, "%*.*ld", (int)Precision, (int)Precision, north); + return (error_code); +} /* Make_USNG_String */ + + +long Break_USNG_String (char* USNG, + long* Zone, + long Letters[USNG_LETTERS], + double* Easting, + double* Northing, + long* Precision) +/* + * The function Break_USNG_String breaks down a USNG + * coordinate string into its component parts. + * + * USNG : USNG coordinate string (input) + * Zone : UTM Zone (output) + * Letters : USNG coordinate string letters (output) + * Easting : Easting value (output) + * Northing : Northing value (output) + * Precision : Precision level of USNG string (output) + */ +{ /* Break_USNG_String */ + long num_digits; + long num_letters; + long i = 0; + long j = 0; + long error_code = USNG_NO_ERROR; + + while (USNG[i] == ' ') + i++; /* skip any leading blanks */ + j = i; + while (isdigit(USNG[i])) + i++; + num_digits = i - j; + if (num_digits <= 2) + if (num_digits > 0) + { + char zone_string[3]; + /* get zone */ + strncpy (zone_string, USNG+j, 2); + zone_string[2] = 0; + sscanf (zone_string, "%ld", Zone); + if ((*Zone < 1) || (*Zone > 60)) + error_code |= USNG_STRING_ERROR; + } + else + *Zone = 0; + else + error_code |= USNG_STRING_ERROR; + j = i; + + while (isalpha(USNG[i])) + i++; + num_letters = i - j; + if (num_letters == 3) + { + /* get letters */ + Letters[0] = (toupper(USNG[j]) - (long)'A'); + if ((Letters[0] == LETTER_I) || (Letters[0] == LETTER_O)) + error_code |= USNG_STRING_ERROR; + Letters[1] = (toupper(USNG[j+1]) - (long)'A'); + if ((Letters[1] == LETTER_I) || (Letters[1] == LETTER_O)) + error_code |= USNG_STRING_ERROR; + Letters[2] = (toupper(USNG[j+2]) - (long)'A'); + if ((Letters[2] == LETTER_I) || (Letters[2] == LETTER_O)) + error_code |= USNG_STRING_ERROR; + } + else + error_code |= USNG_STRING_ERROR; + j = i; + while (isdigit(USNG[i])) + i++; + num_digits = i - j; + if ((num_digits <= 10) && (num_digits%2 == 0)) + { + long n; + char east_string[6]; + char north_string[6]; + long east; + long north; + double multiplier; + /* get easting & northing */ + n = num_digits/2; + *Precision = n; + if (n > 0) + { + strncpy (east_string, USNG+j, n); + east_string[n] = 0; + sscanf (east_string, "%ld", &east); + strncpy (north_string, USNG+j+n, n); + north_string[n] = 0; + sscanf (north_string, "%ld", &north); + multiplier = pow (10.0, 5 - n); + *Easting = east * multiplier; + *Northing = north * multiplier; + } + else + { + *Easting = 0.0; + *Northing = 0.0; + } + } + else + error_code |= USNG_STRING_ERROR; + + return (error_code); +} /* Break_USNG_String */ + + +void USNG_Get_Grid_Values (long zone, + long* ltr2_low_value, + long* ltr2_high_value, + double *pattern_offset) +/* + * The function USNG_Get_Grid_Values sets the letter range used for + * the 2nd letter in the USNG coordinate string, based on the set + * number of the utm zone. It also sets the pattern offset using a + * value of A for the second letter of the grid square, based on + * the grid pattern and set number of the utm zone. + * + * zone : Zone number (input) + * ltr2_low_value : 2nd letter low number (output) + * ltr2_high_value : 2nd letter high number (output) + * pattern_offset : Pattern offset (output) + */ +{ /* BEGIN USNG_Get_Grid_Values */ + long set_number; /* Set number (1-6) based on UTM zone number */ + + set_number = zone % 6; + + if (!set_number) + set_number = 6; + + if ((set_number == 1) || (set_number == 4)) + { + *ltr2_low_value = LETTER_A; + *ltr2_high_value = LETTER_H; + } + else if ((set_number == 2) || (set_number == 5)) + { + *ltr2_low_value = LETTER_J; + *ltr2_high_value = LETTER_R; + } + else if ((set_number == 3) || (set_number == 6)) + { + *ltr2_low_value = LETTER_S; + *ltr2_high_value = LETTER_Z; + } + + /* False northing at A for second letter of grid square */ + if ((set_number % 2) == 0) + *pattern_offset = 500000.0; + else + *pattern_offset = 0.0; + +} /* END OF USNG_Get_Grid_Values */ + + +long UTM_To_USNG (long Zone, + double Latitude, + double Easting, + double Northing, + long Precision, + char *USNG) +/* + * The function UTM_To_USNG calculates a USNG coordinate string + * based on the zone, latitude, easting and northing. + * + * Zone : Zone number (input) + * Latitude : Latitude in radians (input) + * Easting : Easting (input) + * Northing : Northing (input) + * Precision : Precision (input) + * USNG : USNG coordinate string (output) + */ +{ /* BEGIN UTM_To_USNG */ + double pattern_offset; /* Pattern offset for 3rd letter */ + double grid_northing; /* Northing used to derive 3rd letter of USNG */ + long ltr2_low_value; /* 2nd letter range - low number */ + long ltr2_high_value; /* 2nd letter range - high number */ + int letters[USNG_LETTERS]; /* Number location of 3 letters in alphabet */ + double divisor; + long error_code = USNG_NO_ERROR; + + /* Round easting and northing values */ + divisor = pow (10.0, (5 - Precision)); + Easting = (long)(Easting/divisor) * divisor; + Northing = (long)(Northing/divisor) * divisor; + + if( Latitude <= 0.0 && Northing == 1.0e7) + { + Latitude = 0.0; + Northing = 0.0; + } + + ltr2_low_value = LETTER_A; // Make compiler shut up about possibly uninitialized value. + // It should be set by the following but compiler doesn't know. + + USNG_Get_Grid_Values(Zone, <r2_low_value, <r2_high_value, &pattern_offset); + + error_code = USNG_Get_Latitude_Letter(Latitude, &letters[0]); + + if (!error_code) + { + grid_northing = Northing; + + while (grid_northing >= TWOMIL) + { + grid_northing = grid_northing - TWOMIL; + } + grid_northing = grid_northing + pattern_offset; + if(grid_northing >= TWOMIL) + grid_northing = grid_northing - TWOMIL; + + letters[2] = (long)(grid_northing / ONEHT); + if (letters[2] > LETTER_H) + letters[2] = letters[2] + 1; + + if (letters[2] > LETTER_N) + letters[2] = letters[2] + 1; + + letters[1] = ltr2_low_value + ((long)(Easting / ONEHT) -1); + if ((ltr2_low_value == LETTER_J) && (letters[1] > LETTER_N)) + letters[1] = letters[1] + 1; + + Make_USNG_String (USNG, Zone, letters, Easting, Northing, Precision); + } + return error_code; +} /* END UTM_To_USNG */ + + +long Set_USNG_Parameters (double a, + double f, + char *Ellipsoid_Code) +/* + * The function SET_USNG_PARAMETERS receives the ellipsoid parameters and sets + * the corresponding state variables. If any errors occur, the error code(s) + * are returned by the function, otherwise USNG_NO_ERROR is returned. + * + * a : Semi-major axis of ellipsoid in meters (input) + * f : Flattening of ellipsoid (input) + * Ellipsoid_Code : 2-letter code for ellipsoid (input) + */ +{ /* Set_USNG_Parameters */ + + double inv_f = 1 / f; + long Error_Code = USNG_NO_ERROR; + + if (a <= 0.0) + { /* Semi-major axis must be greater than zero */ + Error_Code |= USNG_A_ERROR; + } + if ((inv_f < 250) || (inv_f > 350)) + { /* Inverse flattening must be between 250 and 350 */ + Error_Code |= USNG_INV_F_ERROR; + } + if (!Error_Code) + { /* no errors */ + USNG_a = a; + USNG_f = f; + USNG_recpf = inv_f; + strcpy (USNG_Ellipsoid_Code, Ellipsoid_Code); + } + return (Error_Code); +} /* Set_USNG_Parameters */ + + +void Get_USNG_Parameters (double *a, + double *f, + char* Ellipsoid_Code) +/* + * The function Get_USNG_Parameters returns the current ellipsoid + * parameters. + * + * a : Semi-major axis of ellipsoid, in meters (output) + * f : Flattening of ellipsoid (output) + * Ellipsoid_Code : 2-letter code for ellipsoid (output) + */ +{ /* Get_USNG_Parameters */ + *a = USNG_a; + *f = USNG_f; + strcpy (Ellipsoid_Code, USNG_Ellipsoid_Code); + return; +} /* Get_USNG_Parameters */ + + +long Convert_Geodetic_To_USNG (double Latitude, + double Longitude, + long Precision, + char* USNG) +/* + * The function Convert_Geodetic_To_USNG converts Geodetic (latitude and + * longitude) coordinates to a USNG coordinate string, according to the + * current ellipsoid parameters. If any errors occur, the error code(s) + * are returned by the function, otherwise USNG_NO_ERROR is returned. + * + * Latitude : Latitude in radians (input) + * Longitude : Longitude in radians (input) + * Precision : Precision level of USNG string (input) + * USNG : USNG coordinate string (output) + * + */ +{ /* Convert_Geodetic_To_USNG */ + long zone; + char hemisphere; + double easting; + double northing; + long temp_error_code = USNG_NO_ERROR; + long error_code = USNG_NO_ERROR; + + if ((Latitude < -PI_OVER_2) || (Latitude > PI_OVER_2)) + { /* Latitude out of range */ + error_code |= USNG_LAT_ERROR; + } + if ((Longitude < -PI) || (Longitude > (2*PI))) + { /* Longitude out of range */ + error_code |= USNG_LON_ERROR; + } + if ((Precision < 0) || (Precision > MAX_PRECISION)) + error_code |= USNG_PRECISION_ERROR; + if (!error_code) + { + if ((Latitude < MIN_UTM_LAT) || (Latitude > MAX_UTM_LAT)) + { + temp_error_code = Set_UPS_Parameters (USNG_a, USNG_f); + if(!temp_error_code) + { + temp_error_code |= Convert_Geodetic_To_UPS (Latitude, Longitude, &hemisphere, &easting, &northing); + if(!temp_error_code) + error_code |= Convert_UPS_To_USNG (hemisphere, easting, northing, Precision, USNG); + else + { + if(temp_error_code & UPS_LAT_ERROR) + error_code |= USNG_LAT_ERROR; + if(temp_error_code & UPS_LON_ERROR) + error_code |= USNG_LON_ERROR; + } + } + else + { + if(temp_error_code & UPS_A_ERROR) + error_code |= USNG_A_ERROR; + if(temp_error_code & UPS_INV_F_ERROR) + error_code |= USNG_INV_F_ERROR; + } + } + else + { + temp_error_code = Set_UTM_Parameters (USNG_a, USNG_f, 0); + if(!temp_error_code) + { + temp_error_code |= Convert_Geodetic_To_UTM (Latitude, Longitude, &zone, &hemisphere, &easting, &northing); + if(!temp_error_code) + error_code |= UTM_To_USNG (zone, Latitude, easting, northing, Precision, USNG); + else + { + if(temp_error_code & UTM_LAT_ERROR) + error_code |= USNG_LAT_ERROR; + if(temp_error_code & UTM_LON_ERROR) + error_code |= USNG_LON_ERROR; + if(temp_error_code & UTM_ZONE_OVERRIDE_ERROR) + error_code |= USNG_ZONE_ERROR; + if(temp_error_code & UTM_EASTING_ERROR) + error_code |= USNG_EASTING_ERROR; + if(temp_error_code & UTM_NORTHING_ERROR) + error_code |= USNG_NORTHING_ERROR; + } + } + else + { + if(temp_error_code & UTM_A_ERROR) + error_code |= USNG_A_ERROR; + if(temp_error_code & UTM_INV_F_ERROR) + error_code |= USNG_INV_F_ERROR; + if(temp_error_code & UTM_ZONE_OVERRIDE_ERROR) + error_code |= USNG_ZONE_ERROR; + } + } + } + return (error_code); +} /* Convert_Geodetic_To_USNG */ + + +long Convert_USNG_To_Geodetic (char* USNG, + double *Latitude, + double *Longitude) +/* + * The function Convert_USNG_To_Geodetic converts a USNG coordinate string + * to Geodetic (latitude and longitude) coordinates + * according to the current ellipsoid parameters. If any errors occur, + * the error code(s) are returned by the function, otherwise UTM_NO_ERROR + * is returned. + * + * USNG : USNG coordinate string (input) + * Latitude : Latitude in radians (output) + * Longitude : Longitude in radians (output) + * + */ +{ /* Convert_USNG_To_Geodetic */ + long zone; + char hemisphere = '?'; + double easting; + double northing; + long zone_exists; + long temp_error_code = USNG_NO_ERROR; + long error_code = USNG_NO_ERROR; + + error_code = USNG_Check_Zone(USNG, &zone_exists); + if (!error_code) + { + if (zone_exists) + { + error_code |= Convert_USNG_To_UTM (USNG, &zone, &hemisphere, &easting, &northing); + if(!error_code || (error_code & USNG_LAT_WARNING)) + { + temp_error_code = Set_UTM_Parameters (USNG_a, USNG_f, 0); + if(!temp_error_code) + { + temp_error_code |= Convert_UTM_To_Geodetic (zone, hemisphere, easting, northing, Latitude, Longitude); + if(temp_error_code) + { + if((temp_error_code & UTM_ZONE_ERROR) || (temp_error_code & UTM_HEMISPHERE_ERROR)) + error_code |= USNG_STRING_ERROR; + if(temp_error_code & UTM_EASTING_ERROR) + error_code |= USNG_EASTING_ERROR; + if(temp_error_code & UTM_NORTHING_ERROR) + error_code |= USNG_NORTHING_ERROR; + } + } + else + { + if(temp_error_code & UTM_A_ERROR) + error_code |= USNG_A_ERROR; + if(temp_error_code & UTM_INV_F_ERROR) + error_code |= USNG_INV_F_ERROR; + if(temp_error_code & UTM_ZONE_OVERRIDE_ERROR) + error_code |= USNG_ZONE_ERROR; + } + } + } + else + { + error_code |= Convert_USNG_To_UPS (USNG, &hemisphere, &easting, &northing); + if(!error_code) + { + temp_error_code = Set_UPS_Parameters (USNG_a, USNG_f); + if(!temp_error_code) + { + temp_error_code |= Convert_UPS_To_Geodetic (hemisphere, easting, northing, Latitude, Longitude); + if(temp_error_code) + { + if(temp_error_code & UPS_HEMISPHERE_ERROR) + error_code |= USNG_STRING_ERROR; + if(temp_error_code & UPS_EASTING_ERROR) + error_code |= USNG_EASTING_ERROR; + if(temp_error_code & UPS_LAT_ERROR) + error_code |= USNG_NORTHING_ERROR; + } + } + else + { + if(temp_error_code & UPS_A_ERROR) + error_code |= USNG_A_ERROR; + if(temp_error_code & UPS_INV_F_ERROR) + error_code |= USNG_INV_F_ERROR; + } + } + } + } + return (error_code); +} /* END OF Convert_USNG_To_Geodetic */ + + +long Convert_UTM_To_USNG (long Zone, + char Hemisphere, + double Easting, + double Northing, + long Precision, + char* USNG) +/* + * The function Convert_UTM_To_USNG converts UTM (zone, easting, and + * northing) coordinates to a USNG coordinate string, according to the + * current ellipsoid parameters. If any errors occur, the error code(s) + * are returned by the function, otherwise USNG_NO_ERROR is returned. + * + * Zone : UTM zone (input) + * Hemisphere : North or South hemisphere (input) + * Easting : Easting (X) in meters (input) + * Northing : Northing (Y) in meters (input) + * Precision : Precision level of USNG string (input) + * USNG : USNG coordinate string (output) + */ +{ /* Convert_UTM_To_USNG */ + double latitude; /* Latitude of UTM point */ + double longitude; /* Longitude of UTM point */ + long utm_error_code = USNG_NO_ERROR; + long error_code = USNG_NO_ERROR; + + if ((Zone < 1) || (Zone > 60)) + error_code |= USNG_ZONE_ERROR; + if ((Hemisphere != 'S') && (Hemisphere != 'N')) + error_code |= USNG_HEMISPHERE_ERROR; + if ((Easting < MIN_EASTING) || (Easting > MAX_EASTING)) + error_code |= USNG_EASTING_ERROR; + if ((Northing < MIN_NORTHING) || (Northing > MAX_NORTHING)) + error_code |= USNG_NORTHING_ERROR; + if ((Precision < 0) || (Precision > MAX_PRECISION)) + error_code |= USNG_PRECISION_ERROR; + if (!error_code) + { + Set_UTM_Parameters (USNG_a, USNG_f, 0); + utm_error_code = Convert_UTM_To_Geodetic (Zone, Hemisphere, Easting, Northing, &latitude, &longitude); + + if(utm_error_code) + { + if((utm_error_code & UTM_ZONE_ERROR) || (utm_error_code & UTM_HEMISPHERE_ERROR)) + error_code |= USNG_STRING_ERROR; + if(utm_error_code & UTM_EASTING_ERROR) + error_code |= USNG_EASTING_ERROR; + if(utm_error_code & UTM_NORTHING_ERROR) + error_code |= USNG_NORTHING_ERROR; + } + + error_code |= UTM_To_USNG (Zone, latitude, Easting, Northing, Precision, USNG); + } + return (error_code); +} /* Convert_UTM_To_USNG */ + + +long Convert_USNG_To_UTM (char *USNG, + long *Zone, + char *Hemisphere, + double *Easting, + double *Northing) +/* + * The function Convert_USNG_To_UTM converts a USNG coordinate string + * to UTM projection (zone, hemisphere, easting and northing) coordinates + * according to the current ellipsoid parameters. If any errors occur, + * the error code(s) are returned by the function, otherwise UTM_NO_ERROR + * is returned. + * + * USNG : USNG coordinate string (input) + * Zone : UTM zone (output) + * Hemisphere : North or South hemisphere (output) + * Easting : Easting (X) in meters (output) + * Northing : Northing (Y) in meters (output) + */ +{ /* Convert_USNG_To_UTM */ + double min_northing; + double northing_offset; + long ltr2_low_value; + long ltr2_high_value; + double pattern_offset; + double upper_lat_limit; /* North latitude limits based on 1st letter */ + double lower_lat_limit; /* South latitude limits based on 1st letter */ + double grid_easting; /* Easting for 100,000 meter grid square */ + double grid_northing; /* Northing for 100,000 meter grid square */ + long letters[USNG_LETTERS]; + long in_precision; + double latitude = 0.0; + double longitude = 0.0; + double divisor = 1.0; + long utm_error_code = USNG_NO_ERROR; + long error_code = USNG_NO_ERROR; + + error_code = Break_USNG_String (USNG, Zone, letters, Easting, Northing, &in_precision); + if (!*Zone) + error_code |= USNG_STRING_ERROR; + else + { + if (!error_code) + { + if ((letters[0] == LETTER_X) && ((*Zone == 32) || (*Zone == 34) || (*Zone == 36))) + error_code |= USNG_STRING_ERROR; + else + { + if (letters[0] < LETTER_N) + *Hemisphere = 'S'; + else + *Hemisphere = 'N'; + + ltr2_low_value = LETTER_A; // Make compiler shut up about possibly uninitialized values. + ltr2_high_value = LETTER_Z; // They should be set by the following but compiler doesn't know. + + USNG_Get_Grid_Values(*Zone, <r2_low_value, <r2_high_value, &pattern_offset); + + /* Check that the second letter of the USNG string is within + * the range of valid second letter values + * Also check that the third letter is valid */ + if ((letters[1] < ltr2_low_value) || (letters[1] > ltr2_high_value) || (letters[2] > LETTER_V)) + error_code |= USNG_STRING_ERROR; + + if (!error_code) + { + double row_letter_northing = (double)(letters[2]) * ONEHT; + grid_easting = (double)((letters[1]) - ltr2_low_value + 1) * ONEHT; + if ((ltr2_low_value == LETTER_J) && (letters[1] > LETTER_O)) + grid_easting = grid_easting - ONEHT; + + if (letters[2] > LETTER_O) + row_letter_northing = row_letter_northing - ONEHT; + + if (letters[2] > LETTER_I) + row_letter_northing = row_letter_northing - ONEHT; + + if (row_letter_northing >= TWOMIL) + row_letter_northing = row_letter_northing - TWOMIL; + + error_code = USNG_Get_Latitude_Band_Min_Northing(letters[0], &min_northing, &northing_offset); + if (!error_code) + { + grid_northing = row_letter_northing - pattern_offset; + if(grid_northing < 0) + grid_northing += TWOMIL; + + grid_northing += northing_offset; + + if(grid_northing < min_northing) + grid_northing += TWOMIL; + + *Easting = grid_easting + *Easting; + *Northing = grid_northing + *Northing; + + /* check that point is within Zone Letter bounds */ + utm_error_code = Set_UTM_Parameters(USNG_a, USNG_f, 0); + if (!utm_error_code) + { + utm_error_code = Convert_UTM_To_Geodetic(*Zone,*Hemisphere,*Easting,*Northing,&latitude,&longitude); + if (!utm_error_code) + { + divisor = pow (10.0, in_precision); + error_code = USNG_Get_Latitude_Range(letters[0], &upper_lat_limit, &lower_lat_limit); + if (!error_code) + { + if (!(((lower_lat_limit - DEG_TO_RAD/divisor) <= latitude) && (latitude <= (upper_lat_limit + DEG_TO_RAD/divisor)))) + error_code |= USNG_LAT_ERROR; + } + } + else + { + if((utm_error_code & UTM_ZONE_ERROR) || (utm_error_code & UTM_HEMISPHERE_ERROR)) + error_code |= USNG_STRING_ERROR; + if(utm_error_code & UTM_EASTING_ERROR) + error_code |= USNG_EASTING_ERROR; + if(utm_error_code & UTM_NORTHING_ERROR) + error_code |= USNG_NORTHING_ERROR; + } + } + else + { + if(utm_error_code & UTM_A_ERROR) + error_code |= USNG_A_ERROR; + if(utm_error_code & UTM_INV_F_ERROR) + error_code |= USNG_INV_F_ERROR; + if(utm_error_code & UTM_ZONE_OVERRIDE_ERROR) + error_code |= USNG_ZONE_ERROR; + } + } + } + } + } + } + return (error_code); +} /* Convert_USNG_To_UTM */ + + +long Convert_UPS_To_USNG (char Hemisphere, + double Easting, + double Northing, + long Precision, + char* USNG) +/* + * The function Convert_UPS_To_USNG converts UPS (hemisphere, easting, + * and northing) coordinates to a USNG coordinate string according to + * the current ellipsoid parameters. If any errors occur, the error + * code(s) are returned by the function, otherwise UPS_NO_ERROR is + * returned. + * + * Hemisphere : Hemisphere either 'N' or 'S' (input) + * Easting : Easting/X in meters (input) + * Northing : Northing/Y in meters (input) + * Precision : Precision level of USNG string (input) + * USNG : USNG coordinate string (output) + */ +{ /* Convert_UPS_To_USNG */ + double false_easting; /* False easting for 2nd letter */ + double false_northing; /* False northing for 3rd letter */ + double grid_easting; /* Easting used to derive 2nd letter of USNG */ + double grid_northing; /* Northing used to derive 3rd letter of USNG */ + long ltr2_low_value; /* 2nd letter range - low number */ + int letters[USNG_LETTERS]; /* Number location of 3 letters in alphabet */ + double divisor; + int index = 0; + long error_code = USNG_NO_ERROR; + + if ((Hemisphere != 'N') && (Hemisphere != 'S')) + error_code |= USNG_HEMISPHERE_ERROR; + if ((Easting < MIN_EAST_NORTH) || (Easting > MAX_EAST_NORTH)) + error_code |= USNG_EASTING_ERROR; + if ((Northing < MIN_EAST_NORTH) || (Northing > MAX_EAST_NORTH)) + error_code |= USNG_NORTHING_ERROR; + if ((Precision < 0) || (Precision > MAX_PRECISION)) + error_code |= USNG_PRECISION_ERROR; + if (!error_code) + { + divisor = pow (10.0, (5 - Precision)); + Easting = (long)(Easting/divisor + 1.0e-9) * divisor; + Northing = (long)(Northing/divisor) * divisor; + + if (Hemisphere == 'N') + { + if (Easting >= TWOMIL) + letters[0] = LETTER_Z; + else + letters[0] = LETTER_Y; + + index = letters[0] - 22; + ltr2_low_value = UPS_Constant_Table[index].ltr2_low_value; + false_easting = UPS_Constant_Table[index].false_easting; + false_northing = UPS_Constant_Table[index].false_northing; + } + else + { + if (Easting >= TWOMIL) + letters[0] = LETTER_B; + else + letters[0] = LETTER_A; + + ltr2_low_value = UPS_Constant_Table[letters[0]].ltr2_low_value; + false_easting = UPS_Constant_Table[letters[0]].false_easting; + false_northing = UPS_Constant_Table[letters[0]].false_northing; + } + + grid_northing = Northing; + grid_northing = grid_northing - false_northing; + letters[2] = (long)(grid_northing / ONEHT); + + if (letters[2] > LETTER_H) + letters[2] = letters[2] + 1; + + if (letters[2] > LETTER_N) + letters[2] = letters[2] + 1; + + grid_easting = Easting; + grid_easting = grid_easting - false_easting; + letters[1] = ltr2_low_value + ((long)(grid_easting / ONEHT)); + + if (Easting < TWOMIL) + { + if (letters[1] > LETTER_L) + letters[1] = letters[1] + 3; + + if (letters[1] > LETTER_U) + letters[1] = letters[1] + 2; + } + else + { + if (letters[1] > LETTER_C) + letters[1] = letters[1] + 2; + + if (letters[1] > LETTER_H) + letters[1] = letters[1] + 1; + + if (letters[1] > LETTER_L) + letters[1] = letters[1] + 3; + } + + Make_USNG_String (USNG, 0, letters, Easting, Northing, Precision); + } + return (error_code); +} /* Convert_UPS_To_USNG */ + + +long Convert_USNG_To_UPS ( char *USNG, + char *Hemisphere, + double *Easting, + double *Northing) +/* + * The function Convert_USNG_To_UPS converts a USNG coordinate string + * to UPS (hemisphere, easting, and northing) coordinates, according + * to the current ellipsoid parameters. If any errors occur, the error + * code(s) are returned by the function, otherwide UPS_NO_ERROR is returned. + * + * USNG : USNG coordinate string (input) + * Hemisphere : Hemisphere either 'N' or 'S' (output) + * Easting : Easting/X in meters (output) + * Northing : Northing/Y in meters (output) + */ +{ /* Convert_USNG_To_UPS */ + long ltr2_high_value; /* 2nd letter range - high number */ + long ltr3_high_value; /* 3rd letter range - high number (UPS) */ + long ltr2_low_value; /* 2nd letter range - low number */ + double false_easting; /* False easting for 2nd letter */ + double false_northing; /* False northing for 3rd letter */ + double grid_easting; /* easting for 100,000 meter grid square */ + double grid_northing; /* northing for 100,000 meter grid square */ + long zone = 0; + long letters[USNG_LETTERS]; + long in_precision = 0; + int index = 0; + long error_code = USNG_NO_ERROR; + + error_code = Break_USNG_String (USNG, &zone, letters, Easting, Northing, &in_precision); + if (zone) + error_code |= USNG_STRING_ERROR; + else + { + if (!error_code) + { + if (letters[0] >= LETTER_Y) + { + *Hemisphere = 'N'; + + index = letters[0] - 22; + ltr2_low_value = UPS_Constant_Table[index].ltr2_low_value; + ltr2_high_value = UPS_Constant_Table[index].ltr2_high_value; + ltr3_high_value = UPS_Constant_Table[index].ltr3_high_value; + false_easting = UPS_Constant_Table[index].false_easting; + false_northing = UPS_Constant_Table[index].false_northing; + } + else + { + *Hemisphere = 'S'; + + ltr2_low_value = UPS_Constant_Table[letters[0]].ltr2_low_value; + ltr2_high_value = UPS_Constant_Table[letters[0]].ltr2_high_value; + ltr3_high_value = UPS_Constant_Table[letters[0]].ltr3_high_value; + false_easting = UPS_Constant_Table[letters[0]].false_easting; + false_northing = UPS_Constant_Table[letters[0]].false_northing; + } + + /* Check that the second letter of the USNG string is within + * the range of valid second letter values + * Also check that the third letter is valid */ + if ((letters[1] < ltr2_low_value) || (letters[1] > ltr2_high_value) || + ((letters[1] == LETTER_D) || (letters[1] == LETTER_E) || + (letters[1] == LETTER_M) || (letters[1] == LETTER_N) || + (letters[1] == LETTER_V) || (letters[1] == LETTER_W)) || + (letters[2] > ltr3_high_value)) + error_code = USNG_STRING_ERROR; + + if (!error_code) + { + grid_northing = (double)letters[2] * ONEHT + false_northing; + if (letters[2] > LETTER_I) + grid_northing = grid_northing - ONEHT; + + if (letters[2] > LETTER_O) + grid_northing = grid_northing - ONEHT; + + grid_easting = (double)((letters[1]) - ltr2_low_value) * ONEHT + false_easting; + if (ltr2_low_value != LETTER_A) + { + if (letters[1] > LETTER_L) + grid_easting = grid_easting - 300000.0; + + if (letters[1] > LETTER_U) + grid_easting = grid_easting - 200000.0; + } + else + { + if (letters[1] > LETTER_C) + grid_easting = grid_easting - 200000.0; + + if (letters[1] > LETTER_I) + grid_easting = grid_easting - ONEHT; + + if (letters[1] > LETTER_L) + grid_easting = grid_easting - 300000.0; + } + + *Easting = grid_easting + *Easting; + *Northing = grid_northing + *Northing; + } + } + } + return (error_code); +} /* Convert_USNG_To_UPS */ diff --git a/external/geotranz/usng.h b/external/geotranz/usng.h new file mode 100644 index 00000000..456cb379 --- /dev/null +++ b/external/geotranz/usng.h @@ -0,0 +1,252 @@ +#ifndef USNG_H + #define USNG_H + +/***************************************************************************/ +/* RSC IDENTIFIER: USNG + * + * ABSTRACT + * + * This component converts between geodetic coordinates (latitude and + * longitude) and United States National Grid (USNG) coordinates. + * + * ERROR HANDLING + * + * This component checks parameters for valid values. If an invalid value + * is found, the error code is combined with the current error code using + * the bitwise or. This combining allows multiple error codes to be + * returned. The possible error codes are: + * + * USNG_NO_ERROR : No errors occurred in function + * USNG_LAT_ERROR : Latitude outside of valid range + * (-90 to 90 degrees) + * USNG_LON_ERROR : Longitude outside of valid range + * (-180 to 360 degrees) + * USNG_STR_ERROR : An USNG string error: string too long, + * too short, or badly formed + * USNG_PRECISION_ERROR : The precision must be between 0 and 5 + * inclusive. + * USNG_A_ERROR : Semi-major axis less than or equal to zero + * USNG_INV_F_ERROR : Inverse flattening outside of valid range + * (250 to 350) + * USNG_EASTING_ERROR : Easting outside of valid range + * (100,000 to 900,000 meters for UTM) + * (0 to 4,000,000 meters for UPS) + * USNG_NORTHING_ERROR : Northing outside of valid range + * (0 to 10,000,000 meters for UTM) + * (0 to 4,000,000 meters for UPS) + * USNG_ZONE_ERROR : Zone outside of valid range (1 to 60) + * USNG_HEMISPHERE_ERROR : Invalid hemisphere ('N' or 'S') + * + * REUSE NOTES + * + * USNG is intended for reuse by any application that does conversions + * between geodetic coordinates and USNG coordinates. + * + * REFERENCES + * + * Further information on USNG can be found in the Reuse Manual. + * + * USNG originated from : Federal Geographic Data Committee + * 590 National Center + * 12201 Sunrise Valley Drive + * Reston, VA 22092 + * + * LICENSES + * + * None apply to this component. + * + * RESTRICTIONS + * + * + * ENVIRONMENT + * + * USNG was tested and certified in the following environments: + * + * 1. Solaris 2.5 with GCC version 2.8.1 + * 2. Windows 95 with MS Visual C++ version 6 + * + * MODIFICATIONS + * + * Date Description + * ---- ----------- + * 06-05-06 Original Code (cloned from MGRS) + * + */ + + +/***************************************************************************/ +/* + * DEFINES + */ + + #define USNG_NO_ERROR 0x0000 + #define USNG_LAT_ERROR 0x0001 + #define USNG_LON_ERROR 0x0002 + #define USNG_STRING_ERROR 0x0004 + #define USNG_PRECISION_ERROR 0x0008 + #define USNG_A_ERROR 0x0010 + #define USNG_INV_F_ERROR 0x0020 + #define USNG_EASTING_ERROR 0x0040 + #define USNG_NORTHING_ERROR 0x0080 + #define USNG_ZONE_ERROR 0x0100 + #define USNG_HEMISPHERE_ERROR 0x0200 + #define USNG_LAT_WARNING 0x0400 + + +/***************************************************************************/ +/* + * FUNCTION PROTOTYPES + */ + +/* ensure proper linkage to c++ programs */ + #ifdef __cplusplus +extern "C" { + #endif + + + long Set_USNG_Parameters(double a, + double f, + char *Ellipsoid_Code); +/* + * The function Set_USNG_Parameters receives the ellipsoid parameters and sets + * the corresponding state variables. If any errors occur, the error code(s) + * are returned by the function, otherwise USNG_NO_ERROR is returned. + * + * a : Semi-major axis of ellipsoid in meters (input) + * f : Flattening of ellipsoid (input) + * Ellipsoid_Code : 2-letter code for ellipsoid (input) + */ + + + void Get_USNG_Parameters(double *a, + double *f, + char *Ellipsoid_Code); +/* + * The function Get_USNG_Parameters returns the current ellipsoid + * parameters. + * + * a : Semi-major axis of ellipsoid, in meters (output) + * f : Flattening of ellipsoid (output) + * Ellipsoid_Code : 2-letter code for ellipsoid (output) + */ + + + long Convert_Geodetic_To_USNG (double Latitude, + double Longitude, + long Precision, + char *USNG); +/* + * The function Convert_Geodetic_To_USNG converts geodetic (latitude and + * longitude) coordinates to a USNG coordinate string, according to the + * current ellipsoid parameters. If any errors occur, the error code(s) + * are returned by the function, otherwise USNG_NO_ERROR is returned. + * + * Latitude : Latitude in radians (input) + * Longitude : Longitude in radians (input) + * Precision : Precision level of USNG string (input) + * USNG : USNG coordinate string (output) + * + */ + + + long Convert_USNG_To_Geodetic (char *USNG, + double *Latitude, + double *Longitude); +/* + * This function converts a USNG coordinate string to Geodetic (latitude + * and longitude in radians) coordinates. If any errors occur, the error + * code(s) are returned by the function, otherwise USNG_NO_ERROR is returned. + * + * USNG : USNG coordinate string (input) + * Latitude : Latitude in radians (output) + * Longitude : Longitude in radians (output) + * + */ + + + long Convert_UTM_To_USNG (long Zone, + char Hemisphere, + double Easting, + double Northing, + long Precision, + char *USNG); +/* + * The function Convert_UTM_To_USNG converts UTM (zone, easting, and + * northing) coordinates to a USNG coordinate string, according to the + * current ellipsoid parameters. If any errors occur, the error code(s) + * are returned by the function, otherwise USNG_NO_ERROR is returned. + * + * Zone : UTM zone (input) + * Hemisphere : North or South hemisphere (input) + * Easting : Easting (X) in meters (input) + * Northing : Northing (Y) in meters (input) + * Precision : Precision level of USNG string (input) + * USNG : USNG coordinate string (output) + */ + + + long Convert_USNG_To_UTM (char *USNG, + long *Zone, + char *Hemisphere, + double *Easting, + double *Northing); +/* + * The function Convert_USNG_To_UTM converts a USNG coordinate string + * to UTM projection (zone, hemisphere, easting and northing) coordinates + * according to the current ellipsoid parameters. If any errors occur, + * the error code(s) are returned by the function, otherwise UTM_NO_ERROR + * is returned. + * + * USNG : USNG coordinate string (input) + * Zone : UTM zone (output) + * Hemisphere : North or South hemisphere (output) + * Easting : Easting (X) in meters (output) + * Northing : Northing (Y) in meters (output) + */ + + + + long Convert_UPS_To_USNG ( char Hemisphere, + double Easting, + double Northing, + long Precision, + char *USNG); + +/* + * The function Convert_UPS_To_USNG converts UPS (hemisphere, easting, + * and northing) coordinates to a USNG coordinate string according to + * the current ellipsoid parameters. If any errors occur, the error + * code(s) are returned by the function, otherwise UPS_NO_ERROR is + * returned. + * + * Hemisphere : Hemisphere either 'N' or 'S' (input) + * Easting : Easting/X in meters (input) + * Northing : Northing/Y in meters (input) + * Precision : Precision level of USNG string (input) + * USNG : USNG coordinate string (output) + */ + + + long Convert_USNG_To_UPS ( char *USNG, + char *Hemisphere, + double *Easting, + double *Northing); +/* + * The function Convert_USNG_To_UPS converts a USNG coordinate string + * to UPS (hemisphere, easting, and northing) coordinates, according + * to the current ellipsoid parameters. If any errors occur, the error + * code(s) are returned by the function, otherwide UPS_NO_ERROR is returned. + * + * USNG : USNG coordinate string (input) + * Hemisphere : Hemisphere either 'N' or 'S' (output) + * Easting : Easting/X in meters (output) + * Northing : Northing/Y in meters (output) + */ + + + + #ifdef __cplusplus +} + #endif + +#endif /* USNG_H */ diff --git a/external/geotranz/utm.c b/external/geotranz/utm.c new file mode 100644 index 00000000..81c0f464 --- /dev/null +++ b/external/geotranz/utm.c @@ -0,0 +1,354 @@ +/***************************************************************************/ +/* RSC IDENTIFIER: UTM + * + * ABSTRACT + * + * This component provides conversions between geodetic coordinates + * (latitude and longitudes) and Universal Transverse Mercator (UTM) + * projection (zone, hemisphere, easting, and northing) coordinates. + * + * ERROR HANDLING + * + * This component checks parameters for valid values. If an invalid value + * is found, the error code is combined with the current error code using + * the bitwise or. This combining allows multiple error codes to be + * returned. The possible error codes are: + * + * UTM_NO_ERROR : No errors occurred in function + * UTM_LAT_ERROR : Latitude outside of valid range + * (-80.5 to 84.5 degrees) + * UTM_LON_ERROR : Longitude outside of valid range + * (-180 to 360 degrees) + * UTM_EASTING_ERROR : Easting outside of valid range + * (100,000 to 900,000 meters) + * UTM_NORTHING_ERROR : Northing outside of valid range + * (0 to 10,000,000 meters) + * UTM_ZONE_ERROR : Zone outside of valid range (1 to 60) + * UTM_HEMISPHERE_ERROR : Invalid hemisphere ('N' or 'S') + * UTM_ZONE_OVERRIDE_ERROR: Zone outside of valid range + * (1 to 60) and within 1 of 'natural' zone + * UTM_A_ERROR : Semi-major axis less than or equal to zero + * UTM_INV_F_ERROR : Inverse flattening outside of valid range + * (250 to 350) + * + * REUSE NOTES + * + * UTM is intended for reuse by any application that performs a Universal + * Transverse Mercator (UTM) projection or its inverse. + * + * REFERENCES + * + * Further information on UTM can be found in the Reuse Manual. + * + * UTM originated from : U.S. Army Topographic Engineering Center + * Geospatial Information Division + * 7701 Telegraph Road + * Alexandria, VA 22310-3864 + * + * LICENSES + * + * None apply to this component. + * + * RESTRICTIONS + * + * UTM has no restrictions. + * + * ENVIRONMENT + * + * UTM was tested and certified in the following environments: + * + * 1. Solaris 2.5 with GCC, version 2.8.1 + * 2. MSDOS with MS Visual C++, version 6 + * + * MODIFICATIONS + * + * Date Description + * ---- ----------- + * 10-02-97 Original Code + * + */ + + +/***************************************************************************/ +/* + * INCLUDES + */ +#include "tranmerc.h" +#include "utm.h" +/* + * tranmerc.h - Is used to convert transverse mercator coordinates + * utm.h - Defines the function prototypes for the utm module. + */ + + +/***************************************************************************/ +/* + * DEFINES + */ + +#define PI 3.14159265358979323e0 /* PI */ +#define MIN_LAT ( (-80.5 * PI) / 180.0 ) /* -80.5 degrees in radians */ +#define MAX_LAT ( (84.5 * PI) / 180.0 ) /* 84.5 degrees in radians */ +#define MIN_EASTING 100000 +#define MAX_EASTING 900000 +#define MIN_NORTHING 0 +#define MAX_NORTHING 10000000 + +/***************************************************************************/ +/* + * GLOBAL DECLARATIONS + */ + +static double UTM_a = 6378137.0; /* Semi-major axis of ellipsoid in meters */ +static double UTM_f = 1 / 298.257223563; /* Flattening of ellipsoid */ +static long UTM_Override = 0; /* Zone override flag */ + + +/***************************************************************************/ +/* + * FUNCTIONS + * + */ + +long Set_UTM_Parameters(double a, + double f, + long override) +{ +/* + * The function Set_UTM_Parameters receives the ellipsoid parameters and + * UTM zone override parameter as inputs, and sets the corresponding state + * variables. If any errors occur, the error code(s) are returned by the + * function, otherwise UTM_NO_ERROR is returned. + * + * a : Semi-major axis of ellipsoid, in meters (input) + * f : Flattening of ellipsoid (input) + * override : UTM override zone, zero indicates no override (input) + */ + + double inv_f = 1 / f; + long Error_Code = UTM_NO_ERROR; + + if (a <= 0.0) + { /* Semi-major axis must be greater than zero */ + Error_Code |= UTM_A_ERROR; + } + if ((inv_f < 250) || (inv_f > 350)) + { /* Inverse flattening must be between 250 and 350 */ + Error_Code |= UTM_INV_F_ERROR; + } + if ((override < 0) || (override > 60)) + { + Error_Code |= UTM_ZONE_OVERRIDE_ERROR; + } + if (!Error_Code) + { /* no errors */ + UTM_a = a; + UTM_f = f; + UTM_Override = override; + } + return (Error_Code); +} /* END OF Set_UTM_Parameters */ + + +void Get_UTM_Parameters(double *a, + double *f, + long *override) +{ +/* + * The function Get_UTM_Parameters returns the current ellipsoid + * parameters and UTM zone override parameter. + * + * a : Semi-major axis of ellipsoid, in meters (output) + * f : Flattening of ellipsoid (output) + * override : UTM override zone, zero indicates no override (output) + */ + + *a = UTM_a; + *f = UTM_f; + *override = UTM_Override; +} /* END OF Get_UTM_Parameters */ + + +long Convert_Geodetic_To_UTM (double Latitude, + double Longitude, + long *Zone, + char *Hemisphere, + double *Easting, + double *Northing) +{ +/* + * The function Convert_Geodetic_To_UTM converts geodetic (latitude and + * longitude) coordinates to UTM projection (zone, hemisphere, easting and + * northing) coordinates according to the current ellipsoid and UTM zone + * override parameters. If any errors occur, the error code(s) are returned + * by the function, otherwise UTM_NO_ERROR is returned. + * + * Latitude : Latitude in radians (input) + * Longitude : Longitude in radians (input) + * Zone : UTM zone (output) + * Hemisphere : North or South hemisphere (output) + * Easting : Easting (X) in meters (output) + * Northing : Northing (Y) in meters (output) + */ + + long Lat_Degrees; + long Long_Degrees; + long temp_zone; + long Error_Code = UTM_NO_ERROR; + double Origin_Latitude = 0; + double Central_Meridian = 0; + double False_Easting = 500000; + double False_Northing = 0; + double Scale = 0.9996; + + if ((Latitude < MIN_LAT) || (Latitude > MAX_LAT)) + { /* Latitude out of range */ + Error_Code |= UTM_LAT_ERROR; + } + if ((Longitude < -PI) || (Longitude > (2*PI))) + { /* Longitude out of range */ + Error_Code |= UTM_LON_ERROR; + } + if (!Error_Code) + { /* no errors */ + if((Latitude > -1.0e-9) && (Latitude < 0)) + Latitude = 0.0; + if (Longitude < 0) + Longitude += (2*PI) + 1.0e-10; + + Lat_Degrees = (long)(Latitude * 180.0 / PI); + Long_Degrees = (long)(Longitude * 180.0 / PI); + + if (Longitude < PI) + temp_zone = (long)(31 + ((Longitude * 180.0 / PI) / 6.0)); + else + temp_zone = (long)(((Longitude * 180.0 / PI) / 6.0) - 29); + + if (temp_zone > 60) + temp_zone = 1; + /* UTM special cases */ + if ((Lat_Degrees > 55) && (Lat_Degrees < 64) && (Long_Degrees > -1) + && (Long_Degrees < 3)) + temp_zone = 31; + if ((Lat_Degrees > 55) && (Lat_Degrees < 64) && (Long_Degrees > 2) + && (Long_Degrees < 12)) + temp_zone = 32; + if ((Lat_Degrees > 71) && (Long_Degrees > -1) && (Long_Degrees < 9)) + temp_zone = 31; + if ((Lat_Degrees > 71) && (Long_Degrees > 8) && (Long_Degrees < 21)) + temp_zone = 33; + if ((Lat_Degrees > 71) && (Long_Degrees > 20) && (Long_Degrees < 33)) + temp_zone = 35; + if ((Lat_Degrees > 71) && (Long_Degrees > 32) && (Long_Degrees < 42)) + temp_zone = 37; + + if (UTM_Override) + { + if ((temp_zone == 1) && (UTM_Override == 60)) + temp_zone = UTM_Override; + else if ((temp_zone == 60) && (UTM_Override == 1)) + temp_zone = UTM_Override; + else if ((Lat_Degrees > 71) && (Long_Degrees > -1) && (Long_Degrees < 42)) + { + if (((temp_zone-2) <= UTM_Override) && (UTM_Override <= (temp_zone+2))) + temp_zone = UTM_Override; + else + Error_Code = UTM_ZONE_OVERRIDE_ERROR; + } + else if (((temp_zone-1) <= UTM_Override) && (UTM_Override <= (temp_zone+1))) + temp_zone = UTM_Override; + else + Error_Code = UTM_ZONE_OVERRIDE_ERROR; + } + if (!Error_Code) + { + if (temp_zone >= 31) + Central_Meridian = (6 * temp_zone - 183) * PI / 180.0; + else + Central_Meridian = (6 * temp_zone + 177) * PI / 180.0; + *Zone = temp_zone; + if (Latitude < 0) + { + False_Northing = 10000000; + *Hemisphere = 'S'; + } + else + *Hemisphere = 'N'; + Set_Transverse_Mercator_Parameters(UTM_a, UTM_f, Origin_Latitude, + Central_Meridian, False_Easting, False_Northing, Scale); + Convert_Geodetic_To_Transverse_Mercator(Latitude, Longitude, Easting, + Northing); + if ((*Easting < MIN_EASTING) || (*Easting > MAX_EASTING)) + Error_Code = UTM_EASTING_ERROR; + if ((*Northing < MIN_NORTHING) || (*Northing > MAX_NORTHING)) + Error_Code |= UTM_NORTHING_ERROR; + } + } /* END OF if (!Error_Code) */ + return (Error_Code); +} /* END OF Convert_Geodetic_To_UTM */ + + +long Convert_UTM_To_Geodetic(long Zone, + char Hemisphere, + double Easting, + double Northing, + double *Latitude, + double *Longitude) +{ +/* + * The function Convert_UTM_To_Geodetic converts UTM projection (zone, + * hemisphere, easting and northing) coordinates to geodetic(latitude + * and longitude) coordinates, according to the current ellipsoid + * parameters. If any errors occur, the error code(s) are returned + * by the function, otherwise UTM_NO_ERROR is returned. + * + * Zone : UTM zone (input) + * Hemisphere : North or South hemisphere (input) + * Easting : Easting (X) in meters (input) + * Northing : Northing (Y) in meters (input) + * Latitude : Latitude in radians (output) + * Longitude : Longitude in radians (output) + */ + long Error_Code = UTM_NO_ERROR; + long tm_error_code = UTM_NO_ERROR; + double Origin_Latitude = 0; + double Central_Meridian = 0; + double False_Easting = 500000; + double False_Northing = 0; + double Scale = 0.9996; + + if ((Zone < 1) || (Zone > 60)) + Error_Code |= UTM_ZONE_ERROR; + if ((Hemisphere != 'S') && (Hemisphere != 'N')) + Error_Code |= UTM_HEMISPHERE_ERROR; + if ((Easting < MIN_EASTING) || (Easting > MAX_EASTING)) + Error_Code |= UTM_EASTING_ERROR; + if ((Northing < MIN_NORTHING) || (Northing > MAX_NORTHING)) + Error_Code |= UTM_NORTHING_ERROR; + if (!Error_Code) + { /* no errors */ + if (Zone >= 31) + Central_Meridian = ((6 * Zone - 183) * PI / 180.0 /*+ 0.00000005*/); + else + Central_Meridian = ((6 * Zone + 177) * PI / 180.0 /*+ 0.00000005*/); + if (Hemisphere == 'S') + False_Northing = 10000000; + Set_Transverse_Mercator_Parameters(UTM_a, UTM_f, Origin_Latitude, + Central_Meridian, False_Easting, False_Northing, Scale); + + tm_error_code = Convert_Transverse_Mercator_To_Geodetic(Easting, Northing, Latitude, Longitude); + if(tm_error_code) + { + if(tm_error_code & TRANMERC_EASTING_ERROR) + Error_Code |= UTM_EASTING_ERROR; + if(tm_error_code & TRANMERC_NORTHING_ERROR) + Error_Code |= UTM_NORTHING_ERROR; + } + + if ((*Latitude < MIN_LAT) || (*Latitude > MAX_LAT)) + { /* Latitude out of range */ + Error_Code |= UTM_NORTHING_ERROR; + } + } + return (Error_Code); +} /* END OF Convert_UTM_To_Geodetic */ diff --git a/external/geotranz/utm.h b/external/geotranz/utm.h new file mode 100644 index 00000000..0b32051b --- /dev/null +++ b/external/geotranz/utm.h @@ -0,0 +1,178 @@ +#ifndef UTM_H + #define UTM_H + +/***************************************************************************/ +/* RSC IDENTIFIER: UTM + * + * ABSTRACT + * + * This component provides conversions between geodetic coordinates + * (latitude and longitudes) and Universal Transverse Mercator (UTM) + * projection (zone, hemisphere, easting, and northing) coordinates. + * + * ERROR HANDLING + * + * This component checks parameters for valid values. If an invalid value + * is found, the error code is combined with the current error code using + * the bitwise or. This combining allows multiple error codes to be + * returned. The possible error codes are: + * + * UTM_NO_ERROR : No errors occurred in function + * UTM_LAT_ERROR : Latitude outside of valid range + * (-80.5 to 84.5 degrees) + * UTM_LON_ERROR : Longitude outside of valid range + * (-180 to 360 degrees) + * UTM_EASTING_ERROR : Easting outside of valid range + * (100,000 to 900,000 meters) + * UTM_NORTHING_ERROR : Northing outside of valid range + * (0 to 10,000,000 meters) + * UTM_ZONE_ERROR : Zone outside of valid range (1 to 60) + * UTM_HEMISPHERE_ERROR : Invalid hemisphere ('N' or 'S') + * UTM_ZONE_OVERRIDE_ERROR: Zone outside of valid range + * (1 to 60) and within 1 of 'natural' zone + * UTM_A_ERROR : Semi-major axis less than or equal to zero + * UTM_INV_F_ERROR : Inverse flattening outside of valid range + * (250 to 350) + * + * REUSE NOTES + * + * UTM is intended for reuse by any application that performs a Universal + * Transverse Mercator (UTM) projection or its inverse. + * + * REFERENCES + * + * Further information on UTM can be found in the Reuse Manual. + * + * UTM originated from : U.S. Army Topographic Engineering Center + * Geospatial Information Division + * 7701 Telegraph Road + * Alexandria, VA 22310-3864 + * + * LICENSES + * + * None apply to this component. + * + * RESTRICTIONS + * + * UTM has no restrictions. + * + * ENVIRONMENT + * + * UTM was tested and certified in the following environments: + * + * 1. Solaris 2.5 with GCC, version 2.8.1 + * 2. MSDOS with MS Visual C++, version 6 + * + * MODIFICATIONS + * + * Date Description + * ---- ----------- + * 10-02-97 Original Code + * + */ + + +/***************************************************************************/ +/* + * DEFINES + */ + + #define UTM_NO_ERROR 0x0000 + #define UTM_LAT_ERROR 0x0001 + #define UTM_LON_ERROR 0x0002 + #define UTM_EASTING_ERROR 0x0004 + #define UTM_NORTHING_ERROR 0x0008 + #define UTM_ZONE_ERROR 0x0010 + #define UTM_HEMISPHERE_ERROR 0x0020 + #define UTM_ZONE_OVERRIDE_ERROR 0x0040 + #define UTM_A_ERROR 0x0080 + #define UTM_INV_F_ERROR 0x0100 + + +/***************************************************************************/ +/* + * FUNCTION PROTOTYPES + * for UTM.C + */ + +/* ensure proper linkage to c++ programs */ + #ifdef __cplusplus +extern "C" { + #endif + + long Set_UTM_Parameters(double a, + double f, + long override); +/* + * The function Set_UTM_Parameters receives the ellipsoid parameters and + * UTM zone override parameter as inputs, and sets the corresponding state + * variables. If any errors occur, the error code(s) are returned by the + * function, otherwise UTM_NO_ERROR is returned. + * + * a : Semi-major axis of ellipsoid, in meters (input) + * f : Flattening of ellipsoid (input) + * override : UTM override zone, zero indicates no override (input) + */ + + + void Get_UTM_Parameters(double *a, + double *f, + long *override); +/* + * The function Get_UTM_Parameters returns the current ellipsoid + * parameters and UTM zone override parameter. + * + * a : Semi-major axis of ellipsoid, in meters (output) + * f : Flattening of ellipsoid (output) + * override : UTM override zone, zero indicates no override (output) + */ + + + long Convert_Geodetic_To_UTM (double Latitude, + double Longitude, + long *Zone, + char *Hemisphere, + double *Easting, + double *Northing); +/* + * The function Convert_Geodetic_To_UTM converts geodetic (latitude and + * longitude) coordinates to UTM projection (zone, hemisphere, easting and + * northing) coordinates according to the current ellipsoid and UTM zone + * override parameters. If any errors occur, the error code(s) are returned + * by the function, otherwise UTM_NO_ERROR is returned. + * + * Latitude : Latitude in radians (input) + * Longitude : Longitude in radians (input) + * Zone : UTM zone (output) + * Hemisphere : North or South hemisphere (output) + * Easting : Easting (X) in meters (output) + * Northing : Northing (Y) in meters (output) + */ + + + long Convert_UTM_To_Geodetic(long Zone, + char Hemisphere, + double Easting, + double Northing, + double *Latitude, + double *Longitude); +/* + * The function Convert_UTM_To_Geodetic converts UTM projection (zone, + * hemisphere, easting and northing) coordinates to geodetic(latitude + * and longitude) coordinates, according to the current ellipsoid + * parameters. If any errors occur, the error code(s) are returned + * by the function, otherwise UTM_NO_ERROR is returned. + * + * Zone : UTM zone (input) + * Hemisphere : North or South hemisphere (input) + * Easting : Easting (X) in meters (input) + * Northing : Northing (Y) in meters (input) + * Latitude : Latitude in radians (output) + * Longitude : Longitude in radians (output) + */ + + #ifdef __cplusplus +} + #endif + +#endif /* UTM_H */ diff --git a/external/hidapi/CMakeLists.txt b/external/hidapi/CMakeLists.txt new file mode 100644 index 00000000..c9dd66f1 --- /dev/null +++ b/external/hidapi/CMakeLists.txt @@ -0,0 +1,21 @@ +set(HIDAPI_LIBRARIES "" CACHE INTERNAL "") + +if(WIN32 OR CYGWIN) # windows + + set(HIDAPI_LIBRARIES hidapi CACHE INTERNAL "hidapi") + + list(APPEND hidapi_SOURCES + # Functions for accessing HID devices on Windows. + # These were copied from https://github.com/libusb/hidapi + ${CUSTOM_HIDAPI_DIR}/hid.c + ) + + add_library(hidapi STATIC + ${hidapi_SOURCES} + ) + + set_target_properties(hidapi + PROPERTIES COMPILE_FLAGS "-Dbool=int -Dtrue=1 -Dfalse=0 -DUSE_HIDAPI_STATIC" + ) + +endif() diff --git a/external/hidapi/LICENSE-bsd.txt b/external/hidapi/LICENSE-bsd.txt new file mode 100644 index 00000000..538cdf95 --- /dev/null +++ b/external/hidapi/LICENSE-bsd.txt @@ -0,0 +1,26 @@ +Copyright (c) 2010, Alan Ott, Signal 11 Software +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + + * Redistributions of source code must retain the above copyright notice, + this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. + * Neither the name of Signal 11 Software nor the names of its + contributors may be used to endorse or promote products derived from + this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE +LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +POSSIBILITY OF SUCH DAMAGE. diff --git a/external/hidapi/LICENSE-gpl3.txt b/external/hidapi/LICENSE-gpl3.txt new file mode 100644 index 00000000..94a9ed02 --- /dev/null +++ b/external/hidapi/LICENSE-gpl3.txt @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program 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. + + This program 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 this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/external/hidapi/LICENSE-orig.txt b/external/hidapi/LICENSE-orig.txt new file mode 100644 index 00000000..e3f33808 --- /dev/null +++ b/external/hidapi/LICENSE-orig.txt @@ -0,0 +1,9 @@ + HIDAPI - Multi-Platform library for + communication with HID devices. + + Copyright 2009, Alan Ott, Signal 11 Software. + All Rights Reserved. + + This software may be used by anyone for any reason so + long as the copyright notice in the source files + remains intact. diff --git a/external/hidapi/LICENSE.txt b/external/hidapi/LICENSE.txt new file mode 100644 index 00000000..e1676d4c --- /dev/null +++ b/external/hidapi/LICENSE.txt @@ -0,0 +1,13 @@ +HIDAPI can be used under one of three licenses. + +1. The GNU General Public License, version 3.0, in LICENSE-gpl3.txt +2. A BSD-Style License, in LICENSE-bsd.txt. +3. The more liberal original HIDAPI license. LICENSE-orig.txt + +The license chosen is at the discretion of the user of HIDAPI. For example: +1. An author of GPL software would likely use HIDAPI under the terms of the +GPL. + +2. An author of commercial closed-source software would likely use HIDAPI +under the terms of the BSD-style license or the original HIDAPI license. + diff --git a/external/hidapi/README.md b/external/hidapi/README.md new file mode 100644 index 00000000..6ced0f91 --- /dev/null +++ b/external/hidapi/README.md @@ -0,0 +1 @@ +This is from https://github.com/libusb/hidapi diff --git a/external/hidapi/hid.c b/external/hidapi/hid.c new file mode 100644 index 00000000..e483cd4f --- /dev/null +++ b/external/hidapi/hid.c @@ -0,0 +1,1091 @@ +/******************************************************* + HIDAPI - Multi-Platform library for + communication with HID devices. + + Alan Ott + Signal 11 Software + + 8/22/2009 + + Copyright 2009, All Rights Reserved. + + At the discretion of the user of this library, + this software may be licensed under the terms of the + GNU General Public License v3, a BSD-Style license, or the + original HIDAPI license as outlined in the LICENSE.txt, + LICENSE-gpl3.txt, LICENSE-bsd.txt, and LICENSE-orig.txt + files located at the root of the source distribution. + These files may also be found in the public source + code repository located at: + https://github.com/libusb/hidapi . +********************************************************/ + +#include + +#ifndef _NTDEF_ +typedef LONG NTSTATUS; +#endif + +#ifdef __MINGW32__ +#include +#include +#endif + +#ifdef __CYGWIN__ +#include +#define _wcsdup wcsdup +#endif + +/* The maximum number of characters that can be passed into the + HidD_Get*String() functions without it failing.*/ +#define MAX_STRING_WCHARS 0xFFF + +/*#define HIDAPI_USE_DDK*/ + +#ifdef __cplusplus +extern "C" { +#endif + #include + #include + #ifdef HIDAPI_USE_DDK + #include + #endif + + /* Copied from inc/ddk/hidclass.h, part of the Windows DDK. */ + #define HID_OUT_CTL_CODE(id) \ + CTL_CODE(FILE_DEVICE_KEYBOARD, (id), METHOD_OUT_DIRECT, FILE_ANY_ACCESS) + #define IOCTL_HID_GET_FEATURE HID_OUT_CTL_CODE(100) + #define IOCTL_HID_GET_INPUT_REPORT HID_OUT_CTL_CODE(104) + +#ifdef __cplusplus +} /* extern "C" */ +#endif + +#include +#include + + +#include "hidapi.h" + +#undef MIN +#define MIN(x,y) ((x) < (y)? (x): (y)) + +#ifdef _MSC_VER + /* Thanks Microsoft, but I know how to use strncpy(). */ + #pragma warning(disable:4996) +#endif + +#ifdef __cplusplus +extern "C" { +#endif + +static struct hid_api_version api_version = { + .major = HID_API_VERSION_MAJOR, + .minor = HID_API_VERSION_MINOR, + .patch = HID_API_VERSION_PATCH +}; + +#ifndef HIDAPI_USE_DDK + /* Since we're not building with the DDK, and the HID header + files aren't part of the SDK, we have to define all this + stuff here. In lookup_functions(), the function pointers + defined below are set. */ + typedef struct _HIDD_ATTRIBUTES{ + ULONG Size; + USHORT VendorID; + USHORT ProductID; + USHORT VersionNumber; + } HIDD_ATTRIBUTES, *PHIDD_ATTRIBUTES; + + typedef USHORT USAGE; + typedef struct _HIDP_CAPS { + USAGE Usage; + USAGE UsagePage; + USHORT InputReportByteLength; + USHORT OutputReportByteLength; + USHORT FeatureReportByteLength; + USHORT Reserved[17]; + USHORT fields_not_used_by_hidapi[10]; + } HIDP_CAPS, *PHIDP_CAPS; + typedef void* PHIDP_PREPARSED_DATA; + #define HIDP_STATUS_SUCCESS 0x110000 + + typedef BOOLEAN (__stdcall *HidD_GetAttributes_)(HANDLE device, PHIDD_ATTRIBUTES attrib); + typedef BOOLEAN (__stdcall *HidD_GetSerialNumberString_)(HANDLE device, PVOID buffer, ULONG buffer_len); + typedef BOOLEAN (__stdcall *HidD_GetManufacturerString_)(HANDLE handle, PVOID buffer, ULONG buffer_len); + typedef BOOLEAN (__stdcall *HidD_GetProductString_)(HANDLE handle, PVOID buffer, ULONG buffer_len); + typedef BOOLEAN (__stdcall *HidD_SetFeature_)(HANDLE handle, PVOID data, ULONG length); + typedef BOOLEAN (__stdcall *HidD_GetFeature_)(HANDLE handle, PVOID data, ULONG length); + typedef BOOLEAN (__stdcall *HidD_GetInputReport_)(HANDLE handle, PVOID data, ULONG length); + typedef BOOLEAN (__stdcall *HidD_GetIndexedString_)(HANDLE handle, ULONG string_index, PVOID buffer, ULONG buffer_len); + typedef BOOLEAN (__stdcall *HidD_GetPreparsedData_)(HANDLE handle, PHIDP_PREPARSED_DATA *preparsed_data); + typedef BOOLEAN (__stdcall *HidD_FreePreparsedData_)(PHIDP_PREPARSED_DATA preparsed_data); + typedef NTSTATUS (__stdcall *HidP_GetCaps_)(PHIDP_PREPARSED_DATA preparsed_data, HIDP_CAPS *caps); + typedef BOOLEAN (__stdcall *HidD_SetNumInputBuffers_)(HANDLE handle, ULONG number_buffers); + + static HidD_GetAttributes_ HidD_GetAttributes; + static HidD_GetSerialNumberString_ HidD_GetSerialNumberString; + static HidD_GetManufacturerString_ HidD_GetManufacturerString; + static HidD_GetProductString_ HidD_GetProductString; + static HidD_SetFeature_ HidD_SetFeature; + static HidD_GetFeature_ HidD_GetFeature; + static HidD_GetInputReport_ HidD_GetInputReport; + static HidD_GetIndexedString_ HidD_GetIndexedString; + static HidD_GetPreparsedData_ HidD_GetPreparsedData; + static HidD_FreePreparsedData_ HidD_FreePreparsedData; + static HidP_GetCaps_ HidP_GetCaps; + static HidD_SetNumInputBuffers_ HidD_SetNumInputBuffers; + + static HMODULE lib_handle = NULL; + static BOOLEAN initialized = FALSE; +#endif /* HIDAPI_USE_DDK */ + +struct hid_device_ { + HANDLE device_handle; + BOOL blocking; + USHORT output_report_length; + size_t input_report_length; + USHORT feature_report_length; + unsigned char *feature_buf; + void *last_error_str; + DWORD last_error_num; + BOOL read_pending; + char *read_buf; + OVERLAPPED ol; + OVERLAPPED write_ol; +}; + +static hid_device *new_hid_device() +{ + hid_device *dev = (hid_device*) calloc(1, sizeof(hid_device)); + dev->device_handle = INVALID_HANDLE_VALUE; + dev->blocking = TRUE; + dev->output_report_length = 0; + dev->input_report_length = 0; + dev->feature_report_length = 0; + dev->feature_buf = NULL; + dev->last_error_str = NULL; + dev->last_error_num = 0; + dev->read_pending = FALSE; + dev->read_buf = NULL; + memset(&dev->ol, 0, sizeof(dev->ol)); + dev->ol.hEvent = CreateEvent(NULL, FALSE, FALSE /*initial state f=nonsignaled*/, NULL); + memset(&dev->write_ol, 0, sizeof(dev->write_ol)); + dev->write_ol.hEvent = CreateEvent(NULL, FALSE, FALSE /*inital state f=nonsignaled*/, NULL); + + return dev; +} + +static void free_hid_device(hid_device *dev) +{ + CloseHandle(dev->ol.hEvent); + CloseHandle(dev->write_ol.hEvent); + CloseHandle(dev->device_handle); + LocalFree(dev->last_error_str); + free(dev->feature_buf); + free(dev->read_buf); + free(dev); +} + +static void register_error(hid_device *dev, const char *op) +{ + WCHAR *ptr, *msg; + (void)op; // unreferenced param + FormatMessageW(FORMAT_MESSAGE_ALLOCATE_BUFFER | + FORMAT_MESSAGE_FROM_SYSTEM | + FORMAT_MESSAGE_IGNORE_INSERTS, + NULL, + GetLastError(), + MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT), + (LPWSTR)&msg, 0/*sz*/, + NULL); + + /* Get rid of the CR and LF that FormatMessage() sticks at the + end of the message. Thanks Microsoft! */ + ptr = msg; + while (*ptr) { + if (*ptr == '\r') { + *ptr = 0x0000; + break; + } + ptr++; + } + + /* Store the message off in the Device entry so that + the hid_error() function can pick it up. */ + LocalFree(dev->last_error_str); + dev->last_error_str = msg; +} + +#ifndef HIDAPI_USE_DDK +static int lookup_functions() +{ + lib_handle = LoadLibraryA("hid.dll"); + if (lib_handle) { +#if defined(__GNUC__) +# pragma GCC diagnostic push +//# pragma GCC diagnostic ignored "-Wcast-function-type" +#endif +#define RESOLVE(x) x = (x##_)GetProcAddress(lib_handle, #x); if (!x) return -1; + RESOLVE(HidD_GetAttributes); + RESOLVE(HidD_GetSerialNumberString); + RESOLVE(HidD_GetManufacturerString); + RESOLVE(HidD_GetProductString); + RESOLVE(HidD_SetFeature); + RESOLVE(HidD_GetFeature); + RESOLVE(HidD_GetInputReport); + RESOLVE(HidD_GetIndexedString); + RESOLVE(HidD_GetPreparsedData); + RESOLVE(HidD_FreePreparsedData); + RESOLVE(HidP_GetCaps); + RESOLVE(HidD_SetNumInputBuffers); +#undef RESOLVE +#if defined(__GNUC__) +# pragma GCC diagnostic pop +#endif + } + else + return -1; + + return 0; +} +#endif + +static HANDLE open_device(const char *path, BOOL open_rw) +{ + HANDLE handle; + DWORD desired_access = (open_rw)? (GENERIC_WRITE | GENERIC_READ): 0; + DWORD share_mode = FILE_SHARE_READ|FILE_SHARE_WRITE; + + handle = CreateFileA(path, + desired_access, + share_mode, + NULL, + OPEN_EXISTING, + FILE_FLAG_OVERLAPPED,/*FILE_ATTRIBUTE_NORMAL,*/ + 0); + + return handle; +} + +HID_API_EXPORT const struct hid_api_version* HID_API_CALL hid_version() +{ + return &api_version; +} + +HID_API_EXPORT const char* HID_API_CALL hid_version_str() +{ + return HID_API_VERSION_STR; +} + +int HID_API_EXPORT hid_init(void) +{ +#ifndef HIDAPI_USE_DDK + if (!initialized) { + if (lookup_functions() < 0) { + hid_exit(); + return -1; + } + initialized = TRUE; + } +#endif + return 0; +} + +int HID_API_EXPORT hid_exit(void) +{ +#ifndef HIDAPI_USE_DDK + if (lib_handle) + FreeLibrary(lib_handle); + lib_handle = NULL; + initialized = FALSE; +#endif + return 0; +} + +struct hid_device_info HID_API_EXPORT * HID_API_CALL hid_enumerate(unsigned short vendor_id, unsigned short product_id) +{ + BOOL res; + struct hid_device_info *root = NULL; /* return object */ + struct hid_device_info *cur_dev = NULL; + + /* Windows objects for interacting with the driver. */ + GUID InterfaceClassGuid = {0x4d1e55b2, 0xf16f, 0x11cf, {0x88, 0xcb, 0x00, 0x11, 0x11, 0x00, 0x00, 0x30} }; + SP_DEVINFO_DATA devinfo_data; + SP_DEVICE_INTERFACE_DATA device_interface_data; + SP_DEVICE_INTERFACE_DETAIL_DATA_A *device_interface_detail_data = NULL; + HDEVINFO device_info_set = INVALID_HANDLE_VALUE; + int device_index = 0; + int i; + + if (hid_init() < 0) + return NULL; + + /* Initialize the Windows objects. */ + memset(&devinfo_data, 0x0, sizeof(devinfo_data)); + devinfo_data.cbSize = sizeof(SP_DEVINFO_DATA); + device_interface_data.cbSize = sizeof(SP_DEVICE_INTERFACE_DATA); + + /* Get information for all the devices belonging to the HID class. */ + device_info_set = SetupDiGetClassDevsA(&InterfaceClassGuid, NULL, NULL, DIGCF_PRESENT | DIGCF_DEVICEINTERFACE); + + /* Iterate over each device in the HID class, looking for the right one. */ + + for (;;) { + HANDLE write_handle = INVALID_HANDLE_VALUE; + DWORD required_size = 0; + HIDD_ATTRIBUTES attrib; + + res = SetupDiEnumDeviceInterfaces(device_info_set, + NULL, + &InterfaceClassGuid, + device_index, + &device_interface_data); + + if (!res) { + /* A return of FALSE from this function means that + there are no more devices. */ + break; + } + + /* Call with 0-sized detail size, and let the function + tell us how long the detail struct needs to be. The + size is put in &required_size. */ + res = SetupDiGetDeviceInterfaceDetailA(device_info_set, + &device_interface_data, + NULL, + 0, + &required_size, + NULL); + + /* Allocate a long enough structure for device_interface_detail_data. */ + device_interface_detail_data = (SP_DEVICE_INTERFACE_DETAIL_DATA_A*) malloc(required_size); + device_interface_detail_data->cbSize = sizeof(SP_DEVICE_INTERFACE_DETAIL_DATA_A); + + /* Get the detailed data for this device. The detail data gives us + the device path for this device, which is then passed into + CreateFile() to get a handle to the device. */ + res = SetupDiGetDeviceInterfaceDetailA(device_info_set, + &device_interface_data, + device_interface_detail_data, + required_size, + NULL, + NULL); + + if (!res) { + /* register_error(dev, "Unable to call SetupDiGetDeviceInterfaceDetail"); + Continue to the next device. */ + goto cont; + } + + /* Make sure this device is of Setup Class "HIDClass" and has a + driver bound to it. */ + for (i = 0; ; i++) { + char driver_name[256]; + + /* Populate devinfo_data. This function will return failure + when there are no more interfaces left. */ + res = SetupDiEnumDeviceInfo(device_info_set, i, &devinfo_data); + if (!res) + goto cont; + + res = SetupDiGetDeviceRegistryPropertyA(device_info_set, &devinfo_data, + SPDRP_CLASS, NULL, (PBYTE)driver_name, sizeof(driver_name), NULL); + if (!res) + goto cont; + + if ((strcmp(driver_name, "HIDClass") == 0) || + (strcmp(driver_name, "Mouse") == 0) || + (strcmp(driver_name, "Keyboard") == 0)) { + /* See if there's a driver bound. */ + res = SetupDiGetDeviceRegistryPropertyA(device_info_set, &devinfo_data, + SPDRP_DRIVER, NULL, (PBYTE)driver_name, sizeof(driver_name), NULL); + if (res) + break; + } + } + + //wprintf(L"HandleName: %s\n", device_interface_detail_data->DevicePath); + + /* Open a handle to the device */ + write_handle = open_device(device_interface_detail_data->DevicePath, FALSE); + + /* Check validity of write_handle. */ + if (write_handle == INVALID_HANDLE_VALUE) { + /* Unable to open the device. */ + //register_error(dev, "CreateFile"); + goto cont_close; + } + + + /* Get the Vendor ID and Product ID for this device. */ + attrib.Size = sizeof(HIDD_ATTRIBUTES); + HidD_GetAttributes(write_handle, &attrib); + //wprintf(L"Product/Vendor: %x %x\n", attrib.ProductID, attrib.VendorID); + + /* Check the VID/PID to see if we should add this + device to the enumeration list. */ + if ((vendor_id == 0x0 || attrib.VendorID == vendor_id) && + (product_id == 0x0 || attrib.ProductID == product_id)) { + + #define WSTR_LEN 512 + const char *str; + struct hid_device_info *tmp; + PHIDP_PREPARSED_DATA pp_data = NULL; + HIDP_CAPS caps; + NTSTATUS nt_res; + wchar_t wstr[WSTR_LEN]; /* TODO: Determine Size */ + size_t len; + + /* VID/PID match. Create the record. */ + tmp = (struct hid_device_info*) calloc(1, sizeof(struct hid_device_info)); + if (cur_dev) { + cur_dev->next = tmp; + } + else { + root = tmp; + } + cur_dev = tmp; + + /* Get the Usage Page and Usage for this device. */ + res = HidD_GetPreparsedData(write_handle, &pp_data); + if (res) { + nt_res = HidP_GetCaps(pp_data, &caps); + if (nt_res == HIDP_STATUS_SUCCESS) { + cur_dev->usage_page = caps.UsagePage; + cur_dev->usage = caps.Usage; + } + + HidD_FreePreparsedData(pp_data); + } + + /* Fill out the record */ + cur_dev->next = NULL; + str = device_interface_detail_data->DevicePath; + if (str) { + len = strlen(str); + cur_dev->path = (char*) calloc(len+1, sizeof(char)); + strncpy(cur_dev->path, str, len+1); + cur_dev->path[len] = '\0'; + } + else + cur_dev->path = NULL; + + /* Serial Number */ + wstr[0]= 0x0000; + res = HidD_GetSerialNumberString(write_handle, wstr, sizeof(wstr)); + wstr[WSTR_LEN-1] = 0x0000; + if (res) { + cur_dev->serial_number = _wcsdup(wstr); + } + + /* Manufacturer String */ + wstr[0]= 0x0000; + res = HidD_GetManufacturerString(write_handle, wstr, sizeof(wstr)); + wstr[WSTR_LEN-1] = 0x0000; + if (res) { + cur_dev->manufacturer_string = _wcsdup(wstr); + } + + /* Product String */ + wstr[0]= 0x0000; + res = HidD_GetProductString(write_handle, wstr, sizeof(wstr)); + wstr[WSTR_LEN-1] = 0x0000; + if (res) { + cur_dev->product_string = _wcsdup(wstr); + } + + /* VID/PID */ + cur_dev->vendor_id = attrib.VendorID; + cur_dev->product_id = attrib.ProductID; + + /* Release Number */ + cur_dev->release_number = attrib.VersionNumber; + + /* Interface Number. It can sometimes be parsed out of the path + on Windows if a device has multiple interfaces. See + http://msdn.microsoft.com/en-us/windows/hardware/gg487473 or + search for "Hardware IDs for HID Devices" at MSDN. If it's not + in the path, it's set to -1. */ + cur_dev->interface_number = -1; + if (cur_dev->path) { + char *interface_component = strstr(cur_dev->path, "&mi_"); + if (interface_component) { + char *hex_str = interface_component + 4; + char *endptr = NULL; + cur_dev->interface_number = strtol(hex_str, &endptr, 16); + if (endptr == hex_str) { + /* The parsing failed. Set interface_number to -1. */ + cur_dev->interface_number = -1; + } + } + } + } + +cont_close: + CloseHandle(write_handle); +cont: + /* We no longer need the detail data. It can be freed */ + free(device_interface_detail_data); + + device_index++; + + } + + /* Close the device information handle. */ + SetupDiDestroyDeviceInfoList(device_info_set); + + return root; + +} + +void HID_API_EXPORT HID_API_CALL hid_free_enumeration(struct hid_device_info *devs) +{ + /* TODO: Merge this with the Linux version. This function is platform-independent. */ + struct hid_device_info *d = devs; + while (d) { + struct hid_device_info *next = d->next; + free(d->path); + free(d->serial_number); + free(d->manufacturer_string); + free(d->product_string); + free(d); + d = next; + } +} + + +HID_API_EXPORT hid_device * HID_API_CALL hid_open(unsigned short vendor_id, unsigned short product_id, const wchar_t *serial_number) +{ + /* TODO: Merge this functions with the Linux version. This function should be platform independent. */ + struct hid_device_info *devs, *cur_dev; + const char *path_to_open = NULL; + hid_device *handle = NULL; + + devs = hid_enumerate(vendor_id, product_id); + cur_dev = devs; + while (cur_dev) { + if (cur_dev->vendor_id == vendor_id && + cur_dev->product_id == product_id) { + if (serial_number) { + if (cur_dev->serial_number && wcscmp(serial_number, cur_dev->serial_number) == 0) { + path_to_open = cur_dev->path; + break; + } + } + else { + path_to_open = cur_dev->path; + break; + } + } + cur_dev = cur_dev->next; + } + + if (path_to_open) { + /* Open the device */ + handle = hid_open_path(path_to_open); + } + + hid_free_enumeration(devs); + + return handle; +} + +HID_API_EXPORT hid_device * HID_API_CALL hid_open_path(const char *path) +{ + hid_device *dev; + HIDP_CAPS caps; + PHIDP_PREPARSED_DATA pp_data = NULL; + BOOLEAN res; + NTSTATUS nt_res; + + if (hid_init() < 0) { + return NULL; + } + + dev = new_hid_device(); + + /* Open a handle to the device */ + dev->device_handle = open_device(path, TRUE); + + /* Check validity of write_handle. */ + if (dev->device_handle == INVALID_HANDLE_VALUE) { + /* System devices, such as keyboards and mice, cannot be opened in + read-write mode, because the system takes exclusive control over + them. This is to prevent keyloggers. However, feature reports + can still be sent and received. Retry opening the device, but + without read/write access. */ + dev->device_handle = open_device(path, FALSE); + + /* Check the validity of the limited device_handle. */ + if (dev->device_handle == INVALID_HANDLE_VALUE) { + /* Unable to open the device, even without read-write mode. */ + register_error(dev, "CreateFile"); + goto err; + } + } + + /* Set the Input Report buffer size to 64 reports. */ + res = HidD_SetNumInputBuffers(dev->device_handle, 64); + if (!res) { + register_error(dev, "HidD_SetNumInputBuffers"); + goto err; + } + + /* Get the Input Report length for the device. */ + res = HidD_GetPreparsedData(dev->device_handle, &pp_data); + if (!res) { + register_error(dev, "HidD_GetPreparsedData"); + goto err; + } + nt_res = HidP_GetCaps(pp_data, &caps); + if (nt_res != HIDP_STATUS_SUCCESS) { + register_error(dev, "HidP_GetCaps"); + goto err_pp_data; + } + dev->output_report_length = caps.OutputReportByteLength; + dev->input_report_length = caps.InputReportByteLength; + dev->feature_report_length = caps.FeatureReportByteLength; + HidD_FreePreparsedData(pp_data); + + dev->read_buf = (char*) malloc(dev->input_report_length); + + return dev; + +err_pp_data: + HidD_FreePreparsedData(pp_data); +err: + free_hid_device(dev); + return NULL; +} + +int HID_API_EXPORT HID_API_CALL hid_write(hid_device *dev, const unsigned char *data, size_t length) +{ + DWORD bytes_written = 0; + int function_result = -1; + BOOL res; + BOOL overlapped = FALSE; + + unsigned char *buf; + + /* Make sure the right number of bytes are passed to WriteFile. Windows + expects the number of bytes which are in the _longest_ report (plus + one for the report number) bytes even if the data is a report + which is shorter than that. Windows gives us this value in + caps.OutputReportByteLength. If a user passes in fewer bytes than this, + create a temporary buffer which is the proper size. */ + if (length >= dev->output_report_length) { + /* The user passed the right number of bytes. Use the buffer as-is. */ + buf = (unsigned char *) data; + } else { + /* Create a temporary buffer and copy the user's data + into it, padding the rest with zeros. */ + buf = (unsigned char *) malloc(dev->output_report_length); + memcpy(buf, data, length); + memset(buf + length, 0, dev->output_report_length - length); + length = dev->output_report_length; + } + + res = WriteFile(dev->device_handle, buf, (DWORD) length, NULL, &dev->write_ol); + + if (!res) { + if (GetLastError() != ERROR_IO_PENDING) { + /* WriteFile() failed. Return error. */ + register_error(dev, "WriteFile"); + goto end_of_function; + } + overlapped = TRUE; + } + + if (overlapped) { + /* Wait for the transaction to complete. This makes + hid_write() synchronous. */ + res = WaitForSingleObject(dev->write_ol.hEvent, 1000); + if (res != WAIT_OBJECT_0) { + /* There was a Timeout. */ + register_error(dev, "WriteFile/WaitForSingleObject Timeout"); + goto end_of_function; + } + + /* Get the result. */ + res = GetOverlappedResult(dev->device_handle, &dev->write_ol, &bytes_written, FALSE/*wait*/); + if (res) { + function_result = bytes_written; + } + else { + /* The Write operation failed. */ + register_error(dev, "WriteFile"); + goto end_of_function; + } + } + +end_of_function: + if (buf != data) + free(buf); + + return function_result; +} + + +int HID_API_EXPORT HID_API_CALL hid_read_timeout(hid_device *dev, unsigned char *data, size_t length, int milliseconds) +{ + DWORD bytes_read = 0; + size_t copy_len = 0; + BOOL res = FALSE; + BOOL overlapped = FALSE; + + /* Copy the handle for convenience. */ + HANDLE ev = dev->ol.hEvent; + + if (!dev->read_pending) { + /* Start an Overlapped I/O read. */ + dev->read_pending = TRUE; + memset(dev->read_buf, 0, dev->input_report_length); + ResetEvent(ev); + res = ReadFile(dev->device_handle, dev->read_buf, (DWORD) dev->input_report_length, &bytes_read, &dev->ol); + + if (!res) { + if (GetLastError() != ERROR_IO_PENDING) { + /* ReadFile() has failed. + Clean up and return error. */ + CancelIo(dev->device_handle); + dev->read_pending = FALSE; + goto end_of_function; + } + overlapped = TRUE; + } + } + else { + overlapped = TRUE; + } + + if (overlapped) { + if (milliseconds >= 0) { + /* See if there is any data yet. */ + res = WaitForSingleObject(ev, milliseconds); + if (res != WAIT_OBJECT_0) { + /* There was no data this time. Return zero bytes available, + but leave the Overlapped I/O running. */ + return 0; + } + } + + /* Either WaitForSingleObject() told us that ReadFile has completed, or + we are in non-blocking mode. Get the number of bytes read. The actual + data has been copied to the data[] array which was passed to ReadFile(). */ + res = GetOverlappedResult(dev->device_handle, &dev->ol, &bytes_read, TRUE/*wait*/); + } + /* Set pending back to false, even if GetOverlappedResult() returned error. */ + dev->read_pending = FALSE; + + if (res && bytes_read > 0) { + if (dev->read_buf[0] == 0x0) { + /* If report numbers aren't being used, but Windows sticks a report + number (0x0) on the beginning of the report anyway. To make this + work like the other platforms, and to make it work more like the + HID spec, we'll skip over this byte. */ + bytes_read--; + copy_len = length > bytes_read ? bytes_read : length; + memcpy(data, dev->read_buf+1, copy_len); + } + else { + /* Copy the whole buffer, report number and all. */ + copy_len = length > bytes_read ? bytes_read : length; + memcpy(data, dev->read_buf, copy_len); + } + } + +end_of_function: + if (!res) { + register_error(dev, "GetOverlappedResult"); + return -1; + } + + return (int) copy_len; +} + +int HID_API_EXPORT HID_API_CALL hid_read(hid_device *dev, unsigned char *data, size_t length) +{ + return hid_read_timeout(dev, data, length, (dev->blocking)? -1: 0); +} + +int HID_API_EXPORT HID_API_CALL hid_set_nonblocking(hid_device *dev, int nonblock) +{ + dev->blocking = !nonblock; + return 0; /* Success */ +} + +int HID_API_EXPORT HID_API_CALL hid_send_feature_report(hid_device *dev, const unsigned char *data, size_t length) +{ + BOOL res = FALSE; + unsigned char *buf; + size_t length_to_send; + + /* Windows expects at least caps.FeatureReportByteLength bytes passed + to HidD_SetFeature(), even if the report is shorter. Any less sent and + the function fails with error ERROR_INVALID_PARAMETER set. Any more + and HidD_SetFeature() silently truncates the data sent in the report + to caps.FeatureReportByteLength. */ + if (length >= dev->feature_report_length) { + buf = (unsigned char *) data; + length_to_send = length; + } else { + if (dev->feature_buf == NULL) + dev->feature_buf = (unsigned char *) malloc(dev->feature_report_length); + buf = dev->feature_buf; + memcpy(buf, data, length); + memset(buf + length, 0, dev->feature_report_length - length); + length_to_send = dev->feature_report_length; + } + + res = HidD_SetFeature(dev->device_handle, (PVOID)buf, (DWORD) length_to_send); + + if (!res) { + register_error(dev, "HidD_SetFeature"); + return -1; + } + + return (int) length; +} + + +int HID_API_EXPORT HID_API_CALL hid_get_feature_report(hid_device *dev, unsigned char *data, size_t length) +{ + BOOL res; +#if 0 + res = HidD_GetFeature(dev->device_handle, data, length); + if (!res) { + register_error(dev, "HidD_GetFeature"); + return -1; + } + return 0; /* HidD_GetFeature() doesn't give us an actual length, unfortunately */ +#else + DWORD bytes_returned; + + OVERLAPPED ol; + memset(&ol, 0, sizeof(ol)); + + res = DeviceIoControl(dev->device_handle, + IOCTL_HID_GET_FEATURE, + data, (DWORD) length, + data, (DWORD) length, + &bytes_returned, &ol); + + if (!res) { + if (GetLastError() != ERROR_IO_PENDING) { + /* DeviceIoControl() failed. Return error. */ + register_error(dev, "Send Feature Report DeviceIoControl"); + return -1; + } + } + + /* Wait here until the write is done. This makes + hid_get_feature_report() synchronous. */ + res = GetOverlappedResult(dev->device_handle, &ol, &bytes_returned, TRUE/*wait*/); + if (!res) { + /* The operation failed. */ + register_error(dev, "Send Feature Report GetOverLappedResult"); + return -1; + } + + /* bytes_returned does not include the first byte which contains the + report ID. The data buffer actually contains one more byte than + bytes_returned. */ + bytes_returned++; + + return bytes_returned; +#endif +} + + +int HID_API_EXPORT HID_API_CALL hid_get_input_report(hid_device *dev, unsigned char *data, size_t length) +{ + BOOL res; +#if 0 + res = HidD_GetInputReport(dev->device_handle, data, length); + if (!res) { + register_error(dev, "HidD_GetInputReport"); + return -1; + } + return length; +#else + DWORD bytes_returned; + + OVERLAPPED ol; + memset(&ol, 0, sizeof(ol)); + + res = DeviceIoControl(dev->device_handle, + IOCTL_HID_GET_INPUT_REPORT, + data, (DWORD) length, + data, (DWORD) length, + &bytes_returned, &ol); + + if (!res) { + if (GetLastError() != ERROR_IO_PENDING) { + /* DeviceIoControl() failed. Return error. */ + register_error(dev, "Send Input Report DeviceIoControl"); + return -1; + } + } + + /* Wait here until the write is done. This makes + hid_get_feature_report() synchronous. */ + res = GetOverlappedResult(dev->device_handle, &ol, &bytes_returned, TRUE/*wait*/); + if (!res) { + /* The operation failed. */ + register_error(dev, "Send Input Report GetOverLappedResult"); + return -1; + } + + /* bytes_returned does not include the first byte which contains the + report ID. The data buffer actually contains one more byte than + bytes_returned. */ + bytes_returned++; + + return bytes_returned; +#endif +} + +void HID_API_EXPORT HID_API_CALL hid_close(hid_device *dev) +{ + if (!dev) + return; + CancelIo(dev->device_handle); + free_hid_device(dev); +} + +int HID_API_EXPORT_CALL HID_API_CALL hid_get_manufacturer_string(hid_device *dev, wchar_t *string, size_t maxlen) +{ + BOOL res; + + res = HidD_GetManufacturerString(dev->device_handle, string, sizeof(wchar_t) * (DWORD) MIN(maxlen, MAX_STRING_WCHARS)); + if (!res) { + register_error(dev, "HidD_GetManufacturerString"); + return -1; + } + + return 0; +} + +int HID_API_EXPORT_CALL HID_API_CALL hid_get_product_string(hid_device *dev, wchar_t *string, size_t maxlen) +{ + BOOL res; + + res = HidD_GetProductString(dev->device_handle, string, sizeof(wchar_t) * (DWORD) MIN(maxlen, MAX_STRING_WCHARS)); + if (!res) { + register_error(dev, "HidD_GetProductString"); + return -1; + } + + return 0; +} + +int HID_API_EXPORT_CALL HID_API_CALL hid_get_serial_number_string(hid_device *dev, wchar_t *string, size_t maxlen) +{ + BOOL res; + + res = HidD_GetSerialNumberString(dev->device_handle, string, sizeof(wchar_t) * (DWORD) MIN(maxlen, MAX_STRING_WCHARS)); + if (!res) { + register_error(dev, "HidD_GetSerialNumberString"); + return -1; + } + + return 0; +} + +int HID_API_EXPORT_CALL HID_API_CALL hid_get_indexed_string(hid_device *dev, int string_index, wchar_t *string, size_t maxlen) +{ + BOOL res; + + res = HidD_GetIndexedString(dev->device_handle, string_index, string, sizeof(wchar_t) * (DWORD) MIN(maxlen, MAX_STRING_WCHARS)); + if (!res) { + register_error(dev, "HidD_GetIndexedString"); + return -1; + } + + return 0; +} + + +HID_API_EXPORT const wchar_t * HID_API_CALL hid_error(hid_device *dev) +{ + if (dev) { + if (dev->last_error_str == NULL) + return L"Success"; + return (wchar_t*)dev->last_error_str; + } + + // Global error messages are not (yet) implemented on Windows. + return L"hid_error for global errors is not implemented yet"; +} + + +/*#define PICPGM*/ +/*#define S11*/ +#define P32 +#ifdef S11 + unsigned short VendorID = 0xa0a0; + unsigned short ProductID = 0x0001; +#endif + +#ifdef P32 + unsigned short VendorID = 0x04d8; + unsigned short ProductID = 0x3f; +#endif + + +#ifdef PICPGM + unsigned short VendorID = 0x04d8; + unsigned short ProductID = 0x0033; +#endif + + +#if 0 +int __cdecl main(int argc, char* argv[]) +{ + int res; + unsigned char buf[65]; + + UNREFERENCED_PARAMETER(argc); + UNREFERENCED_PARAMETER(argv); + + /* Set up the command buffer. */ + memset(buf,0x00,sizeof(buf)); + buf[0] = 0; + buf[1] = 0x81; + + + /* Open the device. */ + int handle = open(VendorID, ProductID, L"12345"); + if (handle < 0) + printf("unable to open device\n"); + + + /* Toggle LED (cmd 0x80) */ + buf[1] = 0x80; + res = write(handle, buf, 65); + if (res < 0) + printf("Unable to write()\n"); + + /* Request state (cmd 0x81) */ + buf[1] = 0x81; + write(handle, buf, 65); + if (res < 0) + printf("Unable to write() (2)\n"); + + /* Read requested state */ + read(handle, buf, 65); + if (res < 0) + printf("Unable to read()\n"); + + /* Print out the returned buffer. */ + for (int i = 0; i < 4; i++) + printf("buf[%d]: %d\n", i, buf[i]); + + return 0; +} +#endif + +#ifdef __cplusplus +} /* extern "C" */ +#endif diff --git a/external/hidapi/hidapi.h b/external/hidapi/hidapi.h new file mode 100644 index 00000000..efba3188 --- /dev/null +++ b/external/hidapi/hidapi.h @@ -0,0 +1,498 @@ +/******************************************************* + HIDAPI - Multi-Platform library for + communication with HID devices. + + Alan Ott + Signal 11 Software + + 8/22/2009 + + Copyright 2009, All Rights Reserved. + + At the discretion of the user of this library, + this software may be licensed under the terms of the + GNU General Public License v3, a BSD-Style license, or the + original HIDAPI license as outlined in the LICENSE.txt, + LICENSE-gpl3.txt, LICENSE-bsd.txt, and LICENSE-orig.txt + files located at the root of the source distribution. + These files may also be found in the public source + code repository located at: + https://github.com/libusb/hidapi . +********************************************************/ + +/** @file + * @defgroup API hidapi API + */ + +#ifndef HIDAPI_H__ +#define HIDAPI_H__ + +#include + +#ifdef _WIN32 + #define HID_API_EXPORT __declspec(dllexport) + #define HID_API_CALL +#else + #define HID_API_EXPORT /**< API export macro */ + #define HID_API_CALL /**< API call macro */ +#endif + +#define HID_API_EXPORT_CALL HID_API_EXPORT HID_API_CALL /**< API export and call macro*/ + +/** @brief Static/compile-time major version of the library. + + @ingroup API +*/ +#define HID_API_VERSION_MAJOR 0 +/** @brief Static/compile-time minor version of the library. + + @ingroup API +*/ +#define HID_API_VERSION_MINOR 10 +/** @brief Static/compile-time patch version of the library. + + @ingroup API +*/ +#define HID_API_VERSION_PATCH 1 + +/* Helper macros */ +#define HID_API_AS_STR_IMPL(x) #x +#define HID_API_AS_STR(x) HID_API_AS_STR_IMPL(x) +#define HID_API_TO_VERSION_STR(v1, v2, v3) HID_API_AS_STR(v1.v2.v3) + +/** @brief Static/compile-time string version of the library. + + @ingroup API +*/ +#define HID_API_VERSION_STR HID_API_TO_VERSION_STR(HID_API_VERSION_MAJOR, HID_API_VERSION_MINOR, HID_API_VERSION_PATCH) + +#ifdef __cplusplus +extern "C" { +#endif + struct hid_api_version { + int major; + int minor; + int patch; + }; + + struct hid_device_; + typedef struct hid_device_ hid_device; /**< opaque hidapi structure */ + + /** hidapi info structure */ + struct hid_device_info { + /** Platform-specific device path */ + char *path; + /** Device Vendor ID */ + unsigned short vendor_id; + /** Device Product ID */ + unsigned short product_id; + /** Serial Number */ + wchar_t *serial_number; + /** Device Release Number in binary-coded decimal, + also known as Device Version Number */ + unsigned short release_number; + /** Manufacturer String */ + wchar_t *manufacturer_string; + /** Product string */ + wchar_t *product_string; + /** Usage Page for this Device/Interface + (Windows/Mac/hidraw only) */ + unsigned short usage_page; + /** Usage for this Device/Interface + (Windows/Mac/hidraw only) */ + unsigned short usage; + /** The USB interface which this logical device + represents. + + * Valid on both Linux implementations in all cases. + * Valid on the Windows implementation only if the device + contains more than one interface. + * Valid on the Mac implementation if and only if the device + is a USB HID device. */ + int interface_number; + + /** Pointer to the next device */ + struct hid_device_info *next; + }; + + + /** @brief Initialize the HIDAPI library. + + This function initializes the HIDAPI library. Calling it is not + strictly necessary, as it will be called automatically by + hid_enumerate() and any of the hid_open_*() functions if it is + needed. This function should be called at the beginning of + execution however, if there is a chance of HIDAPI handles + being opened by different threads simultaneously. + + @ingroup API + + @returns + This function returns 0 on success and -1 on error. + */ + int HID_API_EXPORT HID_API_CALL hid_init(void); + + /** @brief Finalize the HIDAPI library. + + This function frees all of the static data associated with + HIDAPI. It should be called at the end of execution to avoid + memory leaks. + + @ingroup API + + @returns + This function returns 0 on success and -1 on error. + */ + int HID_API_EXPORT HID_API_CALL hid_exit(void); + + /** @brief Enumerate the HID Devices. + + This function returns a linked list of all the HID devices + attached to the system which match vendor_id and product_id. + If @p vendor_id is set to 0 then any vendor matches. + If @p product_id is set to 0 then any product matches. + If @p vendor_id and @p product_id are both set to 0, then + all HID devices will be returned. + + @ingroup API + @param vendor_id The Vendor ID (VID) of the types of device + to open. + @param product_id The Product ID (PID) of the types of + device to open. + + @returns + This function returns a pointer to a linked list of type + struct #hid_device_info, containing information about the HID devices + attached to the system, or NULL in the case of failure. Free + this linked list by calling hid_free_enumeration(). + */ + struct hid_device_info HID_API_EXPORT * HID_API_CALL hid_enumerate(unsigned short vendor_id, unsigned short product_id); + + /** @brief Free an enumeration Linked List + + This function frees a linked list created by hid_enumerate(). + + @ingroup API + @param devs Pointer to a list of struct_device returned from + hid_enumerate(). + */ + void HID_API_EXPORT HID_API_CALL hid_free_enumeration(struct hid_device_info *devs); + + /** @brief Open a HID device using a Vendor ID (VID), Product ID + (PID) and optionally a serial number. + + If @p serial_number is NULL, the first device with the + specified VID and PID is opened. + + This function sets the return value of hid_error(). + + @ingroup API + @param vendor_id The Vendor ID (VID) of the device to open. + @param product_id The Product ID (PID) of the device to open. + @param serial_number The Serial Number of the device to open + (Optionally NULL). + + @returns + This function returns a pointer to a #hid_device object on + success or NULL on failure. + */ + HID_API_EXPORT hid_device * HID_API_CALL hid_open(unsigned short vendor_id, unsigned short product_id, const wchar_t *serial_number); + + /** @brief Open a HID device by its path name. + + The path name be determined by calling hid_enumerate(), or a + platform-specific path name can be used (eg: /dev/hidraw0 on + Linux). + + This function sets the return value of hid_error(). + + @ingroup API + @param path The path name of the device to open + + @returns + This function returns a pointer to a #hid_device object on + success or NULL on failure. + */ + HID_API_EXPORT hid_device * HID_API_CALL hid_open_path(const char *path); + + /** @brief Write an Output report to a HID device. + + The first byte of @p data[] must contain the Report ID. For + devices which only support a single report, this must be set + to 0x0. The remaining bytes contain the report data. Since + the Report ID is mandatory, calls to hid_write() will always + contain one more byte than the report contains. For example, + if a hid report is 16 bytes long, 17 bytes must be passed to + hid_write(), the Report ID (or 0x0, for devices with a + single report), followed by the report data (16 bytes). In + this example, the length passed in would be 17. + + hid_write() will send the data on the first OUT endpoint, if + one exists. If it does not, it will send the data through + the Control Endpoint (Endpoint 0). + + This function sets the return value of hid_error(). + + @ingroup API + @param dev A device handle returned from hid_open(). + @param data The data to send, including the report number as + the first byte. + @param length The length in bytes of the data to send. + + @returns + This function returns the actual number of bytes written and + -1 on error. + */ + int HID_API_EXPORT HID_API_CALL hid_write(hid_device *dev, const unsigned char *data, size_t length); + + /** @brief Read an Input report from a HID device with timeout. + + Input reports are returned + to the host through the INTERRUPT IN endpoint. The first byte will + contain the Report number if the device uses numbered reports. + + This function sets the return value of hid_error(). + + @ingroup API + @param dev A device handle returned from hid_open(). + @param data A buffer to put the read data into. + @param length The number of bytes to read. For devices with + multiple reports, make sure to read an extra byte for + the report number. + @param milliseconds timeout in milliseconds or -1 for blocking wait. + + @returns + This function returns the actual number of bytes read and + -1 on error. If no packet was available to be read within + the timeout period, this function returns 0. + */ + int HID_API_EXPORT HID_API_CALL hid_read_timeout(hid_device *dev, unsigned char *data, size_t length, int milliseconds); + + /** @brief Read an Input report from a HID device. + + Input reports are returned + to the host through the INTERRUPT IN endpoint. The first byte will + contain the Report number if the device uses numbered reports. + + This function sets the return value of hid_error(). + + @ingroup API + @param dev A device handle returned from hid_open(). + @param data A buffer to put the read data into. + @param length The number of bytes to read. For devices with + multiple reports, make sure to read an extra byte for + the report number. + + @returns + This function returns the actual number of bytes read and + -1 on error. If no packet was available to be read and + the handle is in non-blocking mode, this function returns 0. + */ + int HID_API_EXPORT HID_API_CALL hid_read(hid_device *dev, unsigned char *data, size_t length); + + /** @brief Set the device handle to be non-blocking. + + In non-blocking mode calls to hid_read() will return + immediately with a value of 0 if there is no data to be + read. In blocking mode, hid_read() will wait (block) until + there is data to read before returning. + + Nonblocking can be turned on and off at any time. + + @ingroup API + @param dev A device handle returned from hid_open(). + @param nonblock enable or not the nonblocking reads + - 1 to enable nonblocking + - 0 to disable nonblocking. + + @returns + This function returns 0 on success and -1 on error. + */ + int HID_API_EXPORT HID_API_CALL hid_set_nonblocking(hid_device *dev, int nonblock); + + /** @brief Send a Feature report to the device. + + Feature reports are sent over the Control endpoint as a + Set_Report transfer. The first byte of @p data[] must + contain the Report ID. For devices which only support a + single report, this must be set to 0x0. The remaining bytes + contain the report data. Since the Report ID is mandatory, + calls to hid_send_feature_report() will always contain one + more byte than the report contains. For example, if a hid + report is 16 bytes long, 17 bytes must be passed to + hid_send_feature_report(): the Report ID (or 0x0, for + devices which do not use numbered reports), followed by the + report data (16 bytes). In this example, the length passed + in would be 17. + + This function sets the return value of hid_error(). + + @ingroup API + @param dev A device handle returned from hid_open(). + @param data The data to send, including the report number as + the first byte. + @param length The length in bytes of the data to send, including + the report number. + + @returns + This function returns the actual number of bytes written and + -1 on error. + */ + int HID_API_EXPORT HID_API_CALL hid_send_feature_report(hid_device *dev, const unsigned char *data, size_t length); + + /** @brief Get a feature report from a HID device. + + Set the first byte of @p data[] to the Report ID of the + report to be read. Make sure to allow space for this + extra byte in @p data[]. Upon return, the first byte will + still contain the Report ID, and the report data will + start in data[1]. + + This function sets the return value of hid_error(). + + @ingroup API + @param dev A device handle returned from hid_open(). + @param data A buffer to put the read data into, including + the Report ID. Set the first byte of @p data[] to the + Report ID of the report to be read, or set it to zero + if your device does not use numbered reports. + @param length The number of bytes to read, including an + extra byte for the report ID. The buffer can be longer + than the actual report. + + @returns + This function returns the number of bytes read plus + one for the report ID (which is still in the first + byte), or -1 on error. + */ + int HID_API_EXPORT HID_API_CALL hid_get_feature_report(hid_device *dev, unsigned char *data, size_t length); + + /** @brief Get a input report from a HID device. + + Set the first byte of @p data[] to the Report ID of the + report to be read. Make sure to allow space for this + extra byte in @p data[]. Upon return, the first byte will + still contain the Report ID, and the report data will + start in data[1]. + + @ingroup API + @param device A device handle returned from hid_open(). + @param data A buffer to put the read data into, including + the Report ID. Set the first byte of @p data[] to the + Report ID of the report to be read, or set it to zero + if your device does not use numbered reports. + @param length The number of bytes to read, including an + extra byte for the report ID. The buffer can be longer + than the actual report. + + @returns + This function returns the number of bytes read plus + one for the report ID (which is still in the first + byte), or -1 on error. + */ + int HID_API_EXPORT HID_API_CALL hid_get_input_report(hid_device *dev, unsigned char *data, size_t length); + + /** @brief Close a HID device. + + This function sets the return value of hid_error(). + + @ingroup API + @param dev A device handle returned from hid_open(). + */ + void HID_API_EXPORT HID_API_CALL hid_close(hid_device *dev); + + /** @brief Get The Manufacturer String from a HID device. + + @ingroup API + @param dev A device handle returned from hid_open(). + @param string A wide string buffer to put the data into. + @param maxlen The length of the buffer in multiples of wchar_t. + + @returns + This function returns 0 on success and -1 on error. + */ + int HID_API_EXPORT_CALL hid_get_manufacturer_string(hid_device *dev, wchar_t *string, size_t maxlen); + + /** @brief Get The Product String from a HID device. + + @ingroup API + @param dev A device handle returned from hid_open(). + @param string A wide string buffer to put the data into. + @param maxlen The length of the buffer in multiples of wchar_t. + + @returns + This function returns 0 on success and -1 on error. + */ + int HID_API_EXPORT_CALL hid_get_product_string(hid_device *dev, wchar_t *string, size_t maxlen); + + /** @brief Get The Serial Number String from a HID device. + + @ingroup API + @param dev A device handle returned from hid_open(). + @param string A wide string buffer to put the data into. + @param maxlen The length of the buffer in multiples of wchar_t. + + @returns + This function returns 0 on success and -1 on error. + */ + int HID_API_EXPORT_CALL hid_get_serial_number_string(hid_device *dev, wchar_t *string, size_t maxlen); + + /** @brief Get a string from a HID device, based on its string index. + + @ingroup API + @param dev A device handle returned from hid_open(). + @param string_index The index of the string to get. + @param string A wide string buffer to put the data into. + @param maxlen The length of the buffer in multiples of wchar_t. + + @returns + This function returns 0 on success and -1 on error. + */ + int HID_API_EXPORT_CALL hid_get_indexed_string(hid_device *dev, int string_index, wchar_t *string, size_t maxlen); + + /** @brief Get a string describing the last error which occurred. + + Whether a function sets the last error is noted in its + documentation. These functions will reset the last error + to NULL before their execution. + + Strings returned from hid_error() must not be freed by the user! + + This function is thread-safe, and error messages are thread-local. + + @ingroup API + @param dev A device handle returned from hid_open(), + or NULL to get the last non-device-specific error + (e.g. for errors in hid_open() itself). + + @returns + This function returns a string containing the last error + which occurred or NULL if none has occurred. + */ + HID_API_EXPORT const wchar_t* HID_API_CALL hid_error(hid_device *dev); + + /** @brief Get a runtime version of the library. + + @ingroup API + + @returns + Pointer to statically allocated struct, that contains version. + */ + HID_API_EXPORT const struct hid_api_version* HID_API_CALL hid_version(void); + + + /** @brief Get a runtime version string of the library. + + @ingroup API + + @returns + Pointer to statically allocated string, that contains version string. + */ + HID_API_EXPORT const char* HID_API_CALL hid_version_str(void); + +#ifdef __cplusplus +} +#endif + +#endif + diff --git a/external/misc/CMakeLists.txt b/external/misc/CMakeLists.txt new file mode 100644 index 00000000..685b89ad --- /dev/null +++ b/external/misc/CMakeLists.txt @@ -0,0 +1,73 @@ + +set(MISC_LIBRARIES misc CACHE INTERNAL "misc") + +include_directories( + ${CMAKE_SOURCE_DIR}/src + ) + +if(LINUX) +# Previously - +# list(APPEND misc_SOURCES +# # Provide our own copy of strlcpy and strlcat +# # because they are not included with Linux. +# ${CUSTOM_MISC_DIR}/strlcpy.c +# ${CUSTOM_MISC_DIR}/strlcat.c +# ) +# It seems that Alpine Linux and Void Linux have strlcpy and +# strlcat so we need to handle the situation more delicately. +# When doing it this way, there is probably no reason to +# distinguish between Linux and BSD-like systems here. +# If we kept going, the same thing could be done for each +# of the functions and no OS check would be needed. + + if (NOT HAVE_STRLCPY) + list(APPEND misc_SOURCES + ${CUSTOM_MISC_DIR}/strlcpy.c + ) + endif() + + if (NOT HAVE_STRLCAT) + list(APPEND misc_SOURCES + ${CUSTOM_MISC_DIR}/strlcat.c + ) + endif() + + # Add_library doesn't like to get an empty source file list. + # I tried several variations on this theme to test whether the list + # was not empty and was not successful in getting it to work + # on both Alpine and RPi. + #if("${misc_SOURCES}") + # This is less elegant and less maintainable but it works. + + if ((NOT HAVE_STRLCPY) OR (NOT HAVE_STRLCAT)) + add_library(misc STATIC + ${misc_SOURCES} + ) + else() + set(MISC_LIBRARIES "" CACHE INTERNAL "") + endif() + + + +elseif(WIN32 OR CYGWIN) # windows + + list(APPEND misc_SOURCES + # There are several string functions found in Linux + # but not on Windows. Need to provide our own copy. + ${CUSTOM_MISC_DIR}/strsep.c + ${CUSTOM_MISC_DIR}/strtok_r.c + ${CUSTOM_MISC_DIR}/strcasestr.c + ${CUSTOM_MISC_DIR}/strlcpy.c + ${CUSTOM_MISC_DIR}/strlcat.c + ) + + add_library(misc STATIC + ${misc_SOURCES} + ) + +else() + + # on macOS, OpenBSD and FreeBSD not misc is necessary + set(MISC_LIBRARIES "" CACHE INTERNAL "") + +endif() diff --git a/external/misc/README b/external/misc/README new file mode 100644 index 00000000..f69c05aa --- /dev/null +++ b/external/misc/README @@ -0,0 +1,27 @@ + +Files in this directory fill in the gaps missing for some operating systems. + + +-------------------------------------- + +These are part of the standard C library for Linux, BSD Unix, and similar operating systems. +They are not present for MS Windows so we need to supply our own copy. + +From http://ftp.netbsd.org/pub/pkgsrc/current/pkgsrc/net/tnftp/files/libnetbsd/strsep.c +and other BSD locations. + + strsep.c + strcasestr.c + strtok_r.c + +-------------------------------------- + + +These are needed for the Linux and Windows versions. +They should be part of the standard C library for OpenBSD, FreeBSD, Mac OS X. + +http://ftp.netbsd.org/pub/pkgsrc/current/pkgsrc/net/tnftp/files/libnetbsd/strlcpy.c +http://ftp.netbsd.org/pub/pkgsrc/current/pkgsrc/net/tnftp/files/libnetbsd/strlcat.c + + strlcpy.c + strlcat.c \ No newline at end of file diff --git a/misc/strcasestr.c b/external/misc/strcasestr.c similarity index 98% rename from misc/strcasestr.c rename to external/misc/strcasestr.c index a418549d..c684db85 100644 --- a/misc/strcasestr.c +++ b/external/misc/strcasestr.c @@ -43,8 +43,7 @@ * Find the first occurrence of find in s, ignore case. */ char * -strcasestr(s, find) - const char *s, *find; +strcasestr(const char *s, const char *find) { char c, sc; size_t len; diff --git a/external/misc/strlcat.c b/external/misc/strlcat.c new file mode 100644 index 00000000..87f9c424 --- /dev/null +++ b/external/misc/strlcat.c @@ -0,0 +1,127 @@ + + +/*------------------------------------------------------------------ + * + * Module: strlcat.c + * + * Purpose: Safe string functions to guard against buffer overflow. + * + * Description: The size of character strings, especially when coming from the + * outside, can sometimes exceed a fixed size storage area. + * + * There was one case where a MIC-E format packet had an enormous + * comment that exceeded an internal buffer of 256 characters, + * resulting in a crash. + * + * We are not always meticulous about checking sizes to avoid overflow. + * Use of these functions, instead of strcpy and strcat, should + * help avoid issues. + * + * Orgin: From OpenBSD as the copyright notice indicates. + * The GNU folks didn't think it was appropriate for inclusion + * in glibc. https://lwn.net/Articles/507319/ + * + * Modifications: Added extra debug output when strings are truncated. + * Not sure if I will leave this in the release version + * or just let it happen silently. + * + *---------------------------------------------------------------*/ + +#include "direwolf.h" + +#include +#include + +#include "textcolor.h" + + +/* $NetBSD: strlcat.c,v 1.5 2014/10/31 18:59:32 spz Exp $ */ +/* from NetBSD: strlcat.c,v 1.16 2003/10/27 00:12:42 lukem Exp */ +/* from OpenBSD: strlcat.c,v 1.10 2003/04/12 21:56:39 millert Exp */ + +/* + * Copyright (c) 1998 Todd C. Miller + * + * Permission to use, copy, modify, and distribute this software for any + * purpose with or without fee is hereby granted, provided that the above + * copyright notice and this permission notice appear in all copies. + * + * THE SOFTWARE IS PROVIDED "AS IS" AND TODD C. MILLER DISCLAIMS ALL + * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL TODD C. MILLER BE LIABLE + * FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES + * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION + * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN + * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. + */ + + + +/* + * Appends src to string dst of size siz (unlike strncat, siz is the + * full size of dst, not space left). At most siz-1 characters + * will be copied. Always NUL terminates (unless siz <= strlen(dst)). + * Returns strlen(src) + MIN(siz, strlen(initial dst)). + * If retval >= siz, truncation occurred. + */ + +#if DEBUG_STRL +size_t strlcat_debug(char *__restrict__ dst, const char *__restrict__ src, size_t siz, const char *file, const char *func, int line) +#else +size_t strlcat_debug(char *__restrict__ dst, const char *__restrict__ src, size_t siz) +#endif +{ + char *d = dst; + const char *s = src; + size_t n = siz; + size_t dlen; + size_t retval; + +#if DEBUG_STRL + if (dst == NULL) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("ERROR: strlcat dst is NULL. (%s %s %d)\n", file, func, line); + return (0); + } + if (src == NULL) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("ERROR: strlcat src is NULL. (%s %s %d)\n", file, func, line); + return (0); + } + if (siz == 1 || siz == 4) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("Suspicious strlcat siz. Is it using sizeof a pointer variable? (%s %s %d)\n", file, func, line); + } +#endif + + /* Find the end of dst and adjust bytes left but don't go past end */ + while (n-- != 0 && *d != '\0') + d++; + dlen = d - dst; + n = siz - dlen; + + if (n == 0) { + retval = dlen + strlen(s); + goto the_end; + } + while (*s != '\0') { + if (n != 1) { + *d++ = *s; + n--; + } + s++; + } + *d = '\0'; + + retval = dlen + (s - src); /* count does not include NUL */ +the_end: + +#if DEBUG_STRL + if (retval >= siz) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("WARNING: strlcat result length %d exceeds maximum length %d. (%s %s %d)\n", + (int)retval, (int)(siz-1), file, func, line); + } +#endif + return (retval); +} \ No newline at end of file diff --git a/external/misc/strlcpy.c b/external/misc/strlcpy.c new file mode 100644 index 00000000..ff188001 --- /dev/null +++ b/external/misc/strlcpy.c @@ -0,0 +1,120 @@ + + +/*------------------------------------------------------------------ + * + * Module: strlcpy.c + * + * Purpose: Safe string functions to guard against buffer overflow. + * + * Description: The size of character strings, especially when coming from the + * outside, can sometimes exceed a fixed size storage area. + * + * There was one case where a MIC-E format packet had an enormous + * comment that exceeded an internal buffer of 256 characters, + * resulting in a crash. + * + * We are not always meticulous about checking sizes to avoid overflow. + * Use of these functions, instead of strcpy and strcat, should + * help avoid issues. + * + * Orgin: From OpenBSD as the copyright notice indicates. + * The GNU folks didn't think it was appropriate for inclusion + * in glibc. https://lwn.net/Articles/507319/ + * + * Modifications: Added extra debug output when strings are truncated. + * Not sure if I will leave this in the release version + * or just let it happen silently. + * + *---------------------------------------------------------------*/ + + + +/* $NetBSD: strlcpy.c,v 1.5 2014/10/31 18:59:32 spz Exp $ */ +/* from NetBSD: strlcpy.c,v 1.14 2003/10/27 00:12:42 lukem Exp */ +/* from OpenBSD: strlcpy.c,v 1.7 2003/04/12 21:56:39 millert Exp */ + +/* + * Copyright (c) 1998 Todd C. Miller + * + * Permission to use, copy, modify, and distribute this software for any + * purpose with or without fee is hereby granted, provided that the above + * copyright notice and this permission notice appear in all copies. + * + * THE SOFTWARE IS PROVIDED "AS IS" AND TODD C. MILLER DISCLAIMS ALL + * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL TODD C. MILLER BE LIABLE + * FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES + * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION + * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN + * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. + */ + +#include "direwolf.h" + +#include +#include + +#include "textcolor.h" + +/* + * Copy src to string dst of size siz. At most siz-1 characters + * will be copied. Always NUL terminates (unless siz == 0). + * Returns strlen(src); if retval >= siz, truncation occurred. + */ + +#if DEBUG_STRL +size_t strlcpy_debug(char *__restrict__ dst, const char *__restrict__ src, size_t siz, const char *file, const char *func, int line) +#else +size_t strlcpy_debug(char *__restrict__ dst, const char *__restrict__ src, size_t siz) +#endif +{ + char *d = dst; + const char *s = src; + size_t n = siz; + size_t retval; + +#if DEBUG_STRL + if (dst == NULL) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("ERROR: strlcpy dst is NULL. (%s %s %d)\n", file, func, line); + return (0); + } + if (src == NULL) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("ERROR: strlcpy src is NULL. (%s %s %d)\n", file, func, line); + return (0); + } + if (siz == 1 || siz == 4) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("Suspicious strlcpy siz. Is it using sizeof a pointer variable? (%s %s %d)\n", file, func, line); + } +#endif + + /* Copy as many bytes as will fit */ + if (n != 0 && --n != 0) { + do { + if ((*d++ = *s++) == 0) + break; + } while (--n != 0); + } + + /* Not enough room in dst, add NUL and traverse rest of src */ + if (n == 0) { + if (siz != 0) + *d = '\0'; /* NUL-terminate dst */ + while (*s++) + ; + } + + retval = s - src - 1; /* count does not include NUL */ + +#if DEBUG_STRL + if (retval >= siz) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("WARNING: strlcpy result length %d exceeds maximum length %d. (%s %s %d)\n", + (int)retval, (int)(siz-1), file, func, line); + } +#endif + return (retval); +} + diff --git a/external/misc/strsep.c b/external/misc/strsep.c new file mode 100644 index 00000000..a3338151 --- /dev/null +++ b/external/misc/strsep.c @@ -0,0 +1,72 @@ +/* $NetBSD: strsep.c,v 1.5 2014/10/31 18:59:32 spz Exp $ */ +/* from NetBSD: strsep.c,v 1.14 2003/08/07 16:43:52 agc Exp */ + +/*- + * Copyright (c) 1990, 1993 + * The Regents of the University of California. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. Neither the name of the University nor the names of its contributors + * may be used to endorse or promote products derived from this software + * without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + */ + +//#include "tnftp.h" +#include + +/* + * Get next token from string *stringp, where tokens are possibly-empty + * strings separated by characters from delim. + * + * Writes NULs into the string at *stringp to end tokens. + * delim need not remain constant from call to call. + * On return, *stringp points past the last NUL written (if there might + * be further tokens), or is NULL (if there are definitely no more tokens). + * + * If *stringp is NULL, strsep returns NULL. + */ +char * +strsep(char **stringp, const char *delim) +{ + char *s; + const char *spanp; + int c, sc; + char *tok; + + if ((s = *stringp) == NULL) + return (NULL); + for (tok = s;;) { + c = *s++; + spanp = delim; + do { + if ((sc = *spanp++) == c) { + if (c == 0) + s = NULL; + else + s[-1] = 0; + *stringp = s; + return (tok); + } + } while (sc != 0); + } + /* NOTREACHED */ +} diff --git a/misc/strtok_r.c b/external/misc/strtok_r.c similarity index 100% rename from misc/strtok_r.c rename to external/misc/strtok_r.c diff --git a/external/regex/CMakeLists.txt b/external/regex/CMakeLists.txt new file mode 100644 index 00000000..76bbf9ba --- /dev/null +++ b/external/regex/CMakeLists.txt @@ -0,0 +1,24 @@ +set(REGEX_LIBRARIES "" CACHE INTERNAL "") + +if(WIN32 OR CYGWIN) # windows + + set(REGEX_LIBRARIES regex CACHE INTERNAL "regex") + + list(APPEND regex_SOURCES + # When building for Linux, we use regular expression + # functions supplied by the gnu C library. + # For the native WIN32 version, we need to use our own copy. + # These were copied from http://gnuwin32.sourceforge.net/packages/regex.htm + # Consider upgrading from https://www.gnu.org/software/libc/sources.html + ${CUSTOM_REGEX_DIR}/regex.c + ) + + add_library(regex STATIC + ${regex_SOURCES} + ) + + set_target_properties(regex + PROPERTIES COMPILE_FLAGS "-Dbool=int -Dtrue=1 -Dfalse=0 -DREGEX_STATIC" + ) + +endif() diff --git a/regex/COPYING b/external/regex/COPYING similarity index 100% rename from regex/COPYING rename to external/regex/COPYING diff --git a/regex/INSTALL b/external/regex/INSTALL similarity index 100% rename from regex/INSTALL rename to external/regex/INSTALL diff --git a/regex/LICENSES b/external/regex/LICENSES similarity index 100% rename from regex/LICENSES rename to external/regex/LICENSES diff --git a/regex/NEWS b/external/regex/NEWS similarity index 100% rename from regex/NEWS rename to external/regex/NEWS diff --git a/regex/README b/external/regex/README similarity index 100% rename from regex/README rename to external/regex/README diff --git a/regex/README-dire-wolf.txt b/external/regex/README-dire-wolf.txt similarity index 53% rename from regex/README-dire-wolf.txt rename to external/regex/README-dire-wolf.txt index cc081c49..f8170840 100644 --- a/regex/README-dire-wolf.txt +++ b/external/regex/README-dire-wolf.txt @@ -4,4 +4,8 @@ For the Windows version, we need to include our own version. The source was obtained from: - http://gnuwin32.sourceforge.net/packages/regex.htm \ No newline at end of file + http://gnuwin32.sourceforge.net/packages/regex.htm + +That is very old with loads of compile warnings. Should we upgrade from here? + + https://www.gnu.org/software/libc/sources.html \ No newline at end of file diff --git a/regex/re_comp.h b/external/regex/re_comp.h similarity index 100% rename from regex/re_comp.h rename to external/regex/re_comp.h diff --git a/regex/regcomp.c b/external/regex/regcomp.c similarity index 99% rename from regex/regcomp.c rename to external/regex/regcomp.c index 4cf16882..eb6d7a4e 100644 --- a/regex/regcomp.c +++ b/external/regex/regcomp.c @@ -2510,7 +2510,7 @@ parse_dup_op (bin_tree_t *elem, re_string_t *regexp, re_dfa_t *dfa, old_tree = NULL; if (elem->token.type == SUBEXP) - postorder (elem, mark_opt_subexp, (void *) (long) elem->token.opr.idx); + postorder (elem, mark_opt_subexp, (void *) (ptrdiff_t) elem->token.opr.idx); tree = create_tree (dfa, elem, NULL, (end == -1 ? OP_DUP_ASTERISK : OP_ALT)); if (BE (tree == NULL, 0)) @@ -3036,7 +3036,9 @@ parse_bracket_exp (re_string_t *regexp, re_dfa_t *dfa, re_token_t *token, while (1) { - bracket_elem_t start_elem, end_elem; + // Got warnings about being used uninitialized. + // bracket_elem_t start_elem, end_elem; + bracket_elem_t start_elem = {.type=0, .opr.name=NULL}, end_elem = {.type=0, .opr.name=NULL}; unsigned char start_name_buf[BRACKET_NAME_BUF_SIZE]; unsigned char end_name_buf[BRACKET_NAME_BUF_SIZE]; reg_errcode_t ret; @@ -3723,7 +3725,7 @@ create_token_tree (re_dfa_t *dfa, bin_tree_t *left, bin_tree_t *right, static reg_errcode_t mark_opt_subexp (void *extra, bin_tree_t *node) { - int idx = (int) (long) extra; + int idx = (int) (ptrdiff_t) extra; if (node->token.type == SUBEXP && node->token.opr.idx == idx) node->token.opt_subexp = 1; diff --git a/regex/regex.c b/external/regex/regex.c similarity index 100% rename from regex/regex.c rename to external/regex/regex.c diff --git a/regex/regex.h b/external/regex/regex.h similarity index 98% rename from regex/regex.h rename to external/regex/regex.h index c2a9a4c3..a84f6a99 100644 --- a/regex/regex.h +++ b/external/regex/regex.h @@ -35,17 +35,23 @@ #if (defined __WIN32__) || (defined _WIN32) # ifdef BUILD_REGEX_DLL # define REGEX_DLL_IMPEXP __DLL_EXPORT__ +# define REGEX_VARIABLE_IMPEXP __DLL_EXPORT__ # elif defined(REGEX_STATIC) # define REGEX_DLL_IMPEXP +# define REGEX_VARIABLE_IMPEXP # elif defined (USE_REGEX_DLL) # define REGEX_DLL_IMPEXP __DLL_IMPORT__ +# define REGEX_VARIABLE_IMPEXP __DLL_IMPORT__ # elif defined (USE_REGEX_STATIC) # define REGEX_DLL_IMPEXP +# define REGEX_VARIABLE_IMPEXP extern # else /* assume USE_REGEX_DLL */ # define REGEX_DLL_IMPEXP __DLL_IMPORT__ +# define REGEX_VARIABLE_IMPEXP __DLL_IMPORT__ # endif #else /* __WIN32__ */ # define REGEX_DLL_IMPEXP +# define REGEX_VARIABLE_IMPEXP #endif /* Allow the use in C++ code. */ @@ -202,7 +208,8 @@ typedef unsigned long int reg_syntax_t; some interfaces). When a regexp is compiled, the syntax used is stored in the pattern buffer, so changing this does not affect already-compiled regexps. */ -REGEX_DLL_IMPEXP reg_syntax_t re_syntax_options; +//REGEX_VARIABLE_IMPEXP reg_syntax_t re_syntax_options; +extern reg_syntax_t re_syntax_options; /* Define combinations of the above bits for the standard possibilities. (The [[[ comments delimit what gets put into the Texinfo file, so diff --git a/regex/regex_internal.c b/external/regex/regex_internal.c similarity index 99% rename from regex/regex_internal.c rename to external/regex/regex_internal.c index 66154e0c..0c11b88f 100644 --- a/regex/regex_internal.c +++ b/external/regex/regex_internal.c @@ -675,9 +675,9 @@ re_string_reconstruct (re_string_t *pstr, int idx, int eflags) else { /* No, skip all characters until IDX. */ +#ifdef RE_ENABLE_I18N int prev_valid_len = pstr->valid_len; -#ifdef RE_ENABLE_I18N if (BE (pstr->offsets_needed, 0)) { pstr->len = pstr->raw_len - idx + offset; @@ -1396,7 +1396,9 @@ static int internal_function re_dfa_add_node (re_dfa_t *dfa, re_token_t token) { +#ifdef RE_ENABLE_I18N int type = token.type; +#endif if (BE (dfa->nodes_len >= dfa->nodes_alloc, 0)) { size_t new_nodes_alloc = dfa->nodes_alloc * 2; diff --git a/regex/regex_internal.h b/external/regex/regex_internal.h similarity index 100% rename from regex/regex_internal.h rename to external/regex/regex_internal.h diff --git a/regex/regexec.c b/external/regex/regexec.c similarity index 99% rename from regex/regexec.c rename to external/regex/regexec.c index 135efe74..a5debc9d 100644 --- a/regex/regexec.c +++ b/external/regex/regexec.c @@ -1,3 +1,9 @@ + +/* this is very old and has massive numbers of compiler warnings. */ +/* Maybe try upgrading to a newer version such as */ +/* https://fossies.org/dox/glibc-2.24/regexec_8c_source.html */ + + /* Extended regular expression matching and search library. Copyright (C) 2002, 2003, 2004, 2005, 2007 Free Software Foundation, Inc. This file is part of the GNU C Library. @@ -18,6 +24,14 @@ Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. */ +/* Added 12/2016 to remove warning: */ +/* incompatible implicit declaration of built-in function 'alloca' */ +#if __WIN32__ +#include +#else +#include +#endif + static reg_errcode_t match_ctx_init (re_match_context_t *cache, int eflags, int n) internal_function; static void match_ctx_clean (re_match_context_t *mctx) internal_function; @@ -228,6 +242,7 @@ regexec (preg, string, nmatch, pmatch, eflags) reg_errcode_t err; int start, length; re_dfa_t *dfa = (re_dfa_t *) preg->buffer; + (void)dfa; if (eflags & ~(REG_NOTBOL | REG_NOTEOL | REG_STARTEND)) return REG_BADPAT; @@ -419,6 +434,7 @@ re_search_stub (bufp, string, length, start, range, stop, regs, ret_len) int nregs, rval; int eflags = 0; re_dfa_t *dfa = (re_dfa_t *) bufp->buffer; + (void)dfa; /* Check for out-of-range. */ if (BE (start < 0 || start > length, 0)) @@ -2894,7 +2910,10 @@ check_arrival (re_match_context_t *mctx, state_array_t *path, int top_node, sizeof (re_dfastate_t *) * (path->alloc - old_alloc)); } - str_idx = path->next_idx ?: top_str; + // Original: + // str_idx = path->next_idx ?: top_str; + // Copied following from another version when cleaning up compiler warnings. + str_idx = path->next_idx ? path->next_idx : top_str; /* Temporary modify MCTX. */ backup_state_log = mctx->state_log; @@ -3032,7 +3051,9 @@ check_arrival_add_next_nodes (re_match_context_t *mctx, int str_idx, const re_dfa_t *const dfa = mctx->dfa; int result; int cur_idx; +#ifdef RE_ENABLE_I18N reg_errcode_t err = REG_NOERROR; +#endif re_node_set union_set; re_node_set_init_empty (&union_set); for (cur_idx = 0; cur_idx < cur_nodes->nelem; ++cur_idx) diff --git a/fsk_demod_agc.h b/fsk_demod_agc.h deleted file mode 100644 index 95c80794..00000000 --- a/fsk_demod_agc.h +++ /dev/null @@ -1,2 +0,0 @@ -#define TUNE_MS_FILTER_SIZE 140 -#define TUNE_PRE_BAUD 1.080 diff --git a/fsk_demod_state.h b/fsk_demod_state.h deleted file mode 100644 index 500bf795..00000000 --- a/fsk_demod_state.h +++ /dev/null @@ -1,216 +0,0 @@ -/* fsk_demod_state.h */ - -#ifndef FSK_DEMOD_STATE_H - -#include "rpack.h" - - -/* - * Demodulator state. - * Different copy is required for each channel & subchannel being processed concurrently. - */ - - -typedef enum bp_window_e { BP_WINDOW_TRUNCATED, - BP_WINDOW_COSINE, - BP_WINDOW_HAMMING, - BP_WINDOW_BLACKMAN, - BP_WINDOW_FLATTOP } bp_window_t; - -struct demodulator_state_s -{ -/* - * These are set once during initialization. - */ - -#define TICKS_PER_PLL_CYCLE ( 256.0 * 256.0 * 256.0 * 256.0 ) - - int pll_step_per_sample; // PLL is advanced by this much each audio sample. - // Data is sampled when it overflows. - - - int ms_filter_size; /* Size of mark & space filters, in audio samples. */ - /* Started off as a guess of one bit length */ - /* but somewhat longer turned out to be better. */ - /* Currently using same size for any prefilter. */ - -#define MAX_FILTER_SIZE 320 /* 304 is needed for profile C, 300 baud & 44100. */ - -/* - * FIR filter length relative to one bit time. - * Use same for both bandpass and lowpass. - */ - float filter_len_bits; - -/* - * Window type for the mark/space filters. - */ - bp_window_t bp_window; - -/* - * Alternate Low pass filters. - * First is arbitrary number for quick IIR. - * Second is frequency as ratio to baud rate for FIR. - */ - int lpf_use_fir; /* 0 for IIR, 1 for FIR. */ - float lpf_iir; - float lpf_baud; - -/* - * Automatic gain control. Fast attack and slow decay factors. - */ - float agc_fast_attack; - float agc_slow_decay; -/* - * Hysteresis before final demodulator 0 / 1 decision. - */ - float hysteresis; - -/* - * Phase Locked Loop (PLL) inertia. - * Larger number means less influence by signal transitions. - */ - float pll_locked_inertia; - float pll_searching_inertia; - - -/* - * Optional band pass pre-filter before mark/space detector. - */ - int use_prefilter; /* True to enable it. */ - - float prefilter_baud; /* Cutoff frequencies, as fraction of */ - /* baud rate, beyond tones used. */ - /* Example, if we used 1600/1800 tones at */ - /* 300 baud, and this was 0.5, the cutoff */ - /* frequencies would be: */ - /* lower = min(1600,1800) - 0.5 * 300 = 1450 */ - /* upper = max(1600,1800) + 0.5 * 300 = 1950 */ - - float pre_filter[MAX_FILTER_SIZE] __attribute__((aligned(16))); - -/* - * Kernel for the mark and space detection filters. - */ - - float m_sin_table[MAX_FILTER_SIZE] __attribute__((aligned(16))); - float m_cos_table[MAX_FILTER_SIZE] __attribute__((aligned(16))); - - float s_sin_table[MAX_FILTER_SIZE] __attribute__((aligned(16))); - float s_cos_table[MAX_FILTER_SIZE] __attribute__((aligned(16))); - -/* - * The rest are continuously updated. - */ - signed int data_clock_pll; // PLL for data clock recovery. - // It is incremented by pll_step_per_sample - // for each audio sample. - - signed int prev_d_c_pll; // Previous value of above, before - // incrementing, to detect overflows. - -/* - * Most recent raw audio samples, before/after prefiltering. - */ - float raw_cb[MAX_FILTER_SIZE] __attribute__((aligned(16))); - -/* - * Input to the mark/space detector. - * Could be prefiltered or raw audio. - */ - float ms_in_cb[MAX_FILTER_SIZE] __attribute__((aligned(16))); - -/* - * Outputs from the mark and space amplitude detection, - * used as inputs to the FIR lowpass filters. - * Kernel for the lowpass filters. - */ - - int lp_filter_size; - - float m_amp_cb[MAX_FILTER_SIZE] __attribute__((aligned(16))); - float s_amp_cb[MAX_FILTER_SIZE] __attribute__((aligned(16))); - - float lp_filter[MAX_FILTER_SIZE] __attribute__((aligned(16))); - - - float m_peak, s_peak; - float m_valley, s_valley; - float m_amp_prev, s_amp_prev; - - int prev_demod_data; // Previous data bit detected. - // Used to look for transitions. - - -/* These are used only for "9600" baud data. */ - - int lfsr; // Descrambler shift register. - - -/* - * Finally, try to come up with some sort of measure of the audio input level. - * Let's try gathering both the peak and average of the - * absolute value of the input signal over some period such as 100 mS. - * - */ - int lev_period; // How many samples go into one measure. - - int lev_count; // Number accumulated so far. - - float lev_peak_acc; // Highest peak so far. - - float lev_sum_acc; // Accumulated sum so far. - -/* - * These will be updated every 'lev_period' samples: - */ - float lev_last_peak; - float lev_last_ave; - float lev_prev_peak; - float lev_prev_ave; - -/* - * Special for Rino decoder only. - * One for each possible signal polarity. - */ - -#if 1 - - struct gr_state_s { - - signed int data_clock_pll; // PLL for data clock recovery. - // It is incremented by pll_step_per_sample - // for each audio sample. - - signed int prev_d_c_pll; // Previous value of above, before - // incrementing, to detect overflows. - - float gr_minus_peak; // For automatic gain control. - float gr_plus_peak; - - int gr_sync; // Is sync pulse present? - int gr_prev_sync; // Previous state to detect leading edge. - - int gr_first_sample; // Index of starting sample index for debugging. - - int gr_dcd; // Data carrier detect. i.e. are we - // currently decoding a message. - - float gr_early_sum; // For averaging bit values in two regions. - int gr_early_count; - float gr_late_sum; - int gr_late_count; - float gr_sync_sum; - int gr_sync_count; - - int gr_bit_count; // Bit index into message. - - struct rpack_s rpack; // Collection of bits. - - } gr_state[2]; -#endif - -}; - -#define FSK_DEMOD_STATE_H 1 -#endif \ No newline at end of file diff --git a/fx25.png b/fx25.png new file mode 100644 index 00000000..33d74a92 Binary files /dev/null and b/fx25.png differ diff --git a/gen_packets.c b/gen_packets.c deleted file mode 100644 index f37665c0..00000000 --- a/gen_packets.c +++ /dev/null @@ -1,729 +0,0 @@ -// -// This file is part of Dire Wolf, an amateur radio packet TNC. -// -// Copyright (C) 2011,2013 John Langner, WB2OSZ -// -// This program 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 2 of the License, or -// (at your option) any later version. -// -// This program 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 this program. If not, see . -// - - -/*------------------------------------------------------------------ - * - * Name: gen_packets.c - * - * Purpose: Test program for generating AFSK AX.25 frames. - * - * Description: Given messages are converted to audio and written - * to a .WAV type audio file. - * - * - * Bugs: Most options not implemented for second audio channel. - * - *------------------------------------------------------------------*/ - - - - -#include -#include -#include -#include -#include - -#include "audio.h" -#include "ax25_pad.h" -#include "hdlc_send.h" -#include "gen_tone.h" -#include "textcolor.h" - - -static void usage (char **argv); -static int audio_file_open (char *fname, struct audio_s *pa); -static int audio_file_close (void); - -static int g_add_noise = 0; -static float g_noise_level = 0; - - - -int main(int argc, char **argv) -{ - int c; - int digit_optind = 0; - int err; - unsigned char fbuf[AX25_MAX_PACKET_LEN+2]; - int flen; - int packet_count = 0; - int i; - int chan; - -/* - * Set up default values for the modem. - */ - struct audio_s modem; - - modem.num_channels = DEFAULT_NUM_CHANNELS; /* -2 stereo */ - modem.samples_per_sec = DEFAULT_SAMPLES_PER_SEC; /* -r option */ - modem.bits_per_sample = DEFAULT_BITS_PER_SAMPLE; /* -8 for 8 instead of 16 bits */ - - for (chan = 0; chan < MAX_CHANS; chan++) { - modem.modem_type[chan] = AFSK; /* change with -g */ - modem.mark_freq[chan] = DEFAULT_MARK_FREQ; /* -m option */ - modem.space_freq[chan] = DEFAULT_SPACE_FREQ; /* -s option */ - modem.baud[chan] = DEFAULT_BAUD; /* -b option */ - } - -/* - * Set up other default values. - */ - int amplitude = 50; /* -a option */ - int leading_zeros = 12; /* -z option */ - char output_file[256]; /* -o option */ - FILE *input_fp = NULL; /* File or NULL for built-in message */ - - packet_t pp; - - - strcpy (output_file, ""); - - - while (1) { - int this_option_optind = optind ? optind : 1; - int option_index = 0; - static struct option long_options[] = { - {"future1", 1, 0, 0}, - {"future2", 0, 0, 0}, - {"future3", 1, 0, 'c'}, - {0, 0, 0, 0} - }; - - /* ':' following option character means arg is required. */ - - c = getopt_long(argc, argv, "gm:s:a:b:B:r:n:o:z:82", - long_options, &option_index); - if (c == -1) - break; - - switch (c) { - - case 0: /* possible future use */ - - text_color_set(DW_COLOR_INFO); - dw_printf("option %s", long_options[option_index].name); - if (optarg) { - dw_printf(" with arg %s", optarg); - } - dw_printf("\n"); - break; - - case 'b': /* -b for data Bit rate */ - - modem.baud[0] = atoi(optarg); - text_color_set(DW_COLOR_INFO); - dw_printf ("Data rate set to %d bits / second.\n", modem.baud[0]); - if (modem.baud[0] < 100 || modem.baud[0] > 10000) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Use a more reasonable bit rate in range of 100 - 10000.\n"); - exit (EXIT_FAILURE); - } - break; - - case 'B': /* -B for data Bit rate */ - /* 300 implies 1600/1800 AFSK. */ - /* 1200 implies 1200/2200 AFSK. */ - /* 9600 implies scrambled. */ - - modem.baud[0] = atoi(optarg); - text_color_set(DW_COLOR_INFO); - dw_printf ("Data rate set to %d bits / second.\n", modem.baud[0]); - if (modem.baud[0] < 100 || modem.baud[0] > 10000) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Use a more reasonable bit rate in range of 100 - 10000.\n"); - exit (EXIT_FAILURE); - } - - switch (modem.baud[0]) { - case 300: - modem.mark_freq[0] = 1600; - modem.space_freq[0] = 1800; - break; - case 1200: - modem.mark_freq[0] = 1200; - modem.space_freq[0] = 2200; - break; - case 9600: - modem.modem_type[0] = SCRAMBLE; - text_color_set(DW_COLOR_INFO); - dw_printf ("Using scrambled baseband signal rather than AFSK.\n"); - break; - } - break; - - case 'g': /* -g for g3ruh scrambling */ - - modem.modem_type[0] = SCRAMBLE; - text_color_set(DW_COLOR_INFO); - dw_printf ("Using scrambled baseband signal rather than AFSK.\n"); - break; - - case 'm': /* -m for Mark freq */ - - modem.mark_freq[0] = atoi(optarg); - text_color_set(DW_COLOR_INFO); - dw_printf ("Mark frequency set to %d Hz.\n", modem.mark_freq[0]); - if (modem.mark_freq[0] < 300 || modem.mark_freq[0] > 3000) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Use a more reasonable value in range of 300 - 3000.\n"); - exit (EXIT_FAILURE); - } - break; - - case 's': /* -s for Space freq */ - - modem.space_freq[0] = atoi(optarg); - text_color_set(DW_COLOR_INFO); - dw_printf ("Space frequency set to %d Hz.\n", modem.space_freq[0]); - if (modem.space_freq[0] < 300 || modem.space_freq[0] > 3000) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Use a more reasonable value in range of 300 - 3000.\n"); - exit (EXIT_FAILURE); - } - break; - - case 'n': /* -n number of packets with increasing noise. */ - - packet_count = atoi(optarg); - - g_add_noise = 1; - - break; - - case 'a': /* -a for amplitude */ - - amplitude = atoi(optarg); - text_color_set(DW_COLOR_INFO); - dw_printf ("Amplitude set to %d%%.\n", amplitude); - if (amplitude < 0 || amplitude > 100) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Amplitude must be in range of 0 to 100.\n"); - exit (EXIT_FAILURE); - } - break; - - case 'r': /* -r for audio sample Rate */ - - modem.samples_per_sec = atoi(optarg); - text_color_set(DW_COLOR_INFO); - dw_printf ("Audio sample rate set to %d samples / second.\n", modem.samples_per_sec); - if (modem.samples_per_sec < MIN_SAMPLES_PER_SEC || modem.samples_per_sec > MAX_SAMPLES_PER_SEC) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Use a more reasonable audio sample rate in range of %d - %d.\n", - MIN_SAMPLES_PER_SEC, MAX_SAMPLES_PER_SEC); - exit (EXIT_FAILURE); - } - break; - - case 'z': /* -z leading zeros before frame flag */ - - leading_zeros = atoi(optarg); - text_color_set(DW_COLOR_INFO); - dw_printf ("Send %d zero bits before frame flag.\n", leading_zeros); - - /* The demodulator needs a few for the clock recovery PLL. */ - /* We don't want to be here all day either. */ - /* We can't translast to time yet because the data bit rate */ - /* could be changed later. */ - - if (leading_zeros < 8 || leading_zeros > 12000) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Use a more reasonable value.\n"); - exit (EXIT_FAILURE); - } - break; - - case '8': /* -8 for 8 bit samples */ - - modem.bits_per_sample = 8; - text_color_set(DW_COLOR_INFO); - dw_printf("8 bits per audio sample rather than 16.\n"); - break; - - case '2': /* -2 for 2 channels of sound */ - - modem.num_channels = 2; - text_color_set(DW_COLOR_INFO); - dw_printf("2 channels of sound rather than 1.\n"); - break; - - case 'o': /* -o for Output file */ - - strcpy (output_file, optarg); - text_color_set(DW_COLOR_INFO); - dw_printf ("Output file set to %s\n", output_file); - break; - - case '?': - - /* Unknown option message was already printed. */ - usage (argv); - break; - - default: - - /* Should not be here. */ - text_color_set(DW_COLOR_ERROR); - dw_printf("?? getopt returned character code 0%o ??\n", c); - usage (argv); - } - } - - if (optind < argc) { - - char str[400]; - - // dw_printf("non-option ARGV-elements: "); - // while (optind < argc) - // dw_printf("%s ", argv[optind++]); - //dw_printf("\n"); - - if (optind < argc - 1) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Warning: File(s) beyond the first are ignored.\n"); - } - - if (strcmp(argv[optind], "-") == 0) { - text_color_set(DW_COLOR_INFO); - dw_printf ("Reading from stdin ...\n"); - input_fp = stdin; - } - else { - input_fp = fopen(argv[optind], "r"); - if (input_fp == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Can't open %s for read.\n", argv[optind]); - exit (EXIT_FAILURE); - } - text_color_set(DW_COLOR_INFO); - dw_printf ("Reading from %s ...\n", argv[optind]); - } - - while (fgets (str, sizeof(str), input_fp) != NULL) { - text_color_set(DW_COLOR_REC); - dw_printf ("%s", str); - } - - if (input_fp != stdin) { - fclose (input_fp); - } - } - else { - text_color_set(DW_COLOR_INFO); - dw_printf ("built in message...\n"); - } - - - if (strlen(output_file) == 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("ERROR: The -o ouput file option must be specified.\n"); - usage (argv); - exit (1); - } - - err = audio_file_open (output_file, &modem); - - - if (err < 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("ERROR - Can't open output file.\n"); - exit (1); - } - - - gen_tone_init (&modem, amplitude); - - assert (modem.bits_per_sample == 8 || modem.bits_per_sample == 16); - assert (modem.num_channels == 1 || modem.num_channels == 2); - assert (modem.samples_per_sec >= MIN_SAMPLES_PER_SEC && modem.samples_per_sec <= MAX_SAMPLES_PER_SEC); - - - if (packet_count > 0) { - -/* - * Generate packets with increasing noise level. - * Would probably be better to record real noise from a radio but - * for now just use a random number generator. - */ - for (i = 1; i <= packet_count; i++) { - - char stemp[80]; - - if (modem.modem_type[0] == SCRAMBLE) { - g_noise_level = 0.33 * (amplitude / 100.0) * ((float)i / packet_count); - } - else { - g_noise_level = (amplitude / 100.0) * ((float)i / packet_count); - } - - sprintf (stemp, "WB2OSZ-1>APRS,W1AB-9,W1ABC-10,WB1ABC-15:,Hello, world! %04d", i); - - pp = ax25_from_text (stemp, 1); - flen = ax25_pack (pp, fbuf); - for (c=0; cAPRS,W1AB-9,W1ABC-10,WB1ABC-15:,Hello, world!", 1); - flen = ax25_pack (pp, fbuf); - for (c=0; cAPRS,W1AB-9*,W1ABC-10,WB1ABC-15:,Hello, world!", 1); - flen = ax25_pack (pp, fbuf); - for (c=0; cAPRS,W1AB-9,W1ABC-10*,WB1ABC-15:,Hello, world!", 1); - flen = ax25_pack (pp, fbuf); - for (c=0; cAPRS,W1AB-9,W1ABC-10,WB1ABC-15*:,Hello, world!", 1); - flen = ax25_pack (pp, fbuf); - for (c=0; c Signal amplitude in range of 0 - 100%%. Default 50.\n"); - dw_printf (" -b Bits / second for data. Default is %d.\n", DEFAULT_BAUD); - dw_printf (" -B Bits / second for data. Proper modem selected for 300, 1200, 9600.\n"); - dw_printf (" -g Scrambled baseband rather than AFSK.\n"); - dw_printf (" -m Mark frequency. Default is %d.\n", DEFAULT_MARK_FREQ); - dw_printf (" -s Space frequency. Default is %d.\n", DEFAULT_SPACE_FREQ); - dw_printf (" -r Audio sample Rate. Default is %d.\n", DEFAULT_SAMPLES_PER_SEC); - dw_printf (" -n Generate specified number of frames with increasing noise.\n"); - dw_printf (" -o Send output to .wav file.\n"); - dw_printf (" -8 8 bit audio rather than 16.\n"); - dw_printf (" -2 2 channels of audio rather than 1.\n"); - dw_printf (" -z Number of leading zero bits before frame.\n"); - dw_printf (" Default is 12 which is .01 seconds at 1200 bits/sec.\n"); - - dw_printf ("\n"); - dw_printf ("An optional file may be specified to provide messages other than\n"); - dw_printf ("the default built-n message. The format should correspond to ...\n"); - dw_printf ("blah blah blah. For example,\n"); - dw_printf (" WB2OSZ-1>APDW10,WIDE2-2:!4237.14NS07120.83W#\n"); - dw_printf ("\n"); - dw_printf ("Example: %s\n", argv[0]); - dw_printf ("\n"); - dw_printf (" With all defaults, a built-in test message is generated\n"); - dw_printf (" with standard Bell 202 tones used for packet radio on ordinary\n"); - dw_printf (" VHF FM transceivers.\n"); - dw_printf ("\n"); - dw_printf ("Example: %s -g -b 9600\n", argv[0]); - dw_printf ("Shortcut: %s -B 9600\n", argv[0]); - dw_printf ("\n"); - dw_printf (" 9600 baud mode.\n"); - dw_printf ("\n"); - dw_printf ("Example: %s -m 1600 -s 1800 -b 300\n", argv[0]); - dw_printf ("Shortcut: %s -B 300\n", argv[0]); - dw_printf ("\n"); - dw_printf (" 200 Hz shift, 300 baud, suitable for HF SSB transceiver.\n"); - dw_printf ("\n"); - dw_printf ("Example: echo -n \"WB2OSZ>WORLD:Hello, world!\" | %s -a 25 -o x.wav -\n", argv[0]); - dw_printf ("\n"); - dw_printf (" Read message from stdin and put quarter volume sound into the file x.wav.\n"); - - exit (EXIT_FAILURE); -} - - - -/*------------------------------------------------------------------ - * - * Name: audio_file_open - * - * Purpose: Open a .WAV format file for output. - * - * Inputs: fname - Name of .WAV file to create. - * - * pa - Address of structure of type audio_s. - * - * The fields that we care about are: - * num_channels - * samples_per_sec - * bits_per_sample - * If zero, reasonable defaults will be provided. - * - * Returns: 0 for success, -1 for failure. - * - *----------------------------------------------------------------*/ - -struct wav_header { /* .WAV file header. */ - char riff[4]; /* "RIFF" */ - int filesize; /* file length - 8 */ - char wave[4]; /* "WAVE" */ - char fmt[4]; /* "fmt " */ - int fmtsize; /* 16. */ - short wformattag; /* 1 for PCM. */ - short nchannels; /* 1 for mono, 2 for stereo. */ - int nsamplespersec; /* sampling freq, Hz. */ - int navgbytespersec; /* = nblockalign * nsamplespersec. */ - short nblockalign; /* = wbitspersample / 8 * nchannels. */ - short wbitspersample; /* 16 or 8. */ - char data[4]; /* "data" */ - int datasize; /* number of bytes following. */ -} ; - - /* 8 bit samples are unsigned bytes */ - /* in range of 0 .. 255. */ - - /* 16 bit samples are signed short */ - /* in range of -32768 .. +32767. */ - -static FILE *out_fp = NULL; - -static struct wav_header header; - -static int byte_count; /* Number of data bytes written to file. */ - /* Will be written to header when file is closed. */ - - -static int audio_file_open (char *fname, struct audio_s *pa) -{ - int n; - -/* - * Fill in defaults for any missing values. - */ - if (pa -> num_channels == 0) - pa -> num_channels = DEFAULT_NUM_CHANNELS; - - if (pa -> samples_per_sec == 0) - pa -> samples_per_sec = DEFAULT_SAMPLES_PER_SEC; - - if (pa -> bits_per_sample == 0) - pa -> bits_per_sample = DEFAULT_BITS_PER_SAMPLE; - - -/* - * Write the file header. Don't know length yet. - */ - out_fp = fopen (fname, "wb"); - - if (out_fp == NULL) { - text_color_set(DW_COLOR_ERROR); dw_printf ("Couldn't open file for write: %s\n", fname); - perror (""); - return (-1); - } - - memset (&header, 0, sizeof(header)); - - memcpy (header.riff, "RIFF", (size_t)4); - header.filesize = 0; - memcpy (header.wave, "WAVE", (size_t)4); - memcpy (header.fmt, "fmt ", (size_t)4); - header.fmtsize = 16; // Always 16. - header.wformattag = 1; // 1 for PCM. - - header.nchannels = pa -> num_channels; - header.nsamplespersec = pa -> samples_per_sec; - header.wbitspersample = pa -> bits_per_sample; - - header.nblockalign = header.wbitspersample / 8 * header.nchannels; - header.navgbytespersec = header.nblockalign * header.nsamplespersec; - memcpy (header.data, "data", (size_t)4); - header.datasize = 0; - - assert (header.nchannels == 1 || header.nchannels == 2); - - n = fwrite (&header, sizeof(header), (size_t)1, out_fp); - - if (n != 1) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Couldn't write header to: %s\n", fname); - perror (""); - fclose (out_fp); - out_fp = NULL; - return (-1); - } - - -/* - * Number of bytes written will be filled in later. - */ - byte_count = 0; - - return (0); - -} /* end audio_open */ - - -/*------------------------------------------------------------------ - * - * Name: audio_put - * - * Purpose: Send one byte to the audio output file. - * - * Inputs: c - One byte in range of 0 - 255. - * - * Returns: Normally non-negative. - * -1 for any type of error. - * - * Description: The caller must deal with the details of mono/stereo - * and number of bytes per sample. - * - *----------------------------------------------------------------*/ - - -int audio_put (int c) -{ - static short sample16; - int s; - - if (g_add_noise) { - - if ((byte_count & 1) == 0) { - sample16 = c & 0xff; /* save lower byte. */ - byte_count++; - return c; - } - else { - float r; - - sample16 |= (c << 8) & 0xff00; /* insert upper byte. */ - byte_count++; - s = sample16; // sign extend. - -/* Add random noise to the signal. */ -/* r should be in range of -1 .. +1. */ - - r = (rand() - RAND_MAX/2.0) / (RAND_MAX/2.0); - - s += 5 * r * g_noise_level * 32767; - - if (s > 32767) s = 32767; - if (s < -32767) s = -32767; - - putc(s & 0xff, out_fp); - return (putc((s >> 8) & 0xff, out_fp)); - } - } - else { - byte_count++; - return (putc(c, out_fp)); - } - -} /* end audio_put */ - - -int audio_flush () -{ - return 0; -} - -/*------------------------------------------------------------------ - * - * Name: audio_file_close - * - * Purpose: Close the audio output file. - * - * Returns: Normally non-negative. - * -1 for any type of error. - * - * - * Description: Must go back to beginning of file and fill in the - * size of the data. - * - *----------------------------------------------------------------*/ - -static int audio_file_close (void) -{ - int n; - - text_color_set(DW_COLOR_DEBUG); - dw_printf ("audio_close()\n"); - -/* - * Go back and fix up lengths in header. - */ - header.filesize = byte_count + sizeof(header) - 8; - header.datasize = byte_count; - - if (out_fp == NULL) { - return (-1); - } - - fflush (out_fp); - - fseek (out_fp, 0L, SEEK_SET); - n = fwrite (&header, sizeof(header), (size_t)1, out_fp); - - if (n != 1) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Couldn't write header to audio file.\n"); - perror (""); // TODO: remove perror. - fclose (out_fp); - out_fp = NULL; - return (-1); - } - - fclose (out_fp); - out_fp = NULL; - - return (0); - -} /* end audio_close */ - diff --git a/gen_tone.c b/gen_tone.c deleted file mode 100644 index 55002046..00000000 --- a/gen_tone.c +++ /dev/null @@ -1,334 +0,0 @@ -// -// This file is part of Dire Wolf, an amateur radio packet TNC. -// -// Copyright (C) 2011 John Langner, WB2OSZ -// -// This program 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 2 of the License, or -// (at your option) any later version. -// -// This program 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 this program. If not, see . -// - - -/*------------------------------------------------------------------ - * - * Module: gen_tone.c - * - * Purpose: Convert bits to AFSK for writing to .WAV sound file - * or a sound device. - * - * - *---------------------------------------------------------------*/ - -#include -#include -#include -#include -#include -#include - -#include "direwolf.h" -#include "audio.h" -#include "gen_tone.h" -#include "textcolor.h" - - - -// Properties of the digitized sound stream & modem. - -static struct audio_s modem; - -/* - * 8 bit samples are unsigned bytes in range of 0 .. 255. - * - * 16 bit samples are signed short in range of -32768 .. +32767. - */ - - -/* Constants after initialization. */ - -#define TICKS_PER_CYCLE ( 256.0 * 256.0 * 256.0 * 256.0 ) - -static int ticks_per_sample; /* same for all channels. */ - -static int ticks_per_bit[MAX_CHANS]; -static int f1_change_per_sample[MAX_CHANS]; -static int f2_change_per_sample[MAX_CHANS]; - -static short sine_table[256]; - - -/* Accumulators. */ - -static unsigned int tone_phase[MAX_CHANS]; // Phase accumulator for tone generation. - // Upper bits are used as index into sine table. - -static int bit_len_acc[MAX_CHANS]; // To accumulate fractional samples per bit. - -static int lfsr[MAX_CHANS]; // Shift register for scrambler. - - -/*------------------------------------------------------------------ - * - * Name: gen_tone_init - * - * Purpose: Initialize for AFSK tone generation which might - * be used for RTTY or amateur packet radio. - * - * Inputs: pp - Pointer to modem parameter structure, modem_s. - * - * The fields we care about are: - * - * samples_per_sec - * baud - * mark_freq - * space_freq - * samples_per_sec - * - * amp - Signal amplitude on scale of 0 .. 100. - * - * Returns: 0 for success. - * -1 for failure. - * - * Description: Calculate various constants for use by the direct digital synthesis - * audio tone generation. - * - *----------------------------------------------------------------*/ - -static int amp16bit; /* for 9600 baud */ - - -int gen_tone_init (struct audio_s *pp, int amp) -{ - int j; - int chan = 0; -/* - * Save away modem parameters for later use. - */ - - memcpy (&modem, pp, sizeof(struct audio_s)); - - amp16bit = (32767 * amp) / 100; - - ticks_per_sample = (int) ((TICKS_PER_CYCLE / (double)modem.samples_per_sec ) + 0.5); - - for (chan = 0; chan < modem.num_channels; chan++) { - - ticks_per_bit[chan] = (int) ((TICKS_PER_CYCLE / (double)modem.baud[chan] ) + 0.5); - - f1_change_per_sample[chan] = (int) (((double)modem.mark_freq[chan] * TICKS_PER_CYCLE / (double)modem.samples_per_sec ) + 0.5); - - f2_change_per_sample[chan] = (int) (((double)modem.space_freq[chan] * TICKS_PER_CYCLE / (double)modem.samples_per_sec ) + 0.5); - - tone_phase[chan] = 0; - - bit_len_acc[chan] = 0; - - lfsr[chan] = 0; - } - - for (j=0; j<256; j++) { - double a; - int s; - - a = ((double)(j) / 256.0) * (2 * M_PI); - s = (int) (sin(a) * 32767 * amp / 100.0); - - /* 16 bit sound sample is in range of -32768 .. +32767. */ - - assert (s >= -32768 && s <= 32767); - - sine_table[j] = s; - } - - return (0); - - } /* end gen_tone_init */ - - -/*------------------------------------------------------------------- - * - * Name: gen_tone_put_bit - * - * Purpose: Generate tone of proper duration for one data bit. - * - * Inputs: chan - Audio channel, 0 = first. - * - * dat - 0 for f1, 1 for f2. - * - * -1 inserts half bit to test data - * recovery PLL. - * - * Assumption: fp is open to a file for write. - * - *--------------------------------------------------------------------*/ - -void tone_gen_put_bit (int chan, int dat) -{ - int cps = dat ? f2_change_per_sample[chan] : f1_change_per_sample[chan]; - unsigned short sam = 0; - int x; - - - if (dat < 0) { - /* Hack to test receive PLL recovery. */ - bit_len_acc[chan] -= ticks_per_bit[chan]; - dat = 0; - } - - if (modem.modem_type[chan] == SCRAMBLE) { - x = (dat ^ (lfsr[chan] >> 16) ^ (lfsr[chan] >> 11)) & 1; - lfsr[chan] = (lfsr[chan] << 1) | (x & 1); - dat = x; - } - - do { - - if (modem.modem_type[chan] == AFSK) { - tone_phase[chan] += cps; - sam = sine_table[(tone_phase[chan] >> 24) & 0xff]; - } - else { - // TODO: Might want to low pass filter this. - sam = dat ? amp16bit : (-amp16bit); - } - - /* Ship out an audio sample. */ - - assert (modem.num_channels == 1 || modem.num_channels == 2); - - /* Generalize to allow 8 bits someday? */ - - assert (modem.bits_per_sample == 16); - - - if (modem.num_channels == 1) - { - audio_put (sam & 0xff); - audio_put ((sam >> 8) & 0xff); - } - else if (modem.num_channels == 2) - { - if (chan == 1) - { - audio_put (0); // silent left - audio_put (0); - } - - audio_put (sam & 0xff); - audio_put ((sam >> 8) & 0xff); - //byte_count += 2; - - if (chan == 0) - { - audio_put (0); // silent right - audio_put (0); - } - } - - /* Enough for the bit time? */ - - bit_len_acc[chan] += ticks_per_sample; - - } while (bit_len_acc[chan] < ticks_per_bit[chan]); - - bit_len_acc[chan] -= ticks_per_bit[chan]; -} - - -/*------------------------------------------------------------------- - * - * Name: main - * - * Purpose: Quick test program for above. - * - * Description: Compile like this for unit test: - * - * gcc -Wall -DMAIN -o gen_tone_test gen_tone.c audio.c textcolor.c - * - * gcc -Wall -DMAIN -o gen_tone_test.exe gen_tone.c audio_win.c textcolor.c -lwinmm - * - *--------------------------------------------------------------------*/ - - -#if MAIN - - -int main () -{ - int n; - int chan1 = 0; - int chan2 = 1; - int r; - struct audio_s audio_param; - - -/* to sound card */ -/* one channel. 2 times: one second of each tone. */ - - memset (&audio_param, 0, sizeof(audio_param)); - strcpy (audio_param.adevice_in, DEFAULT_ADEVICE); - strcpy (audio_param.adevice_out, DEFAULT_ADEVICE); - - audio_open (&audio_param); - gen_tone_init (&audio_param, 100); - - for (r=0; r<2; r++) { - - for (n=0; n. -// - - -/******************************************************************************** - * - * File: hdlc_rec.c - * - * Purpose: Extract HDLC frames from a stream of bits. - * - *******************************************************************************/ - -#include -#include - -#include "direwolf.h" -#include "demod.h" -#include "hdlc_rec.h" -#include "hdlc_rec2.h" -#include "fcs_calc.h" -#include "textcolor.h" -#include "ax25_pad.h" -#include "rrbb.h" -#include "multi_modem.h" - - -//#define TEST 1 /* Define for unit testing. */ - -//#define DEBUG3 1 /* monitor the data detect signal. */ - - - -/* - * Minimum & maximum sizes of an AX.25 frame including the 2 octet FCS. - */ - -#define MIN_FRAME_LEN ((AX25_MIN_PACKET_LEN) + 2) - -#define MAX_FRAME_LEN ((AX25_MAX_PACKET_LEN) + 2) - -/* - * This is the current state of the HDLC decoder. - * - * It is possible to run multiple decoders concurrently by - * having a separate set of state variables for each. - * - * Should have a reset function instead of initializations here. - */ - -struct hdlc_state_s { - - int prev_raw; /* Keep track of previous bit so */ - /* we can look for transitions. */ - /* Should be only 0 or 1. */ - - unsigned char pat_det; /* 8 bit pattern detector shift register. */ - /* See below for more details. */ - - unsigned int flag4_det; /* Last 32 raw bits to look for 4 */ - /* flag patterns in a row. */ - - unsigned char oacc; /* Accumulator for building up an octet. */ - - int olen; /* Number of bits in oacc. */ - /* When this reaches 8, oacc is copied */ - /* to the frame buffer and olen is zeroed. */ - /* The value of -1 is a special case meaning */ - /* bits should not be accumulated. */ - - unsigned char frame_buf[MAX_FRAME_LEN]; - /* One frame is kept here. */ - - int frame_len; /* Number of octets in frame_buf. */ - /* Should be in range of 0 .. MAX_FRAME_LEN. */ - - int data_detect; /* True when HDLC data is detected. */ - /* This will not be triggered by voice or other */ - /* noise or even tones. */ - - enum retry_e fix_bits; /* Level of effort to recover from */ - /* a bad FCS on the frame. */ - - rrbb_t rrbb; /* Handle for bit array for raw received bits. */ - -}; - - -static struct hdlc_state_s hdlc_state[MAX_CHANS][MAX_SUBCHANS]; - -static int num_subchan[MAX_CHANS]; - - -/*********************************************************************************** - * - * Name: hdlc_rec_init - * - * Purpose: Call once at the beginning to initialize. - * - * Inputs: None. - * - ***********************************************************************************/ - -static int was_init = 0; - -void hdlc_rec_init (struct audio_s *pa) -{ - int j, k; - struct hdlc_state_s *H; - - //text_color_set(DW_COLOR_DEBUG); - //dw_printf ("hdlc_rec_init (%p) \n", pa); - - assert (pa != NULL); - - for (j=0; jnum_channels; j++) - { - num_subchan[j] = pa->num_subchan[j]; - - assert (num_subchan[j] >= 1 && num_subchan[j] < MAX_SUBCHANS); - - for (k=0; kprev_raw = 0; - H->pat_det = 0; - H->flag4_det = 0; - H->olen = -1; - H->frame_len = 0; - H->data_detect = 0; - H->fix_bits = pa->fix_bits; - H->rrbb = rrbb_new(j, k, pa->modem_type[j] == SCRAMBLE, -1); - } - } - - was_init = 1; -} - - - -/*********************************************************************************** - * - * Name: hdlc_rec_bit - * - * Purpose: Extract HDLC frames from a stream of bits. - * - * Inputs: chan - Channel number. - * - * subchan - This allows multiple decoders per channel. - * - * raw - One bit from the demodulator. - * should be 0 or 1. - * - * is_scrambled - Is the data scrambled? - * - * descram_state - Current descrambler state. - * - * sam - Possible future: Sample from demodulator output. - * Should nominally be in roughly -1 to +1 range. - * - * Description: This is called once for each received bit. - * For each valid frame, process_rec_frame() - * is called for further processing. - * - ***********************************************************************************/ - -#if SLICENDICE -void hdlc_rec_bit_sam (int chan, int subchan, int raw, float demod_out) -#else -void hdlc_rec_bit (int chan, int subchan, int raw, int is_scrambled, int descram_state) -#endif -{ - - int dbit; /* Data bit after undoing NRZI. */ - /* Should be only 0 or 1. */ - struct hdlc_state_s *H; - - assert (was_init == 1); - - assert (chan >= 0 && chan < MAX_CHANS); - assert (subchan >= 0 && subchan < MAX_SUBCHANS); - -/* - * Different state information for each channel. - */ - H = &hdlc_state[chan][subchan]; - -/* - * Using NRZI encoding, - * A '0' bit is represented by an inversion since previous bit. - * A '1' bit is represented by no change. - */ - - dbit = (raw == H->prev_raw); - H->prev_raw = raw; - -/* - * Octets are sent LSB first. - * Shift the most recent 8 bits thru the pattern detector. - */ - H->pat_det >>= 1; - if (dbit) { - H->pat_det |= 0x80; - } - - H->flag4_det >>= 1; - if (dbit) { - H->flag4_det |= 0x80000000; - } - - -/* - * "Data Carrier detect" function based on data rather than - * tones from a modem. - * - * Idle time, at beginning of transmission should be filled - * with the special "flag" characters. - * - * Idle time of all zero bits (alternating tones at maximum rate) - * has also been observed. - */ - - if (H->flag4_det == 0x7e7e7e7e) { - - - if ( ! H->data_detect) { - H->data_detect = 1; -#if DEBUG3 - text_color_set(DW_COLOR_DEBUG); - dw_printf ("DCD%d = 1 flags\n", chan); -#endif - } - } - - if (H->flag4_det == 0x7e000000) { - - - if ( ! H->data_detect) { - H->data_detect = 1; -#if DEBUG3 - text_color_set(DW_COLOR_DEBUG); - dw_printf ("DCD%d = 1 zero fill\n", chan); -#endif - } - } - - -/* - * Loss of signal should result in lack of transitions. - * (all '1' bits) for at least a little while. - */ - - - if (H->pat_det == 0xff) { - - if ( H->data_detect ) { - H->data_detect = 0; -#if DEBUG3 - text_color_set(DW_COLOR_DEBUG); - dw_printf ("DCD%d = 0\n", chan); -#endif - } - } - - -/* - * End of data carrier detect. - * - * The rest is concerned with framing. - */ - -#if SLICENDICE - rrbb2_append_bit (H->rrbb, demod_out); -#else - rrbb_append_bit (H->rrbb, raw); -#endif - if (H->pat_det == 0x7e) { - - rrbb_chop8 (H->rrbb); - -/* - * The special pattern 01111110 indicates beginning and ending of a frame. - * If we have an adequate number of whole octets, it is a candidate for - * further processing. - * - * It might look odd that olen is being tested for 7 instead of 0. - * This is because oacc would already have 7 bits from the special - * "flag" pattern before it is detected here. - */ - - -#if OLD_WAY - -#if TEST - text_color_set(DW_COLOR_DEBUG); - dw_printf ("\nfound flag, olen = %d, frame_len = %d\n", olen, frame_len); -#endif - if (H->olen == 7 && H->frame_len >= MIN_FRAME_LEN) { - - unsigned short actual_fcs, expected_fcs; - -#if TEST - int j; - dw_printf ("TRADITIONAL: frame len = %d\n", H->frame_len); - for (j=0; jframe_len; j++) { - dw_printf (" %02x", H->frame_buf[j]); - } - dw_printf ("\n"); - -#endif - /* Check FCS, low byte first, and process... */ - - /* Alternatively, it is possible to include the two FCS bytes */ - /* in the CRC calculation and look for a magic constant. */ - /* That would be easier in the case where the CRC is being */ - /* accumulated along the way as the octets are received. */ - /* I think making a second pass over it and comparing is */ - /* easier to understand. */ - - actual_fcs = H->frame_buf[H->frame_len-2] | (H->frame_buf[H->frame_len-1] << 8); - - expected_fcs = fcs_calc (H->frame_buf, H->frame_len - 2); - - if (actual_fcs == expected_fcs) { - int alevel = demod_get_audio_level (chan, subchan); - - multi_modem_process_rec_frame (chan, subchan, H->frame_buf, H->frame_len - 2, alevel, RETRY_NONE); /* len-2 to remove FCS. */ - } - else { - -#if TEST - dw_printf ("*** actual fcs = %04x, expected fcs = %04x ***\n", actual_fcs, expected_fcs); -#endif - - } - - } - -#else - -/* - * New way - Decode the raw bits in later step. - */ - -#if TEST - text_color_set(DW_COLOR_DEBUG); - dw_printf ("\nfound flag, %d bits in frame\n", rrbb_get_len(H->rrbb) - 1); -#endif - if (rrbb_get_len(H->rrbb) >= MIN_FRAME_LEN * 8) { - - int alevel = demod_get_audio_level (chan, subchan); - - rrbb_set_audio_level (H->rrbb, alevel); - rrbb_set_fix_bits (H->rrbb, H->fix_bits); - hdlc_rec2_block (H->rrbb, H->fix_bits); - /* Now owned by someone else who will free it. */ - H->rrbb = rrbb_new (chan, subchan, is_scrambled, descram_state); /* Allocate a new one. */ - } - else { - rrbb_clear (H->rrbb, is_scrambled, descram_state); - } - - H->olen = 0; /* Allow accumulation of octets. */ - H->frame_len = 0; - -#if SLICENDICE - rrbb2_append_bit (H->rrbb, H->prev_raw ? 1.0 : -1.0); /* Last bit of flag. Needed to get first data bit. */ -#else - rrbb_append_bit (H->rrbb, H->prev_raw); /* Last bit of flag. Needed to get first data bit. */ -#endif -#endif - - } - else if (H->pat_det == 0xfe) { - -/* - * Valid data will never have 7 one bits in a row. - * - * 11111110 - * - * This indicates loss of signal. - */ - - H->olen = -1; /* Stop accumulating octets. */ - H->frame_len = 0; /* Discard anything in progress. */ - - rrbb_clear (H->rrbb, is_scrambled, descram_state); -#if SLICENDICE - rrbb2_append_bit (H->rrbb, H->prev_raw ? 1.0 : -1.0); /* Last bit of flag. Needed to get first data bit. */ -#else - rrbb_append_bit (H->rrbb, H->prev_raw); /* Last bit of flag. Needed to get first data bit. */ -#endif - } - else if ( (H->pat_det & 0xfc) == 0x7c ) { - -/* - * If we have five '1' bits in a row, followed by a '0' bit, - * - * 0111110xx - * - * the current '0' bit should be discarded because it was added for - * "bit stuffing." - */ - ; - - } else { - -/* - * In all other cases, accumulate bits into octets, and complete octets - * into the frame buffer. - */ - if (H->olen >= 0) { - - H->oacc >>= 1; - if (dbit) { - H->oacc |= 0x80; - } - H->olen++; - - if (H->olen == 8) { - H->olen = 0; - - if (H->frame_len < MAX_FRAME_LEN) { - H->frame_buf[H->frame_len] = H->oacc; - H->frame_len++; - } - } - } - } -} - - - -/*------------------------------------------------------------------- - * - * Name: hdlc_rec_data_detect_1 - * hdlc_rec_data_detect_any - * - * Purpose: Determine if the radio channel is curently busy - * with packet data. - * This version doesn't care about voice or other sounds. - * This is used by the transmit logic to transmit only - * when the channel is clear. - * - * Inputs: chan - Audio channel. 0 for left, 1 for right. - * - * Returns: True if channel is busy (data detected) or - * false if OK to transmit. - * - * - * Description: We have two different versions here. - * - * hdlc_rec_data_detect_1 tests a single decoder (subchan) - * and is used by the DPLL to determine how much inertia - * to use when trying to follow the incoming signal. - * - * hdlc_rec_data_detect_any sees if ANY of the decoders - * for this channel are receving a signal. This is - * used to determine whether the channel is clear and - * we can transmit. This would apply to the 300 baud - * HF SSB case where we have multiple decoders running - * at the same time. The channel is busy if ANY of them - * thinks the channel is busy. - * - *--------------------------------------------------------------------*/ - -int hdlc_rec_data_detect_1 (int chan, int subchan) -{ - assert (chan >= 0 && chan < MAX_CHANS); - - return ( hdlc_state[chan][subchan].data_detect ); - -} /* end hdlc_rec_data_detect_1 */ - - -int hdlc_rec_data_detect_any (int chan) -{ - int subchan; - - assert (chan >= 0 && chan < MAX_CHANS); - - for (subchan = 0; subchan < num_subchan[chan]; subchan++) { - - assert (subchan >= 0 && subchan < MAX_SUBCHANS); - - if (hdlc_state[chan][subchan].data_detect) { - return (1); - } - } - return (0); - - -} /* end hdlc_rec_data_detect_any */ - - -/* end hdlc_rec.c */ - - diff --git a/hdlc_rec.h b/hdlc_rec.h deleted file mode 100644 index 1bc4101a..00000000 --- a/hdlc_rec.h +++ /dev/null @@ -1,24 +0,0 @@ - - -#include "audio.h" - -#include "rrbb.h" /* Possibly defines SLICENDICE. */ - - -void hdlc_rec_init (struct audio_s *pa); - -#if SLICENDICE -void hdlc_rec_bit_sam (int chan, int subchan, int raw, float demod_out); -#else -void hdlc_rec_bit (int chan, int subchan, int raw, int is_scrambled, int descram_state); -#endif - - -/* Provided elsewhere to process a complete frame. */ - -//void process_rec_frame (int chan, unsigned char *fbuf, int flen, int level); - -/* Transmit needs to know when someone else is transmitting. */ - -int hdlc_rec_data_detect_1 (int chan, int subchan); -int hdlc_rec_data_detect_any (int chan); diff --git a/hdlc_rec2.c b/hdlc_rec2.c deleted file mode 100644 index 78c45323..00000000 --- a/hdlc_rec2.c +++ /dev/null @@ -1,1077 +0,0 @@ -// This file is part of Dire Wolf, an amateur radio packet TNC. -// -// Copyright (C) 2011, 2012, 2013, 2014 John Langner, WB2OSZ -// -// This program 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 2 of the License, or -// (at your option) any later version. -// -// This program 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 this program. If not, see . -// - - -/******************************************************************************** - * - * File: hdlc_rec2.c - * - * Purpose: Extract HDLC frame from a block of bits after someone - * else has done the work of pulling it out from between - * the special "flag" sequences. - * - * - * New in version 1.1: - * - * Several enhancements provided by Fabrice FAURE: - * - * - Additional types of attempts to fix a bad CRC. - * - Optimized code to reduce execution time. - * - Improved detection of duplicate packets from different fixup attempts. - * - Set limit on number of packets in fix up later queue. - * - * One of the new recovery attempt cases recovers three additional - * packets that were lost before. The one thing I disagree with is - * use of the word "swap" because that sounds like two things - * are being exchanged for each other. I would prefer "flip" - * or "invert" to describe changing a bit to the opposite state. - * I took "swap" out of the user-visible messages but left the - * rest of the source code as provided. - * - *******************************************************************************/ - -#include -#include -#include - -//Optimize processing by accessing directly to decoded bits -#define RRBB_C 1 -#include "direwolf.h" -#include "hdlc_rec2.h" -#include "fcs_calc.h" -#include "textcolor.h" -#include "ax25_pad.h" -#include "rrbb.h" -#include "rdq.h" -#include "multi_modem.h" -//#define DEBUG 1 -//#define DEBUGx 1 -//#define DEBUG_LATER 1 - - -/* - * Minimum & maximum sizes of an AX.25 frame including the 2 octet FCS. - */ - -#define MIN_FRAME_LEN ((AX25_MIN_PACKET_LEN) + 2) - -#define MAX_FRAME_LEN ((AX25_MAX_PACKET_LEN) + 2) - -/* - * This is the current state of the HDLC decoder. - * - * It is possible to run multiple decoders concurrently by - * having a separate set of state variables for each. - * - * Should have a reset function instead of initializations here. - */ - -struct hdlc_state_s { - - int prev_raw; /* Keep track of previous bit so */ - /* we can look for transitions. */ - /* Should be only 0 or 1. */ - - unsigned char pat_det; /* 8 bit pattern detector shift register. */ - /* See below for more details. */ - - unsigned char oacc; /* Accumulator for building up an octet. */ - - int olen; /* Number of bits in oacc. */ - /* When this reaches 8, oacc is copied */ - /* to the frame buffer and olen is zeroed. */ - - unsigned char frame_buf[MAX_FRAME_LEN]; - /* One frame is kept here. */ - - int frame_len; /* Number of octets in frame_buf. */ - /* Should be in range of 0 .. MAX_FRAME_LEN. */ - -}; - -#define MAX_RETRY_SWAP_BITS 24 /* Maximum number of contiguous bits to swap */ -#define MAX_RETRY_REMOVE_SEPARATED_BITS 24 /* Maximum number of contiguous bits to remove */ - -static int try_decode (rrbb_t block, int chan, int subchan, int alevel, retry_conf_t retry_conf); -static int try_to_fix_quick_now (rrbb_t block, int chan, int subchan, int alevel, retry_t fix_bits); -static int sanity_check (unsigned char *buf, int blen, retry_t bits_flipped); -#if DEBUG_LATER -static double dtime_now (void); -#endif - -/*********************************************************************************** - * - * Name: hdlc_rec2_block - * - * Purpose: Extract HDLC frame from a stream of bits. - * - * Inputs: block - Handle for bit array. - * fix_bits - Level of effort to recover frames with bad FCS. - * - * Description: The other (original) hdlc decoder took one bit at a time - * right out of the demodulator. - * - * This is different in that it processes a block of bits - * previously extracted from between two "flag" patterns. - * - * This allows us to try decoding the same received data more - * than once. - * - * Bugs: This does not work for 9600 baud, more accurately when - * the transmitted bits are scrambled. - * - * Currently we unscramble the bits as they come from the - * receiver. Instead we need to save the original received - * bits and apply the descrambling after flipping the bits. - * - ***********************************************************************************/ - - -void hdlc_rec2_block (rrbb_t block, retry_t fix_bits) -{ - int chan = rrbb_get_chan(block); - int subchan = rrbb_get_subchan(block); - int alevel = rrbb_get_audio_level(block); - int ok; - int n; - -#if DEBUGx - text_color_set(DW_COLOR_DEBUG); - dw_printf ("\n--- try to decode ---\n"); -#endif - -#if SLICENDICE -/* - * Unfinished experiment. Get back to this again someday. - * The demodulator output is (should be) roughly in the range of -1 to 1. - * Formerly we sliced it at 0 and saved only a single bit for the sample. - * Now we save the sample so we can try adjusting the slicing point. - * - * First time thru, set the slicing point to 0. - */ - - for (n = 0; n < 1 ; n++) { - - rrbb_set_slice_val (block, n); - - ok = try_decode (block, chan, subchan, alevel, RETRY_NONE, -1, -1, -1); - - if (ok) { -//#if DEBUG - text_color_set(DW_COLOR_INFO); - dw_printf ("Got it with no errors. Slice val = %d \n", n); -//#endif - rrbb_delete (block); - return; - } - } - rrbb_set_slice_val (block, 0); - -#else /* not SLICENDICE */ - /* Create an empty retry configuration */ - retry_conf_t retry_cfg; - - /* By default we don't try to alter any bits */ - retry_cfg.type = RETRY_TYPE_NONE; - retry_cfg.mode = RETRY_MODE_CONTIGUOUS; - retry_cfg.retry = RETRY_NONE; - retry_cfg.u_bits.contig.nr_bits = 0; - retry_cfg.u_bits.contig.bit_idx = 0; - /* Prepare the decoded bits in an array for faster processing - *(at cost of memory but 1 or 2 kbytes is nothing compared to processing time ) */ - rrbb_compute_bits(block); - ok = try_decode (block, chan, subchan, alevel, retry_cfg); - - if (ok) { -#if DEBUG - text_color_set(DW_COLOR_INFO); - dw_printf ("Got it the first time.\n"); -#endif - rrbb_delete (block); - return; - } -#endif - - if (try_to_fix_quick_now (block, chan, subchan, alevel, fix_bits)) { - rrbb_delete (block); - return; - } - -/* - * Put in queue for retrying later at lower priority. - */ - - if (fix_bits < RETRY_SWAP_TWO_SEP) { - rrbb_delete (block); - return; - } - - rdq_append (block); - -} - - -static int try_to_fix_quick_now (rrbb_t block, int chan, int subchan, int alevel, retry_t fix_bits) -{ - int ok; - int len, i,j; - - - len = rrbb_get_len(block); - /* Prepare the retry configuration */ - retry_conf_t retry_cfg; - /* Will modify only contiguous bits*/ - retry_cfg.mode = RETRY_MODE_CONTIGUOUS; -/* - * Try fixing one bit. - */ - if (fix_bits < RETRY_SWAP_SINGLE) { - return 0; - } - /* Try to swap one bit */ - retry_cfg.type = RETRY_TYPE_SWAP; - retry_cfg.retry = RETRY_SWAP_SINGLE; - retry_cfg.u_bits.contig.nr_bits = 1; - - for (i=0; i= cont_bit_idx && (bit_idx < cont_bit_idx + cont_nr_bits )) - return 1; - else - return 0; -} -/* Check if the specified index of bit has been modified with the current type of configuration in separated bit index mode - * Provide a specific implementation for separated mode to optimize number of tests done in the loop */ -inline static char is_sep_bit_modified(int bit_idx, retry_conf_t retry_conf) { - if (bit_idx == retry_conf.u_bits.sep.bit_idx_a || - bit_idx == retry_conf.u_bits.sep.bit_idx_b || - bit_idx == retry_conf.u_bits.sep.bit_idx_c) - return 1; - else - return 0; -} - -/* Get the bit value from a precalculated array to optimize access time in the loop */ -inline static unsigned int get_bit (const rrbb_t b,const unsigned int ind) -{ - return b->computed_data[ind]; -} - -static int try_decode (rrbb_t block, int chan, int subchan, int alevel, retry_conf_t retry_conf) -{ - struct hdlc_state_s H; - int blen; /* Block length in bits. */ - int i; - unsigned int raw; /* From demodulator. */ - int crc_failed = 1; - int retry_conf_mode = retry_conf.mode; - int retry_conf_type = retry_conf.type; - int retry_conf_retry = retry_conf.retry; - - - H.prev_raw = get_bit (block, 0); /* Actually last bit of the */ - /* opening flag so we can derive the */ - /* first data bit. */ - - /* Does this make sense? */ - /* This is the last bit of the "flag" pattern. */ - /* If it was corrupted we wouldn't have detected */ - /* the start of frame. */ - if (retry_conf.mode == RETRY_MODE_CONTIGUOUS && is_contig_bit_modified(0, retry_conf) || - retry_conf.mode == RETRY_MODE_SEPARATED && is_sep_bit_modified(0, retry_conf)) { - H.prev_raw = ! H.prev_raw; - } - - H.pat_det = 0; - H.oacc = 0; - H.olen = 0; - H.frame_len = 0; - - blen = rrbb_get_len(block); - /* Prepare space for the inserted bits in contiguous mode (separated mode for insert is not supported yet) */ - if (retry_conf.type == RETRY_TYPE_INSERT && retry_conf.mode == RETRY_MODE_CONTIGUOUS) - blen+=retry_conf.u_bits.contig.nr_bits; - -#if DEBUGx - text_color_set(DW_COLOR_DEBUG); - if (retry_conf.type == RETRY_TYPE_NONE) - dw_printf ("try_decode: blen=%d\n", blen); -#endif - for (i=1; i= bit_idx + nr_bits) - raw = get_bit (block, i-nr_bits); - /* Else if this is a bit to insert, calculate the value of the bit from insert_value */ - else if (is_contig_bit_modified(i, retry_conf)) { - raw = (retry_conf.insert_value >> (i-bit_idx)) & 1; -/* dw_printf ("raw is %d for i %d bit_idx %d insert_value %d\n", - raw, i, bit_idx, retry_conf.insert_value);*/ - /* Else use the original bit value from the buffer */ - } else { - /* Already set before */ - } - /* If in swap mode */ - } else if (retry_conf_type == RETRY_TYPE_SWAP) { - /* If this is the bit to swap */ - if (is_contig_bit_modified(i, retry_conf)) - raw = ! raw; - } - - } else { - } -/* - * Octets are sent LSB first. - * Shift the most recent 8 bits thru the pattern detector. - */ - H.pat_det >>= 1; - -/* - * Using NRZI encoding, - * A '0' bit is represented by an inversion since previous bit. - * A '1' bit is represented by no change. - * Note: this code can be factorized with the raw != H.prev_raw code at the cost of processing time - */ - if (raw == H.prev_raw) { - H.pat_det |= 0x80; - /* Valid data will never have 7 one bits in a row: exit. */ - if (H.pat_det == 0xfe) { -#if DEBUGx - text_color_set(DW_COLOR_DEBUG); - dw_printf ("try_decode: found abort, i=%d\n", i); -#endif - return 0; - } - H.oacc >>= 1; - H.oacc |= 0x80; - } else { - H.prev_raw = raw; - /* The special pattern 01111110 indicates beginning and ending of a frame: exit. */ - if (H.pat_det == 0x7e) { -#if DEBUGx - text_color_set(DW_COLOR_DEBUG); - dw_printf ("try_decode: found flag, i=%d\n", i); -#endif - return 0; -/* - * If we have five '1' bits in a row, followed by a '0' bit, - * - * 011111xx - * - * the current '0' bit should be discarded because it was added for - * "bit stuffing." - */ - - } else if ( (H.pat_det >> 2) == 0x1f ) { - continue; - } - H.oacc >>= 1; - } - -/* - * Now accumulate bits into octets, and complete octets - * into the frame buffer. - */ - - H.olen++; - - if (H.olen & 8) { - H.olen = 0; - - if (H.frame_len < MAX_FRAME_LEN) { - H.frame_buf[H.frame_len] = H.oacc; - H.frame_len++; - - } - } - } /* end of loop on all bits in block */ -/* - * Do we have a minimum number of complete bytes? - */ - -#if DEBUGx - text_color_set(DW_COLOR_DEBUG); - dw_printf ("try_decode: olen=%d, frame_len=%d\n", H.olen, H.frame_len); -#endif - - if (H.olen == 0 && H.frame_len >= MIN_FRAME_LEN) { - - unsigned short actual_fcs, expected_fcs; - -#if DEBUGx - if (retry_conf.type == RETRY_TYPE_NONE) { - int j; - text_color_set(DW_COLOR_DEBUG); - dw_printf ("NEW WAY: frame len = %d\n", H.frame_len); - for (j=0; j>1); - } - dw_printf ("\nORIG\n"); - for (j=0; j 10) { -#if DEBUGx - text_color_set(DW_COLOR_ERROR); - dw_printf ("sanity_check: FAILED. Too few or many addresses.\n"); -#endif - return 0; - } - -/* - * Addresses can contain only upper case letters, digits, and space. - */ - - for (j=0; j> 1; - addr[1] = buf[j+1] >> 1; - addr[2] = buf[j+2] >> 1; - addr[3] = buf[j+3] >> 1; - addr[4] = buf[j+4] >> 1; - addr[5] = buf[j+5] >> 1; - addr[6] = '\0'; - - - if ( (! isupper(addr[0]) && ! isdigit(addr[0])) || - (! isupper(addr[1]) && ! isdigit(addr[1]) && addr[1] != ' ') || - (! isupper(addr[2]) && ! isdigit(addr[2]) && addr[2] != ' ') || - (! isupper(addr[3]) && ! isdigit(addr[3]) && addr[3] != ' ') || - (! isupper(addr[4]) && ! isdigit(addr[4]) && addr[4] != ' ') || - (! isupper(addr[5]) && ! isdigit(addr[5]) && addr[5] != ' ')) { -#if DEBUGx - text_color_set(DW_COLOR_ERROR); - dw_printf ("sanity_check: FAILED. Invalid characters in addresses \"%s\"\n", addr); -#endif - return 0; - } - } - -/* - * The next two bytes should be 0x03 and 0xf0 for APRS. - * Checking that would mean precluding use for other types of packet operation. - * - * The next section is also assumes APRS and might discard good data - * for other protocols. - */ - - -/* - * Finally, look for bogus characters in the information part. - * In theory, the bytes could have any values. - * In practice, we find only printable ASCII characters and: - * - * 0x0a line feed - * 0x0d carriage return - * 0x1c MIC-E - * 0x1d MIC-E - * 0x1e MIC-E - * 0x1f MIC-E - * 0x7f MIC-E - * 0x80 "{UIV32N}<0x0d><0x9f><0x80>" - * 0x9f "{UIV32N}<0x0d><0x9f><0x80>" - * 0xb0 degree symbol, ISO LATIN1 - * (Note: UTF-8 uses two byte sequence 0xc2 0xb0.) - * 0xbe invalid MIC-E encoding. - * 0xf8 degree symbol, Microsoft code page 437 - * - * So, if we have something other than these (in English speaking countries!), - * chances are that we have bogus data from twiddling the wrong bits. - * - * Notice that we shouldn't get here for good packets. This extra level - * of checking happens only if we twiddled a couple of bits, possibly - * creating bad data. We want to be very fussy. - */ - - for (j=alen+2; j= 0x1c && ch <= 0x7f) - || ch == 0x0a - || ch == 0x0d - || ch == 0x80 - || ch == 0x9f - || ch == 0xb0 - || ch == 0xf8) ) { -#if DEBUGx - text_color_set(DW_COLOR_ERROR); - dw_printf ("sanity_check: FAILED. Probably bogus info char 0x%02x\n", ch); -#endif - return 0; - } - } - - return 1; -} - - -/* end hdlc_rec2.c */ - - - - -// TODO: Also in xmit.c. Move to some common location. - - -/* Current time in seconds but more resolution than time(). */ - -/* We don't care what date a 0 value represents because we */ -/* only use this to calculate elapsed time. */ - - - -static double dtime_now (void) -{ -#if __WIN32__ - /* 64 bit integer is number of 100 nanosecond intervals from Jan 1, 1601. */ - - FILETIME ft; - - GetSystemTimeAsFileTime (&ft); - - return ((( (double)ft.dwHighDateTime * (256. * 256. * 256. * 256.) + - (double)ft.dwLowDateTime ) / 10000000.) - 11644473600.); -#else - /* tv_sec is seconds from Jan 1, 1970. */ - - struct timespec ts; - - clock_gettime (CLOCK_REALTIME, &ts); - - return (ts.tv_sec + ts.tv_nsec / 1000000000.); -#endif -} - diff --git a/hdlc_send.c b/hdlc_send.c deleted file mode 100644 index 77d9c2f9..00000000 --- a/hdlc_send.c +++ /dev/null @@ -1,215 +0,0 @@ -// -// This file is part of Dire Wolf, an amateur radio packet TNC. -// -// Copyright (C) 2011,2013 John Langner, WB2OSZ -// -// This program 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 2 of the License, or -// (at your option) any later version. -// -// This program 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 this program. If not, see . -// - - -#include - -#include "direwolf.h" -#include "hdlc_send.h" -#include "audio.h" -#include "gen_tone.h" -#include "textcolor.h" -#include "fcs_calc.h" - -static void send_control (int, int); -static void send_data (int, int); -static void send_bit (int, int); - -static int number_of_bits_sent; - - - -/*------------------------------------------------------------- - * - * Name: hdlc_send - * - * Purpose: Convert HDLC frames to a stream of bits. - * - * Inputs: chan - Audio channel number, 0 = first. - * - * fbuf - Frame buffer address. - * - * flen - Frame length, not including the FCS. - * - * Outputs: Bits are shipped out by calling tone_gen_put_bit(). - * - * Returns: Number of bits sent including "flags" and the - * stuffing bits. - * The required time can be calculated by dividing this - * number by the transmit rate of bits/sec. - * - * Description: Convert to stream of bits including: - * start flag - * bit stuffed data - * calculated FCS - * end flag - * NRZI encoding - * - * - * Assumptions: It is assumed that the tone_gen module has been - * properly initialized so that bits sent with - * tone_gen_put_bit() are processed correctly. - * - *--------------------------------------------------------------*/ - - -int hdlc_send_frame (int chan, unsigned char *fbuf, int flen) -{ - int j, fcs; - - - number_of_bits_sent = 0; - - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("hdlc_send_frame ( chan = %d, fbuf = %p, flen = %d )\n", chan, fbuf, flen); - fflush (stdout); -#endif - - - send_control (chan, 0x7e); /* Start frame */ - - for (j=0; j> 8) & 0xff); - - send_control (chan, 0x7e); /* End frame */ - - return (number_of_bits_sent); -} - - -/*------------------------------------------------------------- - * - * Name: hdlc_send_flags - * - * Purpose: Send HDLC flags before and after the frame. - * - * Inputs: chan - Audio channel number, 0 = first. - * - * nflags - Number of flag patterns to send. - * - * finish - True for end of transmission. - * This causes the last audio buffer to be flushed. - * - * Outputs: Bits are shipped out by calling tone_gen_put_bit(). - * - * Returns: Number of bits sent. - * There is no bit-stuffing so we would expect this to - * be 8 * nflags. - * The required time can be calculated by dividing this - * number by the transmit rate of bits/sec. - * - * Assumptions: It is assumed that the tone_gen module has been - * properly initialized so that bits sent with - * tone_gen_put_bit() are processed correctly. - * - *--------------------------------------------------------------*/ - -int hdlc_send_flags (int chan, int nflags, int finish) -{ - int j; - - - number_of_bits_sent = 0; - - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("hdlc_send_flags ( chan = %d, nflags = %d, finish = %d )\n", chan, nflags, finish); - fflush (stdout); -#endif - - /* The AX.25 spec states that when the transmitter is on but not sending data */ - /* it should send a continuous stream of "flags." */ - - for (j=0; j>= 1; - } - - stuff = 0; -} - -static void send_data (int chan, int x) -{ - int i; - - for (i=0; i<8; i++) { - send_bit (chan, x & 1); - if (x & 1) { - stuff++; - if (stuff == 5) { - send_bit (chan, 0); - stuff = 0; - } - } else { - stuff = 0; - } - x >>= 1; - } -} - -/* - * NRZI encoding. - * data 1 bit -> no change. - * data 0 bit -> invert signal. - */ - -static void send_bit (int chan, int b) -{ - static int output; - - if (b == 0) { - output = ! output; - } - - tone_gen_put_bit (chan, output); - - number_of_bits_sent++; -} - -/* end hdlc_send.c */ \ No newline at end of file diff --git a/hdlc_send.h b/hdlc_send.h deleted file mode 100644 index 41d44b19..00000000 --- a/hdlc_send.h +++ /dev/null @@ -1,10 +0,0 @@ - -/* hdlc_send.h */ - -int hdlc_send_frame (int chan, unsigned char *fbuf, int flen); - -int hdlc_send_flags (int chan, int flags, int finish); - -/* end hdlc_send.h */ - - diff --git a/igate.c b/igate.c deleted file mode 100644 index 32190456..00000000 --- a/igate.c +++ /dev/null @@ -1,1491 +0,0 @@ -// -// This file is part of Dire Wolf, an amateur radio packet TNC. -// -// Copyright (C) 2013, 2014 John Langner, WB2OSZ -// -// This program 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 2 of the License, or -// (at your option) any later version. -// -// This program 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 this program. If not, see . -// - - -/*------------------------------------------------------------------ - * - * Module: igate.c - * - * Purpose: IGate client. - * - * Description: Establish connection with a tier 2 IGate server - * and relay packets between RF and Internet. - * - * References: APRS-IS (Automatic Packet Reporting System-Internet Service) - * http://www.aprs-is.net/Default.aspx - * - * APRS iGate properties - * http://wiki.ham.fi/APRS_iGate_properties - * - *---------------------------------------------------------------*/ - -/*------------------------------------------------------------------ - * - * From http://windows.microsoft.com/en-us/windows7/ipv6-frequently-asked-questions - * - * How can I enable IPv6? - * Follow these steps: - * - * Open Network Connections by clicking the Start button, and then clicking - * Control Panel. In the search box, type adapter, and then, under Network - * and Sharing Center, click View network connections. - * - * Right-click your network connection, and then click Properties. - * If you're prompted for an administrator password or confirmation, type - * the password or provide confirmation. - * - * Select the check box next to Internet Protocol Version 6 (TCP/IPv6). - * - *---------------------------------------------------------------*/ - -/* - * Native Windows: Use the Winsock interface. - * Linux: Use the BSD socket interface. - * Cygwin: Can use either one. - */ - - -#if __WIN32__ - -/* The goal is to support Windows XP and later. */ - -#include -// default is 0x0400 -#undef _WIN32_WINNT -#define _WIN32_WINNT 0x0501 /* Minimum OS version is XP. */ -//#define _WIN32_WINNT 0x0502 /* Minimum OS version is XP with SP2. */ -//#define _WIN32_WINNT 0x0600 /* Minimum OS version is Vista. */ -#include -#else -#include -#include -#include -#include -#include -#include -#include -#endif - -#include -#include -#include - -#include - - -#include "direwolf.h" -#include "ax25_pad.h" -#include "textcolor.h" -#include "version.h" -#include "digipeater.h" -#include "tq.h" -#include "igate.h" -#include "latlong.h" - - - -#if __WIN32__ -static unsigned __stdcall connnect_thread (void *arg); -static unsigned __stdcall igate_recv_thread (void *arg); -#else -static void * connnect_thread (void *arg); -static void * igate_recv_thread (void *arg); -#endif - -static void send_msg_to_server (char *msg); -static void xmit_packet (char *message); - -static void rx_to_ig_init (void); -static void rx_to_ig_remember (packet_t pp); -static int rx_to_ig_allow (packet_t pp); - -static void ig_to_tx_init (void); -static void ig_to_tx_remember (packet_t pp); -static int ig_to_tx_allow (packet_t pp); - - -/* - * File descriptor for socket to IGate server. - * Set to -1 if not connected. - * (Don't use SOCKET type because it is unsigned.) -*/ - -static volatile int igate_sock = -1; - -/* - * After connecting to server, we want to make sure - * that the login sequence is sent first. - * This is set to true after the login is complete. - */ - -static volatile int ok_to_send = 0; - - - - -/* - * Convert Internet address to text. - * Can't use InetNtop because it is supported only on Windows Vista and later. - */ - -static char * ia_to_text (int Family, void * pAddr, char * pStringBuf, size_t StringBufSize) -{ - struct sockaddr_in *sa4; - struct sockaddr_in6 *sa6; - - switch (Family) { - case AF_INET: - sa4 = (struct sockaddr_in *)pAddr; -#if __WIN32__ - sprintf (pStringBuf, "%d.%d.%d.%d", sa4->sin_addr.S_un.S_un_b.s_b1, - sa4->sin_addr.S_un.S_un_b.s_b2, - sa4->sin_addr.S_un.S_un_b.s_b3, - sa4->sin_addr.S_un.S_un_b.s_b4); -#else - inet_ntop (AF_INET, &(sa4->sin_addr), pStringBuf, StringBufSize); -#endif - break; - case AF_INET6: - sa6 = (struct sockaddr_in6 *)pAddr; -#if __WIN32__ - sprintf (pStringBuf, "%x:%x:%x:%x:%x:%x:%x:%x", - ntohs(((unsigned short *)(&(sa6->sin6_addr)))[0]), - ntohs(((unsigned short *)(&(sa6->sin6_addr)))[1]), - ntohs(((unsigned short *)(&(sa6->sin6_addr)))[2]), - ntohs(((unsigned short *)(&(sa6->sin6_addr)))[3]), - ntohs(((unsigned short *)(&(sa6->sin6_addr)))[4]), - ntohs(((unsigned short *)(&(sa6->sin6_addr)))[5]), - ntohs(((unsigned short *)(&(sa6->sin6_addr)))[6]), - ntohs(((unsigned short *)(&(sa6->sin6_addr)))[7])); -#else - inet_ntop (AF_INET6, &(sa6->sin6_addr), pStringBuf, StringBufSize); -#endif - break; - default: - sprintf (pStringBuf, "Invalid address family!"); - } - assert (strlen(pStringBuf) < StringBufSize); - return pStringBuf; -} - - -#if ITEST - -/* For unit testing. */ - -int main (int argc, char *argv[]) -{ - struct igate_config_s igate_config; - struct digi_config_s digi_config; - packet_t pp; - - memset (&igate_config, 0, sizeof(igate_config)); - - strcpy (igate_config.t2_server_name, "localhost"); - igate_config.t2_server_port = 14580; - strcpy (igate_config.t2_login, "WB2OSZ-JL"); - strcpy (igate_config.t2_passcode, "-1"); - igate_config.t2_filter = strdup ("r/1/2/3"); - - igate_config.tx_chan = 0; - strcpy (igate_config.tx_via, ",WIDE2-1"); - igate_config.tx_limit_1 = 3; - igate_config.tx_limit_5 = 5; - - memset (&digi_config, 0, sizeof(digi_config)); - digi_config.num_chans = 2; - strcpy (digi_config.mycall[0], "WB2OSZ-1"); - strcpy (digi_config.mycall[1], "WB2OSZ-2"); - - igate_init(&igate_config, &digi_config); - - while (igate_sock == -1) { - SLEEP_SEC(1); - } - - SLEEP_SEC (2); - pp = ax25_from_text ("A>B,C,D:Ztest message 1", 0); - igate_send_rec_packet (0, pp); - ax25_delete (pp); - - SLEEP_SEC (2); - pp = ax25_from_text ("A>B,C,D:Ztest message 2", 0); - igate_send_rec_packet (0, pp); - ax25_delete (pp); - - SLEEP_SEC (2); - pp = ax25_from_text ("A>B,C,D:Ztest message 2", 0); /* Should suppress duplicate. */ - igate_send_rec_packet (0, pp); - ax25_delete (pp); - - SLEEP_SEC (2); - pp = ax25_from_text ("A>B,TCPIP,D:ZShould drop this due to path", 0); - igate_send_rec_packet (0, pp); - ax25_delete (pp); - - SLEEP_SEC (2); - pp = ax25_from_text ("A>B,C,D:?Should drop query", 0); - igate_send_rec_packet (0, pp); - ax25_delete (pp); - - SLEEP_SEC (5); - pp = ax25_from_text ("A>B,C,D:}E>F,G*,H:Zthird party stuff", 0); - igate_send_rec_packet (0, pp); - ax25_delete (pp); - -#if 1 - while (1) { - SLEEP_SEC (20); - text_color_set(DW_COLOR_INFO); - dw_printf ("Send received packet\n"); - send_msg_to_server ("W1ABC>APRS:?\r\n"); - } -#endif - return 0; -} - -#endif - - -/* - * Global stuff (to this file) - * - * These are set by init function and need to - * be kept around in case connection is lost and - * we need to reestablish the connection later. - */ - -static struct igate_config_s g_config; - -static int g_num_chans; /* Number of radio channels. */ - -static char g_mycall[MAX_CHANS][AX25_MAX_ADDR_LEN]; - /* Call-ssid associated */ - /* with each of the radio channels. */ - /* Could be the same or different. */ - - -/* - * Statistics. - * TODO: need print function. - */ - -static int stats_failed_connect; /* Number of times we tried to connect to */ - /* a server and failed. A small number is not */ - /* a bad thing. Each name should have a bunch */ - /* of addresses for load balancing and */ - /* redundancy. */ - -static int stats_connects; /* Number of successful connects to a server. */ - /* Normally you'd expect this to be 1. */ - /* Could be larger if one disappears and we */ - /* try again to find a different one. */ - -static time_t stats_connect_at; /* Most recent time connection was established. */ - /* can be used to determine elapsed connect time. */ - -static int stats_rf_recv_packets; /* Number of candidate packets from the radio. */ - -static int stats_rx_igate_packets; /* Number of packets passed along to the IGate */ - /* server after filtering. */ - -static int stats_uplink_bytes; /* Total number of bytes sent to IGate server */ - /* including login, packets, and hearbeats. */ - -static int stats_downlink_bytes; /* Total number of bytes from IGate server including */ - /* packets, heartbeats, other messages. */ - -static int stats_tx_igate_packets; /* Number of packets from IGate server. */ - -static int stats_rf_xmit_packets; /* Number of packets passed along to radio */ - /* after rate limiting or other restrictions. */ - - - -/*------------------------------------------------------------------- - * - * Name: igate_init - * - * Purpose: One time initialization when main application starts up. - * - * Inputs: p_igate_config - IGate configuration. - * - * p_digi_config - Digipeater configuration. All we care about is: - * - Number of radio channels. - * - Radio call and SSID for each channel. - * - * Description: This starts two threads: - * - * * to establish and maintain a connection to the server. - * * to listen for packets from the server. - * - *--------------------------------------------------------------------*/ - - -void igate_init (struct igate_config_s *p_igate_config, struct digi_config_s *p_digi_config) -{ -#if __WIN32__ - HANDLE connnect_th; - HANDLE cmd_recv_th; -#else - pthread_t connect_listen_tid; - pthread_t cmd_listen_tid; - int e; -#endif - int j; - -#if DEBUGx - text_color_set(DW_COLOR_DEBUG); - dw_printf ("igate_init ( %s, %d, %s, %s, %s )\n", - p_igate_config->t2_server_name, - p_igate_config->t2_server_port, - p_igate_config->t2_login, - p_igate_config->t2_passcode, - p_igate_config->t2_filter); -#endif - - - stats_failed_connect = 0; - stats_connects = 0; - stats_connect_at = 0; - stats_rf_recv_packets = 0; - stats_rx_igate_packets = 0; - stats_uplink_bytes = 0; - stats_downlink_bytes = 0; - stats_tx_igate_packets = 0; - stats_rf_xmit_packets = 0; - - rx_to_ig_init (); - ig_to_tx_init (); -/* - * Save the arguments for later use. - */ - memcpy (&g_config, p_igate_config, sizeof (g_config)); - - g_num_chans = p_digi_config->num_chans; - assert (g_num_chans >= 1 && g_num_chans <= MAX_CHANS); - for (j=0; jmycall[j]); - } - - -/* - * Continue only if we have server name, login, and passcode. - */ - if (strlen(p_igate_config->t2_server_name) == 0 || - strlen(p_igate_config->t2_login) == 0 || - strlen(p_igate_config->t2_passcode) == 0) { - return; - } - -/* - * This connects to the server and sets igate_sock. - * It also sends periodic messages to say I'm still here. - */ - -#if __WIN32__ - connnect_th = (HANDLE)_beginthreadex (NULL, 0, connnect_thread, (void *)NULL, 0, NULL); - if (connnect_th == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Internal error: Could not create IGate connection thread\n"); - return; - } -#else - e = pthread_create (&connect_listen_tid, NULL, connnect_thread, (void *)NULL); - if (e != 0) { - text_color_set(DW_COLOR_ERROR); - perror("Internal error: Could not create IGate connection thread"); - return; - } -#endif - -/* - * This reads messages from client when igate_sock is valid. - */ - -#if __WIN32__ - cmd_recv_th = (HANDLE)_beginthreadex (NULL, 0, igate_recv_thread, NULL, 0, NULL); - if (cmd_recv_th == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Internal error: Could not create IGate reading thread\n"); - return; - } -#else - e = pthread_create (&cmd_listen_tid, NULL, igate_recv_thread, NULL); - if (e != 0) { - text_color_set(DW_COLOR_ERROR); - perror("Internal error: Could not create IGate reading thread"); - return; - } -#endif -} - - -/*------------------------------------------------------------------- - * - * Name: connnect_thread - * - * Purpose: Establish connection with IGate server. - * Send periodic heartbeat to keep keep connection active. - * Reconnect if something goes wrong and we got disconnected. - * - * Inputs: arg - Not used. - * - * Outputs: igate_sock - File descriptor for communicating with client app. - * Will be -1 if not connected. - * - * References: TCP client example. - * http://msdn.microsoft.com/en-us/library/windows/desktop/ms737591(v=vs.85).aspx - * - * Linux IPv6 HOWTO - * http://www.tldp.org/HOWTO/Linux+IPv6-HOWTO/ - * - *--------------------------------------------------------------------*/ - -/* - * Addresses don't get mixed up very well. - * IPv6 always shows up last so we'd probably never - * end up using any of them. Use our own shuffle. - */ - -static void shuffle (struct addrinfo *host[], int nhosts) -{ - int j, k; - - assert (RAND_MAX >= nhosts); /* for % to work right */ - - if (nhosts < 2) return; - - srand (time(NULL)); - - for (j=0; j=0 && kai_next) { -#if DEBUG_DNS - text_color_set(DW_COLOR_DEBUG); - ia_to_text (ai->ai_family, ai->ai_addr, ipaddr_str, sizeof(ipaddr_str)); - dw_printf (" %s\n", ipaddr_str); -#endif - hosts[num_hosts] = ai; - if (num_hosts < MAX_HOSTS) num_hosts++; - } - - // We can get multiple addresses back for the host name. - // These should be somewhat randomized for load balancing. - // It turns out the IPv6 addresses are always at the - // end for both Windows and Linux. We do our own shuffling - // to mix them up better and give IPv6 a chance. - - shuffle (hosts, num_hosts); - -#if DEBUG_DNS - text_color_set(DW_COLOR_DEBUG); - dw_printf ("after shuffling:\n"); - for (n=0; nai_family, hosts[n]->ai_addr, ipaddr_str, sizeof(ipaddr_str)); - dw_printf (" %s\n", ipaddr_str); - } -#endif - - // Try each address until we find one that is successful. - - for (n=0; nai_family, ai->ai_addr, ipaddr_str, sizeof(ipaddr_str)); - is = socket(ai->ai_family, ai->ai_socktype, ai->ai_protocol); -#if __WIN32__ - if (is == INVALID_SOCKET) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("IGate: Socket creation failed, err=%d", WSAGetLastError()); - WSACleanup(); - is = -1; - stats_failed_connect++; - continue; - } -#else - if (err != 0) { - text_color_set(DW_COLOR_INFO); - dw_printf("Connect to IGate server %s (%s) failed.\n\n", - g_config.t2_server_name, ipaddr_str); - (void) close (is); - is = -1; - stats_failed_connect++; - continue; - } -#endif - -#ifndef DEBUG_DNS - err = connect(is, ai->ai_addr, (int)ai->ai_addrlen); -#if __WIN32__ - if (err == SOCKET_ERROR) { - text_color_set(DW_COLOR_INFO); - dw_printf("Connect to IGate server %s (%s) failed.\n\n", - g_config.t2_server_name, ipaddr_str); - closesocket (is); - is = -1; - stats_failed_connect++; - continue; - } - // TODO: set TCP_NODELAY? -#else - if (err != 0) { - text_color_set(DW_COLOR_INFO); - dw_printf("Connect to IGate server %s (%s) failed.\n\n", - g_config.t2_server_name, ipaddr_str); - (void) close (is); - is = -1; - stats_failed_connect++; - continue; - } - /* IGate documentation says to use it. */ - /* Does it really make a difference for this application? */ - int flag = 1; - err = setsockopt (is, IPPROTO_TCP, TCP_NODELAY, (void*)(long)(&flag), sizeof(flag)); - if (err < 0) { - text_color_set(DW_COLOR_INFO); - dw_printf("setsockopt TCP_NODELAY failed.\n"); - } -#endif - stats_connects++; - stats_connect_at = time(NULL); - -/* Success. */ - - text_color_set(DW_COLOR_INFO); - dw_printf("\nNow connected to IGate server %s (%s)\n", g_config.t2_server_name, ipaddr_str ); - if (strchr(ipaddr_str, ':') != NULL) { - dw_printf("Check server status here http://[%s]:14501\n\n", ipaddr_str); - } - else { - dw_printf("Check server status here http://%s:14501\n\n", ipaddr_str); - } - -/* - * Set igate_sock so everyone else can start using it. - * But make the Rx -> Internet messages wait until after login. - */ - - ok_to_send = 0; - igate_sock = is; -#endif - break; - } - - freeaddrinfo(ai_head); - - if (igate_sock != -1) { - char stemp[256]; - -/* - * Send login message. - * Software name and version must not contain spaces. - */ - - SLEEP_SEC(3); - sprintf (stemp, "user %s pass %s vers Dire-Wolf %d.%d", - g_config.t2_login, g_config.t2_passcode, - MAJOR_VERSION, MINOR_VERSION); - if (g_config.t2_filter != NULL) { - strcat (stemp, " filter "); - strcat (stemp, g_config.t2_filter); - } - strcat (stemp, "\r\n"); - send_msg_to_server (stemp); - -/* Delay until it is ok to start sending packets. */ - - SLEEP_SEC(7); - ok_to_send = 1; - } - } - -/* - * If connected to IGate server, send heartbeat periodically to keep connection active. - */ - if (igate_sock != -1) { - SLEEP_SEC(10); - } - if (igate_sock != -1) { - SLEEP_SEC(10); - } - if (igate_sock != -1) { - SLEEP_SEC(10); - } - - - if (igate_sock != -1) { - - char heartbeat[10]; - - strcpy (heartbeat, "#\r\n"); - - /* This will close the socket if any error. */ - send_msg_to_server (heartbeat); - - } - } -} /* end connnect_thread */ - - - - -/*------------------------------------------------------------------- - * - * Name: igate_send_rec_packet - * - * Purpose: Send a packet to the IGate server - * - * Inputs: chan - Radio channel it was received on. - * - * recv_pp - Pointer to packet object. - * *** CALLER IS RESPONSIBLE FOR DELETING IT! ** - * - * - * Description: Send message to IGate Server if connected. - * - * Assumptions: (1) Caller has already verified it is an APRS packet. - * i.e. control = 3 for UI frame, protocol id = 0xf0 for no layer 3 - * - * (2) This is being called only for packets received with - * a correct CRC. We don't want to propagate corrupted data. - * - *--------------------------------------------------------------------*/ - -void igate_send_rec_packet (int chan, packet_t recv_pp) -{ - packet_t pp; - int n; - unsigned char *pinfo; - char *p; - char msg[520]; /* Message to IGate max 512 characters. */ - int info_len; - - - if (igate_sock == -1) { - return; /* Silently discard if not connected. */ - } - - if ( ! ok_to_send) { - return; /* Login not complete. */ - } - - /* Count only while connected. */ - stats_rf_recv_packets++; - -/* - * First make a copy of it because it might be modified in place. - */ - - pp = ax25_dup (recv_pp); - -/* - * Third party frames require special handling to unwrap payload. - */ - while (ax25_get_dti(pp) == '}') { - packet_t inner_pp; - - for (n = 0; n < ax25_get_num_repeaters(pp); n++) { - char via[AX25_MAX_ADDR_LEN]; /* includes ssid. Do we want to ignore it? */ - - ax25_get_addr_with_ssid (pp, n + AX25_REPEATER_1, via); - - if (strcmp(via, "TCPIP") == 0 || - strcmp(via, "TCPXX") == 0 || - strcmp(via, "RFONLY") == 0 || - strcmp(via, "NOGATE") == 0) { -#if DEBUGx - text_color_set(DW_COLOR_DEBUG); - dw_printf ("Rx IGate: Do not relay with TCPIP etc. in path.\n"); -#endif - ax25_delete (pp); - return; - } - } - -#if DEBUGx - text_color_set(DW_COLOR_DEBUG); - dw_printf ("Rx IGate: Unwrap third party message.\n"); -#endif - inner_pp = ax25_unwrap_third_party(pp); - if (inner_pp == NULL) { - ax25_delete (pp); - return; - } - ax25_delete (pp); - pp = inner_pp; - } - -/* - * Do not relay packets with TCPIP, TCPXX, RFONLY, or NOGATE in the via path. - */ - for (n = 0; n < ax25_get_num_repeaters(pp); n++) { - char via[AX25_MAX_ADDR_LEN]; /* includes ssid. Do we want to ignore it? */ - - ax25_get_addr_with_ssid (pp, n + AX25_REPEATER_1, via); - - if (strcmp(via, "TCPIP") == 0 || - strcmp(via, "TCPXX") == 0 || - strcmp(via, "RFONLY") == 0 || - strcmp(via, "NOGATE") == 0) { -#if DEBUGx - text_color_set(DW_COLOR_DEBUG); - dw_printf ("Rx IGate: Do not relay with TCPIP etc. in path.\n"); -#endif - ax25_delete (pp); - return; - } - } - -/* - * Do not relay generic query. - */ - if (ax25_get_dti(pp) == '?') { -#if DEBUGx - text_color_set(DW_COLOR_DEBUG); - dw_printf ("Rx IGate: Do not relay generic query.\n"); -#endif - ax25_delete (pp); - return; - } - - -/* - * Cut the information part at the first CR or LF. - */ - - info_len = ax25_get_info (pp, &pinfo); - - if ((p = strchr ((char*)pinfo, '\r')) != NULL) { -#if DEBUGx - text_color_set(DW_COLOR_DEBUG); - dw_printf ("Rx IGate: Truncated information part at CR.\n"); -#endif - *p = '\0'; - } - - if ((p = strchr ((char*)pinfo, '\n')) != NULL) { -#if DEBUGx - text_color_set(DW_COLOR_DEBUG); - dw_printf ("Rx IGate: Truncated information part at LF.\n"); -#endif - *p = '\0'; - } - - -/* - * Someone around here occasionally sends a packet with no information part. - */ - if (strlen(pinfo) == 0) { - -#if DEBUGx - text_color_set(DW_COLOR_DEBUG); - dw_printf ("Rx IGate: Information part length is zero.\n"); -#endif - ax25_delete (pp); - return; - } - -// TODO: Should we drop raw touch tone data object type generated here? - -/* - * Do not relay if a duplicate of something sent recently. - */ - - if ( ! rx_to_ig_allow(pp)) { -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("Rx IGate: Drop duplicate of same packet seen recently.\n"); -#endif - ax25_delete (pp); - return; - } - -/* - * Finally, append ",qAR," and my call to the path. - */ - - ax25_format_addrs (pp, msg); - msg[strlen(msg)-1] = '\0'; /* Remove trailing ":" */ - strcat (msg, ",qAR,"); - strcat (msg, g_mycall[chan]); - strcat (msg, ":"); - strcat (msg, (char*)pinfo); - strcat (msg, "\r\n"); - - send_msg_to_server (msg); - stats_rx_igate_packets++; - -/* - * Remember what was sent to avoid duplicates in near future. - */ - rx_to_ig_remember (pp); - - ax25_delete (pp); - -} /* end igate_send_rec_packet */ - - - - - -/*------------------------------------------------------------------- - * - * Name: send_msg_to_server - * - * Purpose: Send to the IGate server. - * This one function should be used for login, hearbeats, - * and packets. - * - * Inputs: msg - Message. Should end with CR/LF. - * - * - * Description: Send message to IGate Server if connected. - * Disconnect from server, and notify user, if any error. - * - *--------------------------------------------------------------------*/ - - -static void send_msg_to_server (char *msg) -{ - int err; - - - if (igate_sock == -1) { - return; /* Silently discard if not connected. */ - } - - stats_uplink_bytes += strlen(msg); - -#if DEBUG - text_color_set(DW_COLOR_XMIT); - dw_printf ("[ig] "); - ax25_safe_print (msg, strlen(msg), 0); - dw_printf ("\n"); -#endif - -#if __WIN32__ - err = send (igate_sock, msg, strlen(msg), 0); - if (err == SOCKET_ERROR) - { - text_color_set(DW_COLOR_ERROR); - dw_printf ("\nError %d sending message to IGate server. Closing connection.\n\n", WSAGetLastError()); - //dw_printf ("DEBUG: igate_sock=%d, line=%d\n", igate_sock, __LINE__); - closesocket (igate_sock); - igate_sock = -1; - WSACleanup(); - } -#else - err = write (igate_sock, msg, strlen(msg)); - if (err <= 0) - { - text_color_set(DW_COLOR_ERROR); - dw_printf ("\nError sending message to IGate server. Closing connection.\n\n"); - close (igate_sock); - igate_sock = -1; - } -#endif - -} /* end send_msg_to_server */ - - -/*------------------------------------------------------------------- - * - * Name: get1ch - * - * Purpose: Read one byte from socket. - * - * Inputs: igate_sock - file handle for socket. - * - * Returns: One byte from stream. - * Waits and tries again later if any error. - * - * - *--------------------------------------------------------------------*/ - -static int get1ch (void) -{ - unsigned char ch; - int n; - - while (1) { - - while (igate_sock == -1) { - SLEEP_SEC(5); /* Not connected. Try again later. */ - } - - /* Just get one byte at a time. */ - // TODO: might read complete packets and unpack from own buffer - // rather than using a system call for each byte. - -#if __WIN32__ - n = recv (igate_sock, (char*)(&ch), 1, 0); -#else - n = read (igate_sock, &ch, 1); -#endif - - if (n == 1) { -#if DEBUG9 - dw_printf (log_fp, "%02x %c %c", ch, - isprint(ch) ? ch : '.' , - (isupper(ch>>1) || isdigit(ch>>1) || (ch>>1) == ' ') ? (ch>>1) : '.'); - if (ch == '\r') fprintf (log_fp, " CR"); - if (ch == '\n') fprintf (log_fp, " LF"); - fprintf (log_fp, "\n"); -#endif - return(ch); - } - - text_color_set(DW_COLOR_ERROR); - dw_printf ("\nError reading from IGate server. Closing connection.\n\n"); -#if __WIN32__ - closesocket (igate_sock); -#else - close (igate_sock); -#endif - igate_sock = -1; - } - -} /* end get1ch */ - - - - -/*------------------------------------------------------------------- - * - * Name: igate_recv_thread - * - * Purpose: Wait for messages from IGate Server. - * - * Inputs: arg - Not used. - * - * Outputs: igate_sock - File descriptor for communicating with client app. - * - * Description: Process messages from the IGate server. - * - *--------------------------------------------------------------------*/ - -#if __WIN32__ -static unsigned __stdcall igate_recv_thread (void *arg) -#else -static void * igate_recv_thread (void *arg) -#endif -{ - unsigned char ch; - unsigned char message[1000]; // Spec says max 500 or so. - int len; - - -#if DEBUGx - text_color_set(DW_COLOR_DEBUG); - dw_printf ("igate_recv_thread ( socket = %d )\n", igate_sock); -#endif - - while (1) { - - len = 0; - - do - { - ch = get1ch(); - stats_downlink_bytes++; - - if (len < sizeof(message)) - { - message[len] = ch; - } - len++; - - } while (ch != '\n'); - -/* - * We have a complete message terminated by LF. - */ - if (len == 0) - { -/* - * Discard if zero length. - */ - } - else if (message[0] == '#') { -/* - * Heartbeat or other control message. - * - * Print only if within seconds of logging in. - * That way we can see login confirmation but not - * be bothered by the heart beat messages. - */ -#ifndef DEBUG - if ( ! ok_to_send) { -#endif - text_color_set(DW_COLOR_REC); - dw_printf ("[ig] "); - ax25_safe_print ((char *)message, len, 0); - dw_printf ("\n"); -#ifndef DEBUG - } -#endif - } - else - { -/* - * Convert to third party packet and transmit. - */ - text_color_set(DW_COLOR_REC); - dw_printf ("\n[ig] "); - ax25_safe_print ((char *)message, len, 0); - dw_printf ("\n"); - -/* - * Remove CR LF from end. - */ - if (len >=2 && message[len-1] == '\n') { message[len-1] = '\0'; len--; } - if (len >=1 && message[len-1] == '\r') { message[len-1] = '\0'; len--; } - - xmit_packet ((char*)message); - } - - } /* while (1) */ - return (0); - -} /* end igate_recv_thread */ - - -/*------------------------------------------------------------------- - * - * Name: xmit_packet - * - * Purpose: Convert text string, from IGate server, to third party - * packet and send to transmit queue. - * - * Inputs: message - As sent by the server. - * - *--------------------------------------------------------------------*/ - -static void xmit_packet (char *message) -{ - packet_t pp3; - char payload[500]; /* what is max len? */ - char *pinfo = NULL; - int info_len; - -/* - * Is IGate to Radio direction enabled? - */ - if (g_config.tx_chan == -1) { - return; - } - - stats_tx_igate_packets++; - - assert (g_config.tx_chan >= 0 && g_config.tx_chan < MAX_CHANS); - -/* - * Try to parse it into a packet object. - * Bug: Up to 8 digipeaters are allowed in radio format. - * There is a potential of finding more here. - */ - pp3 = ax25_from_text(message, 0); - if (pp3 == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Tx IGate: Could not parse message from server.\n"); - dw_printf ("%s\n", message); - return; - } - -/* - * TODO: Discard if qAX in path??? others? - */ - -/* - * Remove the VIA path. - */ - while (ax25_get_num_repeaters(pp3) > 0) { - ax25_remove_addr (pp3, AX25_REPEATER_1); - } - -/* - * Replace the VIA path with TCPIP and my call. - * Mark my call as having been used. - */ - ax25_set_addr (pp3, AX25_REPEATER_1, "TCPIP"); - ax25_set_h (pp3, AX25_REPEATER_1); - ax25_set_addr (pp3, AX25_REPEATER_2, g_mycall[g_config.tx_chan]); - ax25_set_h (pp3, AX25_REPEATER_2); - -/* - * Convert to text representation. - */ - ax25_format_addrs (pp3, payload); - info_len = ax25_get_info (pp3, (unsigned char **)(&pinfo)); - strcat (payload, pinfo); -#if DEBUGx - text_color_set(DW_COLOR_DEBUG); - dw_printf ("Tx IGate: payload=%s\n", payload); -#endif - -/* - * Encapsulate for sending over radio if no reason to drop it. - */ - if (ig_to_tx_allow (pp3)) { - char radio [500]; - packet_t pradio; - - sprintf (radio, "%s>%s%d%d%s:}%s", - g_mycall[g_config.tx_chan], - APP_TOCALL, MAJOR_VERSION, MINOR_VERSION, - g_config.tx_via, - payload); - - pradio = ax25_from_text (radio, 1); -#if ITEST - text_color_set(DW_COLOR_XMIT); - dw_printf ("Xmit: %s\n", radio); - ax25_delete (pradio); -#else - /* This consumes packet so don't reference it again! */ - tq_append (g_config.tx_chan, TQ_PRIO_1_LO, pradio); -#endif - stats_rf_xmit_packets++; - ig_to_tx_remember (pp3); - } - - ax25_delete (pp3); - -} /* end xmit_packet */ - - - -/*------------------------------------------------------------------- - * - * Name: rx_to_ig_remember - * - * Purpose: Keep a record of packets sent to the IGate server - * so we don't send duplicates within some set amount of time. - * - * Inputs: pp - Pointer to a packet object. - * - *------------------------------------------------------------------- - * - * Name: rx_to_ig_allow - * - * Purpose: Check whether this is a duplicate of another sent recently. - * - * Input: pp - Pointer to packet object. - * - * Returns: True if it is OK to send. - * - *------------------------------------------------------------------- - * - * Description: These two functions perform the final stage of filtering - * before sending a received (from radio) packet to the IGate server. - * - * rx_to_ig_remember must be called for every packet sent to the server. - * - * rx_to_ig_allow decides whether this should be allowed thru - * based on recent activity. We will drop the packet if it is a - * duplicate of another sent recently. - * - * Rather than storing the entire packet, we just keep a CRC to - * reduce memory and processing requirements. We do the same in - * the digipeater function to suppress duplicates. - * - * There is a 1 / 65536 chance of getting a false positive match - * which is good enough for this application. - * - *--------------------------------------------------------------------*/ - -#define RX2IG_DEDUPE_TIME 60 /* Do not send duplicate within 60 seconds. */ -#define RX2IG_HISTORY_MAX 30 /* Remember the last 30 sent to IGate server. */ - -static int rx2ig_insert_next; -static time_t rx2ig_time_stamp[RX2IG_HISTORY_MAX]; -static unsigned short rx2ig_checksum[RX2IG_HISTORY_MAX]; - -static void rx_to_ig_init (void) -{ - int n; - for (n=0; n= RX2IG_HISTORY_MAX) { - rx2ig_insert_next = 0; - } -} - -static int rx_to_ig_allow (packet_t pp) -{ - unsigned short crc = ax25_dedupe_crc(pp); - time_t now = time(NULL); - int j; - - for (j=0; j= now - RX2IG_DEDUPE_TIME && rx2ig_checksum[j] == crc) { - return 0; - } - } - return 1; - -} /* end rx_to_ig_allow */ - - - -/*------------------------------------------------------------------- - * - * Name: ig_to_tx_remember - * - * Purpose: Keep a record of packets sent from IGate server to radio transmitter - * so we don't send duplicates within some set amount of time. - * - * Inputs: pp - Pointer to a packet object. - * - *------------------------------------------------------------------------------ - * - * Name: ig_to_tx_allow - * - * Purpose: Check whether this is a duplicate of another sent recently - * or if we exceed the transmit rate limits. - * - * Input: pp - Pointer to packet object. - * - * Returns: True if it is OK to send. - * - *------------------------------------------------------------------------------ - * - * Description: These two functions perform the final stage of filtering - * before sending a packet from the IGate server to the radio. - * - * ig_to_tx_remember must be called for every packet, from the IGate - * server, sent to the radio transmitter. - * - * ig_to_tx_allow decides whether this should be allowed thru - * based on recent activity. We will drop the packet if it is a - * duplicate of another sent recently. - * - * This is the essentially the same as the pair of functions - * above with one addition restriction. - * - * The typical residential Internet connection is about 10,000 - * times faster than the radio links we are using. It would - * be easy to completely saturate the radio channel if we are - * not careful. - * - * Besides looking for duplicates, this will also tabulate the - * number of packets sent during the past minute and past 5 - * minutes and stop sending if a limit is reached. - * - * Future? We might also want to avoid transmitting if the same packet - * was heard on the radio recently. If everything is kept in - * the same table, we'd need to distinguish between those from - * the IGate server and those heard on the radio. - * Those heard on the radio would not count toward the - * 1 and 5 minute rate limiting. - * Maybe even provide informative information such as - - * Tx IGate: Same packet heard recently from W1ABC and W9XYZ. - * - * Of course, the radio encapsulation would need to be removed - * and only the 3rd party packet inside compared. - * - *--------------------------------------------------------------------*/ - -#define IG2TX_DEDUPE_TIME 60 /* Do not send duplicate within 60 seconds. */ -#define IG2TX_HISTORY_MAX 50 /* Remember the last 50 sent from server to radio. */ - -static int ig2tx_insert_next; -static time_t ig2tx_time_stamp[IG2TX_HISTORY_MAX]; -static unsigned short ig2tx_checksum[IG2TX_HISTORY_MAX]; - -static void ig_to_tx_init (void) -{ - int n; - for (n=0; n= IG2TX_HISTORY_MAX) { - ig2tx_insert_next = 0; - } -} - -static int ig_to_tx_allow (packet_t pp) -{ - unsigned short crc = ax25_dedupe_crc(pp); - time_t now = time(NULL); - int j; - int count_1, count_5; - - for (j=0; j= now - IG2TX_DEDUPE_TIME && ig2tx_checksum[j] == crc) { - text_color_set(DW_COLOR_INFO); - dw_printf ("Tx IGate: Drop duplicate packet transmitted recently.\n"); - return 0; - } - } - count_1 = 0; - count_5 = 0; - for (j=0; j= now - 60) count_1++; - if (ig2tx_time_stamp[j] >= now - 300) count_5++; - } - - if (count_1 >= g_config.tx_limit_1) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Tx IGate: Already transmitted maximum of %d packets in 1 minute.\n", g_config.tx_limit_1); - return 0; - } - if (count_5 >= g_config.tx_limit_5) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Tx IGate: Already transmitted maximum of %d packets in 5 minutes.\n", g_config.tx_limit_5); - return 0; - } - - return 1; - -} /* end ig_to_tx_allow */ - -/* end igate.c */ diff --git a/igate.h b/igate.h deleted file mode 100644 index bbf5a6dc..00000000 --- a/igate.h +++ /dev/null @@ -1,65 +0,0 @@ - -/*---------------------------------------------------------------------------- - * - * Name: igate.h - * - * Purpose: Interface to the Internet Gateway functions. - * - *-----------------------------------------------------------------------------*/ - - -#ifndef IGATE_H -#define IGATE_H 1 - - -#include "ax25_pad.h" -#include "digipeater.h" - -#define DEFAULT_IGATE_PORT 14580 - - -struct igate_config_s { - -/* - * For logging into the IGate server. - */ - char t2_server_name[40]; /* Tier 2 IGate server name. */ - - int t2_server_port; /* Typically 14580. */ - - char t2_login[AX25_MAX_ADDR_LEN];/* e.g. WA9XYZ-15 */ - /* Note that the ssid could be any two alphanumeric */ - /* characters not just 1 thru 15. */ - /* Could be same or different than the radio call(s). */ - /* Not sure what the consequences would be. */ - - char t2_passcode[8]; /* Max. 5 digits. Could be "-1". */ - - char *t2_filter; /* Optional filter for IS -> RF direction. */ - -/* - * For transmitting. - */ - int tx_chan; /* Radio channel for transmitting. */ - /* 0=first, etc. -1 for none. */ - - char tx_via[80]; /* VIA path for transmitting third party packets. */ - /* Usual text representation. */ - /* Must start with "," if not empty so it can */ - /* simply be inserted after the destination address. */ - - int tx_limit_1; /* Max. packets to transmit in 1 minute. */ - - int tx_limit_5; /* Max. packets to transmit in 5 minutes. */ -}; - -/* Call this once at startup */ - -void igate_init (struct igate_config_s *p_igate_config, struct digi_config_s *p_digi_config); - -/* Call this with each packet received from the radio. */ - -void igate_send_rec_packet (int chan, packet_t recv_pp); - - -#endif diff --git a/kiss.c b/kiss.c deleted file mode 100644 index bc81dfc8..00000000 --- a/kiss.c +++ /dev/null @@ -1,962 +0,0 @@ -// -// This file is part of Dire Wolf, an amateur radio packet TNC. -// -// Copyright (C) 2011, 2013, 2014 John Langner, WB2OSZ -// -// This program 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 2 of the License, or -// (at your option) any later version. -// -// This program 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 this program. If not, see . -// - - - -/*------------------------------------------------------------------ - * - * Module: kiss.c - * - * Purpose: Act as a virtual KISS TNC for use by other packet radio applications. - * - * Input: - * - * Outputs: - * - * Description: This provides a pseudo terminal for communication with a client application. - * - * It implements the KISS TNC protocol as described in: - * http://www.ka9q.net/papers/kiss.html - * - * Briefly, a frame is composed of - * - * * FEND (0xC0) - * * Contents - with special escape sequences so a 0xc0 - * byte in the data is not taken as end of frame. - * as part of the data. - * * FEND - * - * The first byte of the frame contains: - * - * * port number in upper nybble. - * * command in lower nybble. - * - * - * Commands from application recognized: - * - * 0 Data Frame AX.25 frame in raw format. - * - * 1 TXDELAY See explanation in xmit.c. - * - * 2 Persistence " " - * - * 3 SlotTime " " - * - * 4 TXtail " " - * Spec says it is obsolete but Xastir - * sends it and we respect it. - * - * 5 FullDuplex Ignored. Always full duplex. - * - * 6 SetHardware TNC specific. Ignored. - * - * FF Return Exit KISS mode. Ignored. - * - * - * Messages sent to client application: - * - * 0 Data Frame Received AX.25 frame in raw format. - * - * - * - * Platform differences: - * - * We can use a pseudo terminal for Linux or Cygwin applications. - * However, Microsoft Windows doesn't seem to have similar functionality. - * Native Windows applications expect to see a device named COM1, - * COM2, COM3, or COM4. Some might offer more flexibility but others - * might be limited to these four choices. - * - * The documentation instucts the user to install the com0com - * “Null-modem emulator” from http://sourceforge.net/projects/com0com/ - * and configure it for COM3 & COM4. - * - * By default Dire Wolf will use COM3 (/dev/ttyS2 or /dev/com3 - lower case!) - * and the client application will use COM4 (available as /dev/ttyS or - * /dev/com4 for Cygwin applications). - * - * - * This can get confusing. - * - * If __WIN32__ is defined, - * We use the Windows interface to the specfied serial port. - * This could be a real serial port or the nullmodem driver - * connected to another application. - * - * If __CYGWIN__ is defined, - * We connect to a serial port as in the previous case but - * use the Linux I/O interface. - * We also supply a pseudo terminal for any Cygwin applications - * such as Xastir so the null modem is not needed. - * - * For the Linux case, - * We supply a pseudo terminal for use by other applications. - * - * - * Reference: http://www.robbayer.com/files/serial-win.pdf - * - *---------------------------------------------------------------*/ - -#include -#include - -#if __WIN32__ -#include -#include -#else -#define __USE_XOPEN2KXSI 1 -#define __USE_XOPEN 1 -//#define __USE_POSIX 1 -#include -#include -#include -#include -#include -#include -#ifdef __OpenBSD__ -#include -#else -#include -#endif -#endif - -#include -#include - -#include "direwolf.h" -#include "tq.h" -#include "ax25_pad.h" -#include "textcolor.h" -#include "kiss.h" -#include "kiss_frame.h" -#include "xmit.h" - - -#if __WIN32__ -typedef HANDLE MYFDTYPE; -#define MYFDERROR INVALID_HANDLE_VALUE -#else -typedef int MYFDTYPE; -#define MYFDERROR (-1) -#endif - - -static kiss_frame_t kf; /* Accumulated KISS frame and state of decoder. */ - - -/* - * These are for a Linux/Cygwin pseudo terminal. - */ - -#if ! __WIN32__ - -static MYFDTYPE pt_master_fd = MYFDERROR; /* File descriptor for my end. */ - -static char pt_slave_name[32]; /* Pseudo terminal slave name */ - /* like /dev/pts/999 */ - - - -/* - * Symlink to pseudo terminal name which changes. - */ - -#define TMP_KISSTNC_SYMLINK "/tmp/kisstnc" - -#endif - -/* - * This is for native Windows applications and a virtual null modem. - */ - -#if __CYGWIN__ || __WIN32__ - -static MYFDTYPE nullmodem_fd = MYFDERROR; - -#endif - - -// TODO: define in one place, use everywhere. -#if __WIN32__ -#define THREAD_F unsigned __stdcall -#else -#define THREAD_F void * -#endif - -static THREAD_F kiss_listen_thread (void *arg); - - - -#if DEBUG9 -static FILE *log_fp; -#endif - - -static int kiss_debug = 0; /* Print information flowing from and to client. */ - -void kiss_serial_set_debug (int n) -{ - kiss_debug = n; -} - - -/* In server.c. Should probably move to some misc. function file. */ - -void hex_dump (unsigned char *p, int len); - - - - - -/*------------------------------------------------------------------- - * - * Name: kiss_init - * - * Purpose: Set up a pseudo terminal acting as a virtual KISS TNC. - * - * - * Inputs: mc->nullmodem - name of device for our end of nullmodem. - * - * Outputs: - * - * Description: (1) Create a pseudo terminal for the client to use. - * (2) Start a new thread to listen for commands from client app - * so the main application doesn't block while we wait. - * - * - *--------------------------------------------------------------------*/ - -static MYFDTYPE kiss_open_pt (void); -static MYFDTYPE kiss_open_nullmodem (char *device); - -void kiss_init (struct misc_config_s *mc) -{ - int e; -#if __WIN32__ - HANDLE kiss_nullmodem_listen_th; -#else - pthread_t kiss_pterm_listen_tid; - pthread_t kiss_nullmodem_listen_tid; -#endif - - memset (&kf, 0, sizeof(kf)); - -/* - * This reads messages from client. - */ - -#if ! __WIN32__ - -/* - * Pseudo terminal for Cygwin and Linux versions. - */ - pt_master_fd = MYFDERROR; - - if (mc->enable_kiss_pt) { - - pt_master_fd = kiss_open_pt (); - - if (pt_master_fd != MYFDERROR) { - e = pthread_create (&kiss_pterm_listen_tid, (pthread_attr_t*)NULL, kiss_listen_thread, NULL); - if (e != 0) { - text_color_set(DW_COLOR_ERROR); - perror("Could not create kiss listening thread for Linux pseudo terminal"); - } - } - } - else { - text_color_set(DW_COLOR_INFO); - dw_printf ("Use -p command line option to enable KISS pseudo terminal.\n"); - } -#endif - -#if __CYGWIN__ || __WIN32 - -/* - * Cygwin and native Windows versions have serial port connection. - */ - if (strlen(mc->nullmodem) > 0) { - -#if ! __WIN32__ - - /* Translate Windows device name into Linux name. */ - /* COM1 -> /dev/ttyS0, etc. */ - - if (strncasecmp(mc->nullmodem, "COM", 3) == 0) { - int n = atoi (mc->nullmodem + 3); - text_color_set(DW_COLOR_INFO); - dw_printf ("Converted nullmodem device '%s'", mc->nullmodem); - if (n < 1) n = 1; - sprintf (mc->nullmodem, "/dev/ttyS%d", n-1); - dw_printf (" to Linux equivalent '%s'\n", mc->nullmodem); - } -#endif - nullmodem_fd = kiss_open_nullmodem (mc->nullmodem); - - if (nullmodem_fd != MYFDERROR) { -#if __WIN32__ - kiss_nullmodem_listen_th = (HANDLE)_beginthreadex (NULL, 0, kiss_listen_thread, NULL, 0, NULL); - if (kiss_nullmodem_listen_th == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Could not create kiss nullmodem thread\n"); - return; - } -#else - e = pthread_create (&kiss_nullmodem_listen_tid, NULL, kiss_listen_thread, NULL); - if (e != 0) { - text_color_set(DW_COLOR_ERROR); - perror("Could not create kiss listening thread for Windows virtual COM port."); - - } -#endif - } - } -#endif - - -#if DEBUG - text_color_set (DW_COLOR_DEBUG); -#if ! __WIN32__ - dw_printf ("end of kiss_init: pt_master_fd = %d\n", pt_master_fd); -#endif -#if __CYGWIN__ || __WIN32__ - dw_printf ("end of kiss_init: nullmodem_fd = %d\n", nullmodem_fd); -#endif - -#endif -} - - -/* - * Returns fd for master side of pseudo terminal or MYFDERROR for error. - */ - -#if ! __WIN32__ - -static MYFDTYPE kiss_open_pt (void) -{ - int fd; - char *pts; - struct termios ts; - int e; - //int flags; - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("kiss_open_pt ( )\n"); -#endif - - - fd = posix_openpt(O_RDWR|O_NOCTTY); - - if (fd == MYFDERROR - || grantpt (fd) == MYFDERROR - || unlockpt (fd) == MYFDERROR - || (pts = ptsname (fd)) == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("ERROR - Could not create pseudo terminal for KISS TNC.\n"); - return (MYFDERROR); - } - - strcpy (pt_slave_name, pts); - - e = tcgetattr (fd, &ts); - if (e != 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Can't get pseudo terminal attributes, err=%d\n", e); - perror ("pt tcgetattr"); - } - - cfmakeraw (&ts); - - ts.c_cc[VMIN] = 1; /* wait for at least one character */ - ts.c_cc[VTIME] = 0; /* no fancy timing. */ - - - e = tcsetattr (fd, TCSANOW, &ts); - if (e != 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Can't set pseudo terminal attributes, err=%d\n", e); - perror ("pt tcsetattr"); - } - -/* - * After running for a while on Linux, the write eventually - * blocks if no one is reading from the other side of - * the pseudo terminal. We get stuck on the kiss data - * write and reception stops. - * - * I tried using ioctl(,TIOCOUTQ,) to see how much was in - * the queue but that always returned zero. (Ubuntu) - * - * Let's try using non-blocking writes and see if we get - * the EWOULDBLOCK status instead of hanging. - */ - -#if 0 // this is worse. all writes fail. errno = 0 bad file descriptor - flags = fcntl(fd, F_GETFL, 0); - e = fcntl (fd, F_SETFL, flags | O_NONBLOCK); - if (e != 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Can't set pseudo terminal to nonblocking, fcntl returns %d, errno = %d\n", e, errno); - perror ("pt fcntl"); - } -#endif -#if 0 // same - flags = 1; - e = ioctl (fd, FIONBIO, &flags); - if (e != 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Can't set pseudo terminal to nonblocking, ioctl returns %d, errno = %d\n", e, errno); - perror ("pt ioctl"); - } -#endif - text_color_set(DW_COLOR_INFO); - dw_printf("Virtual KISS TNC is available on %s\n", pt_slave_name); - dw_printf("WARNING - Dire Wolf will hang eventually if nothing is reading from it.\n"); - - -#if 1 - // Sample code shows this. Why would we open it here? - // On Ubuntu, the slave side disappears after a few - // seconds if no one opens it. Same on Raspian which - // is also based on Debian. - // Need to revisit this. - - MYFDTYPE pt_slave_fd; - - pt_slave_fd = open(pt_slave_name, O_RDWR|O_NOCTTY); - - if (pt_slave_fd < 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Can't open %s\n", pt_slave_name); - perror (""); - return MYFDERROR; - } -#endif - -/* - * The device name is not the same every time. - * This is inconvenient for the application because it might - * be necessary to change the device name in the configuration. - * Create a symlink, /tmp/kisstnc, so the application configuration - * does not need to change when the pseudo terminal name changes. - */ - - unlink (TMP_KISSTNC_SYMLINK); - - -// TODO: Is this removed when application exits? - - if (symlink (pt_slave_name, TMP_KISSTNC_SYMLINK) == 0) { - dw_printf ("Created symlink %s -> %s\n", TMP_KISSTNC_SYMLINK, pt_slave_name); - } - else { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Failed to create symlink %s\n", TMP_KISSTNC_SYMLINK); - perror (""); - } - - return (fd); -} - -#endif - -/* - * Returns fd for our side of null modem or MYFDERROR for error. - */ - - -#if __CYGWIN__ || __WIN32__ - -static MYFDTYPE kiss_open_nullmodem (char *devicename) -{ - -#if __WIN32__ - - MYFDTYPE fd; - DCB dcb; - int ok; - char bettername[50]; - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("kiss_open_nullmodem ( '%s' )\n", devicename); -#endif - -#if DEBUG9 - log_fp = fopen ("kiss-debug.txt", "w"); -#endif - -// Need to use FILE_FLAG_OVERLAPPED for full duplex operation. -// Without it, write blocks when waiting on read. - -// Read http://support.microsoft.com/kb/156932 - -// Bug fix in release 1.1 - Need to munge name for COM10 and up. -// http://support.microsoft.com/kb/115831 - - strcpy (bettername, devicename); - if (strncasecmp(devicename, "COM", 3) == 0) { - int n; - n = atoi(devicename+3); - if (n >= 10) { - strcpy (bettername, "\\\\.\\"); - strcat (bettername, devicename); - } - } - - fd = CreateFile(bettername, GENERIC_READ | GENERIC_WRITE, - 0, NULL, OPEN_EXISTING, FILE_FLAG_OVERLAPPED, NULL); - - if (fd == MYFDERROR) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("ERROR - Could not connect to %s side of null modem for Windows KISS TNC.\n", devicename); - return (MYFDERROR); - } - - /* Reference: http://msdn.microsoft.com/en-us/library/windows/desktop/aa363201(v=vs.85).aspx */ - - memset (&dcb, 0, sizeof(dcb)); - dcb.DCBlength = sizeof(DCB); - - ok = GetCommState (fd, &dcb); - if (! ok) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("kiss_open_nullmodem: GetCommState failed.\n"); - } - - /* http://msdn.microsoft.com/en-us/library/windows/desktop/aa363214(v=vs.85).aspx */ - - dcb.DCBlength = sizeof(DCB); - dcb.BaudRate = CBR_9600; // shouldn't matter - dcb.fBinary = 1; - dcb.fParity = 0; - dcb.fOutxCtsFlow = 0; - dcb.fOutxDsrFlow = 0; - dcb.fDtrControl = 0; - dcb.fDsrSensitivity = 0; - dcb.fOutX = 0; - dcb.fInX = 0; - dcb.fErrorChar = 0; - dcb.fNull = 0; /* Don't drop nul characters! */ - dcb.fRtsControl = 0; - dcb.ByteSize = 8; - dcb.Parity = NOPARITY; - dcb.StopBits = ONESTOPBIT; - - ok = SetCommState (fd, &dcb); - if (! ok) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("kiss_open_nullmodem: SetCommState failed.\n"); - } - - text_color_set(DW_COLOR_INFO); - dw_printf("Virtual KISS TNC is connected to %s side of null modem.\n", devicename); - -#else - -/* Cygwin version. */ - - int fd; - struct termios ts; - int e; - - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("kiss_open_nullmodem ( '%s' )\n", devicename); -#endif - - fd = open (devicename, O_RDWR); - - if (fd == MYFDERROR) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("ERROR - Could not connect to %s side of null modem for Windows KISS TNC.\n", devicename); - return (MYFDERROR); - } - - e = tcgetattr (fd, &ts); - if (e != 0) { perror ("nm tcgetattr"); } - - cfmakeraw (&ts); - - ts.c_cc[VMIN] = 1; /* wait for at least one character */ - ts.c_cc[VTIME] = 0; /* no fancy timing. */ - - e = tcsetattr (fd, TCSANOW, &ts); - if (e != 0) { perror ("nm tcsetattr"); } - - text_color_set(DW_COLOR_INFO); - dw_printf("Virtual KISS TNC is connected to %s side of null modem.\n", devicename); - -#endif - - return (fd); -} - -#endif - - - - -/*------------------------------------------------------------------- - * - * Name: kiss_send_rec_packet - * - * Purpose: Send a received packet or text string to the client app. - * - * Inputs: chan - Channel number where packet was received. - * 0 = first, 1 = second if any. - * - * pp - Identifier for packet object. - * - * fbuf - Address of raw received frame buffer - * or a text string. - * - * flen - Length of raw received frame not including the FCS - * or -1 for a text string. - * - * - * Description: Send message to client. - * We really don't care if anyone is listening or not. - * I don't even know if we can find out. - * - * - *--------------------------------------------------------------------*/ - - -void kiss_send_rec_packet (int chan, unsigned char *fbuf, int flen) -{ - unsigned char kiss_buff[2 * AX25_MAX_PACKET_LEN + 2]; - int kiss_len; - int j; - int err; - -#if ! __WIN32__ - if (pt_master_fd == MYFDERROR) { - return; - } -#endif - -#if __CYGWIN__ || __WIN32__ - - if (nullmodem_fd == MYFDERROR) { - return; - } -#endif - - if (flen < 0) { - flen = strlen((char*)fbuf); - if (kiss_debug) { - kiss_debug_print (TO_CLIENT, "Fake command prompt", fbuf, flen); - } - strcpy ((char *)kiss_buff, (char *)fbuf); - kiss_len = strlen((char *)kiss_buff); - } - else { - - - unsigned char stemp[AX25_MAX_PACKET_LEN + 1]; - - assert (flen < sizeof(stemp)); - - stemp[0] = (chan << 4) + 0; - memcpy (stemp+1, fbuf, flen); - - if (kiss_debug >= 2) { - /* AX.25 frame with the CRC removed. */ - text_color_set(DW_COLOR_DEBUG); - dw_printf ("\n"); - dw_printf ("Packet content before adding KISS framing and any escapes:\n"); - hex_dump ((char*)fbuf, flen); - } - - kiss_len = kiss_encapsulate (stemp, flen+1, kiss_buff); - - /* This has KISS framing and escapes for sending to client app. */ - - if (kiss_debug) { - kiss_debug_print (TO_CLIENT, NULL, kiss_buff, kiss_len); - } - - } - -#if ! __WIN32__ - -/* Pseudo terminal for Cygwin and Linux. */ - - - err = write (pt_master_fd, kiss_buff, (size_t)kiss_len); - - if (err == -1 && errno == EWOULDBLOCK) { -#if DEBUG - text_color_set (DW_COLOR_INFO); - dw_printf ("KISS SEND - discarding message because write would block.\n"); -#endif - } - else if (err != kiss_len) - { - text_color_set(DW_COLOR_ERROR); - dw_printf ("\nError sending KISS message to client application on pseudo terminal. fd=%d, len=%d, write returned %d, errno = %d\n\n", - pt_master_fd, kiss_len, err, errno); - perror ("pt write"); - } - -#endif - -#if __CYGWIN__ || __WIN32__ - - -/* - * This write can block if nothing is connected to the other end. - * The solution is found in the com0com ReadMe file: - * - * Q. My application hangs during its startup when it sends anything to one paired - * COM port. The only way to unhang it is to start HyperTerminal, which is connected - * to the other paired COM port. I didn't have this problem with physical serial - * ports. - * A. Your application can hang because receive buffer overrun is disabled by - * default. You can fix the problem by enabling receive buffer overrun for the - * receiving port. Also, to prevent some flow control issues you need to enable - * baud rate emulation for the sending port. So, if your application use port CNCA0 - * and other paired port is CNCB0, then: - * - * 1. Launch the Setup Command Prompt shortcut. - * 2. Enter the change commands, for example: - * - * command> change CNCB0 EmuOverrun=yes - * command> change CNCA0 EmuBR=yes - */ - -#if __WIN32__ - - DWORD nwritten; - - /* Without this, write blocks while we are waiting on a read. */ - static OVERLAPPED ov_wr; - memset (&ov_wr, 0, sizeof(ov_wr)); - - if ( ! WriteFile (nullmodem_fd, kiss_buff, kiss_len, &nwritten, &ov_wr)) - { - err = GetLastError(); - if (err != ERROR_IO_PENDING) - { - text_color_set(DW_COLOR_ERROR); - dw_printf ("\nError sending KISS message to client application thru null modem. Error %d.\n\n", (int)GetLastError()); - //CloseHandle (nullmodem_fd); - //nullmodem_fd = MYFDERROR; - } - } - else if (nwritten != kiss_len) - { - text_color_set(DW_COLOR_ERROR); - dw_printf ("\nError sending KISS message to client application thru null modem. Only %d of %d written.\n\n", (int)nwritten, kiss_len); - //CloseHandle (nullmodem_fd); - //nullmodem_fd = MYFDERROR; - } - -#if DEBUG - /* Could wait with GetOverlappedResult but we never */ - /* have an issues in this direction. */ - //text_color_set(DW_COLOR_DEBUG); - //dw_printf ("KISS SEND completed. wrote %d / %d\n", nwritten, kiss_len); -#endif - -#else - err = write (nullmodem_fd, kiss_buf, (size_t)kiss_len); - if (err != len) - { - text_color_set(DW_COLOR_ERROR); - dw_printf ("\nError sending KISS message to client application thru null modem. err=%d\n\n", err); - //close (nullmodem_fd); - //nullmodem_fd = MYFDERROR; - } -#endif - -#endif - -} /* kiss_send_rec_packet */ - - - -/*------------------------------------------------------------------- - * - * Name: kiss_listen_thread - * - * Purpose: Wait for messages from an application. - * - * Global In: nullmodem_fd or pt_master_fd - * - * Description: Process messages from the client application. - * - *--------------------------------------------------------------------*/ - -/* Return one byte (value 0 - 255) or terminate thread on error. */ - - -static int kiss_get (/* MYFDTYPE fd*/ void ) -{ - unsigned char ch; - -#if __WIN32__ /* Native Windows version. */ - - DWORD n; - static OVERLAPPED ov_rd; - - memset (&ov_rd, 0, sizeof(ov_rd)); - ov_rd.hEvent = CreateEvent (NULL, TRUE, FALSE, NULL); - - - /* Overlapped I/O makes reading rather complicated. */ - /* See: http://msdn.microsoft.com/en-us/library/ms810467.aspx */ - - /* It seems that the read completes OK with a count */ - /* of 0 every time we send a message to the serial port. */ - - n = 0; /* Number of characters read. */ - - while (n == 0) { - - if ( ! ReadFile (nullmodem_fd, &ch, 1, &n, &ov_rd)) - { - int err1 = GetLastError(); - - if (err1 == ERROR_IO_PENDING) - { - /* Wait for completion. */ - - if (WaitForSingleObject (ov_rd.hEvent, INFINITE) == WAIT_OBJECT_0) - { - if ( ! GetOverlappedResult (nullmodem_fd, &ov_rd, &n, 1)) - { - int err3 = GetLastError(); - - text_color_set(DW_COLOR_ERROR); - dw_printf ("\nKISS GetOverlappedResult error %d.\n\n", err3); - } - else - { - /* Success! n should be 1 */ - } - } - } - else - { - text_color_set(DW_COLOR_ERROR); - dw_printf ("\nKISS ReadFile error %d. Closing connection.\n\n", err1); - CloseHandle (nullmodem_fd); - nullmodem_fd = MYFDERROR; - //pthread_exit (NULL); - } - } - - } /* end while n==0 */ - - CloseHandle(ov_rd.hEvent); - - if (n != 1) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("\nKISS failed to get one byte. n=%d.\n\n", (int)n); - -#if DEBUG9 - fprintf (log_fp, "n=%d\n", n); -#endif - } - - -#else /* Linux/Cygwin version */ - - int n = 0; - - while ( n == 0 ) { - - n = read(pt_master_fd, &ch, (size_t)1); - - if (n != 1) { - - text_color_set(DW_COLOR_ERROR); - dw_printf ("\nError receiving kiss message from client application. Closing %s.\n\n", pt_slave_name); - perror (""); - - /* Message added between 1.1 beta test and final version 1.1 */ - - /* TODO: Determine root cause and find proper solution. */ - - dw_printf ("This is a known problem that sometimes shows up when using with kissattach.\n"); - dw_printf ("There are a couple work-arounds described in the Dire Wolf User Guide\n"); - dw_printf ("and the Raspberry Pi APRS documents.\n"); - - close (pt_master_fd); - - pt_master_fd = MYFDERROR; - unlink (TMP_KISSTNC_SYMLINK); - pthread_exit (NULL); - } - } - -#endif - -#if DEBUGx - text_color_set(DW_COLOR_DEBUG); - dw_printf ("kiss_get(%d) returns 0x%02x\n", fd, ch); -#endif - -#if DEBUG9 - fprintf (log_fp, "%02x %c %c", ch, - isprint(ch) ? ch : '.' , - (isupper(ch>>1) || isdigit(ch>>1) || (ch>>1) == ' ') ? (ch>>1) : '.'); - if (ch == FEND) fprintf (log_fp, " FEND"); - if (ch == FESC) fprintf (log_fp, " FESC"); - if (ch == TFEND) fprintf (log_fp, " TFEND"); - if (ch == TFESC) fprintf (log_fp, " TFESC"); - if (ch == '\r') fprintf (log_fp, " CR"); - if (ch == '\n') fprintf (log_fp, " LF"); - fprintf (log_fp, "\n"); - if (ch == FEND) fflush (log_fp); -#endif - return (ch); -} - - - - -static THREAD_F kiss_listen_thread (void *arg) -{ - unsigned char ch; - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("kiss_listen_thread ( %d )\n", fd); -#endif - - - while (1) { - ch = kiss_get(); - kiss_rec_byte (&kf, ch, kiss_debug, kiss_send_rec_packet); - } - -#if __WIN32__ - return(0); -#else - return; /* Unreachable but avoids compiler warning. */ -#endif -} - -/* end kiss.c */ diff --git a/kiss.h b/kiss.h deleted file mode 100644 index 4c037fbb..00000000 --- a/kiss.h +++ /dev/null @@ -1,21 +0,0 @@ - -/* - * Name: kiss.h - */ - - -#include "ax25_pad.h" /* for packet_t */ - -#include "config.h" - - - - -void kiss_init (struct misc_config_s *misc_config); - -void kiss_send_rec_packet (int chan, unsigned char *fbuf, int flen); - -void kiss_serial_set_debug (int n); - - -/* end kiss.h */ diff --git a/kiss_frame.c b/kiss_frame.c deleted file mode 100644 index 9c56e94d..00000000 --- a/kiss_frame.c +++ /dev/null @@ -1,643 +0,0 @@ -// -// This file is part of Dire Wolf, an amateur radio packet TNC. -// -// Copyright (C) 2013, 2014 John Langner, WB2OSZ -// -// This program 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 2 of the License, or -// (at your option) any later version. -// -// This program 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 this program. If not, see . -// - - - -/*------------------------------------------------------------------ - * - * Module: kiss_frame.c - * - * Purpose: Common code used by Serial port and network versions of KISS protocol. - * - * Description: The KISS TNS protocol is described in http://www.ka9q.net/papers/kiss.html - * - * Briefly, a frame is composed of - * - * * FEND (0xC0) - * * Contents - with special escape sequences so a 0xc0 - * byte in the data is not taken as end of frame. - * as part of the data. - * * FEND - * - * The first byte of the frame contains: - * - * * port number in upper nybble. - * * command in lower nybble. - * - * - * Commands from application recognized: - * - * 0 Data Frame AX.25 frame in raw format. - * - * 1 TXDELAY See explanation in xmit.c. - * - * 2 Persistence " " - * - * 3 SlotTime " " - * - * 4 TXtail " " - * Spec says it is obsolete but Xastir - * sends it and we respect it. - * - * 5 FullDuplex Ignored. Always full duplex. - * - * 6 SetHardware TNC specific. Ignored. - * - * FF Return Exit KISS mode. Ignored. - * - * - * Messages sent to client application: - * - * 0 Data Frame Received AX.25 frame in raw format. - * - *---------------------------------------------------------------*/ - -#include -#include - -#include -#include - -#include -#include - -#include "direwolf.h" -#include "ax25_pad.h" -#include "textcolor.h" -#include "kiss_frame.h" -#include "tq.h" -#include "xmit.h" - -/* In server.c. Should probably move to some misc. function file. */ -void hex_dump (unsigned char *p, int len); - - -static void kiss_process_msg (unsigned char *kiss_msg, int kiss_len, int debug); - - -#if TEST - -#define dw_printf printf - -void text_color_set (dw_color_t c) -{ - return; -} - -#endif - - - -/*------------------------------------------------------------------- - * - * Name: kiss_encapsulate - * - * Purpose: Ecapsulate a frame into KISS format. - * - * Inputs: in - Address of input block. - * First byte is the "type indicator" with type and - * channel but we don't care about that here. - * Note that this is "binary" data and can contain - * nul (0x00) values. Don't treat it like a text string! - * - * ilen - Number of bytes in input block. - * - * Outputs: out - Address where to place the KISS encoded representation. - * The sequence is: - * FEND - Magic frame separator. - * data - with certain byte values replaced so - * FEND will never occur here. - * FEND - Magic frame separator. - * - * Returns: Number of bytes in the output. - * Absolute max length will be twice input plus 2. - * - *-----------------------------------------------------------------*/ - -int kiss_encapsulate (unsigned char *in, int ilen, unsigned char *out) -{ - int olen; - int j; - - olen = 0; - out[olen++] = FEND; - for (j=0; j - * <0x0d> - * XFLOW OFF<0x0d> - * FULLDUP OFF<0x0d> - * KISS ON<0x0d> - * RESTART<0x0d> - * <0x03><0x03><0x03> - * TC 1<0x0d> - * TN 2,0<0x0d><0x0d><0x0d> - * XFLOW OFF<0x0d> - * FULLDUP OFF<0x0d> - * KISS ON<0x0d> - * RESTART<0x0d> - * - * This keeps repeating over and over and over and over again if - * it doesn't get any sort of response. - * - * Let's try to keep it happy by sending back a command prompt. - */ - - - - -void kiss_rec_byte (kiss_frame_t *kf, unsigned char ch, int debug, void (*sendfun)(int,unsigned char*,int)) -{ - - //printf ("kiss_frame ( %c %02x ) \n", ch, ch); - - switch (kf->state) { - - case KS_SEARCHING: /* Searching for starting FEND. */ - default: - - if (ch == FEND) { - - /* Start of frame. But first print any collected noise for debugging. */ - - if (kf->noise_len > 0) { - if (debug) { - kiss_debug_print (FROM_CLIENT, "Rejected Noise", kf->noise, kf->noise_len); - } - kf->noise_len = 0; - } - - kf->kiss_len = 0; - kf->kiss_msg[kf->kiss_len++] = ch; - kf->state = KS_COLLECTING; - return; - } - - /* Noise to be rejected. */ - - if (kf->noise_len < MAX_NOISE_LEN) { - kf->noise[kf->noise_len++] = ch; - } - if (ch == '\r') { - if (debug) { - kiss_debug_print (FROM_CLIENT, "Rejected Noise", kf->noise, kf->noise_len); - kf->noise[kf->noise_len] = '\0'; - } - - /* Try to appease client app by sending something back. */ - if (strcasecmp("restart\r", (char*)(kf->noise)) == 0 || - strcasecmp("reset\r", (char*)(kf->noise)) == 0) { - (*sendfun) (0, (unsigned char *)"\xc0\xc0", -1); - } - else { - (*sendfun) (0, (unsigned char *)"\r\ncmd:", -1); - } - kf->noise_len = 0; - } - return; - break; - - case KS_COLLECTING: /* Frame collection in progress. */ - - - if (ch == FEND) { - - unsigned char unwrapped[AX25_MAX_PACKET_LEN]; - int ulen; - - /* End of frame. */ - - if (kf->kiss_len == 0) { - /* Empty frame. Starting a new one. */ - kf->kiss_msg[kf->kiss_len++] = ch; - return; - } - if (kf->kiss_len == 1 && kf->kiss_msg[0] == FEND) { - /* Empty frame. Just go on collecting. */ - return; - } - - kf->kiss_msg[kf->kiss_len++] = ch; - if (debug) { - /* As received over the wire from client app. */ - kiss_debug_print (FROM_CLIENT, NULL, kf->kiss_msg, kf->kiss_len); - } - - ulen = kiss_unwrap (kf->kiss_msg, kf->kiss_len, unwrapped); - - if (debug >= 2) { - /* Append CRC to this and it goes out over the radio. */ - text_color_set(DW_COLOR_DEBUG); - dw_printf ("\n"); - dw_printf ("Packet content after removing KISS framing and any escapes:\n"); - /* Don't include the "type" indicator. */ - /* It contains the radio channel and type should always be 0 here. */ - hex_dump (unwrapped+1, ulen-1); - } - - kiss_process_msg (unwrapped, ulen, debug); - - kf->state = KS_SEARCHING; - return; - } - - if (kf->kiss_len < MAX_KISS_LEN) { - kf->kiss_msg[kf->kiss_len++] = ch; - } - else { - text_color_set(DW_COLOR_ERROR); - dw_printf ("KISS message exceeded maximum length.\n"); - } - return; - break; - } - - return; /* unreachable but suppress compiler warning. */ - -} /* end kiss_rec_byte */ - - - - -/*------------------------------------------------------------------- - * - * Name: kiss_process_msg - * - * Purpose: Process a message from the KISS client. - * - * Inputs: kiss_msg - Kiss frame with FEND and escapes removed. - * The first byte contains channel and command. - * - * kiss_len - Number of bytes including the command. - * - * debug - Debug option is selected. - * - *-----------------------------------------------------------------*/ - -static void kiss_process_msg (unsigned char *kiss_msg, int kiss_len, int debug) -{ - int port; - int cmd; - packet_t pp; - - port = (kiss_msg[0] >> 4) & 0xf; - cmd = kiss_msg[0] & 0xf; - - switch (cmd) - { - case 0: /* Data Frame */ - - /* Special hack - Discard apparently bad data from Linux AX25. */ - - if ((port == 2 || port == 8) && - kiss_msg[1] == 'Q' << 1 && - kiss_msg[2] == 'S' << 1 && - kiss_msg[3] == 'T' << 1 && - kiss_msg[4] == ' ' << 1 && - kiss_msg[15] == 3 && - kiss_msg[16] == 0xcd) { - - if (debug) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Special case - Drop packets which appear to be in error.\n"); - } - return; - } - - // Should really check if single or dual channel mode. - // Do more thoroughly in 1.2. - - if (port != 0 && port != 1) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Invalid channel %d from KISS client app.\n", port); - return; - } - - pp = ax25_from_frame (kiss_msg+1, kiss_len-1, -1); - if (pp == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("ERROR - Invalid KISS data frame from client app.\n"); - } - else { - - /* How can we determine if it is an original or repeated message? */ - /* If there is at least one digipeater in the frame, AND */ - /* that digipeater has been used, it should go out quickly thru */ - /* the high priority queue. */ - /* Otherwise, it is an original for the low priority queue. */ - - if (ax25_get_num_repeaters(pp) >= 1 && - ax25_get_h(pp,AX25_REPEATER_1)) { - tq_append (port, TQ_PRIO_0_HI, pp); - } - else { - tq_append (port, TQ_PRIO_1_LO, pp); - } - } - break; - - case 1: /* TXDELAY */ - - text_color_set(DW_COLOR_INFO); - dw_printf ("KISS protocol set TXDELAY = %d, port %d\n", kiss_msg[1], port); - xmit_set_txdelay (port, kiss_msg[1]); - break; - - case 2: /* Persistence */ - - text_color_set(DW_COLOR_INFO); - dw_printf ("KISS protocol set Persistence = %d, port %d\n", kiss_msg[1], port); - xmit_set_persist (port, kiss_msg[1]); - break; - - case 3: /* SlotTime */ - - text_color_set(DW_COLOR_INFO); - dw_printf ("KISS protocol set SlotTime = %d, port %d\n", kiss_msg[1], port); - xmit_set_slottime (port, kiss_msg[1]); - break; - - case 4: /* TXtail */ - - text_color_set(DW_COLOR_INFO); - dw_printf ("KISS protocol set TXtail = %d, port %d\n", kiss_msg[1], port); - xmit_set_txtail (port, kiss_msg[1]); - break; - - case 5: /* FullDuplex */ - - text_color_set(DW_COLOR_INFO); - dw_printf ("KISS protocol set FullDuplex = %d, port %d\n", kiss_msg[1], port); - break; - - case 6: /* TNC specific */ - - text_color_set(DW_COLOR_INFO); - dw_printf ("KISS protocol set hardware - ignored.\n"); - break; - - case 15: /* End KISS mode, port should be 15. */ - /* Ignore it. */ - text_color_set(DW_COLOR_INFO); - dw_printf ("KISS protocol end KISS mode\n"); - break; - - default: - text_color_set(DW_COLOR_DEBUG); - dw_printf ("KISS Invalid command %d\n", cmd); - kiss_debug_print (FROM_CLIENT, NULL, kiss_msg, kiss_len); - break; - } - -} /* end kiss_process_msg */ - - -/*------------------------------------------------------------------- - * - * Name: kiss_debug_print - * - * Purpose: Print message to/from client for debugging. - * - * Inputs: fromto - Direction of message. - * special - Comment if not a KISS frame. - * pmsg - Address of the message block. - * msg_len - Length of the message. - * - *--------------------------------------------------------------------*/ - - -void kiss_debug_print (fromto_t fromto, char *special, unsigned char *pmsg, int msg_len) -{ - const char *direction [2] = { "from", "to" }; - const char *prefix [2] = { "<<<", ">>>" }; - const char *function[16] = { - "Data frame", "TXDELAY", "P", "SlotTime", - "TXtail", "FullDuplex", "SetHardware", "Invalid 7", - "Invalid 8", "Invalid 9", "Invalid 10", "Invalid 11", - "Invalid 12", "Invalid 13", "Invalid 14", "Return" }; - - - text_color_set(DW_COLOR_DEBUG); - dw_printf ("\n"); - - if (special == NULL) { - unsigned char *p; /* to skip over FEND if present. */ - - p = pmsg; - if (*p == FEND) p++; - - dw_printf ("%s %s %s KISS client application, port %d, total length = %d\n", - prefix[(int)fromto], function[p[0] & 0xf], direction[(int)fromto], - (p[0] >> 4) & 0xf, msg_len); - } - else { - dw_printf ("%s %s %s KISS client application, total length = %d\n", - prefix[(int)fromto], special, direction[(int)fromto], - msg_len); - } - hex_dump (pmsg, msg_len); - -} /* end kiss_debug_print */ - - -#endif - - -/* Quick unit test for encapsulate & unwrap */ - -// $ gcc -DTEST kiss_frame.c ; ./a -// Quick KISS test passed OK. - - -#if TEST - - -main () -{ - unsigned char din[512]; - unsigned char kissed[520]; - unsigned char dout[520]; - int klen; - int dlen; - int k; - - for (k = 0; k < 512; k++) { - if (k < 256) { - din[k] = k; - } - else { - din[k] = 511 - k; - } - } - - klen = kiss_encapsulate (din, 512, kissed); - assert (klen == 512 + 6); - - dlen = kiss_unwrap (kissed, klen, dout); - assert (dlen == 512); - assert (memcmp(din, dout, 512) == 0); - - dlen = kiss_unwrap (kissed+1, klen-1, dout); - assert (dlen == 512); - assert (memcmp(din, dout, 512) == 0); - - printf ("Quick KISS test passed OK.\n"); -} - -#endif - -/* end kiss_frame.c */ diff --git a/kiss_frame.h b/kiss_frame.h deleted file mode 100644 index 118f48ed..00000000 --- a/kiss_frame.h +++ /dev/null @@ -1,51 +0,0 @@ - -/* kiss_frame.h */ - - -/* - * Special characters used by SLIP protocol. - */ - -#define FEND 0xC0 -#define FESC 0xDB -#define TFEND 0xDC -#define TFESC 0xDD - - -enum kiss_state_e { - KS_SEARCHING, /* Looking for FEND to start KISS frame. */ - KS_COLLECTING}; /* In process of collecting KISS frame. */ - - -#define MAX_KISS_LEN 2048 /* Spec calls for at least 1024. */ - /* Might want to make it longer to accomodate */ - /* maximum packet length. */ - -#define MAX_NOISE_LEN 100 - -typedef struct kiss_frame_s { - - enum kiss_state_e state; - - unsigned char kiss_msg[MAX_KISS_LEN]; - /* Leading FEND is optional. */ - /* Contains escapes and ending FEND. */ - int kiss_len; - - unsigned char noise[MAX_NOISE_LEN]; - int noise_len; - -} kiss_frame_t; - - - -int kiss_encapsulate (unsigned char *in, int ilen, unsigned char *out); - -void kiss_rec_byte (kiss_frame_t *kf, unsigned char ch, int debug, void (*sendfun)(int,unsigned char*,int)); - - -typedef enum fromto_e { FROM_CLIENT=0, TO_CLIENT=1 } fromto_t; - -void kiss_debug_print (fromto_t fromto, char *special, unsigned char *pmsg, int msg_len); - -/* end kiss_frame.h */ \ No newline at end of file diff --git a/kissnet.c b/kissnet.c deleted file mode 100644 index 66c728fa..00000000 --- a/kissnet.c +++ /dev/null @@ -1,666 +0,0 @@ -// -// This file is part of Dire Wolf, an amateur radio packet TNC. -// -// Copyright (C) 2011-2014 John Langner, WB2OSZ -// -// This program 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 2 of the License, or -// (at your option) any later version. -// -// This program 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 this program. If not, see . -// - - -/*------------------------------------------------------------------ - * - * Module: kissnet.c - * - * Purpose: Provide service to other applications via KISS protocol via TCP socket. - * - * Input: - * - * Outputs: - * - * Description: This provides a TCP socket for communication with a client application. - * - * It implements the KISS TNS protocol as described in: - * http://www.ka9q.net/papers/kiss.html - * - * Briefly, a frame is composed of - * - * * FEND (0xC0) - * * Contents - with special escape sequences so a 0xc0 - * byte in the data is not taken as end of frame. - * as part of the data. - * * FEND - * - * The first byte of the frame contains: - * - * * port number in upper nybble. - * * command in lower nybble. - * - * - * Commands from application recognized: - * - * 0 Data Frame AX.25 frame in raw format. - * - * 1 TXDELAY See explanation in xmit.c. - * - * 2 Persistence " " - * - * 3 SlotTime " " - * - * 4 TXtail " " - * Spec says it is obsolete but Xastir - * sends it and we respect it. - * - * 5 FullDuplex Ignored. Always full duplex. - * - * 6 SetHardware TNC specific. Ignored. - * - * FF Return Exit KISS mode. Ignored. - * - * - * Messages sent to client application: - * - * 0 Data Frame Received AX.25 frame in raw format. - * - * - * - * - * References: Getting Started with Winsock - * http://msdn.microsoft.com/en-us/library/windows/desktop/bb530742(v=vs.85).aspx - * - * Future: Originally we had: - * KISS over serial port. - * AGW over socket. - * This is the two of them munged together and we end up with duplicate code. - * It would have been better to separate out the transport and application layers. - * Maybe someday. - * - *---------------------------------------------------------------*/ - - -/* - * Native Windows: Use the Winsock interface. - * Linux: Use the BSD socket interface. - * Cygwin: Can use either one. - */ - - -#if __WIN32__ -#include -#define _WIN32_WINNT 0x0501 -#include -#else -#include -#include -#include -#include -#include -#endif - -#include -#include -#include - -#include - - -#include "direwolf.h" -#include "tq.h" -#include "ax25_pad.h" -#include "textcolor.h" -#include "audio.h" -#include "kissnet.h" -#include "kiss_frame.h" -#include "xmit.h" - - -static kiss_frame_t kf; /* Accumulated KISS frame and state of decoder. */ - // TODO: multiple instances if multiple KISS network clients! - - -static int client_sock; /* File descriptor for socket for */ - /* communication with client application. */ - /* Set to -1 if not connected. */ - /* (Don't use SOCKET type because it is unsigned.) */ - -static int num_channels; /* Number of radio ports. */ - - -static void * connect_listen_thread (void *arg); -static void * kissnet_listen_thread (void *arg); - - - -static int kiss_debug = 0; /* Print information flowing from and to client. */ - -void kiss_net_set_debug (int n) -{ - kiss_debug = n; -} - - - -/*------------------------------------------------------------------- - * - * Name: kissnet_init - * - * Purpose: Set up a server to listen for connection requests from - * an application such as Xastir or APRSIS32. - * - * Inputs: mc->kiss_port - TCP port for server. - * Main program has default of 8000 but allows - * an alternative to be specified on the command line - * - * Outputs: - * - * Description: This starts two threads: - * * to listen for a connection from client app. - * * to listen for commands from client app. - * so the main application doesn't block while we wait for these. - * - *--------------------------------------------------------------------*/ - - -void kissnet_init (struct misc_config_s *mc) -{ -#if __WIN32__ - HANDLE connect_listen_th; - HANDLE cmd_listen_th; -#else - pthread_t connect_listen_tid; - pthread_t cmd_listen_tid; -#endif - int e; - int kiss_port = mc->kiss_port; - - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("kissnet_init ( %d )\n", kiss_port); -#endif - - memset (&kf, 0, sizeof(kf)); - - client_sock = -1; - num_channels = mc->num_channels; - -/* - * This waits for a client to connect and sets client_sock. - */ -#if __WIN32__ - connect_listen_th = _beginthreadex (NULL, 0, connect_listen_thread, (void *)kiss_port, 0, NULL); - if (connect_listen_th == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Could not create KISS socket connect listening thread\n"); - return; - } -#else - e = pthread_create (&connect_listen_tid, NULL, connect_listen_thread, (void *)(long)kiss_port); - if (e != 0) { - text_color_set(DW_COLOR_ERROR); - perror("Could not create KISS socket connect listening thread"); - return; - } -#endif - -/* - * This reads messages from client when client_sock is valid. - */ -#if __WIN32__ - cmd_listen_th = _beginthreadex (NULL, 0, kissnet_listen_thread, NULL, 0, NULL); - if (cmd_listen_th == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Could not create KISS socket command listening thread\n"); - return; - } -#else - e = pthread_create (&cmd_listen_tid, NULL, kissnet_listen_thread, NULL); - if (e != 0) { - text_color_set(DW_COLOR_ERROR); - perror("Could not create KISS socket command listening thread"); - return; - } -#endif -} - - -/*------------------------------------------------------------------- - * - * Name: connect_listen_thread - * - * Purpose: Wait for a connection request from an application. - * - * Inputs: arg - TCP port for server. - * Main program has default of 8001 but allows - * an alternative to be specified on the command line - * - * Outputs: client_sock - File descriptor for communicating with client app. - * - * Description: Wait for connection request from client and establish - * communication. - * Note that the client can go away and come back again and - * re-establish communication without restarting this application. - * - *--------------------------------------------------------------------*/ - -static void * connect_listen_thread (void *arg) -{ -#if __WIN32__ - - struct addrinfo hints; - struct addrinfo *ai = NULL; - int err; - char kiss_port_str[12]; - - SOCKET listen_sock; - WSADATA wsadata; - - sprintf (kiss_port_str, "%d", (int)(long)arg); -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("DEBUG: kissnet port = %d = '%s'\n", (int)(long)arg, kiss_port_str); -#endif - err = WSAStartup (MAKEWORD(2,2), &wsadata); - if (err != 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf("WSAStartup failed: %d\n", err); - return (NULL); - } - - if (LOBYTE(wsadata.wVersion) != 2 || HIBYTE(wsadata.wVersion) != 2) { - text_color_set(DW_COLOR_ERROR); - dw_printf("Could not find a usable version of Winsock.dll\n"); - WSACleanup(); - //sleep (1); - return (NULL); - } - - memset (&hints, 0, sizeof(hints)); - hints.ai_family = AF_INET; - hints.ai_socktype = SOCK_STREAM; - hints.ai_protocol = IPPROTO_TCP; - hints.ai_flags = AI_PASSIVE; - - err = getaddrinfo(NULL, kiss_port_str, &hints, &ai); - if (err != 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf("getaddrinfo failed: %d\n", err); - //sleep (1); - WSACleanup(); - return (NULL); - } - - listen_sock= socket(ai->ai_family, ai->ai_socktype, ai->ai_protocol); - if (listen_sock == INVALID_SOCKET) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("connect_listen_thread: Socket creation failed, err=%d", WSAGetLastError()); - return (NULL); - } - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf("Binding to port %s ... \n", kiss_port_str); -#endif - - err = bind( listen_sock, ai->ai_addr, (int)ai->ai_addrlen); - if (err == SOCKET_ERROR) { - text_color_set(DW_COLOR_ERROR); - dw_printf("Bind failed with error: %d\n", WSAGetLastError()); - freeaddrinfo(ai); - closesocket(listen_sock); - WSACleanup(); - return (NULL); - } - - freeaddrinfo(ai); - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf("opened KISS socket as fd (%d) on port (%s) for stream i/o\n", listen_sock, kiss_port_str ); -#endif - - while (1) { - - while (client_sock > 0) { - SLEEP_SEC(1); /* Already connected. Try again later. */ - } - -#define QUEUE_SIZE 5 - - if(listen(listen_sock,QUEUE_SIZE) == SOCKET_ERROR) - { - text_color_set(DW_COLOR_ERROR); - dw_printf("Listen failed with error: %d\n", WSAGetLastError()); - return (NULL); - } - - text_color_set(DW_COLOR_INFO); - dw_printf("Ready to accept KISS client application on port %s ...\n", kiss_port_str); - - client_sock = accept(listen_sock, NULL, NULL); - - if (client_sock == -1) { - text_color_set(DW_COLOR_ERROR); - dw_printf("Accept failed with error: %d\n", WSAGetLastError()); - closesocket(listen_sock); - WSACleanup(); - return (NULL); - } - - text_color_set(DW_COLOR_INFO); - dw_printf("\nConnected to KISS client application ...\n\n"); - - } - -#else - - struct sockaddr_in sockaddr; /* Internet socket address stuct */ - socklen_t sockaddr_size = sizeof(struct sockaddr_in); - int kiss_port = (int)(long)arg; - int listen_sock; - - listen_sock= socket(AF_INET,SOCK_STREAM,0); - if (listen_sock == -1) { - text_color_set(DW_COLOR_ERROR); - perror ("connect_listen_thread: Socket creation failed"); - return (NULL); - } - - sockaddr.sin_addr.s_addr = INADDR_ANY; - sockaddr.sin_port = htons(kiss_port); - sockaddr.sin_family = AF_INET; - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf("Binding to port %d ... \n", kiss_port); -#endif - - if (bind(listen_sock,(struct sockaddr*)&sockaddr,sizeof(sockaddr)) == -1) { - text_color_set(DW_COLOR_ERROR); - perror ("connect_listen_thread: Bind failed"); - return (NULL); - } - - getsockname( listen_sock, (struct sockaddr *)(&sockaddr), &sockaddr_size); - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf("opened KISS socket as fd (%d) on port (%d) for stream i/o\n", listen_sock, ntohs(sockaddr.sin_port) ); -#endif - - while (1) { - - while (client_sock > 0) { - SLEEP_SEC(1); /* Already connected. Try again later. */ - } - -#define QUEUE_SIZE 5 - - if(listen(listen_sock,QUEUE_SIZE) == -1) - { - text_color_set(DW_COLOR_ERROR); - perror ("connect_listen_thread: Listen failed"); - return (NULL); - } - - text_color_set(DW_COLOR_INFO); - dw_printf("Ready to accept KISS client application on port %d ...\n", kiss_port); - - client_sock = accept(listen_sock, (struct sockaddr*)(&sockaddr),&sockaddr_size); - - text_color_set(DW_COLOR_INFO); - dw_printf("\nConnected to KISS client application ...\n\n"); - - } -#endif -} - - - - - -/*------------------------------------------------------------------- - * - * Name: kissnet_send_rec_packet - * - * Purpose: Send a received packet to the client app. - * - * Inputs: chan - Channel number where packet was received. - * 0 = first, 1 = second if any. - * - * fbuf - Address of raw received frame buffer - * or a text string. - * - * flen - Number of bytes for AX.25 frame. - * or -1 for a text string. - * - * - * Description: Send message to client if connected. - * Disconnect from client, and notify user, if any error. - * - *--------------------------------------------------------------------*/ - - -void kissnet_send_rec_packet (int chan, unsigned char *fbuf, int flen) -{ - unsigned char kiss_buff[2 * AX25_MAX_PACKET_LEN]; - int kiss_len; - int j; - int err; - - - if (client_sock == -1) { - return; - } - if (flen < 0) { - flen = strlen((char*)fbuf); - if (kiss_debug) { - kiss_debug_print (TO_CLIENT, "Fake command prompt", fbuf, flen); - } - strcpy ((char *)kiss_buff, (char *)fbuf); - kiss_len = strlen((char *)kiss_buff); - } - else { - - - unsigned char stemp[AX25_MAX_PACKET_LEN + 1]; - - assert (flen < sizeof(stemp)); - - stemp[0] = (chan << 4) + 0; - memcpy (stemp+1, fbuf, flen); - - if (kiss_debug >= 2) { - /* AX.25 frame with the CRC removed. */ - text_color_set(DW_COLOR_DEBUG); - dw_printf ("\n"); - dw_printf ("Packet content before adding KISS framing and any escapes:\n"); - hex_dump ((char*)fbuf, flen); - } - - kiss_len = kiss_encapsulate (stemp, flen+1, kiss_buff); - - /* This has the escapes and the surrounding FENDs. */ - - if (kiss_debug) { - kiss_debug_print (TO_CLIENT, NULL, kiss_buff, kiss_len); - } - } - -#if __WIN32__ - err = send (client_sock, (char*)kiss_buff, kiss_len, 0); - if (err == SOCKET_ERROR) - { - text_color_set(DW_COLOR_ERROR); - dw_printf ("\nError %d sending message to KISS client application. Closing connection.\n\n", WSAGetLastError()); - closesocket (client_sock); - client_sock = -1; - WSACleanup(); - } -#else - err = write (client_sock, kiss_buff, kiss_len); - if (err <= 0) - { - text_color_set(DW_COLOR_ERROR); - dw_printf ("\nError sending message to KISS client application. Closing connection.\n\n"); - close (client_sock); - client_sock = -1; - } -#endif - -} /* end kissnet_send_rec_packet */ - - - -/*------------------------------------------------------------------- - * - * Name: read_from_socket - * - * Purpose: Read from socket until we have desired number of bytes. - * - * Inputs: fd - file descriptor. - * ptr - address where data should be placed. - * len - desired number of bytes. - * - * Description: Just a wrapper for the "read" system call but it should - * never return fewer than the desired number of bytes. - * - * Not really needed for KISS because we are dealing with - * a stream of bytes rather than message blocks. - * - *--------------------------------------------------------------------*/ - -static int read_from_socket (int fd, char *ptr, int len) -{ - int got_bytes = 0; - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("read_from_socket (%d, %p, %d)\n", fd, ptr, len); -#endif - while (got_bytes < len) { - int n; - -#if __WIN32__ - -//TODO: any flags for send/recv? - - n = recv (fd, ptr + got_bytes, len - got_bytes, 0); -#else - n = read (fd, ptr + got_bytes, len - got_bytes); -#endif - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("read_from_socket: n = %d\n", n); -#endif - if (n <= 0) { - return (n); - } - - got_bytes += n; - } - assert (got_bytes >= 0 && got_bytes <= len); - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("read_from_socket: return %d\n", got_bytes); -#endif - return (got_bytes); -} - - -/*------------------------------------------------------------------- - * - * Name: kissnet_listen_thread - * - * Purpose: Wait for KISS messages from an application. - * - * Inputs: arg - Not used. - * - * Outputs: client_sock - File descriptor for communicating with client app. - * - * Description: Process messages from the client application. - * Note that the client can go away and come back again and - * re-establish communication without restarting this application. - * - *--------------------------------------------------------------------*/ - - -/* Return one byte (value 0 - 255) */ - - -static int kiss_get (void) -{ - unsigned char ch; - int n; - - while (1) { - - while (client_sock <= 0) { - SLEEP_SEC(1); /* Not connected. Try again later. */ - } - - /* Just get one byte at a time. */ - - n = read_from_socket (client_sock, (char *)(&ch), 1); - - if (n == 1) { -#if DEBUG9 - dw_printf (log_fp, "%02x %c %c", ch, - isprint(ch) ? ch : '.' , - (isupper(ch>>1) || isdigit(ch>>1) || (ch>>1) == ' ') ? (ch>>1) : '.'); - if (ch == FEND) fprintf (log_fp, " FEND"); - if (ch == FESC) fprintf (log_fp, " FESC"); - if (ch == TFEND) fprintf (log_fp, " TFEND"); - if (ch == TFESC) fprintf (log_fp, " TFESC"); - if (ch == '\r') fprintf (log_fp, " CR"); - if (ch == '\n') fprintf (log_fp, " LF"); - fprintf (log_fp, "\n"); - if (ch == FEND) fflush (log_fp); -#endif - return(ch); - } - - text_color_set(DW_COLOR_ERROR); - dw_printf ("\nError reading KISS byte from clent application. Closing connection.\n\n"); -#if __WIN32__ - closesocket (client_sock); -#else - close (client_sock); -#endif - client_sock = -1; - } -} - - - -static void * kissnet_listen_thread (void *arg) -{ - unsigned char ch; - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("kissnet_listen_thread ( socket = %d )\n", client_sock); -#endif - - while (1) { - ch = kiss_get(); - kiss_rec_byte (&kf, ch, kiss_debug, kissnet_send_rec_packet); - } - - return (NULL); /* to suppress compiler warning. */ - -} /* end kissnet_listen_thread */ - -/* end kissnet.c */ diff --git a/kissnet.h b/kissnet.h deleted file mode 100644 index 361f435f..00000000 --- a/kissnet.h +++ /dev/null @@ -1,21 +0,0 @@ - -/* - * Name: kissnet.h - */ - - -#include "ax25_pad.h" /* for packet_t */ - -#include "config.h" - - - - -void kissnet_init (struct misc_config_s *misc_config); - -void kissnet_send_rec_packet (int chan, unsigned char *fbuf, int flen); - -void kiss_net_set_debug (int n); - - -/* end kissnet.h */ diff --git a/latlong.c b/latlong.c deleted file mode 100644 index 9d83cad8..00000000 --- a/latlong.c +++ /dev/null @@ -1,521 +0,0 @@ -// -// This file is part of Dire Wolf, an amateur radio packet TNC. -// -// Copyright (C) 2013,2014 John Langner, WB2OSZ -// -// This program 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 2 of the License, or -// (at your option) any later version. -// -// This program 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 this program. If not, see . -// - - -/*------------------------------------------------------------------ - * - * Module: latlong.c - * - * Purpose: Various functions for dealing with latitude and longitude. - * - * Description: Originally, these were scattered around in many places. - * Over time they might all be gathered into one place - * for consistency, reuse, and easier maintenance. - * - *---------------------------------------------------------------*/ - - -#include -#include -#include -#include -#include -#include -#include -#include - -#include "direwolf.h" -#include "latlong.h" -#include "textcolor.h" - - -/*------------------------------------------------------------------ - * - * Name: latitude_to_str - * - * Purpose: Convert numeric latitude to string for transmission. - * - * Inputs: dlat - Floating point degrees. - * ambiguity - If 1, 2, 3, or 4, blank out that many trailing digits. - * - * Outputs: slat - String in format ddmm.mm[NS] - * - * Returns: None - * - *----------------------------------------------------------------*/ - -void latitude_to_str (double dlat, int ambiguity, char *slat) -{ - char hemi; /* Hemisphere: N or S */ - int ideg; /* whole number of degrees. */ - double dmin; /* Minutes after removing degrees. */ - char smin[8]; /* Minutes in format mm.mm */ - - if (dlat < -90.) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Latitude is less than -90. Changing to -90.n"); - dlat = -90.; - } - if (dlat > 90.) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Latitude is greater than 90. Changing to 90.n"); - dlat = 90.; - } - - if (dlat < 0) { - dlat = (- dlat); - hemi = 'S'; - } - else { - hemi = 'N'; - } - - ideg = (int)dlat; - dmin = (dlat - ideg) * 60.; - - sprintf (smin, "%05.2f", dmin); - /* Due to roundoff, 59.9999 could come out as "60.00" */ - if (smin[0] == '6') { - smin[0] = '0'; - ideg++; - } - - sprintf (slat, "%02d%s%c", ideg, smin, hemi); - - if (ambiguity >= 1) { - slat[6] = ' '; - if (ambiguity >= 2) { - slat[5] = ' '; - if (ambiguity >= 3) { - slat[3] = ' '; - if (ambiguity >= 4) { - slat[2] = ' '; - } - } - } - } - -} /* end latitude_to_str */ - - -/*------------------------------------------------------------------ - * - * Name: longitude_to_str - * - * Purpose: Convert numeric longitude to string for transmission. - * - * Inputs: dlong - Floating point degrees. - * ambiguity - If 1, 2, 3, or 4, blank out that many trailing digits. - * - * Outputs: slat - String in format dddmm.mm[NS] - * - * Returns: None - * - *----------------------------------------------------------------*/ - -void longitude_to_str (double dlong, int ambiguity, char *slong) -{ - char hemi; /* Hemisphere: N or S */ - int ideg; /* whole number of degrees. */ - double dmin; /* Minutes after removing degrees. */ - char smin[8]; /* Minutes in format mm.mm */ - - if (dlong < -180.) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Longitude is less than -180. Changing to -180.n"); - dlong = -180.; - } - if (dlong > 180.) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Longitude is greater than 180. Changing to 180.n"); - dlong = 180.; - } - - if (dlong < 0) { - dlong = (- dlong); - hemi = 'W'; - } - else { - hemi = 'E'; - } - - ideg = (int)dlong; - dmin = (dlong - ideg) * 60.; - - sprintf (smin, "%05.2f", dmin); - /* Due to roundoff, 59.9999 could come out as "60.00" */ - if (smin[0] == '6') { - smin[0] = '0'; - ideg++; - } - - sprintf (slong, "%03d%s%c", ideg, smin, hemi); -/* - * The spec says position ambiguity in latitude also - * applies to longitude automatically. - * Blanking longitude digits is not necessary but I do it - * because it makes things clearer. - */ - if (ambiguity >= 1) { - slong[7] = ' '; - if (ambiguity >= 2) { - slong[6] = ' '; - if (ambiguity >= 3) { - slong[4] = ' '; - if (ambiguity >= 4) { - slong[3] = ' '; - } - } - } - } - -} /* end longitude_to_str */ - - -/*------------------------------------------------------------------ - * - * Name: latitude_to_comp_str - * - * Purpose: Convert numeric latitude to compressed string for transmission. - * - * Inputs: dlat - Floating point degrees. - * - * Outputs: slat - String in format yyyy. - * - *----------------------------------------------------------------*/ - -void latitude_to_comp_str (double dlat, char *clat) -{ - int y, y0, y1, y2, y3; - - if (dlat < -90.) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Latitude is less than -90. Changing to -90.n"); - dlat = -90.; - } - if (dlat > 90.) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Latitude is greater than 90. Changing to 90.n"); - dlat = 90.; - } - - y = (int)round(380926. * (90. - dlat)); - - y0 = y / (91*91*91); - y -= y0 * (91*91*91); - - y1 = y / (91*91); - y -= y1 * (91*91); - - y2 = y / (91); - y -= y2 * (91); - - y3 = y; - - clat[0] = y0 + 33; - clat[1] = y1 + 33; - clat[2] = y2 + 33; - clat[3] = y3 + 33; -} - -/*------------------------------------------------------------------ - * - * Name: longitude_to_comp_str - * - * Purpose: Convert numeric longitude to compressed string for transmission. - * - * Inputs: dlong - Floating point degrees. - * - * Outputs: slat - String in format xxxx. - * - *----------------------------------------------------------------*/ - -void longitude_to_comp_str (double dlong, char *clon) -{ - int x, x0, x1, x2, x3; - - if (dlong < -180.) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Longitude is less than -180. Changing to -180.n"); - dlong = -180.; - } - if (dlong > 180.) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Longitude is greater than 180. Changing to 180.n"); - dlong = 180.; - } - - x = (int)round(190463. * (180. + dlong)); - - x0 = x / (91*91*91); - x -= x0 * (91*91*91); - - x1 = x / (91*91); - x -= x1 * (91*91); - - x2 = x / (91); - x -= x2 * (91); - - x3 = x; - - clon[0] = x0 + 33; - clon[1] = x1 + 33; - clon[2] = x2 + 33; - clon[3] = x3 + 33; -} - - -/*------------------------------------------------------------------ - * - * Name: latitude_to_nmea - * - * Purpose: Convert numeric latitude to strings for NMEA sentence. - * - * Inputs: dlat - Floating point degrees. - * - * Outputs: slat - String in format ddmm.mmmm - * hemi - Hemisphere or empty string. - * - * Returns: None - * - *----------------------------------------------------------------*/ - -void latitude_to_nmea (double dlat, char *slat, char *hemi) -{ - int ideg; /* whole number of degrees. */ - double dmin; /* Minutes after removing degrees. */ - char smin[10]; /* Minutes in format mm.mmmm */ - - if (dlat == G_UNKNOWN) { - strcpy (slat, ""); - strcpy (hemi, ""); - return; - } - - if (dlat < -90.) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Latitude is less than -90. Changing to -90.n"); - dlat = -90.; - } - if (dlat > 90.) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Latitude is greater than 90. Changing to 90.n"); - dlat = 90.; - } - - if (dlat < 0) { - dlat = (- dlat); - strcpy (hemi, "S"); - } - else { - strcpy (hemi, "N"); - } - - ideg = (int)dlat; - dmin = (dlat - ideg) * 60.; - - sprintf (smin, "%07.4f", dmin); - /* Due to roundoff, 59.99999 could come out as "60.0000" */ - if (smin[0] == '6') { - smin[0] = '0'; - ideg++; - } - - sprintf (slat, "%02d%s", ideg, smin); - -} /* end latitude_to_str */ - - -/*------------------------------------------------------------------ - * - * Name: longitude_to_nmea - * - * Purpose: Convert numeric longitude to strings for NMEA sentence. - * - * Inputs: dlong - Floating point degrees. - * - * Outputs: slong - String in format dddmm.mmmm - * hemi - Hemisphere or empty string. - * - * Returns: None - * - *----------------------------------------------------------------*/ - -void longitude_to_nmea (double dlong, char *slong, char *hemi) -{ - int ideg; /* whole number of degrees. */ - double dmin; /* Minutes after removing degrees. */ - char smin[10]; /* Minutes in format mm.mmmm */ - - if (dlong == G_UNKNOWN) { - strcpy (slong, ""); - strcpy (hemi, ""); - return; - } - - if (dlong < -180.) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("longitude is less than -180. Changing to -180.n"); - dlong = -180.; - } - if (dlong > 180.) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("longitude is greater than 180. Changing to 180.n"); - dlong = 180.; - } - - if (dlong < 0) { - dlong = (- dlong); - strcpy (hemi, "W"); - } - else { - strcpy (hemi, "E"); - } - - ideg = (int)dlong; - dmin = (dlong - ideg) * 60.; - - sprintf (smin, "%07.4f", dmin); - /* Due to roundoff, 59.99999 could come out as "60.0000" */ - if (smin[0] == '6') { - smin[0] = '0'; - ideg++; - } - - sprintf (slong, "%03d%s", ideg, smin); - -} /* end longitude_to_nmea */ - - - -/*------------------------------------------------------------------ - * - * Function: latitude_from_nmea - * - * Purpose: Convert NMEA latitude encoding to degrees. - * - * Inputs: pstr - Pointer to numeric string. - * phemi - Pointer to following field. Should be N or S. - * - * Returns: Double precision value in degrees. Negative for South. - * - * Description: Latitude field has - * 2 digits for degrees - * 2 digits for minutes - * period - * Variable number of fractional digits for minutes. - * I've seen 2, 3, and 4 fractional digits. - * - * - * Bugs: Very little validation of data. - * - * Errors: Return constant G_UNKNOWN for any type of error. - * Could we use special "NaN" code? - * - *------------------------------------------------------------------*/ - - -double latitude_from_nmea (char *pstr, char *phemi) -{ - - double lat; - - if ( ! isdigit((unsigned char)(pstr[0]))) return (G_UNKNOWN); - - if (pstr[4] != '.') return (G_UNKNOWN); - - - lat = (pstr[0] - '0') * 10 + (pstr[1] - '0') + atof(pstr+2) / 60.0; - - if (lat < 0 || lat > 90) { - text_color_set(DW_COLOR_ERROR); - dw_printf("Error: Latitude not in range of 0 to 90.\n"); - } - - // Saw this one time: - // $GPRMC,000000,V,0000.0000,0,00000.0000,0,000,000,000000,,*01 - - // If location is unknown, I think the hemisphere should be - // an empty string. TODO: Check on this. - // 'V' means void, so sentence should be discarded rather than - // trying to extract any data from it. - - if (*phemi != 'N' && *phemi != 'S' && *phemi != '\0') { - text_color_set(DW_COLOR_ERROR); - dw_printf("Error: Latitude hemisphere should be N or S.\n"); - } - - if (*phemi == 'S') lat = ( - lat); - - return (lat); -} - - - - -/*------------------------------------------------------------------ - * - * Function: longitude_from_nmea - * - * Purpose: Convert NMEA longitude encoding to degrees. - * - * Inputs: pstr - Pointer to numeric string. - * phemi - Pointer to following field. Should be E or W. - * - * Returns: Double precision value in degrees. Negative for West. - * - * Description: Longitude field has - * 3 digits for degrees - * 2 digits for minutes - * period - * Variable number of fractional digits for minutes - * - * - * Bugs: Very little validation of data. - * - * Errors: Return constant G_UNKNOWN for any type of error. - * Could we use special "NaN" code? - * - *------------------------------------------------------------------*/ - - -double longitude_from_nmea (char *pstr, char *phemi) -{ - double lon; - - if ( ! isdigit((unsigned char)(pstr[0]))) return (G_UNKNOWN); - - if (pstr[5] != '.') return (G_UNKNOWN); - - lon = (pstr[0] - '0') * 100 + (pstr[1] - '0') * 10 + (pstr[2] - '0') + atof(pstr+3) / 60.0; - - if (lon < 0 || lon > 180) { - text_color_set(DW_COLOR_ERROR); - dw_printf("Error: Longitude not in range of 0 to 180.\n"); - } - - if (*phemi != 'E' && *phemi != 'W' && *phemi != '\0') { - text_color_set(DW_COLOR_ERROR); - dw_printf("Error: Longitude hemisphere should be E or W.\n"); - } - - if (*phemi == 'W') lon = ( - lon); - - return (lon); -} diff --git a/ll2utm.c b/ll2utm.c deleted file mode 100644 index 409dae39..00000000 --- a/ll2utm.c +++ /dev/null @@ -1,55 +0,0 @@ -/* Latitude / Longitude to UTM conversion */ - -#include -#include - -#include "LatLong-UTMconversion.h" - - -static void usage(); - - -void main (int argc, char *argv[]) -{ - double easting; - double northing; - double lat, lon; - char zone[8]; - - if (argc != 3) usage(); - - - lat = atof(argv[1]); - if (lat < -90 || lat > 90) { - fprintf (stderr, "Latitude value is out of range.\n\n"); - usage(); - } - - lon = atof(argv[2]); - if (lon < -180 || lon > 180) { - fprintf (stderr, "Longitude value is out of range.\n\n"); - usage(); - } - - LLtoUTM (WSG84, lat, lon, &northing, &easting, zone); - - printf ("zone = %s, easting = %.0f, northing = %.0f\n", zone, easting, northing); -} - - -static void usage (void) -{ - fprintf (stderr, "Latitude / Longitude to UTM conversion\n"); - fprintf (stderr, "\n"); - fprintf (stderr, "Usage:\n"); - fprintf (stderr, "\tll2utm latitude longitude\n"); - fprintf (stderr, "\n"); - fprintf (stderr, "where,\n"); - fprintf (stderr, "\tLatitude and longitude are in decimal degrees.\n"); - fprintf (stderr, "\t Use negative for south or west.\n"); - fprintf (stderr, "\n"); - fprintf (stderr, "Example:\n"); - fprintf (stderr, "\tll2utm 42.662139 -71.365553\n"); - - exit (1); -} \ No newline at end of file diff --git a/log.c b/log.c deleted file mode 100644 index 64e838b2..00000000 --- a/log.c +++ /dev/null @@ -1,362 +0,0 @@ -// -// This file is part of Dire Wolf, an amateur radio packet TNC. -// -// Copyright (C) 2014 John Langner, WB2OSZ -// -// This program 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 2 of the License, or -// (at your option) any later version. -// -// This program 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 this program. If not, see . -// - - -/*------------------------------------------------------------------ - * - * File: log.c - * - * Purpose: Save received packets to a log file. - * - * Description: Rather than saving the raw, sometimes rather cryptic and - * unreadable, format, write separated properties into - * CSV format for easy reading and later processing. - * - * - *------------------------------------------------------------------*/ - -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include - - -#include "direwolf.h" -#include "ax25_pad.h" -#include "textcolor.h" -#include "decode_aprs.h" -#include "log.h" - - -/* - * CSV format needs quotes if value contains comma or quote. - */ - -static void quote_for_csv (char *out, const char *in) { - const char *p; - char *q = out; - int need_quote = 0; - - for (p = in; *p != '\0'; p++) { - if (*p == ',' || *p == '"') { - need_quote = 1; - break; - } - } - - if (need_quote) { - *q++ = '"'; - for (p = in; *p != '\0'; p++) { - if (*p == '"') { - *q++ = *p; - } - *q++ = *p; - } - *q++ = '"'; - *q = '\0'; - } - else { - strcpy (out, in); - } -} - - -/*------------------------------------------------------------------ - * - * Function: log_init - * - * Purpose: Initialization at start of application. - * - * Inputs: path - Path of log file directory. - * Use "." for current directory. - * Empty string disables feature. - * - * Global Out: g_log_dir - Save directory here for later use. - * g_log_fp - File pointer for writing. - * g_open_fname - Name of currently open file. - * - *------------------------------------------------------------------*/ - -static char g_log_dir[80]; -static FILE *g_log_fp; -static char g_open_fname[20]; - - -void log_init (char *path) -{ - struct stat st; - - strcpy (g_log_dir, ""); - g_log_fp = NULL; - strcpy (g_open_fname, ""); - - if (strlen(path) == 0) { - return; - } - - if (stat(path,&st) == 0) { - // Exists, but is it a directory? - if (S_ISDIR(st.st_mode)) { - // Specified directory exists. - strcpy (g_log_dir, path); - } - else { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Log file location \"%s\" is not a directory.\n", path); - dw_printf ("Using current working directory \".\" instead.\n"); - strcpy (g_log_dir, "."); - } - } - else { - // Doesn't exist. Try to create it. - // parent directory must exist. - // We don't create multiple levels like "mkdir -p" -#if __WIN32__ - if (_mkdir (path) == 0) { -#else - if (mkdir (path, 0777) == 0) { -#endif - // Success. - text_color_set(DW_COLOR_INFO); - dw_printf ("Log file location \"%s\" has been created.\n", path); - strcpy (g_log_dir, path); - } - else { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Failed to create log file location \"%s\".\n", path); - dw_printf ("%s\n", strerror(errno)); - dw_printf ("Using current working directory \".\" instead.\n"); - strcpy (g_log_dir, "."); - } - } -} - - - -/*------------------------------------------------------------------ - * - * Function: log_write - * - * Purpose: Save information to log file. - * - * Inputs: chan - Radio channel where heard. - * - * A - Explode information from APRS packet. - * - * pp - Received packet object. - * - * alevel - audio level. - * - * retries - Amount of effort to get a good CRC. - * - *------------------------------------------------------------------*/ - -void log_write (int chan, decode_aprs_t *A, packet_t pp, int alevel, retry_t retries) -{ - time_t now; // make 'now' a parameter so we can process historical data ??? - char fname[20]; - struct tm tm; - - - if (strlen(g_log_dir) == 0) return; - - // Generate the file name from current date, UTC. - - now = time(NULL); - gmtime_r (&now, &tm); - - // Microsoft doesn't recognize %F as equivalent to %Y-%m-%d - - strftime (fname, sizeof(fname), "%Y-%m-%d.log", &tm); - - // Close current file if name has changed - - if (g_log_fp != NULL && strcmp(fname, g_open_fname) != 0) { - log_term (); - } - - // Open for append if not already open. - - if (g_log_fp == NULL) { - char full_path[120]; - struct stat st; - int already_there; - - strcpy (full_path, g_log_dir); -#if __WIN32__ - strcat (full_path, "\\"); -#else - strcat (full_path, "/"); -#endif - strcat (full_path, fname); - - // See if it already exists. - // This is used later to write a header if it did not exist already. - - already_there = stat(full_path,&st) == 0; - - text_color_set(DW_COLOR_INFO); - dw_printf("Opening log file \"%s\".\n", fname); - - g_log_fp = fopen (full_path, "a"); - - if (g_log_fp != NULL) { - strcpy (g_open_fname, fname); - } - else { - text_color_set(DW_COLOR_ERROR); - dw_printf("Can't open log file \"%s\" for write.\n", full_path); - dw_printf ("%s\n", strerror(errno)); - strcpy (g_open_fname, ""); - return; - } - - // Write a header suitable for importing into a spreadsheet - // only if this will be the first line. - - if ( ! already_there) { - fprintf (g_log_fp, "chan,utime,isotime,source,heard,level,error,dti,name,symbol,latitude,longitude,speed,course,altitude,frequency,offset,tone,system,status,comment\n"); - } - } - - if (g_log_fp != NULL) { - - char itime[24]; - char heard[AX25_MAX_ADDR_LEN+1]; - int h; - char stemp[256]; - char slat[16], slon[16], sspd[12], scse[12], salt[12]; - char sfreq[20], soffs[10], stone[10]; - char sdti[10]; - char sname[24]; - char ssymbol[8]; - char smfr[60]; - char sstatus[40]; - char stelemetry[200]; - char scomment[256]; - - - // Microsoft doesn't recognize %T as equivalent to %H:%M:%S - - strftime (itime, sizeof(itime), "%Y-%m-%dT%H:%M:%SZ", &tm); - - /* Who are we hearing? Original station or digipeater? */ - /* Similar code in direwolf.c. Combine into one function? */ - - strcpy(heard, ""); - if (pp != NULL) { - if (ax25_get_num_addr(pp) == 0) { - /* Not AX.25. No station to display below. */ - h = -1; - strcpy (heard, ""); - } - else { - h = ax25_get_heard(pp); - ax25_get_addr_with_ssid(pp, h, heard); - } - - if (h >= AX25_REPEATER_2 && - strncmp(heard, "WIDE", 4) == 0 && - isdigit(heard[4]) && - heard[5] == '\0') { - - ax25_get_addr_with_ssid(pp, h-1, heard); - strcat (heard, "?"); - } - } - - // Might need to quote anything that could contain comma or quote. - - strcpy(sdti, ""); - if (pp != NULL) { - stemp[0] = ax25_get_dti(pp); - stemp[1] = '\0'; - quote_for_csv (sdti, stemp); - } - - quote_for_csv (sname, (strlen(A->g_name) > 0) ? A->g_name : A->g_src); - - stemp[0] = A->g_symbol_table; - stemp[1] = A->g_symbol_code; - stemp[2] = '\0'; - quote_for_csv (ssymbol, stemp); - - quote_for_csv (smfr, A->g_mfr); - quote_for_csv (sstatus, A->g_mic_e_status); - quote_for_csv (stelemetry, A->g_telemetry); - quote_for_csv (scomment, A->g_comment); - - strcpy (slat, ""); if (A->g_lat != G_UNKNOWN) sprintf (slat, "%.6f", A->g_lat); - strcpy (slon, ""); if (A->g_lon != G_UNKNOWN) sprintf (slon, "%.6f", A->g_lon); - strcpy (sspd, ""); if (A->g_speed != G_UNKNOWN) sprintf (sspd, "%.1f", DW_MPH_TO_KNOTS(A->g_speed)); - strcpy (scse, ""); if (A->g_course != G_UNKNOWN) sprintf (scse, "%.1f", A->g_course); - strcpy (salt, ""); if (A->g_altitude != G_UNKNOWN) sprintf (salt, "%.1f", DW_FEET_TO_METERS(A->g_altitude)); - - strcpy (sfreq, ""); if (A->g_freq != G_UNKNOWN) sprintf (sfreq, "%.3f", A->g_freq); - strcpy (soffs, ""); if (A->g_offset != G_UNKNOWN) sprintf (soffs, "%+d", A->g_offset); - strcpy (stone, ""); if (A->g_tone != G_UNKNOWN) sprintf (stone, "%.1f", A->g_tone); - if (A->g_dcs != G_UNKNOWN) sprintf (stone, "D%03o", A->g_dcs); - - fprintf (g_log_fp, "%d,%d,%s,%s,%s,%d,%d,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s\n", - chan, (int)now, itime, - A->g_src, heard, alevel, (int)retries, sdti, - sname, ssymbol, - slat, slon, sspd, scse, salt, - sfreq, soffs, stone, - smfr, sstatus, stelemetry, scomment); - fflush (g_log_fp); - } - -} /* end log_write */ - - - -/*------------------------------------------------------------------ - * - * Function: log_term - * - * Purpose: Close any open log file. - * Called when exiting or when date changes. - * - *------------------------------------------------------------------*/ - - -void log_term (void) -{ - if (g_log_fp != NULL) { - - text_color_set(DW_COLOR_INFO); - dw_printf("Closing log file \"%s\".\n", g_open_fname); - - fclose (g_log_fp); - - g_log_fp = NULL; - strcpy (g_open_fname, ""); - } - -} /* end log_term */ - - -/* end log.c */ diff --git a/log.h b/log.h deleted file mode 100644 index e7f7a5fb..00000000 --- a/log.h +++ /dev/null @@ -1,16 +0,0 @@ - -/* log.h */ - - -#include "hdlc_rec2.h" // for retry_t - -#include "decode_aprs.h" // for decode_aprs_t - - - - -void log_init (char *path); - -void log_write (int chan, decode_aprs_t *A, packet_t pp, int alevel, retry_t retries); - -void log_term (void); \ No newline at end of file diff --git a/man/CMakeLists.txt b/man/CMakeLists.txt new file mode 100644 index 00000000..071db62a --- /dev/null +++ b/man/CMakeLists.txt @@ -0,0 +1,13 @@ +if(NOT (WIN32 OR CYGWIN)) + install(FILES "${CUSTOM_MAN_DIR}/aclients.1" DESTINATION ${INSTALL_MAN_DIR}) + install(FILES "${CUSTOM_MAN_DIR}/atest.1" DESTINATION ${INSTALL_MAN_DIR}) + install(FILES "${CUSTOM_MAN_DIR}/decode_aprs.1" DESTINATION ${INSTALL_MAN_DIR}) + install(FILES "${CUSTOM_MAN_DIR}/direwolf.1" DESTINATION ${INSTALL_MAN_DIR}) + install(FILES "${CUSTOM_MAN_DIR}/gen_packets.1" DESTINATION ${INSTALL_MAN_DIR}) + install(FILES "${CUSTOM_MAN_DIR}/kissutil.1" DESTINATION ${INSTALL_MAN_DIR}) + install(FILES "${CUSTOM_MAN_DIR}/ll2utm.1" DESTINATION ${INSTALL_MAN_DIR}) + install(FILES "${CUSTOM_MAN_DIR}/log2gpx.1" DESTINATION ${INSTALL_MAN_DIR}) + install(FILES "${CUSTOM_MAN_DIR}/text2tt.1" DESTINATION ${INSTALL_MAN_DIR}) + install(FILES "${CUSTOM_MAN_DIR}/tt2text.1" DESTINATION ${INSTALL_MAN_DIR}) + install(FILES "${CUSTOM_MAN_DIR}/utm2ll.1" DESTINATION ${INSTALL_MAN_DIR}) +endif(NOT (WIN32 OR CYGWIN)) diff --git a/man/aclients.1 b/man/aclients.1 new file mode 100644 index 00000000..71dab11c --- /dev/null +++ b/man/aclients.1 @@ -0,0 +1,52 @@ +.TH ACLIENTS 1 + +.SH NAME +aclients \- Test program for side-by-side TNC performance comparison. + + +.SH SYNOPSIS +.B aclients +.I tnc ... +.RS +.P +Each \fItnc\fR reference is a port, =, and a description. +.P +.RE + +.SH DESCRIPTION +\fBaclients\fR is used to compare how well different TNCs decode AS.25 frames. +The port can be a serial port name, host_name:tcp_port, ip_addr:port, or simply tcp_port. +.P + + + +.SH OPTIONS +None. + + + +.SH EXAMPLES + +.B aclients /dev/ttyS0=KPC3+ /dev/ttyUSB0=D710A 8000=DireWolf 192.168.1.64:8002=other +.P +Serial port /dev/ttyS0 is connected to a KPC3+ with monitor mode turned on. +.P +Serial port /dev/ttyUSB0 is connected to a TM-D710A with monitor mode turned on. +.P +The Dire Wolf software TNC is available on network port 8000. +.P +Some other software TNC is available on network port 8002 on host 192.168.1.64. +.P +Packets from each are displayed in columns so it is easy to see how well each decodes +the received signals. +.P + +The "Receive Performance" section of the \fBUser Guide\fR contains some complete examples +of how to set up tests and the results. + + +.SH SEE ALSO +More detailed information is in the pdf files in /usr/local/share/doc/direwolf, or possibly /usr/share/doc/direwolf, depending on installation location. + +Applications in this package: aclients, atest, decode_aprs, direwolf, gen_packets, kissutil, ll2utm, log2gpx, text2tt, tt2text, utm2ll + diff --git a/man/atest.1 b/man/atest.1 new file mode 100644 index 00000000..58c90f64 --- /dev/null +++ b/man/atest.1 @@ -0,0 +1,132 @@ +.TH ATEST 1 + +.SH NAME +atest \- Decode AX.25 frames from an audio file. + + +.SH SYNOPSIS +.B atest +[ \fIoptions\fR ] +.I wav-file-in +.RS +.P +\fIwav-file-in\fR is a WAV format audio file. +.P +.RE + +.SH DESCRIPTION +\fBatest\fR is a test application which decodes AX.25 frames from an audio recording. This provides an easy way to test Dire Wolf decoding performance much quicker than normal real-time. + + + +.SH OPTIONS + + +.TP +.BI "-B " "n" +Data rate in bits/sec. Standard values are 300, 1200, 2400, 4800, 9600. +.PD 0 +.RS +.RS +300 bps defaults to AFSK tones of 1600 & 1800. +.P +1200 bps uses AFSK tones of 1200 & 2200. +.P +2400 bps uses QPSK based on V.26 standard. +.P +4800 bps uses 8PSK based on V.27 standard. +.P +9600 bps and up uses K9NG/G3RUH standard. +.P +AIS for ship Automatic Identification System. +.P +EAS for Emergency Alert System (EAS) Specific Area Message Encoding (SAME). +.RE +.RE +.PD + +.TP +.BI "-g " +Force G3RUH modem regardless of data rate. + +.TP +.BI "-j " +2400 bps QPSK compatible with Dire Wolf <= 1.5. + +.TP +.BI "-J " +2400 bps QPSK compatible with MFJ-2400. + +.TP +.BI "-D " "n" +Divide audio sample rate by n. + +.TP +.BI "-h " +Print frame contents as hexadecimal bytes. + +.TP +.BI "-F " "n" +Amount of effort to try fixing frames with an invalid CRC. +0 (default) = consider only correct frames. +1 = Try to fix only a single bit. +more = Try modifying more bits to get a good CRC. + +.TP +.BI "-L " +Error if Less than this number decoded. + +.TP +.BI "-G " +Error if Greater than this number decoded. + +.TP +.BI "-P " "m" +Select the demodulator type such as D (default for 300 bps), E+ (default for 1200 bps), PQRS for 2400 bps, etc. + + + +.SH EXAMPLES +.P +.PD 0 +.B gen_packets -o test1.wav +.P +.B atest test1.wav +.PD +.P +.PD 0 +.B gen_packets -B 300 -o test3.wav +.P +.B atest -B 300 test3.wav +.PD +.P +.PD 0 +.B gen_packets -B 9600 -o test9.wav +.P +.B atest -B 9600 test9.wav +.PD +.P +.RS +This generates and decodes 3 test files with 1200, 300, and 9600 bits per second. +.RE +.P +.PD 0 +.B atest 02_Track_2.wav +.P +.B atest -P E- 02_Track_2.wav +.P +.B atest -F 1 02_Track_2.wav +.P +.B atest -P E- -F 1 02_Track_2.wav +.PD +.P +.RS +Try different combinations of options to compare decoding performance. +.RE +.P + +.SH SEE ALSO +More detailed information is in the pdf files in /usr/local/share/doc/direwolf, or possibly /usr/share/doc/direwolf, depending on installation location. + +Applications in this package: aclients, atest, cm108, decode_aprs, direwolf, gen_packets, kissutil, ll2utm, log2gpx, text2tt, tt2text, utm2ll + diff --git a/man/decode_aprs.1 b/man/decode_aprs.1 new file mode 100644 index 00000000..634fd669 --- /dev/null +++ b/man/decode_aprs.1 @@ -0,0 +1,103 @@ +.TH DECODE_APRS 1 + +.SH NAME +decode_aprs \- Convert APRS raw data to human readable form. + + +.SH SYNOPSIS +.B decode_aprs +[ \fItext-file\fR ] +.RS +.P +\fItext-file\fR should contain AX.25 packets in the standard monitoring format or +as a series two digit hexadecimal numbers. +If the first number is 00 or c0, it will be treated as a KISS frame. +If no file specified, data will be read from stdin. +.P +.RE + +.SH DESCRIPTION +\fBdecode_aprs\fR is useful for understanding sometimes obscure APRS packets and finding errors. + + +.SH OPTIONS +None. + + + +.SH EXAMPLES + +You see something like this show up on your screen: +.P +.RS +M0XER-3>APRS63,WIDE2-1:!/4\\;u/)K$O J]YD/A=041216|h`RY(1>q!(| +.RE +.P +What does it mean? If you haven't spent a lot of time studying the APRS protocol +specification, most of it probably looks like random noise. +Pipe it into decode_aprs to find out. +.P +.RS +.B echo 'M0XER-3>APRS63,WIDE2-1:!/4\\\\;u/)K$O J]YD/A=041216|h`RY(1>q!(|' | decode_aprs +.RE +.P + +http://www.findu.com/cgi-bin/errors.cgi has a never-ending collection of packets +with errors. Sometimes it's not obvious what is wrong with them. +Dire Wolf will usually tell you what is wrong. First, +cut-n-paste the bad packets into a text file. Here a few examples: +.P +.RS +.nf +n2cma>APRS,TCPIP*,qAC,SEVENTH:@212127z43.2333n/77.1w_338/002g001t025P000h65b10208.wview_5_19_0 +.P +K0YTH-10>APNU3B,NULL,qAR,K0DMF-10:!4601.5NS09255.52W#PHG6360/W2,MNn 444.575 +.P +00 82 a0 ae ae 62 60 e0 82 96 68 84 40 40 60 9c 68 b0 ae 86 40 e0 40 ae 92 88 8a 64 63 03 f0 3e 45 4d 36 34 6e 65 2f 23 20 45 63 68 6f 6c 69 6e 6b 20 31 34 35 2e 33 31 30 2f 31 30 30 68 7a 20 54 6f 6e 65 ++.fi +.RE +.P +If you simply fed this into decode_aprs, it would complain about the +lower case in qA-something, added by the IGate, in the via path. +We can take it out with something like this: +.P +.RS +.B cat findu-errors.txt | sed -e 's/,qA.*:/:/' | decode_aprs +.RE +.P +In the first case, we get, +.P +.RS +Address has lower case letters. "n2cma" must be all upper case. +.RE +.P +After changing the source address to upper case, there are other issues. Identifying them is left as an exercise for the reader. +.P +In the second example, +.P +.RS +.PD 0 +Invalid character in latitude. Found 'N' when expecting 0-9 for hundredths of minutes. +.P +Invalid character in longitude. Found '9' when expecting 0 or 1 for hundreds of degrees. +.PD +.RE + +.P +In the third example, +.P +.RS +.PD 0 +Warning: Lower case letter in Maidenhead locator. Specification requires upper case. +.P +Digi2 Address, " WIDE2-1" contains character other than letter or digit in character position 1. +.PD +.RE + + + +.SH SEE ALSO +More detailed information is in the pdf files in /usr/local/share/doc/direwolf, or possibly /usr/share/doc/direwolf, depending on installation location. + +Applications in this package: aclients, atest, decode_aprs, direwolf, gen_packets, ll2utm, log2gpx, text2tt, tt2text, utm2ll + diff --git a/man/direwolf.1 b/man/direwolf.1 new file mode 100644 index 00000000..93f786dc --- /dev/null +++ b/man/direwolf.1 @@ -0,0 +1,221 @@ +.TH DIREWOLF 1 + +.SH NAME +direwolf \- Soundcard TNC for packet radio. + + +.SH SYNOPSIS +.B direwolf +[ \fIoptions\fR ] +[ \- | \fBudp:\fR9999 ] +.P +The first audio channel can be streamed thru stdin or a UDP port. This is typically used with an SDR receiver. + + +.SH DESCRIPTION +\fBdirewolf\fR is a software "soundcard" modem/TNC and APRS encoder/decoder. +It can be used stand-alone to receive APRS messages, as a digipeater, +APRStt gateway, or Internet Gateway (IGate). +It can also be used as a virtual TNC for other applications such as +APRSIS32, UI-View32, Xastir, APRS-TW, YAAC, UISS, Linux AX25, SARTrack, +RMS Express, and many others. + + +.SH OPTIONS +.TP +.BI "-c " "file" +Read configuration file from specified location rather than the default locations. + +.TP +.BI "-l " "logdir" +Generate daily log files in specified directory. Use "." for current directory. + +.TP +.BI "-L " "logfile" +Generate single log file with fixed name. + +.TP +.BI "-r " "n" +Audio sample rate per second for first channel. Default 44100. + +.TP +.BI "-n " "n" +Number of audio channels for first device. 1 or 2. Default 1. + +.TP +.BI "-b " "n" +Audio sample size for first channel. 8 or 16. Default 16. + +.TP +.BI "-B " "n" +Data rate in bits/sec for first channel. Standard values are 300, 1200, 2400, 4800, 9600. +.PD 0 +.RS +.RS +300 bps defaults to AFSK tones of 1600 & 1800. +.P +1200 bps uses AFSK tones of 1200 & 2200. +.P +2400 bps uses QPSK based on V.26 standard. +.P +4800 bps uses 8PSK based on V.27 standard. +.P +9600 bps and up uses K9NG/G3RUH standard. +.P +AIS for ship Automatic Identification System. +.P +EAS for Emergency Alert System (EAS) Specific Area Message Encoding (SAME). +.RE +.RE +.PD + +.TP +.BI "-g " +Force G3RUH modem regardless of data rate. + +.TP +.BI "-j " +2400 bps QPSK compatible with Dire Wolf <= 1.5. + +.TP +.BI "-J " +2400 bps QPSK compatible with MFJ-2400. + +.TP +.BI "-D " "n" +Divide audio sample by n for first channel. + +.TP +.BI "-X " "n" +1 to enable FX.25 transmit. 16, 32, 64 for specific number of check bytes. + +.TP +.BI "-I " "n" +Enable IL2P transmit. n=1 is recommended. 0 uses weaker FEC. + +.TP +.BI "-i " "n" +Enable IL2P transmit, inverted polarity. n=1 is recommended. 0 uses weaker FEC. + +.TP +.BI "-d " "x" +Debug options. Specify one or more of the following in place of x. +.PD 0 +.RS +.RS +a = AGWPE network protocol client. +.P +k = KISS serial port client. +.P +n = Network KISS client. +.P +u = Display non-ASCII text in hexadecimal. +.P +p = Packet dump in hexadecimal. +.P +g = GPS interface. +.P +W = Waypoints for position or object reports. +.P +t = Tracker beacon. +.P +o = Output controls such as PTT and DCD. +.P +i = IGate +.P +h = Hamlib verbose level. Repeat for more. +.P +m = Monitor heard station list. +.P +f = Packet filtering. +.P +x = FX.25 increase verbose level. +.P +d = APRStt (DTMF to APRS object conversion). +.RE +.RE +.PD + +.TP +.BI "-q " "x" +Quiet (suppress output). Specify one or more of the following in place of x. +.PD 0 +.RS +.RS +h = Heard line with the audio level. +.P +d = Decoding of APRS packets. +.P +x = Silence FX.25 information. +.RE +.RE +.PD + +.TP +.BI "-t " "n" +Text colors. 0=disabled. 1=default. 2,3,4,... alternatives. Use 9 to test compatibility with your terminal. + + +.TP +.B "-p " +Enable pseudo terminal for KISS protocol. + +.TP +.BI "-x " +Send Xmit level calibration tones. +.PD 0 +.RS +.RS +a = Alternating mark/space tones. +.P +m = steady Mark tone (e.g. 1200 Hz) +.P +s = steady Space tone (e.g. 2200 Hz) +.P +p = selence (set Ptt only). +.P +Optionally add a number to specify radio channel. +.RE +.RE +.PD + +.TP +.B "-u " +Print UTF-8 test string and exit. + +.TP +.B "-S " +Print Symbol tables and exit. + +.TP +.BI "-a " "n" +Report audio device statistics each n seconds. + +.TP +.BI "-T " "fmt" +Time stamp format for sent and received frames. + +.TP +.BI "-e " "ber" +Receive Bit Error Rate (BER), e.g. 1e-5 + +.SH EXAMPLES +gqrx (2.3 and later) has the ability to send streaming audio through a UDP socket to another application for further processing. +direwolf can listen over a UDP port with options like this: +.RS +.P +direwolf \-n 1 \-r 48000 \-b 16 udp:7355 +.RE +.P +Other SDR applications might produce audio on stdout so it is convenient to pipe into the next application. In this example, the final "-" means read from stdin. +.RS +.P +rtl_fm \-f 144.39M \-o 4 \- | direwolf \-n 1 \-r 24000 \-b 16 \- +.RE + + +.SH SEE ALSO +More detailed information is in the pdf files in /usr/local/share/doc/direwolf, or possibly /usr/share/doc/direwolf, depending on installation location. + +Applications in this package: aclients, atest, cm108, decode_aprs, direwolf, gen_packets, kissutil, ll2utm, log2gpx, text2tt, tt2text, utm2ll + diff --git a/man/gen_packets.1 b/man/gen_packets.1 new file mode 100644 index 00000000..740d4db4 --- /dev/null +++ b/man/gen_packets.1 @@ -0,0 +1,158 @@ +.TH GEN_PACKETS 1 + +.SH NAME +gen_packets \- Generate audio file for AX.25 frames. + + +.SH SYNOPSIS +.B gen_packets \-o +.I wav-file-out +[ \fIoptions\fR ] [ \fItext-file\fR | \- ] +.RS +.P +\fIwav-file-out\fR is the result. The \-o option is required. +.P +\fItext-file\fR may contain AX.25 packets in the standard monitoring format. Use "-" to read from stdin. If not specified, a default builtin message will be used. +.RE + +.SH DESCRIPTION +\fBgen_packets\fR is a test application which converts text to AX.25 audio for testing packet decoders. + +It is very flexible allowing a wide range of audio sample rates, data speeds, and AFSK tones. It will even generate the scrambled signals commonly used for 9600 baud operation. + + +.SH OPTIONS + +.TP +.BI "-a " "n" +Signal amplitude in range of 0-200%. Default 50. Note that 100% is corresponds to signal peaks of +/- 16383 so we have plenty of headroom to avoid saturation. + +.TP +.BI "-b " "n" +Bits / second for data. Default is 1200. + +.TP +.BI "-B " "n" +Data rate in bits/sec for first channel. Standard values are 300, 1200, 2400, 4800, 9600. +.PD 0 +.RS +.RS +300 bps defaults to AFSK tones of 1600 & 1800. +.P +1200 bps uses AFSK tones of 1200 & 2200. +.P +2400 bps uses QPSK based on V.26 standard. +.P +4800 bps uses 8PSK based on V.27 standard. +.P +9600 bps and up uses K9NG/G3RUH standard. +.P +EAS for Emergency Alert System (EAS) Specific Area Message Encoding (SAME). +.RE +.RE +.PD + +.TP +.BI "-g " +Force G3RUH modem regardless of data rate. + +.TP +.BI "-j " +2400 bps QPSK compatible with Dire Wolf <= 1.5. + +.TP +.BI "-J " +2400 bps QPSK compatible with MFJ-2400. + +.TP +.BI "-X " "n" +1 to enable FX.25 transmit. 16, 32, 64 for specific number of check bytes. + +.TP +.BI "-I " "n" +Enable IL2P transmit. n=1 is recommended. 0 uses weaker FEC. + +.TP +.BI "-i " "n" +Enable IL2P transmit, inverted polarity. n=1 is recommended. 0 uses weaker FEC. + + +.TP +.BI "-m " "n" +Mark frequency. Default is 1200. + +.TP +.BI "-s " "n" +Space frequency. Default is 2200. + +.TP +.BI "-r " "n" +Audio sample Rate. Default is 44100. + +.TP +.BI "-n " "n" +Generate specified number of frames with increasing noise. (For built-in message only.) + +.TP +.BI "-o " "file" +Send output to .wav file. + +.TP +.B "-8" +8 bit audio rather than 16. + +.TP +.BI "-2" +2 channels of audio rather than 1. + +.TP +.BI "-v" "max[,incr]" +Variable speed with specified maximum error and optional increment. + + +.SH EXAMPLES +.P +.B gen_packets \-o x.wav +.P +.RS +With all defaults, a built-in test message is generated +with standard Bell 202 tones used for packet radio on ordinary +VHF FM transceivers. +.RE +.P +.B gen_packets \-o x.wav \-g \-b 9600 +.PD 0 +.P +.PD +.B gen_packets \-o x.wav \-B 9600 +.P +.RS +Both of these are equivalent. "-B 9600" automatically selects scrambled baseband rather than AFSK. +.RE +.P +.B gen_packets \-o x.wav \-m 1600 \-s 1800 \-b 300 +.PD 0 +.P +.PD +.B gen_packets \-o x.wav \-B 300 +.P +.RS +Both of these generate 200 Hz shift, 300 baud, suitable for HF SSB transceiver. +.RE +.P +.B echo \-n 'WB2OSZ>WORLD:Hello, world!' | gen_packets \-a 25 \-o x.wav \- +.PD 0 +.P +.PD +.B atest x.wav +.P +.RS +Read message from stdin and put quarter volume sound into the file x.wav. Decode the sound file. +.RE +.P + +.SH SEE ALSO +More detailed information is in the pdf files in /usr/local/share/doc/direwolf, or possibly /usr/share/doc/direwolf, depending on installation location. + +Applications in this package: aclients, atest, cm108, decode_aprs, direwolf, gen_packets, kissutil, ll2utm, log2gpx, text2tt, tt2text, utm2ll + diff --git a/man/kissutil.1 b/man/kissutil.1 new file mode 100644 index 00000000..a7968f97 --- /dev/null +++ b/man/kissutil.1 @@ -0,0 +1,60 @@ +.TH KISSUTIL 1 + +.SH NAME +kissutil \- KISS TNC troubleshooting and Application Interface. + + +.SH SYNOPSIS +.B kissutil +[ \fIoptions\fR ] + + + +.SH DESCRIPTION +\fBkissutil\fR can be used interactively for troubleshooting a KISS TNC. +It is usable with direwolf and other generic KISS TNCs connected to a serial port. +It can also be used as an application interface where each side places files in a +directory for the other to process. +See User Guide for more details. + + +.SH OPTIONS +.TP +.BI "-h " "host" +Hostname or IP address for a TCP KISS TNC. Default is localhost. + +.TP +.BI "-p " "port" +A number may be specified for a TCP port other than the default 8001. +If not a number, it is considered to be a serial port name such as /dev/ttyS0 or COM3. + +.TP +.BI "-s " "speed" +Speed for serial port. e.g. 9600. + +.TP +.BI "-o " "rec-directory" +For each received frame, a new file is created here. +It is expected that some other application will process files in this directory then delete them. + +.TP +.BI "-T " "format" +Each received frame will be preceded by a timestamp in the specified format. +See strftime documentation for a description of the format string. +Example: %H:%M:%S for current time in hours, minutes, seconds. + +.TP +.BI "-f " "xmit-directory" +Files in this directory are transmitted and deleted. +Another application places a file here when it wants something to be transmitted. + +.TP +.BI "-v " +Verbose - Display the KISS frames going to and from the TNC. + + +.SH SEE ALSO +More detailed information is in the pdf files in /usr/local/share/doc/direwolf, or possibly /usr/share/doc/direwolf, depending on installation location. + +Applications in this package: aclients, atest, decode_aprs, direwolf, gen_packets, kissutil, ll2utm, log2gpx, text2tt, tt2text, utm2ll + diff --git a/man/ll2utm.1 b/man/ll2utm.1 new file mode 100644 index 00000000..10f37ebc --- /dev/null +++ b/man/ll2utm.1 @@ -0,0 +1,34 @@ +.TH LL2UTM 1 + +.SH NAME +ll2utm \- Convert Latitude and Longitude to UTM coordinates. + + +.SH SYNOPSIS +.B ll2utm +.I latitude longitude +.P +Latitude and longitude are in decimal degrees. Use negative for south or west. + +.SH DESCRIPTION +\fBll2utm\fR converts Latitude and Longitude to UTM coordinates. + + +.SH OPTIONS +.TP +None. + + +.SH EXAMPLES +.P +.B ll2utm 42.619 -71.34717 +.P +zone = 19T, easting = 307504, northing = 4721177 +.P + + +.SH SEE ALSO +More detailed information is in the pdf files in /usr/local/share/doc/direwolf, or possibly /usr/share/doc/direwolf, depending on installation location. + +Applications in this package: aclients, atest, decode_aprs, direwolf, gen_packets, kissutil, ll2utm, log2gpx, text2tt, tt2text, utm2ll + diff --git a/man/log2gpx.1 b/man/log2gpx.1 new file mode 100644 index 00000000..094aa036 --- /dev/null +++ b/man/log2gpx.1 @@ -0,0 +1,40 @@ +.TH LOG2GPX 1 + +.SH NAME +log2gpx \- Convert Dire Wolf log files to GPX format. + + +.SH SYNOPSIS +.B log2gpx +[ \fIfile\fR ... ] +.P +The command line can contain one or more log file names. If no files are specified, stdin is used. +.P +The result is always written to stdout. Redirect stdout to save results to a file. + + +.SH DESCRIPTION +\fBlog2gpx\fR converts Dire Wolf log files to the GPX format used by many mapping applications. +.P +Stationary entities are converted to waypoints. Moving entities are converted to tracks. + +.SH OPTIONS +.TP +None. + + +.SH EXAMPLES +.P +.B direwolf -l logdir +.P +.B log2gpx logdir/* > everybody.gpx +.P +.B egrep -e '^[^,]+,[^,]+,[^,]+,WB2OSZ,' logdir/* | log2gpx > justme.gpx +.P + + +.SH SEE ALSO +More detailed information is in the pdf files in /usr/local/share/doc/direwolf, or possibly /usr/share/doc/direwolf, depending on installation location. + +Applications in this package: aclients, atest, decode_aprs, direwolf, gen_packets, kissutil, ll2utm, log2gpx, text2tt, tt2text, utm2ll + diff --git a/man/text2tt.1 b/man/text2tt.1 new file mode 100644 index 00000000..2551d5ca --- /dev/null +++ b/man/text2tt.1 @@ -0,0 +1,64 @@ +.TH TEXT2TT 1 + +.SH NAME +text2tt \- Convert text to Touch Tone representation + + +.SH SYNOPSIS +.B text2tt +.I text ... +.P + + +.SH DESCRIPTION +\fBtext2tt\fR converts text to the Touch Tone sequence used by APRStt. There are two types +of encoding: +.RS +.HP +.BR "Multi-Press" " - Used for comments." +.RS +.P +Letters are represented by one or more presses of the same key depending on their order listed on the button. e.g. Press 5 key once for J, twice for K, thrice for L. +.P +To specify a digit use the number of letters listed on the button plus one. e.g. Press 5 key four times to get digit 5. When two characters in a row use the same key, use the "A" key as a separator. +.RE +.P +.BR "Two-Key" " - Used for callsigns." +.RS +.P +Digits are represented by a single key press. +.P +Letters (or space) are represented by the corresponding key followed by A, B, C, or D depending on the order of the letter in the order listed. +.RE +.RE +.P +This application will convert using both methods. + + +.SH OPTIONS +.TP +None. + + +.SH EXAMPLES +.P +.B text2tt abcdefg 0123 +.P +.PD 0 +.P +Push buttons for multi-press method: +.P +"2A22A2223A33A33340A00122223333" +.P +Push buttons for two-key method: +.P +"2A2B2C3A3B3C4A0A0123" +.PD +.P + + +.SH SEE ALSO +More detailed information is in the pdf files in /usr/local/share/doc/direwolf, or possibly /usr/share/doc/direwolf, depending on installation location. + +Applications in this package: aclients, atest, decode_aprs, direwolf, gen_packets, kissutil, ll2utm, log2gpx, text2tt, tt2text, utm2ll + diff --git a/man/tt2text.1 b/man/tt2text.1 new file mode 100644 index 00000000..c6214c27 --- /dev/null +++ b/man/tt2text.1 @@ -0,0 +1,66 @@ +.TH TT2TEXT 1 + +.SH NAME +tt2text \- Convert Touch Tone sequence to text + + +.SH SYNOPSIS +.B tt2text +.I touch-tone-squence +.P + + +.SH DESCRIPTION +\fBtt2text\fR converts a Touch Tone sequence to text. There are two types +of encoding: +.RS +.HP +.BR "Multi-Press" " - Used for comments." +.RS +.P +Letters are represented by one or more presses of the same key depending on their order listed on the button. e.g. Press 5 key once for J, twice for K, thrice for L. +.P +To specify a digit use the number of letters listed on the button plus one. e.g. Press 5 key four times to get digit 5. When two characters in a row use the same key, use the "A" key as a separator. +.RE +.P +.BR "Two-Key" " - Used for callsigns." +.RS +.P +Digits are represented by a single key press. +.P +Letters (or space) are represented by the corresponding key followed by A, B, C, or D depending on the order of the letter in the order listed. +.RE +.RE +.P +This application will try to decode the sequence using both methods. + + +.SH OPTIONS +.TP +None. + + +.SH EXAMPLES +.P +.B tt2text 2A22A2223A33A33340A00122223333 +.P +.PD 0 +.P +Could be either type of encoding. +.P +Decoded text from multi-press method: +.P +"ABCDEFG 0123" +.P +Decoded text from two-key method: +.P +"A2A222D3D3334 00122223333" +.PD +.P + + +.SH SEE ALSO +More detailed information is in the pdf files in /usr/local/share/doc/direwolf, or possibly /usr/share/doc/direwolf, depending on installation location. + +Applications in this package: aclients, atest, decode_aprs, direwolf, gen_packets, kissutil, ll2utm, log2gpx, text2tt, tt2text, utm2ll + diff --git a/man/utm2ll.1 b/man/utm2ll.1 new file mode 100644 index 00000000..9bc3ef86 --- /dev/null +++ b/man/utm2ll.1 @@ -0,0 +1,40 @@ +.TH UTM2LL 1 + +.SH NAME +utm2ll \- Convert UTM coordinates to Latitude and Longitude. + + +.SH SYNOPSIS +.B utm2ll +.I zone easting northing +.RS +.P +\fIzone\fR is UTM zone 1 thru 60 with optional latitudinal band. +.P +\fIeasting\fR is x coordinate in meters. +.P +\fInorthing\fR is y coordinate in meters. +.RE + +.SH DESCRIPTION +\fBll2utm\fR converts UTM coordinates to latitude and longitude. + + +.SH OPTIONS +.TP +None. + + +.SH EXAMPLES +.P +.B utm2ll 19T 306130 4726010 +.P +latitude = 42.662139, longitude = -71.365553 +.P + + +.SH SEE ALSO +More detailed information is in the pdf files in /usr/local/share/doc/direwolf, or possibly /usr/share/doc/direwolf, depending on installation location. + +Applications in this package: aclients, atest, decode_aprs, direwolf, gen_packets, kissutil, ll2utm, log2gpx, text2tt, tt2text, utm2ll + diff --git a/misc/README-dire-wolf.txt b/misc/README-dire-wolf.txt deleted file mode 100644 index 36e7e286..00000000 --- a/misc/README-dire-wolf.txt +++ /dev/null @@ -1,9 +0,0 @@ -This is NOT used for the Linux version. -These are part of the standard C library for Linux and Cygwin. -For the Windows version we need to include our own copy. - -They were copied from Cygwin source: - - /usr/src/cygwin-1.7.10-1/newlib/libc/string/strsep.c - /usr/src/cygwin-1.7.10-1/newlib/libc/string/strtok_r.c - diff --git a/misc/strsep.c b/misc/strsep.c deleted file mode 100644 index 7d764d00..00000000 --- a/misc/strsep.c +++ /dev/null @@ -1,22 +0,0 @@ -/* BSD strsep function */ - -/* Copyright 2002, Red Hat Inc. */ - -/* undef STRICT_ANSI so that strsep prototype will be defined */ -#undef __STRICT_ANSI__ -#include -//#include <_ansi.h> -//#include - -#define _DEFUN(name,arglist,args) name(args) -#define _AND , - -extern char *__strtok_r (char *, const char *, char **, int); - -char * -_DEFUN (strsep, (source_ptr, delim), - register char **source_ptr _AND - register const char *delim) -{ - return __strtok_r (*source_ptr, delim, source_ptr, 0); -} diff --git a/multi_modem.c b/multi_modem.c deleted file mode 100644 index 7d23dabd..00000000 --- a/multi_modem.c +++ /dev/null @@ -1,594 +0,0 @@ -// -// This file is part of Dire Wolf, an amateur radio packet TNC. -// -// Copyright (C) 2013 John Langner, WB2OSZ -// -// This program 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 2 of the License, or -// (at your option) any later version. -// -// This program 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 this program. If not, see . -// - - - -/*------------------------------------------------------------------ - * - * Name: multi_modem.c - * - * Purpose: Use multiple modems in parallel to increase chances - * of decoding less than ideal signals. - * - * Description: The initial motivation was for HF SSB where mistuning - * causes a shift in the audio frequencies. Here, we can - * have multiple modems tuned to staggered pairs of tones - * in hopes that one will be close enough. - * - * The overall structure opens the door to other approaches - * as well. For VHF FM, the tones should always have the - * right frequencies but we might want to tinker with other - * modem parameters instead of using a single compromise. - * - * Originally: The the interface application is in 3 places: - * - * (a) Main program (direwolf.c or atest.c) calls - * demod_init to set up modem properties and - * hdlc_rec_init for the HDLC decoders. - * - * (b) demod_process_sample is called for each audio sample - * from the input audio stream. - * - * (c) When a valid AX.25 frame is found, process_rec_frame, - * provided by the application, in direwolf.c or atest.c, - * is called. Normally this comes from hdlc_rec.c but - * there are a couple other special cases to consider. - * It can be called from hdlc_rec2.c if it took a long - * time to "fix" corrupted bits. aprs_tt.c constructs - * a fake packet when a touch tone message is received. - * - * New in version 0.9: - * - * Put an extra layer in between which potentially uses - * multiple modems & HDLC decoders per channel. The tricky - * part is picking the best one when there is more than one - * success and discarding the rest. - * - * New in version 1.1: - * - * Several enhancements provided by Fabrice FAURE: - * - * Additional types of attempts to fix a bad CRC. - * Optimized code to reduce execution time. - * Improved detection of duplicate packets from - * different fixup attempts. - * Set limit on number of packets in fix up later queue. - * - *------------------------------------------------------------------*/ -//#define DEBUG 1 -#define DIGIPEATER_C - - -#include -#include -#include -#include -#include - -#include "direwolf.h" -#include "ax25_pad.h" -#include "textcolor.h" -#include "multi_modem.h" -#include "demod.h" -#include "hdlc_rec.h" -#include "hdlc_rec2.h" - - -// Properties of the radio channels. - -static struct audio_s modem; - - -// Candidates for further processing. - -static struct { - - packet_t packet_p; - int alevel; - retry_t retries; - int age; - unsigned int crc; - int score; - -} candidate[MAX_CHANS][MAX_SUBCHANS]; -#define MAX_STORED_CRC 256 - -typedef struct crc_s { - struct crc_s* nextp; /* Next pointer to maintain a queue. */ - unsigned int crc; -} *crc_t; - -static crc_t crc_queue_of_last_to_app[MAX_CHANS]; - -#define PROCESS_AFTER_BITS 2 - -static int process_age[MAX_CHANS]; - -static void pick_best_candidate (int chan); - - - -/*------------------------------------------------------------------------------ - * - * Name: multi_modem_init - * - * Purpose: Called at application start up to initialize appropriate - * modems and HDLC decoders. - * - * Input: Modem properties structure as filled in from the configuration file. - * - * Outputs: - * - * Description: Called once at application startup time. - * - *------------------------------------------------------------------------------*/ - -void multi_modem_init (struct audio_s *pmodem) -{ - int chan; - -/* - * Save parameters for later use. - */ - memcpy (&modem, pmodem, sizeof(modem)); - - memset (candidate, 0, sizeof(candidate)); - - demod_init (pmodem); - hdlc_rec_init (pmodem); - - for (chan=0; chan=MAX_CHANS) { - return -1; - } - new_crc = (crc_t) malloc (10*sizeof(struct crc_s)); - if (!new_crc) - return -1; - new_crc->crc = crc; - new_crc->nextp = NULL; - if (crc_queue_of_last_to_app[chan] == NULL) { - crc_queue_of_last_to_app[chan] = new_crc; - nb_crc = 1; - } - else { - nb_crc = 2; - plast = crc_queue_of_last_to_app[chan]; - pnext = plast->nextp; - while (pnext != NULL) { - nb_crc++; - plast = pnext; - pnext = pnext->nextp; - } - plast->nextp = new_crc; - } -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf("Out crc_queue_append nb_crc = %d\n", nb_crc); -#endif - return nb_crc; - - -} - -//Remove the crc from the top of the queue -unsigned int crc_queue_remove (unsigned int chan) { - - unsigned int res; - crc_t plast; - crc_t pnext; -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf("In crc_queue_remove\n"); -#endif - crc_t removed_crc; - if (chan>=MAX_CHANS) { - return 0; - } - removed_crc = crc_queue_of_last_to_app[chan]; - if (removed_crc == NULL) { - return 0; - } - else { - - crc_queue_of_last_to_app[chan] = removed_crc->nextp; - res = removed_crc->crc; - free(removed_crc); - - } - return res; - -} - -unsigned char is_crc_in_queue(unsigned int chan, unsigned int crc) { - crc_t plast; - crc_t pnext; - - if (crc_queue_of_last_to_app[chan] == NULL) { - return 0; - } - else { - plast = crc_queue_of_last_to_app[chan]; - do { - pnext = plast->nextp; - if (plast->crc == crc) { - return 1; - } - plast = pnext; - } while (pnext != NULL); - } - return 0; -} - -/*------------------------------------------------------------------------------ - * - * Name: multi_modem_process_sample - * - * Purpose: Feed the sample into the proper modem(s) for the channel. - * - * Inputs: chan - Radio channel number - * - * audio_sample - * - *------------------------------------------------------------------------------*/ - - -__attribute__((hot)) -void multi_modem_process_sample (int chan, int audio_sample) -{ - int subchan; - - for (subchan = 0; subchan < modem.num_subchan[chan]; subchan++) { - demod_process_sample(chan, subchan, audio_sample); - - if (candidate[chan][subchan].packet_p != NULL) { - candidate[chan][subchan].age++; - if (candidate[chan][subchan].age > process_age[chan]) { - pick_best_candidate (chan); - } - } - } -} - - - -/*------------------------------------------------------------------- - * - * Name: multi_modem_process_rec_frame - * - * Purpose: This is called when we receive a frame with a valid - * FCS and acceptable size. - * - * Inputs: chan - Audio channel number, 0 or 1. - * subchan - Which modem/decoder found it. - * fbuf - Pointer to first byte in HDLC frame. - * flen - Number of bytes excluding the FCS. - * alevel - Audio level, range of 0 - 100. - * (Special case, use negative to skip - * display of audio level line. - * Use -2 to indicate DTMF message.) - * retries - Level of bit correction used. - * - * - * Description: Add to list of candidates. Best one will be picked later. - * - *--------------------------------------------------------------------*/ - -/* - - It gets a little more complicated when we try fixing frames - with imperfect CRCs. - - Changing of adjacent bits is quick and done immediately. These - all come in at nearly the same time. The processing of two - separated bits can take a long time and is handled in the - background by another thread. These could come in seconds later. - - We need a way to remove duplicates. I think these are the - two cases we need to consider. - - (1) Same result as earlier no error or adjacent bit errors. - - ____||||_ - 0.0: ptr=00000000 - 0.1: ptr=00000000 - 0.2: ptr=00000000 - 0.3: ptr=00000000 - 0.4: ptr=009E5540, retry=0, age=295, crc=9458, score=5024 - 0.5: ptr=0082F008, retry=0, age=294, crc=9458, score=5026 *** - 0.6: ptr=009CE560, retry=0, age=293, crc=9458, score=5026 - 0.7: ptr=009CEE08, retry=0, age=293, crc=9458, score=5024 - 0.8: ptr=00000000 - - ___._____ - 0.0: ptr=00000000 - 0.1: ptr=00000000 - 0.2: ptr=00000000 - 0.3: ptr=009E5540, retry=4, age=295, crc=9458, score=1000 *** - 0.4: ptr=00000000 - 0.5: ptr=00000000 - 0.6: ptr=00000000 - 0.7: ptr=00000000 - 0.8: ptr=00000000 - - (2) Only results from adjusting two non-adjacent bits. - - - ||||||||_ - 0.0: ptr=022EBA08, retry=0, age=289, crc=5acd, score=5042 - 0.1: ptr=022EA8B8, retry=0, age=290, crc=5acd, score=5048 - 0.2: ptr=022EB160, retry=0, age=290, crc=5acd, score=5052 - 0.3: ptr=05BD0048, retry=0, age=291, crc=5acd, score=5054 *** - 0.4: ptr=04FE0048, retry=0, age=292, crc=5acd, score=5054 - 0.5: ptr=05E10048, retry=0, age=294, crc=5acd, score=5052 - 0.6: ptr=053D0048, retry=0, age=294, crc=5acd, score=5048 - 0.7: ptr=02375558, retry=0, age=295, crc=5acd, score=5042 - 0.8: ptr=00000000 - - _______._ - 0.0: ptr=00000000 - 0.1: ptr=00000000 - 0.2: ptr=00000000 - 0.3: ptr=00000000 - 0.4: ptr=00000000 - 0.5: ptr=00000000 - 0.6: ptr=00000000 - 0.7: ptr=02375558, retry=4, age=295, crc=5fc5, score=1000 *** - 0.8: ptr=00000000 - - ________. - 0.0: ptr=00000000 - 0.1: ptr=00000000 - 0.2: ptr=00000000 - 0.3: ptr=00000000 - 0.4: ptr=00000000 - 0.5: ptr=00000000 - 0.6: ptr=00000000 - 0.7: ptr=00000000 - 0.8: ptr=02375558, retry=4, age=295, crc=5fc5, score=1000 *** - - - These can both be covered by keepin the last CRC and dropping - duplicates. In theory we could get another frame in between with - a slow computer so the complete solution would be to remember more - than one. -*/ - -void multi_modem_process_rec_frame (int chan, int subchan, unsigned char *fbuf, int flen, int alevel, retry_t retries) -{ - packet_t pp; - - - assert (chan >= 0 && chan < MAX_CHANS); - assert (subchan >= 0 && subchan < MAX_SUBCHANS); - - pp = ax25_from_frame (fbuf, flen, alevel); - - if (pp == NULL) { - return; /* oops! why would it fail? */ - } - -/* - * If single modem, push it thru and forget about all this foolishness. - */ - if (modem.num_subchan[chan] == 1) { - app_process_rec_packet (chan, subchan, pp, alevel, retries, ""); - return; - } - -/* - * Special handing for two separated bit errors. - * See description earlier. - * - * Not combined with others to find the best score. - * Either pass it along or drop if duplicate. - */ - - if (retries >= RETRY_SWAP_TWO_SEP) { - int mycrc; - char spectrum[MAX_SUBCHANS+1]; - int dropped = 0; - - memset (spectrum, 0, sizeof(spectrum)); - memset (spectrum, '_', (size_t)modem.num_subchan[chan]); - spectrum[subchan] = '.'; - - mycrc = ax25_m_m_crc(pp); -/* Smetimes recovered packet is not the latest one send to the app: - * It can be a packet sent to the app before the latest one because of the processing time ... - * So we check if the crc of current packet has already been received in the queue of others crc - */ - dropped = is_crc_in_queue(chan, mycrc); - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("\n%s\n%d.%d: ptr=%p, retry=%d, age=, crc=%04x, score= , dropped =%d\n", - spectrum, chan, subchan, pp, (int)retries, mycrc,dropped); -#endif - if (dropped) { - /* Same as last one. Drop it. */ - ax25_delete (pp); -#if DEBUG - dw_printf ("Drop duplicate.\n"); -#endif - return; - } - -#if DEBUG - dw_printf ("Send the best one along.\n"); -#endif - app_process_rec_packet (chan, subchan, pp, alevel, retries, spectrum); - if (crc_queue_append(mycrc, chan) > MAX_STORED_CRC) - crc_queue_remove(chan); - return; - } - - -/* - * Otherwise, save them up for a few bit times so we can pick the best. - */ - if (candidate[chan][subchan].packet_p != NULL) { - /* Oops! Didn't expect it to be there. */ - ax25_delete (candidate[chan][subchan].packet_p); - candidate[chan][subchan].packet_p = NULL; - } - - candidate[chan][subchan].packet_p = pp; - candidate[chan][subchan].alevel = alevel; - candidate[chan][subchan].retries = retries; - candidate[chan][subchan].age = 0; - candidate[chan][subchan].crc = ax25_m_m_crc(pp); -} - - - - -/*------------------------------------------------------------------- - * - * Name: pick_best_candidate - * - * Purpose: This is called when we have one or more candidates - * available for a certain amount of time. - * - * Description: Pick the best one and send it up to the application. - * Discard the others. - * - * Rules: We prefer one received perfectly but will settle for - * one where some bits had to be flipped to get a good CRC. - * - *--------------------------------------------------------------------*/ - - -static void pick_best_candidate (int chan) -{ - int subchan; - int best_subchan, best_score; - char spectrum[MAX_SUBCHANS+1]; - int k; - - memset (spectrum, 0, sizeof(spectrum)); - - for (subchan = 0; subchan < modem.num_subchan[chan]; subchan++) { - - /* Build the spectrum display. */ - - if (candidate[chan][subchan].packet_p == NULL) { - spectrum[subchan] = '_'; - } - else if (candidate[chan][subchan].retries == RETRY_NONE) { - spectrum[subchan] = '|'; - } - else if (candidate[chan][subchan].retries == RETRY_SWAP_SINGLE) { - spectrum[subchan] = ':'; - } - else { - spectrum[subchan] = '.'; - } - - /* Begining score depends on effort to get a valid frame CRC. */ - - candidate[chan][subchan].score = RETRY_MAX * 1000 - ((int)candidate[chan][subchan].retries * 1000); - - /* Bump it up slightly if others nearby have the same CRC. */ - - for (k = 0; k < modem.num_subchan[chan]; k++) { - if (k != subchan && candidate[chan][k].packet_p != NULL) { - if (candidate[chan][k].crc == candidate[chan][subchan].crc) { - candidate[chan][subchan].score += (MAX_SUBCHANS+1) - abs(subchan-k); - } - } - } - } - - best_subchan = 0; - best_score = 0; - - for (subchan = 0; subchan < modem.num_subchan[chan]; subchan++) { - if (candidate[chan][subchan].packet_p != NULL) { - if (candidate[chan][subchan].score > best_score) { - best_score = candidate[chan][subchan].score; - best_subchan = subchan; - } - } - } - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("\n%s\n", spectrum); - - for (subchan = 0; subchan < modem.num_subchan[chan]; subchan++) { - - if (candidate[chan][subchan].packet_p == NULL) { - dw_printf ("%d.%d: ptr=%p\n", chan, subchan, - candidate[chan][subchan].packet_p); - } - else { - dw_printf ("%d.%d: ptr=%p, retry=%d, age=%3d, crc=%04x, score=%d %s\n", chan, subchan, - candidate[chan][subchan].packet_p, - (int)(candidate[chan][subchan].retries), - candidate[chan][subchan].age, - candidate[chan][subchan].crc, - candidate[chan][subchan].score, - subchan == best_subchan ? "***" : ""); - } - } -#endif - -/* - * send the best one along. - */ - app_process_rec_packet (chan, best_subchan, - candidate[chan][best_subchan].packet_p, - candidate[chan][best_subchan].alevel, - (int)(candidate[chan][best_subchan].retries), - spectrum); - if (crc_queue_append(candidate[chan][best_subchan].crc, chan) > MAX_STORED_CRC) - crc_queue_remove(chan); - /* Someone else will delete so don't do it below. */ - candidate[chan][best_subchan].packet_p = NULL; - - /* Clear out in preparation for next time. */ - - for (subchan = 0; subchan < modem.num_subchan[chan]; subchan++) { - if (candidate[chan][subchan].packet_p != NULL) { - ax25_delete (candidate[chan][subchan].packet_p); - candidate[chan][subchan].packet_p = NULL; - } - candidate[chan][subchan].alevel = 0; - candidate[chan][subchan].retries = 0; - candidate[chan][subchan].age = 0; - candidate[chan][subchan].crc = 0; - } -} - - -/* end multi_modem.c */ diff --git a/multi_modem.h b/multi_modem.h deleted file mode 100644 index f1dcdd9f..00000000 --- a/multi_modem.h +++ /dev/null @@ -1,20 +0,0 @@ -/* multi_modem.h */ - -#ifndef MULTI_MODEM_H -#define MULTI_MODEM 1 - -/* Needed for typedef retry_t. */ -#include "hdlc_rec2.h" - -/* Needed for struct audio_s */ -#include "audio.h" - - -void multi_modem_init (struct audio_s *pmodem); - -void multi_modem_process_sample (int c, int audio_sample); - -void multi_modem_process_rec_frame (int chan, int subchan, unsigned char *fbuf, int flen, int level, retry_t retries); - - -#endif diff --git a/nmea.c b/nmea.c deleted file mode 100644 index 8433945f..00000000 --- a/nmea.c +++ /dev/null @@ -1,1037 +0,0 @@ -// -// This file is part of Dire Wolf, an amateur radio packet TNC. -// -// Copyright (C) 2014 John Langner, WB2OSZ -// -// This program 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 2 of the License, or -// (at your option) any later version. -// -// This program 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 this program. If not, see . -// - - -//#define DEBUG 1 - -/*------------------------------------------------------------------ - * - * Module: nmea.c - * - * Purpose: Receive NMEA sentences from a GPS receiver. - * Send NMEA waypoint sentences to GPS display or mapping application. - * - *---------------------------------------------------------------*/ - -#include -#include - -#if __WIN32__ -#include -#include -#else -#define __USE_XOPEN2KXSI 1 -#define __USE_XOPEN 1 -//#define __USE_POSIX 1 -#include -#include -#include -#include -#include -#include -#include -#endif - -#include -#include - -#if __WIN32__ -char *strsep(char **stringp, const char *delim); -#endif - -#include "direwolf.h" -#include "config.h" -#include "ax25_pad.h" -#include "textcolor.h" -//#include "xmit.h" -#include "latlong.h" -#include "nmea.h" -#include "grm_sym.h" /* Garmin symbols */ -#include "mgn_icon.h" /* Magellan icons */ - - -#if __WIN32__ -typedef HANDLE MYFDTYPE; -#define MYFDERROR INVALID_HANDLE_VALUE -#else -typedef int MYFDTYPE; -#define MYFDERROR (-1) -#endif - - -// TODO: receive buffer... static kiss_frame_t kf; /* Accumulated KISS frame and state of decoder. */ - -static MYFDTYPE nmea_port_fd = MYFDERROR; - -static void nmea_send_sentence (char *sent); - -#if __WIN32__ -static unsigned __stdcall nmea_listen_thread (void *arg); -#else -static void * nmea_listen_thread (void *arg); -#endif - -static void nmea_parse_gps (char *sentence); - - -static int nmea_debug = 0; /* Print information flowing from and to attached device. */ - -void nmea_set_debug (int n) -{ - nmea_debug = n; -} - - -/*------------------------------------------------------------------- - * - * Name: nmea_init - * - * Purpose: Initialization for NMEA communication port. - & - * Inputs: mc->nmea_port - name of serial port. - * - * Global output: nmea_port_fd - * - * - * Description: (1) Open serial port device. - * (2) Start a new thread to listen for GPS receiver. - * - * Reference: http://www.robbayer.com/files/serial-win.pdf - * - *---------------------------------------------------------------*/ - - - - -static MYFDTYPE nmea_open_port (char *device); - -void nmea_init (struct misc_config_s *mc) -{ - -#if __WIN32__ - HANDLE nmea_listen_th; -#else - pthread_t nmea_listen_tid; -#endif - -/* - * Open serial port connection. - */ - if (strlen(mc->nmea_port) > 0) { - -#if ! __WIN32__ - - /* Translate Windows device name into Linux name. */ - /* COM1 -> /dev/ttyS0, etc. */ - - if (strncasecmp(mc->nmea_port, "COM", 3) == 0) { - int n = atoi (mc->nmea_port + 3); - text_color_set(DW_COLOR_INFO); - dw_printf ("Converted NMEA device '%s'", mc->nmea_port); - if (n < 1) n = 1; - sprintf (mc->nmea_port, "/dev/ttyS%d", n-1); - dw_printf (" to Linux equivalent '%s'\n", mc->nmea_port); - } -#endif - nmea_port_fd = nmea_open_port (mc->nmea_port); - - if (nmea_port_fd != MYFDERROR) { -#if __WIN32__ - nmea_listen_th = (HANDLE)_beginthreadex (NULL, 0, nmea_listen_thread, (void*)(long)nmea_port_fd, 0, NULL); - if (nmea_listen_th == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Could not create NMEA listening thread.\n"); - return; - } -#else - int e; - e = pthread_create (&nmea_listen_tid, NULL, nmea_listen_thread, (void*)(long)nmea_port_fd); - if (e != 0) { - text_color_set(DW_COLOR_ERROR); - perror("Could not create NMEA listening thread."); - - } -#endif - } - } - - -#if DEBUG - text_color_set (DW_COLOR_DEBUG); - - dw_printf ("end of nmea_init: nmea_port_fd = %d\n", nmea_port_fd); -#endif -} - - -/* - * Returns fd for serial port or MYFDERROR for error. - */ - - -static MYFDTYPE nmea_open_port (char *devicename) -{ - -#if __WIN32__ - - MYFDTYPE fd; - DCB dcb; - int ok; - char bettername[50]; - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("nmea_open_port ( '%s' )\n", devicename); -#endif - - -// Need to use FILE_FLAG_OVERLAPPED for full duplex operation. -// Without it, write blocks when waiting on read. - -// Read http://support.microsoft.com/kb/156932 - -// Bug fix in release 1.1 - Need to munge name for COM10 and up. -// http://support.microsoft.com/kb/115831 - - strcpy (bettername, devicename); - if (strncasecmp(devicename, "COM", 3) == 0) { - int n; - n = atoi(devicename+3); - if (n >= 10) { - strcpy (bettername, "\\\\.\\"); - strcat (bettername, devicename); - } - } - - fd = CreateFile(bettername, GENERIC_READ | GENERIC_WRITE, - 0, NULL, OPEN_EXISTING, FILE_FLAG_OVERLAPPED, NULL); - - if (fd == MYFDERROR) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("ERROR - Could not open NMEA port %s.\n", devicename); - return (MYFDERROR); - } - - /* Reference: http://msdn.microsoft.com/en-us/library/windows/desktop/aa363201(v=vs.85).aspx */ - - memset (&dcb, 0, sizeof(dcb)); - dcb.DCBlength = sizeof(DCB); - - ok = GetCommState (fd, &dcb); - if (! ok) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("nmea_open_port: GetCommState failed.\n"); - } - - /* http://msdn.microsoft.com/en-us/library/windows/desktop/aa363214(v=vs.85).aspx */ - - dcb.DCBlength = sizeof(DCB); - dcb.BaudRate = CBR_4800; - dcb.fBinary = 1; - dcb.fParity = 0; - dcb.fOutxCtsFlow = 0; - dcb.fOutxDsrFlow = 0; - dcb.fDtrControl = DTR_CONTROL_DISABLE; - dcb.fDsrSensitivity = 0; - dcb.fOutX = 0; - dcb.fInX = 0; - dcb.fErrorChar = 0; - dcb.fNull = 0; /* Don't drop nul characters! */ - dcb.fRtsControl = 0; - dcb.ByteSize = 8; - dcb.Parity = NOPARITY; - dcb.StopBits = ONESTOPBIT; - - ok = SetCommState (fd, &dcb); - if (! ok) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("nmea_open_port: SetCommState failed.\n"); - } - - text_color_set(DW_COLOR_INFO); - dw_printf("NMEA communication started on %s.\n", devicename); - -#else - -/* Linux version. */ - - int fd; - struct termios ts; - int e; - - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("nmea_open_port ( '%s' )\n", devicename); -#endif - - fd = open (devicename, O_RDWR); - - if (fd == MYFDERROR) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("ERROR - Could not open NMEA port %s.\n", devicename); - return (MYFDERROR); - } - - e = tcgetattr (fd, &ts); - if (e != 0) { perror ("nm tcgetattr"); } - - cfmakeraw (&ts); - - ts.c_cc[VMIN] = 1; /* wait for at least one character */ - ts.c_cc[VTIME] = 0; /* no fancy timing. */ - - cfsetispeed (&ts, B4800); - cfsetospeed (&ts, B4800); - - e = tcsetattr (fd, TCSANOW, &ts); - if (e != 0) { perror ("nmea tcsetattr"); } - - text_color_set(DW_COLOR_INFO); - dw_printf("NMEA communication started on %s.\n", devicename); - -#endif - - return (fd); -} - - - -/*------------------------------------------------------------------- - * - * Name: append_checksum - * - * Purpose: Append checksum to the sentence. - * - * In/out: sentence - NMEA sentence beginning with '$'. - * - * Description: Checksum is exclusive of characters except leading '$'. - * We append '*' and an upper case two hexadecimal value. - * - *--------------------------------------------------------------------*/ - -static void append_checksum (char *sentence) -{ - char *p; - int cs; - - assert (sentence[0] == '$'); - - cs = 0; - for (p = sentence+1; *p != '\0'; p++) { - cs ^= *p; - } - - sprintf (p, "*%02X", cs & 0xff); - -// Add crlf too? - -} /* end append_checksum */ - - - -/*------------------------------------------------------------------- - * - * Name: nema_send_waypoint - * - * Purpose: Convert APRS position or object into NMEA waypoint sentence - * for use by a GPS display or other mapping application. - * - * Inputs: wname_in - Name of waypoint. - * dlat - Latitude. - * dlong - Longitude. - * symtab - Symbol table or overlay character. - * symbol - Symbol code. - * alt - Altitude in meters or G_UNKOWN. - * course - Course in degrees or ??? for unknown. - * speed - Speed in knots ?? or ?? - * comment - Description or message. - * - * - * Description: Currently we send multiple styles. Maybe someday there might - * be an option to send a selected subset. - * - * $GPWPL - Generic with only location and name. - * $PGRMW - Garmin, adds altitude, symbol, and comment - * to previously named waypoint. - * $PMGNWPL - Magellan, more complete for stationary objects. - * $PKWDWPL - Kenwood with APRS style symbol but missing comment. - * - *--------------------------------------------------------------------*/ - - -void nmea_send_waypoint (char *wname_in, double dlat, double dlong, char symtab, char symbol, - float alt, float course, float speed, char *comment) -{ - char wname[12]; /* Waypoint name. Any , or * removed. */ - char slat[12]; /* DDMM.mmmm */ - char slat_ns[2]; /* N or S */ - char slong[12]; /* DDDMM.mmmm */ - char slong_ew[2]; /* E or W */ - char sentence[500]; - char salt[12]; /* altitude as string, empty if unknown */ - char sspeed[12]; /* speed as string, empty if unknown */ - char scourse[12]; /* course as string, empty if unknown */ - int grm_sym; /* Garmin symbol code. */ - char sicon[4]; /* Magellan icon string */ - char stime[8]; - char sdate[8]; - char *p; - - - -// Remove any comma from name. - -// TODO: remove any , or * from comment. - - strcpy (wname, wname_in); - for (p=wname; *p != '\0'; p++) { - if (*p == ',') *p = ' '; - if (*p == '*') *p = ' '; - } - -// Convert position to character form. - - latitude_to_nmea (dlat, slat, slat_ns); - longitude_to_nmea (dlong, slong, slong_ew); - -/* - * Generic. - * - * $GPWPL,ddmm.mmmm,ns,dddmm.mmmm,ew,wname*99 - * - * Where, - * ddmm.mmmm,ns is latitude - * dddmm.mmmm,ew is longitude - * wname is the waypoint name - * *99 is checksum - */ - - sprintf (sentence, "$GPWPL,%s,%s,%s,%s,%s", slat, slat_ns, slong, slong_ew, wname); - append_checksum (sentence); - nmea_send_sentence (sentence); - - - -/* - * Garmin - https://www8.garmin.com/support/pdf/NMEA_0183.pdf - * http://gpsinformation.net/mag-proto.htm - * - * $PGRMW,wname,alt,symbol,comment*99 - * - * Where, - * - * wname is waypoint name. Must match existing waypoint. - * alt is altitude in meters. - * symbol is symbol code. Hexadecimal up to FFFF. - * See Garmin Device Interface Specification 001-0063-00. - * comment is comment for the waypoint. - * *99 is checksum - */ - - if (alt == G_UNKNOWN) { - strcpy (salt, ""); - } - else { - sprintf (salt, "%.1f", alt); - } - grm_sym = 0x1234; // TODO - - sprintf (sentence, "$PGRMW,%s,%s,%04X,%s", wname, salt, grm_sym, comment); - append_checksum (sentence); - nmea_send_sentence (sentence); - -/* - * Magellan - http://www.gpsinformation.org/mag-proto-2-11.pdf - * - * $PMGNWPL,ddmm.mmmm,ns,dddmm.mmmm,ew,alt,unit,wname,comment,icon,xx*99 - * - * Where, - * ddmm.mmmm,ns is latitude - * dddmm.mmmm,ew is longitude - * alt is altitude - * unit is M for meters or F for feet - * wname is the waypoint name - * comment is message or comment - * icon is one or two letters for icon code - * xx is waypoint type which is optional, not well - * defined, and not used in their example. - * *99 is checksum - */ - -// TODO: icon - - sprintf (sicon, "??"); - sprintf (sentence, "$PMGNWPL,%s,%s,%s,%s,%s,M,%s,%s,%s", - slat, slat_ns, slong, slong_ew, salt, wname, comment, sicon); - append_checksum (sentence); - nmea_send_sentence (sentence); - -/* - * Kenwood - Speculation due to no official spec found so far. - * - * $PKWDWPL,hhmmss,v,ddmm.mmmm,ns,dddmm.mmmm,ew,speed,course,ddmmyy,alt,wname,ts*99 - * - * Where, - * hhmmss is time in UTC. Should we supply current - * time or only pass along time from - * received signal? - * v indicates valid data ????????????????? - * Why would we send if not valid? - * ddmm.mmmm,ns is latitude - * dddmm.mmmm,ew is longitude - * speed is speed in UNITS ??? knots ????? - * course is course in degrees - * ddmmyy is date. Same question as time. - * alt is altitude. in UNITS ??? meters ??? - * wname is the waypoint name - * ts are the table and symbol. - * Non-standard parsing would be required - * to deal with these for symbol: - * , Boy Scouts / Girl Scouts - * * SnowMobile / Snow - * *99 is checksum - * - * Oddly, there is not place for comment. - */ - - if (speed == G_UNKNOWN) { - strcpy (sspeed, ""); - } - else { - sprintf (sspeed, "%.1f", speed); - } - if (course == G_UNKNOWN) { - strcpy (scourse, ""); - } - else { - sprintf (scourse, "%.1f", course); - } - -// TODO: how to handle time & date ??? - - strcpy (stime, "123456"); - strcpy (sdate, "123456"); - - sprintf (sentence, "$PKWDWPL,%s,V,%s,%s,%s,%s,%s,%s,%s,%s,%s,%c%c", - stime, slat, slat_ns, slong, slong_ew, - sspeed, scourse, sdate, salt, wname, symtab, symbol); - append_checksum (sentence); - nmea_send_sentence (sentence); - -/* - * One application recognizes these. Not implemented at this time. - * - * $GPTLL,01,ddmm.mmmm,ns,dddmm.mmmm,ew,tname,000000.00,T,R*99 - * - * Where, - * ddmm.mmmm,ns is latitude - * dddmm.mmmm,ew is longitude - * tname is the target name - * 000000.00 is timestamp ??? - * T is target status (S for need help) - * R is reference target ??? - * *99 is checksum - * - * - * $GPTXT,01,01,tname,message*99 - * - * Where, - * - * 01 is total number of messages in transmission - * 01 is message number in this transmission - * tname is target name. Should match name in WPL or TTL. - * message is the message. - * *99 is checksum - * - */ - -} /* end nmea_send_waypoint */ - - -#if 0 - -* d710a menu 603 $GPWPL $PMGNWPL $PKWDWPL - -symbol mapping - -https://freepository.com:444/50lItuLQ7fW6s-web/browser/Tracker2/trunk/sources/waypoint.c?rev=108 - - - -Data Transmission Protocol For Magellan Products – version 2.11 - - - - - - -$PMGNWPL,4651.529,N,07111.425,W,0000000,M,GC5A5F, GC. The straight line,a*13 - $PMGNWPL,3549.499,N,08650.827,W,0000257,M,HOME,HOME,c*4D - -http://gpsbabel.sourcearchive.com/documentation/1.3.7~cvs1/magproto_8c-source.html - - sscanf(trkmsg,"$PMGNWPL,%lf,%c,%lf,%c,%d,%c,%[^,],%[^,]", - &latdeg,&latdir, - &lngdeg,&lngdir, - &alt,&altunits,shortname,descr); then icon - - sprintf(obuf, "PMGNWPL,%4.3f,%c,%09.3f,%c,%07.0f,M,%-.*s,%-.46s,%s", - lat, ilat < 0 ? 'S' : 'N', - lon, ilon < 0 ? 'W' : 'E', - waypointp->altitude == unknown_alt ? - 0 : waypointp->altitude, - wpt_len, - owpt, - odesc, - icon_token); - -https://freepository.com:444/50lItuLQ7fW6s-web/changeset/108/Tracker2/trunk/sources/waypoint.c - -$PMGNWPL,4106.003,S,14640.214,E,0000069,M,KISSING SPOT,,a*3C - - - - - - * -https://freepository.com:444/50lItuLQ7fW6s-web/changeset/325 - - -#endif - - -static void nmea_send_sentence (char *sent) -{ - - int err; - int len = strlen(sent); - - - if (nmea_port_fd == MYFDERROR) { - return; - } - - text_color_set(DW_COLOR_XMIT); - dw_printf ("%s\n", sent); - - if (nmea_debug) { - // TODO: debugg out... nmea_debug_print (TO_CLIENT, NULL, nmea_buff+1, nmea_len-2); - } - -// TODO: need to append CR LF. - - -#if __WIN32__ - - DWORD nwritten; - - /* Without this, write blocks while we are waiting on a read. */ - static OVERLAPPED ov_wr; - memset (&ov_wr, 0, sizeof(ov_wr)); - - if ( ! WriteFile (nmea_port_fd, sent, len, &nwritten, &ov_wr)) - { - err = GetLastError(); - if (err != ERROR_IO_PENDING) - { - text_color_set(DW_COLOR_ERROR); - dw_printf ("\nError sending NMEA sentence. Error %d.\n\n", (int)GetLastError()); - //CloseHandle (nmea_port_fd); - //nmea_port_fd = MYFDERROR; - } - } - else if (nwritten != len) - { - text_color_set(DW_COLOR_ERROR); - dw_printf ("\nError sending NMEA sentence. Only %d of %d written.\n\n", (int)nwritten, len); - //CloseHandle (nmea_port_fd); - //nmea_port_fd = MYFDERROR; - } - -#else - err = write (nmea_port_fd, sent, (size_t)len); - if (err != len) - { - text_color_set(DW_COLOR_ERROR); - dw_printf ("\nError sending NMEA sentence. err=%d\n\n", err); - //close (nmea_port_fd); - //nmea_port_fd = MYFDERROR; - } -#endif - - -} /* nmea_send_sentence */ - - - -/*------------------------------------------------------------------- - * - * Name: nmea_listen_thread - * - * Purpose: Wait for messages from GPS receiver. - * - * Inputs: arg - File descriptor for reading. - * - * Outputs: pt_slave_fd - File descriptor for communicating with client app. - * - * Description: Process messages from the client application. - * - *--------------------------------------------------------------------*/ - -//TODO: should pass fd by reference so it can be zapped. -//BUG: If we close it here, that fact doesn't get back -// to the main receiving thread. - -/* Return one byte (value 0 - 255) or terminate thread on error. */ - - -static int nmea_get (MYFDTYPE fd) -{ - unsigned char ch; - -#if __WIN32__ /* Native Windows version. */ - - DWORD n; - static OVERLAPPED ov_rd; - - memset (&ov_rd, 0, sizeof(ov_rd)); - ov_rd.hEvent = CreateEvent (NULL, TRUE, FALSE, NULL); - - - /* Overlapped I/O makes reading rather complicated. */ - /* See: http://msdn.microsoft.com/en-us/library/ms810467.aspx */ - - /* It seems that the read completes OK with a count */ - /* of 0 every time we send a message to the serial port. */ - - n = 0; /* Number of characters read. */ - - while (n == 0) { - - if ( ! ReadFile (fd, &ch, 1, &n, &ov_rd)) - { - int err1 = GetLastError(); - - if (err1 == ERROR_IO_PENDING) - { - /* Wait for completion. */ - - if (WaitForSingleObject (ov_rd.hEvent, INFINITE) == WAIT_OBJECT_0) - { - if ( ! GetOverlappedResult (fd, &ov_rd, &n, 1)) - { - int err3 = GetLastError(); - - text_color_set(DW_COLOR_ERROR); - dw_printf ("\nKISS GetOverlappedResult error %d.\n\n", err3); - } - else - { - /* Success! n should be 1 */ - } - } - } - else - { - text_color_set(DW_COLOR_ERROR); - dw_printf ("\nKISS ReadFile error %d. Closing connection.\n\n", err1); - //CloseHandle (fd); - //fd = MYFDERROR; - //pthread_exit (NULL); - } - } - - } /* end while n==0 */ - - CloseHandle(ov_rd.hEvent); - - if (n != 1) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("\nNMEA failed to get one byte. n=%d.\n\n", (int)n); - -#if DEBUG9 - fprintf (log_fp, "n=%d\n", n); -#endif - } - - -#else /* Linux version */ - - int n; - - n = read(fd, &ch, (size_t)1); - - if (n != 1) { - //text_color_set(DW_COLOR_ERROR); - //dw_printf ("\nError receiving kiss message from client application. Closing connection %d.\n\n", fd); - - close (fd); - - fd = MYFDERROR; - pthread_exit (NULL); - } - -#endif - -#if DEBUGx - text_color_set(DW_COLOR_DEBUG); - dw_printf ("nmea_get(%d) returns 0x%02x\n", fd, ch); -#endif - - return (ch); -} - - -// Maximum length of message from GPS receiver. -// 82 according to some people. Larger to be safe. - -#define NMEA_MAX_LEN 120 - -static char gps_msg[NMEA_MAX_LEN]; -int gps_msg_len = 0; - - -#if __WIN32__ -static unsigned __stdcall nmea_listen_thread (void *arg) -#else -static void * nmea_listen_thread (void *arg) -#endif -{ - MYFDTYPE fd = (MYFDTYPE)(long)arg; - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("nmea_listen_thread ( %d )\n", fd); -#endif - - - while (1) { - unsigned char ch; - - ch = nmea_get(fd); - - if (ch == '$') { - // Start of new sentence. - gps_msg_len = 0; - gps_msg[gps_msg_len++] = ch; - gps_msg[gps_msg_len] = '\0'; - } - else if (ch == '\r' || ch == '\n') { - if (gps_msg_len >= 6 && gps_msg[0] == '$') { - nmea_parse_gps (gps_msg); - text_color_set(DW_COLOR_REC); - dw_printf ("%s\n", gps_msg); - } - gps_msg_len = 0; - gps_msg[gps_msg_len] = '\0'; - } - else { - if (gps_msg_len < NMEA_MAX_LEN-1) { - gps_msg[gps_msg_len++] = ch; - gps_msg[gps_msg_len] = '\0'; - } - } - } /* while (1) */ - - return (NULL); /* Unreachable but avoids compiler warning. */ -} - - -/*------------------------------------------------------------------- - * - * Name: ... - * - * Purpose: ... - * - * Inputs: ... - * - * Outputs: ... - * - * Description: ... - * - *--------------------------------------------------------------------*/ - - -static void remove_checksum (char *sent) -{ - char *p; - char *next; - unsigned char cs; - - -// Do we have valid checksum? - - cs = 0; - for (p = sent+1; *p != '*' && *p != '\0'; p++) { - cs ^= *p; - } - - p = strchr (sent, '*'); - if (p == NULL) { - text_color_set (DW_COLOR_INFO); - dw_printf("Missing GPS checksum.\n"); - return; - } - if (cs != strtoul(p+1, NULL, 16)) { - text_color_set (DW_COLOR_ERROR); - dw_printf("GPS checksum error. Expected %02x but found %s.\n", cs, p+1); - return; - } - *p = '\0'; // Remove the checksum. -} - -static void nmea_parse_gps (char *sentence) -{ - - char stemp[NMEA_MAX_LEN]; - char *ptype; - char *next; - double g_lat, g_lon; - float g_speed, g_course; - static float g_alt = G_UNKNOWN; - int fix; /* 0=none, 2=2D, 3=3D */ - - strcpy (stemp, sentence); - - // TODO: process only if good. - remove_checksum (stemp); - - next = stemp; - ptype = strsep(&next, ","); - - -// $GPRMC has everything we care about except altitude. -// -// Examples: $GPRMC,212404.000,V,4237.1505,N,07120.8602,W,,,150614,,*0B -// $GPRMC,000029.020,V,,,,,,,080810,,,N*45 -// $GPRMC,003413.710,A,4237.1240,N,07120.8333,W,5.07,291.42,160614,,,A*7F - - if (strcmp(ptype, "$GPRMC") == 0) - { - - char *ptime; /* Time, hhmmss[.sss] */ - char *pstatus; /* Status, A=Active (valid position), V=Void */ - char *plat; /* Latitude */ - char *pns; /* North/South */ - char *plon; /* Longitude */ - char *pew; /* East/West */ - char *pknots; /* Speed over ground, knots. */ - char *pcourse; /* True course, degrees. */ - char *pdate; /* Date, ddmmyy */ - /* Magnetic variation */ - /* In version 3.00, mode is added: A D E N (see below) */ - /* Checksum */ - - ptime = strsep(&next, ","); - pstatus = strsep(&next, ","); - plat = strsep(&next, ","); - pns = strsep(&next, ","); - plon = strsep(&next, ","); - pew = strsep(&next, ","); - pknots = strsep(&next, ","); - pcourse = strsep(&next, ","); - pdate = strsep(&next, ","); - - - g_lat = G_UNKNOWN; - g_lon = G_UNKNOWN; - g_speed = G_UNKNOWN; - g_course = G_UNKNOWN; - - if (plat != NULL && strlen(plat) > 0) { - g_lat = latitude_from_nmea(plat, pns); - } - if (plon != NULL && strlen(plon) > 0) { - g_lon = longitude_from_nmea(plon, pew); - } - if (pknots != NULL && strlen(pknots) > 0) { - g_speed = atof(pknots); - } - if (pcourse != NULL && strlen(pcourse) > 0) { - g_course = atof(pcourse); - } - - if (*pstatus == 'A') { - if (g_alt != G_UNKNOWN) { - fix = 3; - } - else { - fix = 2; - } - } - else { - fix = 0; - } - - text_color_set (DW_COLOR_INFO); - dw_printf("%d %.6f %.6f %.1f %.0f %.1f\n", fix, g_lat, g_lon, g_speed, g_course, g_alt); - - } - -// $GPGGA has altitude. -// -// Examples: $GPGGA,212407.000,4237.1505,N,07120.8602,W,0,00,,,M,,M,,*58 -// $GPGGA,000409.392,,,,,0,00,,,M,0.0,M,,0000*53 -// $GPGGA,003518.710,4237.1250,N,07120.8327,W,1,03,5.9,33.5,M,-33.5,M,,0000*5B - - else if (strcmp(ptype, "$GPGGA") == 0) - { - - char *ptime; /* Time, hhmmss[.sss] */ - char *plat; /* Latitude */ - char *pns; /* North/South */ - char *plon; /* Longitude */ - char *pew; /* East/West */ - char *pfix; /* 0=invalid, 1=GPS fix, 2=DGPS fix */ - char *pnum_sat; /* Number of satellites */ - char *phdop; /* Horiz. Dilution fo Precision */ - char *paltitude; /* Altitude, above mean sea level */ - char *palt_u; /* Units for Altitude, typically M for meters. */ - char *pheight; /* Height above ellipsoid */ - char *pheight_u; /* Units for height, typically M for meters. */ - char *psince; /* Time since last DGPS update. */ - char *pdsta; /* DGPS reference station id. */ - - ptime = strsep(&next, ","); - plat = strsep(&next, ","); - pns = strsep(&next, ","); - plon = strsep(&next, ","); - pew = strsep(&next, ","); - pfix = strsep(&next, ","); - pnum_sat = strsep(&next, ","); - phdop = strsep(&next, ","); - paltitude = strsep(&next, ","); - palt_u = strsep(&next, ","); - pheight = strsep(&next, ","); - pheight_u = strsep(&next, ","); - psince = strsep(&next, ","); - pdsta = strsep(&next, ","); - - g_alt = G_UNKNOWN; - - if (paltitude != NULL && strlen(paltitude) > 0) { - g_alt = atof(paltitude); - } - } - - -} /* end nmea_parse_gps */ - -/* end nmea.c */ diff --git a/nmea.h b/nmea.h deleted file mode 100644 index 9ff85537..00000000 --- a/nmea.h +++ /dev/null @@ -1,19 +0,0 @@ - -/* - * Name: nmea.h - */ - - -#include "ax25_pad.h" /* for packet_t */ - -#include "config.h" /* for struct misc_config_s */ - - -void nmea_init (struct misc_config_s *misc_config); - -void nmea_set_debug (int n); - -void nmea_send_waypoint (char *wname_in, double dlat, double dlong, char symtab, char symbol, - float alt, float course, float speed, char *comment); - -/* end nmea.h */ diff --git a/ptt.c b/ptt.c deleted file mode 100644 index b3b95332..00000000 --- a/ptt.c +++ /dev/null @@ -1,855 +0,0 @@ -// -// This file is part of Dire Wolf, an amateur radio packet TNC. -// -// Copyright (C) 2011,2013,2014 John Langner, WB2OSZ -// -// This program 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 2 of the License, or -// (at your option) any later version. -// -// This program 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 this program. If not, see . - - - -/*------------------------------------------------------------------ - * - * Module: ptt.c - * - * Purpose: Activate the push to talk (PTT) signal to turn on transmitter. - * - * Description: Traditionally this is done with the RTS signal of the serial port. - * - * If we have two radio channels and only one serial port, DTR - * can be used for the second channel. - * - * If __WIN32__ is defined, we use the Windows interface. - * Otherwise we use the unix version suitable for either Cygwin or Linux. - * - * Version 0.9: Add ability to use GPIO pins on Linux. - * - * Version 1.1: Add parallel printer port for x86 Linux only. - * - * References: http://www.robbayer.com/files/serial-win.pdf - * - * https://www.kernel.org/doc/Documentation/gpio.txt - * - *---------------------------------------------------------------*/ - -#include -#include -#include -#include -#include -#include - -#if __WIN32__ -#include -#else -#include -#include -#include -#include -#include -#include -#include - -/* So we can have more common code for fd. */ -typedef int HANDLE; -#define INVALID_HANDLE_VALUE (-1) - -#endif - -#include "direwolf.h" -#include "textcolor.h" -#include "audio.h" -#include "ptt.h" - - -#if __WIN32__ - -#define RTS_ON(fd) EscapeCommFunction(fd,SETRTS); -#define RTS_OFF(fd) EscapeCommFunction(fd,CLRRTS); -#define DTR_ON(fd) EscapeCommFunction(fd,SETDTR); -#define DTR_OFF(fd) EscapeCommFunction(fd,CLRDTR); - -#else - -#define RTS_ON(fd) { int stuff; ioctl (fd, TIOCMGET, &stuff); stuff |= TIOCM_RTS; ioctl (fd, TIOCMSET, &stuff); } -#define RTS_OFF(fd) { int stuff; ioctl (fd, TIOCMGET, &stuff); stuff &= ~TIOCM_RTS; ioctl (fd, TIOCMSET, &stuff); } -#define DTR_ON(fd) { int stuff; ioctl (fd, TIOCMGET, &stuff); stuff |= TIOCM_DTR; ioctl (fd, TIOCMSET, &stuff); } -#define DTR_OFF(fd) { int stuff; ioctl (fd, TIOCMGET, &stuff); stuff &= ~TIOCM_DTR; ioctl (fd, TIOCMSET, &stuff); } - -#endif - -#define LPT_IO_ADDR 0x378 - - -#if TEST -#define dw_printf printf -#endif - - - -/*------------------------------------------------------------------- - * - * Name: ptt_init - * - * Purpose: Open serial port(s) used for PTT signals and set to proper state. - * - * Inputs: modem - Structure with communication parameters. - * - * - * Outputs: Remember required information for future use. - * - * Description: - * - *--------------------------------------------------------------------*/ - -static int ptt_num_channels; - -static ptt_method_t ptt_method[MAX_CHANS]; /* Method for PTT signal. */ - /* PTT_METHOD_NONE - not configured. Could be using VOX. */ - /* PTT_METHOD_SERIAL - serial (com) port. */ - /* PTT_METHOD_GPIO - general purpose I/O. */ - /* PTT_METHOD_LPT - Parallel printer port. */ - -static char ptt_device[MAX_CHANS][20]; /* Name of serial port device. */ - /* e.g. COM1 or /dev/ttyS0. */ - -static ptt_line_t ptt_line[MAX_CHANS]; /* RTS or DTR when using serial port. */ - -static int ptt_gpio[MAX_CHANS]; /* GPIO number. Only used for Linux. */ - /* Valid only when ptt_method is PTT_METHOD_GPIO. */ - -int ptt_lpt_bit[MAX_CHANS]; /* Bit number for parallel printer port. */ - /* Bit 0 = pin 2, ..., bit 7 = pin 9. */ - /* Valid only when ptt_method is PTT_METHOD_LPT. */ - -static int ptt_invert[MAX_CHANS]; /* Invert the signal. */ - /* Normally higher voltage means transmit. */ - -static HANDLE ptt_fd[MAX_CHANS]; /* Serial port handle or fd. */ - /* Could be the same for two channels */ - /* if using both RTS and DTR. */ - - - -void ptt_init (struct audio_s *p_modem) -{ - int ch; - HANDLE fd; -#if __WIN32__ -#else - int using_gpio; -#endif - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("ptt_init ( ... )\n"); -#endif - -/* - * First copy everything from p_modem to local variables - * so it is available for later use. - * - * Maybe all the PTT stuff should have its own structure. - */ - - ptt_num_channels = p_modem->num_channels; - - assert (ptt_num_channels >= 1 && ptt_num_channels <= MAX_CHANS); - - for (ch=0; chptt_method[ch]; - strcpy (ptt_device[ch], p_modem->ptt_device[ch]); - ptt_line[ch] = p_modem->ptt_line[ch]; - ptt_gpio[ch] = p_modem->ptt_gpio[ch]; - ptt_lpt_bit[ch] = p_modem->ptt_lpt_bit[ch]; - ptt_invert[ch] = p_modem->ptt_invert[ch]; - ptt_fd[ch] = INVALID_HANDLE_VALUE; -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("ch=%d, method=%d, device=%s, line=%d, gpio=%d, lpt_bit=%d, invert=%d\n", - ch, - ptt_method[ch], - ptt_device[ch], - ptt_line[ch], - ptt_gpio[ch], - ptt_lpt_bit[ch], - ptt_invert[ch]); -#endif - } - -/* - * Set up serial ports. - */ - - for (ch=0; ch /dev/ttyS0, etc. */ - - if (strncasecmp(ptt_device[ch], "COM", 3) == 0) { - int n = atoi (ptt_device[ch] + 3); - text_color_set(DW_COLOR_INFO); - dw_printf ("Converted PTT device '%s'", ptt_device[ch]); - if (n < 1) n = 1; - sprintf (ptt_device[ch], "/dev/ttyS%d", n-1); - dw_printf (" to Linux equivalent '%s'\n", ptt_device[ch]); - } -#endif - /* Can't open the same device more than once so we */ - /* need more logic to look for the case of both radio */ - /* channels using different pins of the same COM port. */ - - /* TODO: Needs to be rewritten in a more general manner */ - /* if we ever have more than 2 channels. */ - - if (ch == 1 && strcmp(ptt_device[0],ptt_device[1]) == 0) { - fd = ptt_fd[0]; - } - else { -#if __WIN32__ - char bettername[50]; - // Bug fix in release 1.1 - Need to munge name for COM10 and up. - // http://support.microsoft.com/kb/115831 - - strcpy (bettername, ptt_device[ch]); - if (strncasecmp(bettername, "COM", 3) == 0) { - int n; - n = atoi(bettername+3); - if (n >= 10) { - strcpy (bettername, "\\\\.\\"); - strcat (bettername, ptt_device[ch]); - } - } - fd = CreateFile(bettername, - GENERIC_READ, 0, 0, OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, 0); -#else - - /* O_NONBLOCK added in version 0.9. */ - /* https://bugs.launchpad.net/ubuntu/+source/linux/+bug/661321/comments/12 */ - - fd = open (ptt_device[ch], O_RDONLY | O_NONBLOCK); -#endif - } - - if (fd != INVALID_HANDLE_VALUE) { - ptt_fd[ch] = fd; - } - else { -#if __WIN32__ -#else - int e = errno; -#endif - text_color_set(DW_COLOR_ERROR); - dw_printf ("ERROR can't open device %s for channel %d PTT control.\n", - ptt_device[ch], ch); -#if __WIN32__ -#else - dw_printf ("%s\n", strerror(errno)); -#endif - /* Don't try using it later if device open failed. */ - - ptt_method[ch] = PTT_METHOD_NONE; - } - -/* - * Set initial state of PTT off. - * ptt_set will invert output signal if appropriate. - */ - ptt_set (ch, 0); - - } /* if serial method. */ - - } /* For each channel. */ - - -/* - * Set up GPIO - for Linux only. - */ - -#if __WIN32__ -#else - -/* - * Does any channel use GPIO? - */ - - using_gpio = 0; - for (ch=0; ch ../../devices/virtual/gpio/gpiochip0 - * --w------- 1 root root 4096 Aug 20 07:59 unexport - */ - if (geteuid() != 0) { - if ( ! (finfo.st_mode & S_IWOTH)) { - int err; - - /* Try to change protection. */ - err = system ("sudo chmod go+w /sys/class/gpio/export /sys/class/gpio/unexport"); - - if (stat("/sys/class/gpio/export", &finfo) < 0) { - /* Unexpected because we could do it before. */ - text_color_set(DW_COLOR_ERROR); - dw_printf ("This system is not configured with the GPIO user interface.\n"); - dw_printf ("Use a different method for PTT control.\n"); - exit (1); - } - - /* Did we succeed in changing the protection? */ - if ( ! (finfo.st_mode & S_IWOTH)) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Permissions do not allow ordinary users to access GPIO.\n"); - dw_printf ("Log in as root and type this command:\n"); - dw_printf (" chmod go+w /sys/class/gpio/export /sys/class/gpio/unexport\n"); - exit (1); - } - } - } - } -/* - * We should now be able to create the device nodes for - * the pins we want to use. - */ - - for (ch=0; ch= 0 && chan < MAX_CHANS); - -/* - * Using serial port? - */ - if (ptt_method[chan] == PTT_METHOD_SERIAL && - ptt_fd[chan] != INVALID_HANDLE_VALUE) { - - if (ptt_line[chan] == PTT_LINE_RTS) { - - if (ptt) { - RTS_ON(ptt_fd[chan]); - } - else { - RTS_OFF(ptt_fd[chan]); - } - } - else if (ptt_line[chan] == PTT_LINE_DTR) { - - if (ptt) { - DTR_ON(ptt_fd[chan]); - } - else { - DTR_OFF(ptt_fd[chan]); - } - } - } - -/* - * Using GPIO? - */ - -#if __WIN32__ -#else - - if (ptt_method[chan] == PTT_METHOD_GPIO) { - int fd; - char stemp[80]; - - sprintf (stemp, "/sys/class/gpio/gpio%d/value", ptt_gpio[chan]); - - fd = open(stemp, O_WRONLY); - if (fd < 0) { - int e = errno; - text_color_set(DW_COLOR_ERROR); - dw_printf ("Error opening %s to set PTT signal.\n", stemp); - dw_printf ("%s\n", strerror(e)); - return; - } - - sprintf (stemp, "%d", ptt); - - if (write (fd, stemp, 1) != 1) { - int e = errno; - text_color_set(DW_COLOR_ERROR); - dw_printf ("Error setting GPIO %d for PTT\n", ptt_gpio[chan]); - dw_printf ("%s\n", strerror(e)); - } - close (fd); - - } -#endif - -/* - * Using parallel printer port? - */ - -#if ( defined(__i386__) || defined(__x86_64__) ) && ( defined(__linux__) || defined(__unix__) ) - - if (ptt_method[chan] == PTT_METHOD_LPT && - ptt_fd[chan] != INVALID_HANDLE_VALUE) { - - char lpt_data; - ssize_t n; - - lseek (ptt_fd[chan], (off_t)LPT_IO_ADDR, SEEK_SET); - if (read (ptt_fd[chan], &lpt_data, (size_t)1) != 1) { - int e = errno; - text_color_set(DW_COLOR_ERROR); - dw_printf ("Error reading current state of LPT for channel %d PTT\n", chan); - dw_printf ("%s\n", strerror(e)); - } - - if (ptt) { - lpt_data |= ( 1 << ptt_lpt_bit[chan] ); - } - else { - lpt_data &= ~ ( 1 << ptt_lpt_bit[chan] ); - } - - lseek (ptt_fd[chan], (off_t)LPT_IO_ADDR, SEEK_SET); - if (write (ptt_fd[chan], &lpt_data, (size_t)1) != 1) { - int e = errno; - text_color_set(DW_COLOR_ERROR); - dw_printf ("Error writing to LPT for channel %d PTT\n", chan); - dw_printf ("%s\n", strerror(e)); - } - } - -#endif /* x86 Linux */ - - -} /* end ptt_set */ - - - -/*------------------------------------------------------------------- - * - * Name: ptt_term - * - * Purpose: Make sure PTT is turned off when we exit. - * - * Inputs: none - * - * Description: - * - *--------------------------------------------------------------------*/ - -void ptt_term (void) -{ - int n; - - for (n = 0; n < ptt_num_channels; n++) { - ptt_set (n, 0); - } - - for (n = 0; n < ptt_num_channels; n++) { - if (ptt_fd[n] != INVALID_HANDLE_VALUE) { -#if __WIN32__ - CloseHandle (ptt_fd[n]); -#else - close(ptt_fd[n]); -#endif - ptt_fd[n] = INVALID_HANDLE_VALUE; - } - } -} - - - - -/* - * Quick stand-alone test for above. - * - * gcc -DTEST -o ptest ptt.c ; ./ptest - * - */ - - -#if TEST - -void text_color_set (dw_color_t c) { } - -#define dw_printf printf - -main () -{ - struct audio_s modem; - int n; - int chan; - - memset (&modem, 0, sizeof(modem)); - - modem.num_channels = 2; - - modem.ptt_method[0] = PTT_METHOD_SERIAL; - //strcpy (modem.ptt_device[0], "COM1"); - strcpy (modem.ptt_device[0], "/dev/ttyUSB0"); - modem.ptt_line[0] = PTT_LINE_RTS; - - modem.ptt_method[1] = PTT_METHOD_SERIAL; - //strcpy (modem.ptt_device[1], "COM1"); - strcpy (modem.ptt_device[1], "/dev/ttyUSB0"); - modem.ptt_line[1] = PTT_LINE_DTR; - - -/* initialize - both off */ - - ptt_init (&modem); - - SLEEP_SEC(2); - -/* flash each a few times. */ - - dw_printf ("turn on RTS a few times...\n"); - - chan = 0; - for (n=0; n<3; n++) { - ptt_set (chan, 1); - SLEEP_SEC(1); - ptt_set (chan, 0); - SLEEP_SEC(1); - } - - dw_printf ("turn on DTR a few times...\n"); - - chan = 1; - for (n=0; n<3; n++) { - ptt_set (chan, 1); - SLEEP_SEC(1); - ptt_set (chan, 0); - SLEEP_SEC(1); - } - - ptt_term(); - -/* Same thing again but invert RTS. */ - - modem.ptt_invert[0] = 1; - - ptt_init (&modem); - - SLEEP_SEC(2); - - dw_printf ("INVERTED - RTS a few times...\n"); - - chan = 0; - for (n=0; n<3; n++) { - ptt_set (chan, 1); - SLEEP_SEC(1); - ptt_set (chan, 0); - SLEEP_SEC(1); - } - - dw_printf ("turn on DTR a few times...\n"); - - chan = 1; - for (n=0; n<3; n++) { - ptt_set (chan, 1); - SLEEP_SEC(1); - ptt_set (chan, 0); - SLEEP_SEC(1); - } - - ptt_term (); - - -/* Test GPIO */ - -#if __arm__ - - memset (&modem, 0, sizeof(modem)); - modem.num_channels = 1; - modem.ptt_method[0] = PTT_METHOD_GPIO; - modem.ptt_gpio[0] = 25; - - dw_printf ("Try GPIO %d a few times...\n", modem.ptt_gpio[0]); - - ptt_init (&modem); - - SLEEP_SEC(2); - chan = 0; - for (n=0; n<3; n++) { - ptt_set (chan, 1); - SLEEP_SEC(1); - ptt_set (chan, 0); - SLEEP_SEC(1); - } - - ptt_term (); -#endif - - - memset (&modem, 0, sizeof(modem)); - modem.num_channels = 2; - modem.ptt_method[0] = PTT_METHOD_LPT; - modem.ptt_lpt_bit[0] = 0; - modem.ptt_method[1] = PTT_METHOD_LPT; - modem.ptt_lpt_bit[1] = 1; - - dw_printf ("Try LPT bits 0 & 1 a few times...\n"); - - ptt_init (&modem); - - for (n=0; n<8; n++) { - ptt_set (0, n & 1); - ptt_set (1, (n>>1) & 1); - SLEEP_SEC(1); - } - - ptt_term (); - -/* Parallel printer port. */ - -#if ( defined(__i386__) || defined(__x86_64__) ) && ( defined(__linux__) || defined(__unix__) ) - - - -#endif - - -} - -#endif - -/* end ptt.c */ - - - diff --git a/ptt.h b/ptt.h deleted file mode 100644 index 014b8c0d..00000000 --- a/ptt.h +++ /dev/null @@ -1,23 +0,0 @@ - - -#ifndef PTT_H -#define PTT_H 1 - - -#include "audio.h" /* for struct audio_s */ - - -void ptt_init (struct audio_s *p_modem); - -void ptt_set (int chan, int ptt); - -void ptt_term (void); - - -#endif - - -/* end ptt.h */ - - - diff --git a/pttest.c b/pttest.c deleted file mode 100644 index 82c7a81e..00000000 --- a/pttest.c +++ /dev/null @@ -1,287 +0,0 @@ - - -/*------------------------------------------------------------------ - * - * Module: pttest.c - * - * Purpose: Test for pseudo terminal. - * - * Input: - * - * Outputs: - * - * Description: The protocol name is an acronym for Keep it Simple Stupid. - * You would expect it to be simple but this caused a lot - * of effort on Linux. The problem is that writes to a pseudo - * terminal eventually block if nothing at the other end - * is removing the data. This causes the application to - * hang and stop receiving after a while. - * - * This is an attempt to demonstrate the problem in a small - * test case and, hopefully, find a solution. - * - * - * Instructions: - * First compile like this: - * - * - * Run it, noting the name of pseudo terminal, - * typically /dev/pts/1. - * - * In another window, type: - * - * cat /dev/pts/1 - * - * This should run "forever" as long as something is - * reading from the slave side of the pseudo terminal. - * - * If nothing is removing the data, this runs for a while - * and then blocks on the write. - * For this particular application we just want to discard - * excess data if no one is listening. - * - * - * Failed experiments: - * - * Notice that ??? always returns 0 for amount of data - * in the queue. - * Define TEST1 to make the device non-blocking. - * Write fails entirely. - * - * Define TEST2 to use a different method. - * Also fails in the same way. - * - * - *---------------------------------------------------------------*/ - -#include -#include - - -#define __USE_XOPEN2KXSI 1 -#define __USE_XOPEN 1 -//#define __USE_POSIX 1 -#include - -#include -#include -#include -#include -#include -#include - -#include -#include - -//#include "direwolf.h" -//#include "tq.h" -//#include "ax25_pad.h" -//#include "textcolor.h" -//#include "kiss.h" -//#include "xmit.h" - - - -static MYFDTYPE pt_master_fd = -1; /* File descriptor for my end. */ - -static MYFDTYPE pt_slave_fd = -1; /* File descriptor for pseudo terminal */ - /* for use by application. */ -static int msg_number; -static int total_bytes; - - -/*------------------------------------------------------------------- - * - * Name: kiss_init - * - * Purpose: Set up a pseudo terminal acting as a virtual KISS TNC. - * - * - * Inputs: mc->nullmodem - name of device for our end of nullmodem. - * - * Outputs: - * - * Description: (1) Create a pseudo terminal for the client to use. - * (2) Start a new thread to listen for commands from client app - * so the main application doesn't block while we wait. - * - * - *--------------------------------------------------------------------*/ - -static int kiss_open_pt (void); - - -main (int argc, char *argv) -{ - - pt_master_fd = kiss_open_pt (); - printf ("msg total qcount\n"); - - msg_number = 0; - total_bytes = 0; - -#endif -} - - -/* - * Returns fd for master side of pseudo terminal or MYFDERROR for error. - */ - - -static int kiss_open_pt (void) -{ - int fd; - char *slave_device; - struct termios ts; - int e; - int flags; - - fd = posix_openpt(O_RDWR|O_NOCTTY); - - if (fd == -1 - || grantpt (fd) == -1 - || unlockpt (fd) == -1 - || (slave_device = ptsname (fd)) == NULL) { - text_color_set(DW_COLOR_ERROR); - printf ("ERROR - Could not create pseudo terminal.\n"); - return (-1); - } - - - e = tcgetattr (fd, &ts); - if (e != 0) { - printf ("Can't get pseudo terminal attributes, err=%d\n", e); - perror ("pt tcgetattr"); - } - - cfmakeraw (&ts); - - ts.c_cc[VMIN] = 1; /* wait for at least one character */ - ts.c_cc[VTIME] = 0; /* no fancy timing. */ - - - e = tcsetattr (fd, TCSANOW, &ts); - if (e != 0) { - text_color_set(DW_COLOR_ERROR); - printf ("Can't set pseudo terminal attributes, err=%d\n", e); - perror ("pt tcsetattr"); - } - -/* - * After running for a while on Linux, the write eventually - * blocks if no one is reading from the other side of - * the pseudo terminal. We get stuck on the kiss data - * write and reception stops. - * - * I tried using ioctl(,TIOCOUTQ,) to see how much was in - * the queue but that always returned zero. (Ubuntu) - * - * Let's try using non-blocking writes and see if we get - * the EWOULDBLOCK status instead of hanging. - */ - -#if TEST1 - // this is worse. all writes fail. errno = ? bad file descriptor - flags = fcntl(fd, F_GETFL, 0); - e = fcntl (fd, F_SETFL, flags | O_NONBLOCK); - if (e != 0) { - printf ("Can't set pseudo terminal to nonblocking, fcntl returns %d, errno = %d\n", e, errno); - perror ("pt fcntl"); - } -#endif -#if TEST2 - // same - flags = 1; - e = ioctl (fd, FIONBIO, &flags); - if (e != 0) { - printf ("Can't set pseudo terminal to nonblocking, ioctl returns %d, errno = %d\n", e, errno); - perror ("pt ioctl"); - } -#endif - - printf("Virtual KISS TNC is available on %s\n", slave_device); - - - // Sample code shows this. Why would we open it here? - - // pt_slave_fd = open(slave_device, O_RDWR|O_NOCTTY); - - - return (fd); -} - - - -/*------------------------------------------------------------------- - * - * Name: kiss_send_rec_packet - * - * Purpose: Send a received packet to the client app. - * - * Inputs: chan - Channel number where packet was received. - * 0 = first, 1 = second if any. - * - * pp - Identifier for packet object. - * - * fbuf - Address of raw received frame buffer. - * flen - Length of raw received frame. - * Not including the FCS. - * - * - * Description: Send message to client. - * We really don't care if anyone is listening or not. - * I don't even know if we can find out. - * - * - *--------------------------------------------------------------------*/ - - -void kiss_send_rec_packet (void) -{ - - - char kiss_buff[100]; - - int kiss_len; - int q_count = 123; - - - int j; - - strcpy (kiss_buff, "The quick brown fox jumps over the lazy dog.\n"); - kiss_len = strlen(kiss_buff); - - - if (pt_master_fd != MYFDERROR) { - int err; - - msg_number++; - total_bytes += kiss_len; - -//#if DEBUG - printf ("%3d %5d %5d\n", msg_number, total_bytes, q_count); -//#endif - err = write (pt_master_fd, kiss_buff, kiss_len); - - if (err == -1 && errno == EWOULDBLOCK) { -//#if DEBUG - printf ("Discarding message because write would block.\n"); -//#endif - } - else if (err != kiss_len) - { - printf ("\nError sending message on pseudo terminal. len=%d, write returned %d, errno = %d\n\n", - kiss_len, err, errno); - perror ("pt write"); - } - - } -//#endif - - - -} - - -/* end pttest.c */ diff --git a/rdq.c b/rdq.c deleted file mode 100644 index 3126291d..00000000 --- a/rdq.c +++ /dev/null @@ -1,461 +0,0 @@ -// -// This file is part of Dire Wolf, an amateur radio packet TNC. -// -// Copyright (C) 2011,2012 John Langner, WB2OSZ -// -// This program 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 2 of the License, or -// (at your option) any later version. -// -// This program 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 this program. If not, see . -// - - - -/*------------------------------------------------------------------ - * - * Module: rdq.c - * - * Purpose: Retry later decode queue for frames with bad FCS. - * - * Description: - * - *---------------------------------------------------------------*/ - -#include -#include -#include -#include -#include - -#include "direwolf.h" -#include "ax25_pad.h" -#include "textcolor.h" -#include "audio.h" -#include "rdq.h" -#include "dedupe.h" - - - -static rrbb_t queue_head = NULL; /* Head of linked list for queue. */ -static int rdq_len = 0; -#define RDQ_UNDERRUN_THRESHOLD 30 /* A warning will be emitted if there are still this number of packets to decode in the queue and we try to add another one */ -#if __WIN32__ - -static CRITICAL_SECTION rdq_cs; /* Critical section for updating queues. */ - -static HANDLE wake_up_event; /* Notify try decode again thread when queue not empty. */ - -#else - -static pthread_mutex_t rdq_mutex; /* Critical section for updating queues. */ - -static pthread_cond_t wake_up_cond; /* Notify try decode again thread when queue not empty. */ - -static pthread_mutex_t wake_up_mutex; /* Required by cond_wait. */ - -#endif - - -/*------------------------------------------------------------------- - * - * Name: rdq_init - * - * Purpose: Initialize the receive decode again queue. - * - * Inputs: None. Only single queue for all channels. - * - * Outputs: - * - * Description: Initialize the queue to be empty and set up other - * mechanisms for sharing it between different threads. - * - *--------------------------------------------------------------------*/ - - -void rdq_init (void) -{ - //int c, p; -#if __WIN32__ -#else - int err; -#endif - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("rdq_init ( )\n"); - dw_printf ("rdq_init: pthread_mutex_init...\n"); -#endif - -#if __WIN32__ - InitializeCriticalSection (&rdq_cs); -#else - err = pthread_mutex_init (&wake_up_mutex, NULL); - err = pthread_mutex_init (&rdq_mutex, NULL); - if (err != 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("rdq_init: pthread_mutex_init err=%d", err); - perror (""); - exit (1); - } -#endif - - - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("rdq_init: pthread_cond_init...\n"); -#endif - -#if __WIN32__ - - wake_up_event = CreateEvent (NULL, 0, 0, NULL); - - if (wake_up_event == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("rdq_init: pthread_cond_init: can't create decode wake up event"); - exit (1); - } - -#else - err = pthread_cond_init (&wake_up_cond, NULL); - - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("rdq_init: pthread_cond_init returns %d\n", err); -#endif - - - if (err != 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("rdq_init: pthread_cond_init err=%d", err); - perror (""); - exit (1); - } -#endif - - -} /* end rdq_init */ - - -/*------------------------------------------------------------------- - * - * Name: rdq_append - * - * Purpose: Add a packet to the end of the queue. - * - * Inputs: pp - Address of raw received bit buffer. - * Caller should NOT make any references to - * it after this point because it could - * be deleted at any time. - * - * Outputs: - * - * Description: Add buffer to end of linked list. - * Signal the decode thread if the queue was formerly empty. - * - *--------------------------------------------------------------------*/ - -void rdq_append (rrbb_t rrbb) -{ - //int was_empty; - rrbb_t plast; - rrbb_t pnext; -#ifndef __WIN32__ - int err; -#endif - - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("rdq_append (rrbb=%p)\n", rrbb); - dw_printf ("rdq_append: enter critical section\n"); -#endif -#if __WIN32__ - EnterCriticalSection (&rdq_cs); -#else - err = pthread_mutex_lock (&rdq_mutex); - if (err != 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("rdq_append: pthread_mutex_lock err=%d", err); - perror (""); - exit (1); - } -#endif - - //was_empty = 1; - //if (queue_head != NULL) { - //was_empty = 0; - //} - if (queue_head == NULL) { - queue_head = rrbb; - } - else { - plast = queue_head; - while ((pnext = rrbb_get_nextp(plast)) != NULL) { - plast = pnext; - } - rrbb_set_nextp (plast, rrbb); - } - rdq_len++; - if (rdq_len > RDQ_UNDERRUN_THRESHOLD) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Too many packets to decode (%d) in the queue, decrease the FIX_BITS value\n", rdq_len); - } - -#if __WIN32__ - LeaveCriticalSection (&rdq_cs); -#else - err = pthread_mutex_unlock (&rdq_mutex); - if (err != 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("rdq_append: pthread_mutex_unlock err=%d", err); - perror (""); - exit (1); - } -#endif -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("rdq_append: left critical section\n"); - dw_printf ("rdq_append (): about to wake up retry decode thread.\n"); -#endif - -#if __WIN32__ - SetEvent (wake_up_event); -#else - err = pthread_mutex_lock (&wake_up_mutex); - if (err != 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("rdq_append: pthread_mutex_lock wu err=%d", err); - perror (""); - exit (1); - } - - err = pthread_cond_signal (&wake_up_cond); - if (err != 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("rdq_append: pthread_cond_signal err=%d", err); - perror (""); - exit (1); - } - - err = pthread_mutex_unlock (&wake_up_mutex); - if (err != 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("rdq_append: pthread_mutex_unlock wu err=%d", err); - perror (""); - exit (1); - } -#endif - -} - - -/*------------------------------------------------------------------- - * - * Name: rdq_wait_while_empty - * - * Purpose: Sleep while the queue is empty rather than - * polling periodically. - * - * Inputs: None. - * - *--------------------------------------------------------------------*/ - - -void rdq_wait_while_empty (void) -{ - int is_empty; -#ifndef __WIN32__ - int err; -#endif - - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("rdq_wait_while_empty () : enter critical section\n"); -#endif - -#if __WIN32__ - EnterCriticalSection (&rdq_cs); -#else - err = pthread_mutex_lock (&rdq_mutex); - if (err != 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("rdq_wait_while_empty: pthread_mutex_lock err=%d", err); - perror (""); - exit (1); - } -#endif - -#if DEBUG - //text_color_set(DW_COLOR_DEBUG); - //dw_printf ("rdq_wait_while_empty (): after pthread_mutex_lock\n"); -#endif - is_empty = 1; - if (queue_head != NULL) - is_empty = 0; - - -#if __WIN32__ - LeaveCriticalSection (&rdq_cs); -#else - err = pthread_mutex_unlock (&rdq_mutex); - if (err != 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("rdq_wait_while_empty: pthread_mutex_unlock err=%d", err); - perror (""); - exit (1); - } -#endif -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("rdq_wait_while_empty () : left critical section\n"); -#endif - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("rdq_wait_while_empty (): is_empty = %d\n", is_empty); -#endif - - if (is_empty) { -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("rdq_wait_while_empty (): SLEEP - about to call cond wait\n"); -#endif - - -#if __WIN32__ - WaitForSingleObject (wake_up_event, INFINITE); - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("rdq_wait_while_empty (): returned from wait\n"); -#endif - -#else - err = pthread_mutex_lock (&wake_up_mutex); - if (err != 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("rdq_wait_while_empty: pthread_mutex_lock wu err=%d", err); - perror (""); - exit (1); - } - - err = pthread_cond_wait (&wake_up_cond, &wake_up_mutex); - - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("rdq_wait_while_empty (): WOKE UP - returned from cond wait, err = %d\n", err); -#endif - - if (err != 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("rdq_wait_while_empty: pthread_cond_wait err=%d", err); - perror (""); - exit (1); - } - - err = pthread_mutex_unlock (&wake_up_mutex); - if (err != 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("rdq_wait_while_empty: pthread_mutex_unlock wu err=%d", err); - perror (""); - exit (1); - } - -#endif - } - - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("rdq_wait_while_empty () returns (%d buffers remaining)\n", rdq_len); -#endif - -} - - -/*------------------------------------------------------------------- - * - * Name: rdq_remove - * - * Purpose: Remove raw bit buffer from the head of the queue. - * - * Inputs: none - * - * Returns: Pointer to rrbb object. - * Caller should destroy it with rrbb_delete when finished with it. - * - *--------------------------------------------------------------------*/ - -rrbb_t rdq_remove (void) -{ - - rrbb_t result_p; -#ifndef __WIN32__ - int err; -#endif - - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("rdq_remove() enter critical section\n"); -#endif - -#if __WIN32__ - EnterCriticalSection (&rdq_cs); -#else - err = pthread_mutex_lock (&rdq_mutex); - if (err != 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("rdq_remove: pthread_mutex_lock err=%d", err); - perror (""); - exit (1); - } -#endif - rdq_len--; -#if DEBUG - dw_printf ("-rdq_len: %d\n", rdq_len); -#endif - if (queue_head == NULL) { - result_p = NULL; - } - else { - - result_p = queue_head; - queue_head = rrbb_get_nextp(result_p); - rrbb_set_nextp (result_p, NULL); - } - -#if __WIN32__ - LeaveCriticalSection (&rdq_cs); -#else - err = pthread_mutex_unlock (&rdq_mutex); - if (err != 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("rdq_remove: pthread_mutex_unlock err=%d", err); - perror (""); - exit (1); - } -#endif - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("rdq_remove() leave critical section, returns %p\n", result_p); -#endif - return (result_p); -} - - - -/* end rdq.c */ diff --git a/rdq.h b/rdq.h deleted file mode 100644 index b0e430c0..00000000 --- a/rdq.h +++ /dev/null @@ -1,28 +0,0 @@ - -/*------------------------------------------------------------------ - * - * Module: rdq.h - * - * Purpose: Retry decode queue - Hold raw received frames with errors - * for retrying the decoding later. - * - *---------------------------------------------------------------*/ - -#ifndef RDQ_H -#define RDQ_H 1 - -#include "rrbb.h" -//#include "audio.h" - -void rdq_init (void); - -void rdq_append (rrbb_t rrbb); - -void rdq_wait_while_empty (void); - -rrbb_t rdq_remove (void); - - -#endif - -/* end rdq.h */ diff --git a/redecode.c b/redecode.c deleted file mode 100644 index 1db45a8c..00000000 --- a/redecode.c +++ /dev/null @@ -1,252 +0,0 @@ -// -// This file is part of Dire Wolf, an amateur radio packet TNC. -// -// Copyright (C) 2011,2012,2013 John Langner, WB2OSZ -// -// This program 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 2 of the License, or -// (at your option) any later version. -// -// This program 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 this program. If not, see . -// - - - -/*------------------------------------------------------------------ - * - * Module: redecode.c - * - * Purpose: Retry decoding frames that have a bad FCS. - * - * Description: - * - * - * Usage: (1) The main application calls redecode_init. - * - * This will initialize the retry decoding queue - * and create a thread to work on contents of the queue. - * - * (2) The application queues up frames by calling rdq_append. - * - * - * (3) redecode_thread removes raw frames from the queue and - * tries to recover from errors. - * - *---------------------------------------------------------------*/ - -#include -#include -#include -#include -#include - -//#include -#include - -#if __WIN32__ -#include -#endif - -#include "direwolf.h" -#include "ax25_pad.h" -#include "textcolor.h" -#include "audio.h" -#include "rdq.h" -#include "redecode.h" -#include "hdlc_send.h" -#include "hdlc_rec2.h" -#include "ptt.h" - - - - - - -#if __WIN32__ -static unsigned redecode_thread (void *arg); -#else -static void * redecode_thread (void *arg); -#endif - - -/*------------------------------------------------------------------- - * - * Name: redecode_init - * - * Purpose: Initialize the process to try fixing bits in frames with bad FCS. - * - * Inputs: none. - * - * Outputs: none. - * - * Description: Initialize the queue to be empty and set up other - * mechanisms for sharing it between different threads. - * - * Start up redecode_thread to actually process the - * raw frames from the queue. - * - *--------------------------------------------------------------------*/ - - - -void redecode_init (void) -{ - //int j; -#if __WIN32__ - HANDLE redecode_th; -#else - pthread_t redecode_tid; - int e; -#endif - - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("redecode_init ( ... )\n"); -#endif - - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("redecode_init: about to call rdq_init \n"); -#endif - rdq_init (); - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("redecode_init: about to create thread \n"); -#endif - - -#if __WIN32__ - redecode_th = _beginthreadex (NULL, 0, redecode_thread, NULL, 0, NULL); - if (redecode_th == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Could not create redecode thread\n"); - return; - } -#else - -//TODO: Give thread lower priority. - - e = pthread_create (&redecode_tid, NULL, redecode_thread, (void *)0); - if (e != 0) { - text_color_set(DW_COLOR_ERROR); - perror("Could not create redecode thread"); - return; - } -#endif - - - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("redecode_init: finished \n"); -#endif - - -} /* end redecode_init */ - - - - - -/*------------------------------------------------------------------- - * - * Name: redecode_thread - * - * Purpose: Try to decode frames with a bad FCS. - * - * Inputs: None. - * - * Outputs: - * - * Description: Initialize the queue to be empty and set up other - * mechanisms for sharing it between different threads. - * - * - *--------------------------------------------------------------------*/ - -#if __WIN32__ -static unsigned redecode_thread (void *arg) -#else -static void * redecode_thread (void *arg) -#endif -{ - rrbb_t block; - int blen; - int chan, subchan; - int alevel; - - -#if __WIN32__ - HANDLE tid = GetCurrentThread(); - //int tp; - - //tp = GetThreadPriority (tid); - //text_color_set(DW_COLOR_DEBUG); - //dw_printf ("Starting redecode thread priority=%d\n", tp); - SetThreadPriority (tid, THREAD_PRIORITY_LOWEST); - //tp = GetThreadPriority (tid); - //dw_printf ("New redecode thread priority=%d\n", tp); -#endif - - while (1) { - - rdq_wait_while_empty (); -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("redecode_thread: woke up\n"); -#endif - - block = rdq_remove (); - - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("redecode_thread: rdq_remove() returned %p\n", block); -#endif - -/* Don't expect null ever but be safe. */ - - if (block != NULL) { - - chan = rrbb_get_chan(block); - subchan = rrbb_get_subchan(block); - alevel = rrbb_get_audio_level(block); - blen = rrbb_get_len(block); -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("redecode_thread: begin processing %p, from channel %d, blen=%d\n", block, chan, blen); -#endif - - hdlc_rec2_try_to_fix_later (block, chan, subchan, alevel); - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("redecode_thread: finished processing %p\n", block); -#endif - rrbb_delete (block); - } - - } - - return 0; - -} /* end redecode_thread */ - - - - - -/* end redecode.c */ - - - diff --git a/rpm/direwolf.spec b/rpm/direwolf.spec new file mode 100644 index 00000000..d37bf5c1 --- /dev/null +++ b/rpm/direwolf.spec @@ -0,0 +1,175 @@ +%global shorttag 0d2c175c +Name: direwolf +Version: 1.6 +Release: 0.4.20200419git%{shorttag}%{?dist} +Summary: Sound Card-based AX.25 TNC + +License: GPLv2+ +URL: https://github.com/wb2osz/direwolf/ +Source0: https://github.com/wb2osz/direwolf/archive/%{version}/%{name}-%{version}.tar.gz +#Source0: https://github.com/wb2osz/direwolf/archive/%{version}/%{name}-%{shorttag}.tar.gz + +BuildRequires: gcc gcc-c++ +BuildRequires: cmake +BuildRequires: glibc-devel +BuildRequires: alsa-lib-devel +BuildRequires: gpsd-devel +BuildRequires: hamlib-devel +BuildRequires: systemd systemd-devel +Requires: ax25-tools ax25-apps +Requires(pre): shadow-utils + + +%description +Dire Wolf is a modern software replacement for the old 1980's style +TNC built with special hardware. Without any additional software, it +can perform as an APRS GPS Tracker, Digipeater, Internet Gateway +(IGate), APRStt gateway. It can also be used as a virtual TNC for +other applications such as APRSIS32, UI-View32, Xastir, APRS-TW, YAAC, +UISS, Linux AX25, SARTrack, Winlink Express, BPQ32, Outpost PM, and many +others. + + +%prep +%autosetup -n %{name}-%{version} + + +%build +%cmake -DUNITTEST=1 -DENABLE_GENERIC=1 . + + +%check +ctest -V %{?_smp_mflags} + + +%install +%make_install + +# Install service file +mkdir -p ${RPM_BUILD_ROOT}%{_unitdir} +cp %{_builddir}/%{buildsubdir}/systemd/%{name}.service ${RPM_BUILD_ROOT}%{_unitdir}/%{name}.service + +# Install service config file +mkdir -p ${RPM_BUILD_ROOT}%{_sysconfdir}/sysconfig +cp %{_builddir}/%{buildsubdir}/systemd/%{name}.sysconfig ${RPM_BUILD_ROOT}%{_sysconfdir}/sysconfig/%{name} + +# Install logrotate config file +mkdir -p ${RPM_BUILD_ROOT}%{_sysconfdir}/logrotate.d +cp %{_builddir}/%{buildsubdir}/systemd/%{name}.logrotate ${RPM_BUILD_ROOT}%{_sysconfdir}/logrotate.d/%{name} + +# copy config file +cp ${RPM_BUILD_ROOT}%{_pkgdocdir}/conf/%{name}.conf ${RPM_BUILD_ROOT}/%{_sysconfdir}/%{name}.conf + +# Make log directory +mkdir -m 0755 -p ${RPM_BUILD_ROOT}/var/log/%{name} + +# Move udev rules to system dir +mkdir -p ${RPM_BUILD_ROOT}%{_udevrulesdir} +mv ${RPM_BUILD_ROOT}%{_sysconfdir}/udev/rules.d/99-direwolf-cmedia.rules ${RPM_BUILD_ROOT}%{_udevrulesdir}/99-direwolf-cmedia.rules + +# Copy doc pngs +cp direwolf-block-diagram.png ${RPM_BUILD_ROOT}%{_pkgdocdir}/direwolf-block-diagram.png +cp tnc-test-cd-results.png ${RPM_BUILD_ROOT}%{_pkgdocdir}/tnc-test-cd-results.png + +# remove extraneous files +# This is not a desktop application, per the guidelines. Running it in a terminal +# does not make it a desktop application. +rm ${RPM_BUILD_ROOT}/usr/share/applications/direwolf.desktop +rm ${RPM_BUILD_ROOT}%{_datadir}/pixmaps/direwolf_icon.png +rm ${RPM_BUILD_ROOT}%{_pkgdocdir}/CHANGES.md +rm ${RPM_BUILD_ROOT}%{_pkgdocdir}/LICENSE +rm ${RPM_BUILD_ROOT}%{_pkgdocdir}/README.md + +# remove Windows external library directories +rm -r ${RPM_BUILD_ROOT}%{_pkgdocdir}/external + +# Move Telemetry Toolkit sample scripts into docs +mkdir -p ${RPM_BUILD_ROOT}%{_pkgdocdir}/telem/ +mv ${RPM_BUILD_ROOT}%{_bindir}/telem* ${RPM_BUILD_ROOT}%{_pkgdocdir}/telem/ +chmod 0644 ${RPM_BUILD_ROOT}%{_pkgdocdir}/telem/* + + +%package -n %{name}-doc +Summary: Documentation for Dire Wolf +BuildArch: noarch +Requires: %{name} = %{version}-%{release} + +%description -n %{name}-doc +Dire Wolf is a modern software replacement for the old 1980's style +TNC built with special hardware. Without any additional software, it +can perform as an APRS GPS Tracker, Digipeater, Internet Gateway +(IGate), APRStt gateway. It can also be used as a virtual TNC for +other applications such as APRSIS32, UI-View32, Xastir, APRS-TW, YAAC, +UISS, Linux AX25, SARTrack, RMS Express, BPQ32, Outpost PM, and many +others. + + +%files +%license LICENSE +%{_udevrulesdir}/99-direwolf-cmedia.rules +%{_bindir}/* +%{_mandir}/man1/* +%{_datadir}/%{name}/* +%dir %{_pkgdocdir} +%{_pkgdocdir}/conf/* +%{_pkgdocdir}/scripts/* +%{_pkgdocdir}/telem/* +%{_unitdir}/%{name}.service +%config(noreplace) %attr(0644,root,root) %{_sysconfdir}/sysconfig/%{name} +%config(noreplace) %attr(0644,root,root) %{_sysconfdir}/%{name}.conf +%config(noreplace) %attr(0644,root,root) %{_sysconfdir}/logrotate.d/%{name} +%dir %attr(0755, %{name}, %{name}) /var/log/%{name} + +%files -n %{name}-doc +%{_pkgdocdir}/*.pdf +%{_pkgdocdir}/*.png + +# At install, create a user in group audio (so can open sound card device files) +# and in group dialout (so can open serial device files) +%pre +getent group direwolf >/dev/null || groupadd -r direwolf +getent passwd direwolf >/dev/null || \ + useradd -r -g audio -G audio,dialout -d %{_datadir}/%{name} -s /sbin/nologin \ + -c "Direwolf Sound Card-based AX.25 TNC" direwolf +exit 0 + + +%changelog +* Mon Apr 20 2020 Matt Domsch - 1.6-0.3 +- drop unneeded BR libax25-devel + +* Mon Apr 20 2020 Matt Domsch - 1.6-0.2 +- write stdout/err to /var/log/direwolf, logrotate 30 days. +- run ctest +- remove CPU instruction tests, leave architecture choice up to the distro + +* Sun Apr 19 2020 Matt Domsch - 1.6-0.1 +- upstream 1.6 prerelease +- drop obsolete patches, use cmake +- add systemd startup, direwolf user + +* Tue Mar 31 2020 Richard Shaw - 1.5-6 +- Rebuild for hamlib 4. + +* Thu Feb 20 2020 Matt Domsch - 1.5-5 +- Remove unneeded dependency on python2-devel (#1805225) + +* Tue Jan 28 2020 Fedora Release Engineering - 1.5-4 +- Rebuilt for https://fedoraproject.org/wiki/Fedora_32_Mass_Rebuild + +* Wed Jul 24 2019 Fedora Release Engineering - 1.5-3 +- Rebuilt for https://fedoraproject.org/wiki/Fedora_31_Mass_Rebuild + +* Wed Jul 03 2019 Björn Esser - 1.5-2 +- Rebuild (gpsd) + +* Sun Feb 17 2019 Matt Domsch - 1.5-1 +- Upgrade to released version 1.5 +- Apply upstream patch for newer gpsd API + +* Thu Jan 31 2019 Fedora Release Engineering - 1.5-0.2.beta4 +- Rebuilt for https://fedoraproject.org/wiki/Fedora_30_Mass_Rebuild + +* Mon Aug 27 2018 Matt Domsch - 1.5-0.1.beta4 +- Fedora Packaging Guidelines, based on spec by David Ranch + Moved Telemetry Toolkit examples into examples/ docs. diff --git a/scripts/CMakeLists.txt b/scripts/CMakeLists.txt new file mode 100644 index 00000000..886e5b17 --- /dev/null +++ b/scripts/CMakeLists.txt @@ -0,0 +1,6 @@ + +if(NOT (WIN32 OR CYGWIN)) + install(PROGRAMS "${CUSTOM_SCRIPTS_DIR}/dwespeak.sh" DESTINATION ${INSTALL_BIN_DIR}) + install(PROGRAMS "${CUSTOM_SCRIPTS_DIR}/dw-start.sh" DESTINATION ${INSTALL_SCRIPTS_DIR}) + add_subdirectory(telemetry-toolkit) +endif() diff --git a/scripts/dw-start.sh b/scripts/dw-start.sh new file mode 100755 index 00000000..e0b06cda --- /dev/null +++ b/scripts/dw-start.sh @@ -0,0 +1,198 @@ +#!/usr/bin/env bash + +# Why not simply "#!/bin/bash" ? + +# For OpenBSD, the bash location is /usr/local/bin/bash. +# By using env here, bash is found based on the user's $PATH. +# I hope this does not break some other operating system. + + +# Run this from crontab periodically to start up +# Dire Wolf automatically. + +# See User Guide for more discussion. +# For release 1.4 it is section 5.7 "Automatic Start Up After Reboot" +# but it could change in the future as more information is added. + + +# Versioning (this file, not direwolf version) +#----------- +# v1.3 - KI6ZHD - added variable support for direwolf binary location +# v1.2 - KI6ZHD - support different versions of VNC +# v1.1 - KI6ZHD - expanded version to support running on text-only displays with +# auto support; log placement change +# v1.0 - WB2OSZ - original version for Xwindow displays only + + + +#How are you running Direwolf : within a GUI (Xwindows / VNC) or CLI mode +# +# AUTO mode is design to try starting direwolf with GUI support and then +# if no GUI environment is available, it reverts to CLI support with screen +# +# GUI mode is suited for users with the machine running LXDE/Gnome/KDE or VNC +# which auto-logs on (sitting at a login prompt won't work) +# +# CLI mode is suited for say a Raspberry Pi running the Jessie LITE version +# where it will run from the CLI w/o requiring Xwindows - uses screen + +RUNMODE=AUTO + +# Location of the direwolf binary. Depends on $PATH as shown. +# change this if you want to use some other specific location. +# e.g. DIREWOLF="/usr/local/bin/direwolf" + +DIREWOLF="direwolf" + + +#Direwolf start up command :: Uncomment only one of the examples. +# +# 1. For normal operation as TNC, digipeater, IGate, etc. +# Print audio statistics each 100 seconds for troubleshooting. +# Change this command to however you wish to start Direwolf + +DWCMD="$DIREWOLF -a 100" + +# 2. FX.25 Forward Error Correction (FEC) will allow your signal to +# go farther under poor radio conditions. Add "-X 1" to the command line. + +#DWCMD="$DIREWOLF -a 100 -X 1" + +#--------------------------------------------------------------- +# +# 3. Alternative for running with SDR receiver. +# Piping one application into another makes it a little more complicated. +# We need to use bash for the | to be recognized. + +#DWCMD="bash -c 'rtl_fm -f 144.39M - | direwolf -c sdr.conf -r 24000 -D 1 -'" + + +#Where will logs go - needs to be writable by non-root users +LOGFILE=/var/tmp/dw-start.log + + +#------------------------------------- +# Main functions of the script +#------------------------------------- + +#Status variables +SUCCESS=0 + +function CLI { + SCREEN=`which screen` + if [ $? -ne 0 ]; then + echo -e "Error: screen is not installed but is required for CLI mode. Aborting" + exit 1 + fi + + echo "Direwolf in CLI mode start up" + echo "Direwolf in CLI mode start up" >> $LOGFILE + + # Screen commands + # -d m :: starts the command in detached mode + # -S :: name the session + $SCREEN -d -m -S direwolf $DWCMD >> $LOGFILE + SUCCESS=1 + + $SCREEN -list direwolf + $SCREEN -list direwolf >> $LOGFILE + + echo "-----------------------" + echo "-----------------------" >> $LOGFILE +} + +function GUI { + # In this case + # In my case, the Raspberry Pi is not connected to a monitor. + # I access it remotely using VNC as described here: + # http://learn.adafruit.com/adafruit-raspberry-pi-lesson-7-remote-control-with-vnc + # + # If VNC server is running, use its display number. + # Otherwise default to :0 (the Xwindows on the HDMI display) + # + export DISPLAY=":0" + + #Reviewing for RealVNC sessions (stock in Raspbian Pixel) + if [ -n "`ps -ef | grep vncserver-x11-serviced | grep -v grep`" ]; then + sleep 0.1 + echo -e "\nRealVNC found - defaults to connecting to the :0 root window" + elif [ -n "`ps -ef | grep Xtightvnc | grep -v grep`" ]; then + #Reviewing for TightVNC sessions + echo -e "\nTightVNC found - defaults to connecting to the :1 root window" + v=`ps -ef | grep Xtightvnc | grep -v grep` + d=`echo "$v" | sed 's/.*tightvnc *\(:[0-9]\).*/\1/'` + export DISPLAY="$d" + fi + + echo "Direwolf in GUI mode start up" + echo "Direwolf in GUI mode start up" >> $LOGFILE + echo "DISPLAY=$DISPLAY" + echo "DISPLAY=$DISPLAY" >> $LOGFILE + + # + # Auto adjust the startup for your particular environment: gnome-terminal, xterm, etc. + # + + if [ -x /usr/bin/lxterminal ]; then + /usr/bin/lxterminal -t "Dire Wolf" -e "$DWCMD" & + SUCCESS=1 + elif [ -x /usr/bin/xterm ]; then + /usr/bin/xterm -bg white -fg black -e "$DWCMD" & + SUCCESS=1 + elif [ -x /usr/bin/x-terminal-emulator ]; then + /usr/bin/x-terminal-emulator -e "$DWCMD" & + SUCCESS=1 + else + echo "Did not find an X terminal emulator. Reverting to CLI mode" + SUCCESS=0 + fi + echo "-----------------------" + echo "-----------------------" >> $LOGFILE +} + +# ----------------------------------------------------------- +# Main Script start +# ----------------------------------------------------------- + +# When running from cron, we have a very minimal environment +# including PATH=/usr/bin:/bin. +# +export PATH=/usr/local/bin:$PATH + +#Log the start of the script run and re-run +date >> $LOGFILE + +# First wait a little while in case we just rebooted +# and the desktop hasn't started up yet. +# +sleep 30 + + +# +# Nothing to do if Direwolf is already running. +# + +a=`ps ax | grep direwolf | grep -vi -e bash -e screen -e grep | awk '{print $1}'` +if [ -n "$a" ] +then + #date >> /tmp/dw-start.log + #echo "Direwolf already running." >> $LOGFILE + exit +fi + +# Main execution of the script + +if [ $RUNMODE == "AUTO" ];then + GUI + if [ $SUCCESS -eq 0 ]; then + CLI + fi + elif [ $RUNMODE == "GUI" ];then + GUI + elif [ $RUNMODE == "CLI" ];then + CLI + else + echo -e "ERROR: illegal run mode given. Giving up" + exit 1 +fi + diff --git a/scripts/dwespeak.bat b/scripts/dwespeak.bat new file mode 100644 index 00000000..8ea21507 --- /dev/null +++ b/scripts/dwespeak.bat @@ -0,0 +1,8 @@ +echo off + +set chan=%1 +set msg=%2 + +sleep 1 + +"C:\Program Files (x86)\eSpeak\command_line\espeak.exe" -v en-sc %msg% \ No newline at end of file diff --git a/scripts/dwespeak.sh b/scripts/dwespeak.sh new file mode 100755 index 00000000..341d2cf8 --- /dev/null +++ b/scripts/dwespeak.sh @@ -0,0 +1,5 @@ +#!/bin/bash +chan=$1 +msg=$2 +sleep 1 +espeak -v en-sc "$msg" diff --git a/scripts/telemetry-toolkit/CMakeLists.txt b/scripts/telemetry-toolkit/CMakeLists.txt new file mode 100644 index 00000000..46f8e61c --- /dev/null +++ b/scripts/telemetry-toolkit/CMakeLists.txt @@ -0,0 +1,13 @@ +install(PROGRAMS "${CUSTOM_TELEMETRY_DIR}/telem-balloon.pl" DESTINATION ${INSTALL_BIN_DIR}) +install(PROGRAMS "${CUSTOM_TELEMETRY_DIR}/telem-bits.pl" DESTINATION ${INSTALL_BIN_DIR}) +install(PROGRAMS "${CUSTOM_TELEMETRY_DIR}/telem-data.pl" DESTINATION ${INSTALL_BIN_DIR}) +install(PROGRAMS "${CUSTOM_TELEMETRY_DIR}/telem-data91.pl" DESTINATION ${INSTALL_BIN_DIR}) +install(PROGRAMS "${CUSTOM_TELEMETRY_DIR}/telem-eqns.pl" DESTINATION ${INSTALL_BIN_DIR}) +install(PROGRAMS "${CUSTOM_TELEMETRY_DIR}/telem-parm.pl" DESTINATION ${INSTALL_BIN_DIR}) +install(PROGRAMS "${CUSTOM_TELEMETRY_DIR}/telem-seq.sh" DESTINATION ${INSTALL_BIN_DIR}) +install(PROGRAMS "${CUSTOM_TELEMETRY_DIR}/telem-unit.pl" DESTINATION ${INSTALL_BIN_DIR}) +install(PROGRAMS "${CUSTOM_TELEMETRY_DIR}/telem-volts.py" DESTINATION ${INSTALL_BIN_DIR}) + +install(FILES "${CUSTOM_TELEMETRY_DIR}/telem-m0xer-3.txt" DESTINATION ${INSTALL_CONF_DIR}) +install(FILES "${CUSTOM_TELEMETRY_DIR}/telem-balloon.conf" DESTINATION ${INSTALL_CONF_DIR}) +install(FILES "${CUSTOM_TELEMETRY_DIR}/telem-volts.conf" DESTINATION ${INSTALL_CONF_DIR}) diff --git a/scripts/telemetry-toolkit/telem-balloon.conf b/scripts/telemetry-toolkit/telem-balloon.conf new file mode 100644 index 00000000..666bb75b --- /dev/null +++ b/scripts/telemetry-toolkit/telem-balloon.conf @@ -0,0 +1,55 @@ +# Sample configuration for demonstration of sending telemetry. +# Here we try to replicate actual data heard for a balloon. + +CHANNEL 0 +MYCALL M0XER-3 + +# These will send the beacons to the transmitter (which you disconnected, right?) + +# First the metadata. + +# Channel 1: Battery voltage, Volts, scaled up by 100 +# Channel 2: Solar voltage, Volts, scaled up by 100 +# Channel 3: Temperature, degrees C, sent as Kelvin x 10 +# Channel 4: Number of satellites, no units + +# Note: When using Strawberry perl, as specified in the example, Windows knows +# that the .pl file type is associated with it. When using a different implementation +# of perl, which doesn't make this association of file type to application, it might +# be necessary to use something like this instead: +# +# ... infocmd="c:\strawberry\perl\bin\perl.exe telem-parm.pl M0XER-3 Vbat Vsolar Temp Sat" + +# Here we use the generic scripts to generate the messages with metadata. +# The "infocmd=..." option means use the result for the info part of the packet. + +CBEACON delay=0:10 every=1:00 infocmd="telem-parm.pl M0XER-3 Vbat Vsolar Temp Sat" +CBEACON delay=0:12 every=1:00 infocmd="telem-unit.pl M0XER-3 V V C """" m" +CBEACON delay=0:14 every=1:00 infocmd="telem-eqns.pl M0XER-3 0 0.001 0 0 0.001 0 0 0.1 -273.2 0 1 0 0 1 0" +CBEACON delay=0:16 every=1:00 infocmd="telem-bits.pl M0XER-3 11111111 ""10mW research balloon""" + +# Now the telemetry data. +# In a real situation, the location and telemetry data would come from sensors. +# Here we have just hardcoded 3 sets of historical data as a demonstration. + +# telem-balloon.pl accumulates the data then invokes telem-data91.pl to convert +# it to the compressed format. This is inserted into the position comment with "commentcmd=..." + +PBEACON compress=1 delay=0:20 every=1:00 via=WIDE2-1 symbol=Balloon lat=61^34.2876N lon=155^40.0931W alt=12953 commentcmd="telem-balloon.pl 3307 4.383 0.436 -34.6 12" +PBEACON compress=1 delay=0:22 every=1:00 via=WIDE2-1 symbol=Balloon lat=51^07.4402N lon=124^14.4472W alt=12563 commentcmd="telem-balloon.pl 6524 4.515 0.653 -1.3 7" +PBEACON compress=1 delay=0:24 every=1:00 via=WIDE2-1 symbol=Balloon lat=55^58.5558N lon=122^28.5933W alt=12680 commentcmd="telem-balloon.pl 7458 4.521 0.587 -8.3 7" + + +# Now we do the same thing again. + +# This time, add the SENDTO=R0 option to simulate reception. +# These will be sent to any attached applications so you can see how they process the data. + +CBEACON SENDTO=R0 delay=0:30 every=1:00 infocmd="telem-parm.pl M0XER-3 Vbat Vsolar Temp Sat" +CBEACON SENDTO=R0 delay=0:32 every=1:00 infocmd="telem-unit.pl M0XER-3 V V C """" m" +CBEACON SENDTO=R0 delay=0:34 every=1:00 infocmd="telem-eqns.pl M0XER-3 0 0.001 0 0 0.001 0 0 0.1 -273.2 0 1 0 0 1 0" +CBEACON SENDTO=R0 delay=0:36 every=1:00 infocmd="telem-bits.pl M0XER-3 11111111 ""10mW research balloon""" + +PBEACON SENDTO=R0 compress=1 delay=0:40 every=1:00 via=WIDE2-1 symbol=Balloon lat=61^34.2876N lon=155^40.0931W alt=12953 commentcmd="telem-balloon.pl 3307 4.383 0.436 -34.6 12" +PBEACON SENDTO=R0 compress=1 delay=0:42 every=1:00 via=WIDE2-1 symbol=Balloon lat=51^07.4402N lon=124^14.4472W alt=12563 commentcmd="telem-balloon.pl 6524 4.515 0.653 -1.3 7" +PBEACON SENDTO=R0 compress=1 delay=0:44 every=1:00 via=WIDE2-1 symbol=Balloon lat=55^58.5558N lon=122^28.5933W alt=12680 commentcmd="telem-balloon.pl 7458 4.521 0.587 -8.3 7" diff --git a/scripts/telemetry-toolkit/telem-balloon.pl b/scripts/telemetry-toolkit/telem-balloon.pl new file mode 100644 index 00000000..ed54aff9 --- /dev/null +++ b/scripts/telemetry-toolkit/telem-balloon.pl @@ -0,0 +1,43 @@ +#!/usr/bin/perl + +# Part of Dire Wolf APRS Telemetry Toolkit, WB2OSZ, 2015 + +# In a real situation this would obtain data from sensors. +# For demonstration purposes we use historical data supplied on the command line. + +if ($#ARGV+1 != 5) { + print STDERR "5 command line arguments must be provided.\n"; + usage(); +} + +($seq,$vbat,$vsolar,$temp,$sat) = @ARGV; + +# Scale to integer in range of 0 to 8280. +# This must be the inverse of the mapping in the EQNS message. + +$vbat = int(($vbat * 1000) + 0.5); +$vsolar = int(($vsolar * 1000) + 0.5); +$temp = int((($temp + 273.2) * 10) + 0.5); + +exit system("telem-data91.pl $seq $vbat $vsolar $temp $sat"); + + +sub usage () +{ + print STDERR "\n"; + print STDERR "balloon.pl - Format data into Compressed telemetry format.\n"; + print STDERR "\n"; + print STDERR "In a real situation this would obtain data from sensors.\n"; + print STDERR "For demonstration purposes we use historical data supplied on the command line.\n"; + print STDERR "\n"; + print STDERR "Usage: balloon.pl seq vbat vsolar temp sat\n"; + print STDERR "\n"; + print STDERR "Where,\n"; + print STDERR " seq is a sequence number.\n"; + print STDERR " vbat is battery voltage.\n"; + print STDERR " vsolar is solar cell voltage.\n"; + print STDERR " temp is temperature, degrees C.\n"; + print STDERR " sat is number of GPS satellites visible.\n"; + + exit 1; +} \ No newline at end of file diff --git a/scripts/telemetry-toolkit/telem-bits.pl b/scripts/telemetry-toolkit/telem-bits.pl new file mode 100644 index 00000000..a3fcdd23 --- /dev/null +++ b/scripts/telemetry-toolkit/telem-bits.pl @@ -0,0 +1,33 @@ +#!/usr/bin/perl + +# Part of Dire Wolf APRS Telemetry Toolkit, WB2OSZ, 2015 + +if ($#ARGV+1 < 2 || $#ARGV+1 > 3) { + print STDERR "A callsign, bit sense string, and optional project title must be provided.\n"; + usage(); +} + +# Separate out call and pad to 9 characters. +$call = shift @ARGV; +$call = substr($call . " ", 0, 9); + +if ( ! ($ARGV[0] =~ m/^[01]{8}$/)) { + print STDERR "The bit-sense value must be 8 binary digits.\n"; + usage(); +} + +print ":$call:BITS." . join (',', @ARGV) . "\n"; +exit 0; + +sub usage () +{ + print STDERR "\n"; + print STDERR "telem-bits.pl - Generate BITS message with bit polarity and optional project title.\n"; + print STDERR "\n"; + print STDERR "Usage: telem-bits.pl call bit-sense [ project-title ]\n"; + print STDERR "\n"; + print STDERR "Bit-sense is string of 8 binary digits.\n"; + print STDERR "If project title contains any spaces, enclose it in quotes.\n"; + + exit 1; +} \ No newline at end of file diff --git a/scripts/telemetry-toolkit/telem-data.pl b/scripts/telemetry-toolkit/telem-data.pl new file mode 100644 index 00000000..1484f44f --- /dev/null +++ b/scripts/telemetry-toolkit/telem-data.pl @@ -0,0 +1,31 @@ +#!/usr/bin/perl + +# Part of Dire Wolf APRS Telemetry Toolkit, WB2OSZ, 2015 + +if ($#ARGV+1 < 2 || $#ARGV+1 > 7) { + print STDERR "2 to 7 command line arguments must be provided.\n"; + usage(); +} + +if ($#ARGV+1 == 7) { + if ( ! ($ARGV[6] =~ m/^[01]{8}$/)) { + print STDERR "The sixth value must be 8 binary digits.\n"; + usage(); + } +} + +print "T#" . join (',', @ARGV) . "\n"; +exit 0; + +sub usage () +{ + print STDERR "\n"; + print STDERR "telem-data.pl - Format data into Telemetry Report format.\n"; + print STDERR "\n"; + print STDERR "Usage: telem-data.pl sequence value1 [ value2 ... ]\n"; + print STDERR "\n"; + print STDERR "A sequence number and up to 5 analog values can be specified.\n"; + print STDERR "Any sixth value must be 8 binary digits.\n"; + + exit 1; +} \ No newline at end of file diff --git a/scripts/telemetry-toolkit/telem-data91.pl b/scripts/telemetry-toolkit/telem-data91.pl new file mode 100644 index 00000000..54da1ad9 --- /dev/null +++ b/scripts/telemetry-toolkit/telem-data91.pl @@ -0,0 +1,65 @@ +#!/usr/bin/perl + +# Part of Dire Wolf APRS Telemetry Toolkit, WB2OSZ, 2015 + +# For explanation of encoding see: +# http://he.fi/doc/aprs-base91-comment-telemetry.txt + + +if ($#ARGV+1 < 2 || $#ARGV+1 > 7) { + print STDERR "2 to 7 command line arguments must be provided.\n"; + usage(); +} + + +if ($#ARGV+1 == 7) { + if ( ! ($ARGV[6] =~ m/^[01]{8}$/)) { + print STDERR "The sixth value must be 8 binary digits.\n"; + usage(); + } + # Convert binary digits to value. + $ARGV[6] = oct("0b" . reverse($ARGV[6])); +} + +$result = "|"; + +for ($n = 0 ; $n <= $#ARGV; $n++) { + #print $n . " = " . $ARGV[$n] . "\n"; + $v = $ARGV[$n]; + if ($v != int($v) || $v < 0 || $v > 8280) { + print STDERR "$v is not an integer in range of 0 to 8280.\n"; + usage(); + } + + $result .= base91($v); +} + +$result .= "|"; +print "$result\n"; +exit 0; + + +sub base91 () +{ + my $x = @_[0]; + + my $d1 = int ($x / 91); + my $d2 = $x % 91; + + return chr($d1+33) . chr($d2+33); +} + + +sub usage () +{ + print STDERR "\n"; + print STDERR "telem-data91.pl - Format data into compressed base 91 telemetry.\n"; + print STDERR "\n"; + print STDERR "Usage: telem-data91.pl sequence value1 [ value2 ... ]\n"; + print STDERR "\n"; + print STDERR "A sequence number and up to 5 analog values can be specified.\n"; + print STDERR "Any sixth value must be 8 binary digits.\n"; + print STDERR "Values must be integers in range of 0 to 8280.\n"; + + exit 1; +} \ No newline at end of file diff --git a/scripts/telemetry-toolkit/telem-eqns.pl b/scripts/telemetry-toolkit/telem-eqns.pl new file mode 100644 index 00000000..741ad940 --- /dev/null +++ b/scripts/telemetry-toolkit/telem-eqns.pl @@ -0,0 +1,28 @@ +#!/usr/bin/perl + +# Part of Dire Wolf APRS Telemetry Toolkit, WB2OSZ, 2015 + +if ($#ARGV+1 != 4 && $#ARGV+1 != 7 && $#ARGV+1 != 10 && $#ARGV+1 != 13 && $#ARGV+1 != 16) { + print STDERR "A callsign and 1 to 5 sets of 3 coefficients must be provided.\n"; + usage(); +} + +# Separate out call and pad to 9 characters. +$call = shift @ARGV; +$call = substr($call . " ", 0, 9); + +print ":$call:EQNS." . join (',', @ARGV) . "\n"; +exit 0; + +sub usage () +{ + print STDERR "\n"; + print STDERR "telem-eqns.pl - Generate EQNS message with scaling coefficients\n"; + print STDERR "\n"; + print STDERR "Usage: telem-eqns.pl call a1 b1 c1 [ a2 b2 c2 ... ]\n"; + print STDERR "\n"; + print STDERR "Specify a callsign and 1 to 5 sets of 3 coefficients.\n"; + print STDERR "See APRS protocol reference for their meaning.\n"; + + exit 1; +} \ No newline at end of file diff --git a/scripts/telemetry-toolkit/telem-m0xer-3.txt b/scripts/telemetry-toolkit/telem-m0xer-3.txt new file mode 100644 index 00000000..93ce5bbe --- /dev/null +++ b/scripts/telemetry-toolkit/telem-m0xer-3.txt @@ -0,0 +1,7 @@ +2E0TOY>APRS::M0XER-3 :BITS.11111111,10mW research balloon +2E0TOY>APRS::M0XER-3 :PARM.Vbat,Vsolar,Temp,Sat +2E0TOY>APRS::M0XER-3 :EQNS.0,0.001,0,0,0.001,0,0,0.1,-273.2,0,1,0,0,1,0 +2E0TOY>APRS::M0XER-3 :UNIT.V,V,C,,m +M0XER-3>APRS63,WIDE2-1:!//Bap'.ZGO JHAE/A=042496|E@Q0%i;5!-| +M0XER-3>APRS63,WIDE2-1:!/4\;u/)K$O J]YD/A=041216|h`RY(1>q!(| +M0XER-3>APRS63,WIDE2-1:!/23*f/R$UO Jf'x/A=041600|rxR_'J>+!(| \ No newline at end of file diff --git a/scripts/telemetry-toolkit/telem-parm.pl b/scripts/telemetry-toolkit/telem-parm.pl new file mode 100644 index 00000000..464fa60d --- /dev/null +++ b/scripts/telemetry-toolkit/telem-parm.pl @@ -0,0 +1,27 @@ +#!/usr/bin/perl + +# Part of Dire Wolf APRS Telemetry Toolkit, WB2OSZ, 2015 + +if ($#ARGV+1 < 2 || $#ARGV+1 > 14) { + print STDERR "A callsign and 1 to 13 channel names must be provided.\n"; + usage(); +} + +# Separate out call and pad to 9 characters. +$call = shift @ARGV; +$call = substr($call . " ", 0, 9); + +print ":$call:PARM." . join (',', @ARGV) . "\n"; +exit 0; + +sub usage () +{ + print STDERR "\n"; + print STDERR "telem-parm.pl - Generate PARM message with channel names.\n"; + print STDERR "\n"; + print STDERR "Usage: telem-parm.pl call aname1 ... aname5 dname1 .,, dname8\n"; + print STDERR "\n"; + print STDERR "Specify a callsign and up to 13 names for the analog & digital channels.\n"; + + exit 1; +} \ No newline at end of file diff --git a/scripts/telemetry-toolkit/telem-seq.sh b/scripts/telemetry-toolkit/telem-seq.sh new file mode 100644 index 00000000..0d2a36d7 --- /dev/null +++ b/scripts/telemetry-toolkit/telem-seq.sh @@ -0,0 +1,7 @@ +#!/bin/sh +# Generate sequence number as described here: +# https://github.com/wb2osz/direwolf/issues/9 +# +SEQ=`cat /tmp/seq 2>/dev/null` +SEQ=$(expr \( $SEQ + 1 \) % 1000) +echo $SEQ | tee /tmp/seq \ No newline at end of file diff --git a/scripts/telemetry-toolkit/telem-unit.pl b/scripts/telemetry-toolkit/telem-unit.pl new file mode 100644 index 00000000..c1d999d2 --- /dev/null +++ b/scripts/telemetry-toolkit/telem-unit.pl @@ -0,0 +1,27 @@ +#!/usr/bin/perl + +# Part of Dire Wolf APRS Telemetry Toolkit, WB2OSZ, 2015 + +if ($#ARGV+1 < 2 || $#ARGV+1 > 14) { + print STDERR "A callsign and 1 to 13 units/labels must be provided.\n"; + usage(); +} + +# Separate out call and pad to 9 characters. +$call = shift @ARGV; +$call = substr($call . " ", 0, 9); + +print ":$call:UNIT." . join (',', @ARGV) . "\n"; +exit 0; + +sub usage () +{ + print STDERR "\n"; + print STDERR "telem-unit.pl - Generate UNIT message with channel units/labels.\n"; + print STDERR "\n"; + print STDERR "Usage: telem-unit.pl call unit1 ... unit5 label1 .,, label8\n"; + print STDERR "\n"; + print STDERR "Specify a callsign and up to 13 names for the units/labels.\n"; + + exit 1; +} \ No newline at end of file diff --git a/scripts/telemetry-toolkit/telem-volts.conf b/scripts/telemetry-toolkit/telem-volts.conf new file mode 100644 index 00000000..dfcc08ae --- /dev/null +++ b/scripts/telemetry-toolkit/telem-volts.conf @@ -0,0 +1,28 @@ +# Sample configuration for demonstration of sending telemetry. +# Here we take a voltage from an analog to digital converter (ADC). + +ADEVICE plughw:1,0 + +MYCALL MYCALL-9 + +# For demonstration purposes, the metadata will be sent each minute and +# voltage data every 10 seconds. In actual practice, it would be much less frequent. + +# First the metadata. + +# The "infocmd=..." option means use the result for the info part of the packet. + +CBEACON delay=0:10 every=1:00 via=WIDE2-1 infocmd="telem-parm.pl MYCALL-9 Supply" +CBEACON delay=0:11 every=1:00 via=WIDE2-1 infocmd="telem-unit.pl MYCALL-9 Volts" + +# Now the telemetry data. + +# First we use telem-volts.py to read a volage from the A/D converter. +# This is supplied to telem-data.pl as a command line argument. +# The result is used as the info part of a custom beacon. + +# Sequence numbers are generated as suggested here: +# https://github.com/wb2osz/direwolf/issues/9 + +CBEACON delay=0:15 every=0:10 via=WIDE2-1 infocmd="telem-data.pl `telem-seq.sh` `PYTHONPATH=~/Adafruit-Raspberry-Pi-Python-Code/Adafruit_ADS1x15 telem-volts.py`" + diff --git a/scripts/telemetry-toolkit/telem-volts.py b/scripts/telemetry-toolkit/telem-volts.py new file mode 100644 index 00000000..34c59c4d --- /dev/null +++ b/scripts/telemetry-toolkit/telem-volts.py @@ -0,0 +1,36 @@ +#!/usr/bin/python3 + +# Part of Dire Wolf APRS Telemetry Toolkit, WB2OSZ, 2015 + +# Derived from +# https://github.com/adafruit/Adafruit-Raspberry-Pi-Python-Code/blob/master/Adafruit_ADS1x15/ads1x15_ex_singleended.py + +import time, signal, sys +from Adafruit_ADS1x15 import ADS1x15 + +ADS1015 = 0x00 # 12-bit ADC +ADS1115 = 0x01 # 16-bit ADC + +# Set ADC full scale to 2048 mV. +# Can't use original 4096 with 3.3V supply. +gain = 2048 + +# Select the sample time, 1/sps second. +# Longer is better to average out noise. +sps = 64 + +# Set this to ADS1015 or ADS1115 depending on the ADC you are using! +adc = ADS1x15(ic=ADS1115) + +# Values for voltage divider on ADC input. +r1 = 1000000. +r2 = 100000. + +# Read channel 0 in single-ended mode using the settings above +volts = adc.readADCSingleEnded(0, gain, sps) * 0.001 * (r1+r2) / r2 + +# Calibration correction specific to my hardware. +# (multiply by expected value, divide by uncalibrated result.) +#volts = volts * 4.98 / 4.889 + +print("%.3f" % (volts)) diff --git a/server.c b/server.c deleted file mode 100644 index 9bad9a22..00000000 --- a/server.c +++ /dev/null @@ -1,1389 +0,0 @@ -// -// This file is part of Dire Wolf, an amateur radio packet TNC. -// -// Copyright (C) 2011, 2012, 2013, 2014 John Langner, WB2OSZ -// -// This program 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 2 of the License, or -// (at your option) any later version. -// -// This program 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 this program. If not, see . -// - - -/*------------------------------------------------------------------ - * - * Module: server.c - * - * Purpose: Provide service to other applications via "AGW TCPIP Socket Interface". - * - * Input: - * - * Outputs: - * - * Description: This provides a TCP socket for communication with a client application. - * It implements a subset of the AGW socket interface. - * - * Commands from application recognized: - * - * 'R' Request for version number. - * (See below for response.) - * - * 'G' Ask about radio ports. - * (See below for response.) - * - * 'g' Capabilities of a port. (new in 0.8) - * (See below for response.) - * - * 'k' Ask to start receiving RAW AX25 frames. - * - * 'm' Ask to start receiving Monitor AX25 frames. - * - * 'V' Transmit UI data frame. - * Generate audio for transmission. - * - * 'H' Report recently heard stations. Not implemented yet. - * - * 'K' Transmit raw AX.25 frame. - * - * 'X' Register CallSign - * - * 'x' Unregister CallSign - * - * A message is printed if any others are received. - * - * TODO: Should others be implemented? - * - * - * Messages sent to client application: - * - * 'R' Reply to Request for version number. - * Currently responds with major 1, minor 0. - * - * 'G' Reply to Ask about radio ports. - * - * 'g' Reply to capabilities of a port. (new in 0.8) - * - * 'K' Received AX.25 frame in raw format. - * (Enabled with 'k' command.) - * - * 'U' Received AX.25 frame in monitor format. - * (Enabled with 'm' command.) - * - * - * - * References: AGWPE TCP/IP API Tutorial - * http://uz7ho.org.ua/includes/agwpeapi.htm - * - * Getting Started with Winsock - * http://msdn.microsoft.com/en-us/library/windows/desktop/bb530742(v=vs.85).aspx - * - * - * Major change in 1.1: - * - * Formerly a single client was allowed. - * Now we can have multiple concurrent clients. - * - *---------------------------------------------------------------*/ - - -/* - * Native Windows: Use the Winsock interface. - * Linux: Use the BSD socket interface. - * Cygwin: Can use either one. - */ - - -#if __WIN32__ -#include -#define _WIN32_WINNT 0x0501 -#include -#else -#include -#include -#include -#include -#include -#endif - -#include -#include -#include -#include -#include -#include - -#include "direwolf.h" -#include "tq.h" -#include "ax25_pad.h" -#include "textcolor.h" -#include "audio.h" -#include "server.h" - - -/* - * Previously, we allowed only one network connection at a time to each port. - * In version 1.1, we allow multiple concurrent client apps to connect. - */ - -#define MAX_NET_CLIENTS 3 - -static int client_sock[MAX_NET_CLIENTS]; - /* File descriptor for socket for */ - /* communication with client application. */ - /* Set to -1 if not connected. */ - /* (Don't use SOCKET type because it is unsigned.) */ - -static int enable_send_raw_to_client[MAX_NET_CLIENTS]; - /* Should we send received packets to client app in raw form? */ - /* Note that it starts as false for a new connection. */ - /* the client app must send a command to enable this. */ - -static int enable_send_monitor_to_client[MAX_NET_CLIENTS]; - /* Should we send received packets to client app in monitor form? */ - /* Note that it starts as false for a new connection. */ - /* the client app must send a command to enable this. */ - - -static int num_channels; /* Number of radio ports. */ - - -// TODO: define in one place, use everywhere. -#if __WIN32__ -#define THREAD_F unsigned __stdcall -#else -#define THREAD_F void * -#endif - -static THREAD_F connect_listen_thread (void *arg); -static THREAD_F cmd_listen_thread (void *arg); - -/* - * Message header for AGW protocol. - * Assuming little endian such as x86 or ARM. - * Byte swapping would be required for big endian cpu. - */ - -#if __GNUC__ -#if __BYTE_ORDER__ != __ORDER_LITTLE_ENDIAN__ -#error This needs to be more portable to work on big endian. -#endif -#endif - -struct agwpe_s { - short portx; /* 0 for first, 1 for second, etc. */ - short port_hi_reserved; - short kind_lo; /* message type */ - short kind_hi; - char call_from[10]; - char call_to[10]; - int data_len; /* Number of data bytes following. */ - int user_reserved; -}; - - -/*------------------------------------------------------------------- - * - * Name: debug_print - * - * Purpose: Print message to/from client for debugging. - * - * Inputs: fromto - Direction of message. - * client - client number, 0 .. MAX_NET_CLIENTS-1 - * pmsg - Address of the message block. - * msg_len - Length of the message. - * - *--------------------------------------------------------------------*/ - -static int debug_client = 0; /* Debug option: Print information flowing from and to client. */ - -void server_set_debug (int n) -{ - debug_client = n; -} - -void hex_dump (unsigned char *p, int len) -{ - int n, i, offset; - - offset = 0; - while (len > 0) { - n = len < 16 ? len : 16; - dw_printf (" %03x: ", offset); - for (i=0; i>>" }; - - switch (fromto) { - - case FROM_CLIENT: - strcpy (direction, "from"); /* from the client application */ - - switch (pmsg->kind_lo) { - case 'P': strcpy (datakind, "Application Login"); break; - case 'X': strcpy (datakind, "Register CallSign"); break; - case 'x': strcpy (datakind, "Unregister CallSign"); break; - case 'G': strcpy (datakind, "Ask Port Information"); break; - case 'm': strcpy (datakind, "Enable Reception of Monitoring Frames"); break; - case 'R': strcpy (datakind, "AGWPE Version Info"); break; - case 'g': strcpy (datakind, "Ask Port Capabilities"); break; - case 'H': strcpy (datakind, "Callsign Heard on a Port"); break; - case 'y': strcpy (datakind, "Ask Outstanding frames waiting on a Port"); break; - case 'Y': strcpy (datakind, "Ask Outstanding frames waiting for a connection"); break; - case 'M': strcpy (datakind, "Send UNPROTO Information"); break; - case 'C': strcpy (datakind, "Connect, Start an AX.25 Connection"); break; - case 'D': strcpy (datakind, "Send Connected Data"); break; - case 'd': strcpy (datakind, "Disconnect, Terminate an AX.25 Connection"); break; - case 'v': strcpy (datakind, "Connect VIA, Start an AX.25 circuit thru digipeaters"); break; - case 'V': strcpy (datakind, "Send UNPROTO VIA"); break; - case 'c': strcpy (datakind, "Non-Standard Connections, Connection with PID"); break; - case 'K': strcpy (datakind, "Send data in raw AX.25 format"); break; - case 'k': strcpy (datakind, "Activate reception of Frames in raw format"); break; - default: strcpy (datakind, "**INVALID**"); break; - } - break; - - case TO_CLIENT: - default: - strcpy (direction, "to"); /* sent to the client application. */ - - switch (pmsg->kind_lo) { - case 'R': strcpy (datakind, "Version Number"); break; - case 'X': strcpy (datakind, "Callsign Registration"); break; - case 'G': strcpy (datakind, "Port Information"); break; - case 'g': strcpy (datakind, "Capabilities of a Port"); break; - case 'y': strcpy (datakind, "Frames Outstanding on a Port"); break; - case 'Y': strcpy (datakind, "Frames Outstanding on a Connection"); break; - case 'H': strcpy (datakind, "Heard Stations on a Port"); break; - case 'C': strcpy (datakind, "AX.25 Connection Received"); break; - case 'D': strcpy (datakind, "Connected AX.25 Data"); break; - case 'M': strcpy (datakind, "Monitored Connected Information"); break; - case 'S': strcpy (datakind, "Monitored Supervisory Information"); break; - case 'U': strcpy (datakind, "Monitored Unproto Information"); break; - case 'T': strcpy (datakind, "Monitoring Own Information"); break; - case 'K': strcpy (datakind, "Monitored Information in Raw Format"); break; - default: strcpy (datakind, "**INVALID**"); break; - } - } - - text_color_set(DW_COLOR_DEBUG); - dw_printf ("\n"); - - dw_printf ("%s %s %s AGWPE client application %d, total length = %d\n", - prefix[(int)fromto], datakind, direction, client, msg_len); - - dw_printf ("\tportx = %d, port_hi_reserved = %d\n", pmsg->portx, pmsg->port_hi_reserved); - dw_printf ("\tkind_lo = %d = '%c', kind_hi = %d\n", pmsg->kind_lo, pmsg->kind_lo, pmsg->kind_hi); - dw_printf ("\tcall_from = \"%s\", call_to = \"%s\"\n", pmsg->call_from, pmsg->call_to); - dw_printf ("\tdata_len = %d, user_reserved = %d, data =\n", pmsg->data_len, pmsg->user_reserved); - - hex_dump ((unsigned char*)pmsg + sizeof(struct agwpe_s), pmsg->data_len); - - if (msg_len < 36) { - text_color_set (DW_COLOR_ERROR); - dw_printf ("AGWPE message length, %d, is shorter than minumum 36.\n", msg_len); - } - if (msg_len != pmsg->data_len + 36) { - text_color_set (DW_COLOR_ERROR); - dw_printf ("AGWPE message length, %d, inconsistent with data length %d.\n", msg_len, pmsg->data_len); - } - -} - -/*------------------------------------------------------------------- - * - * Name: server_init - * - * Purpose: Set up a server to listen for connection requests from - * an application such as Xastir. - * - * Inputs: mc->agwpe_port - TCP port for server. - * Main program has default of 8000 but allows - * an alternative to be specified on the command line - * - * Outputs: - * - * Description: This starts at least two threads: - * * one to listen for a connection from client app. - * * one or more to listen for commands from client app. - * so the main application doesn't block while we wait for these. - * - *--------------------------------------------------------------------*/ - - -void server_init (struct misc_config_s *mc) -{ - int client; - -#if __WIN32__ - HANDLE connect_listen_th; - HANDLE cmd_listen_th[MAX_NET_CLIENTS]; -#else - pthread_t connect_listen_tid; - pthread_t cmd_listen_tid[MAX_NET_CLIENTS]; -#endif - int e; - int server_port = mc->agwpe_port; /* Usually 8000 but can be changed. */ - - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("server_init ( %d )\n", server_port); - debug_a = 1; -#endif - for (client=0; clientnum_channels; - -/* - * This waits for a client to connect and sets an available client_sock[n]. - */ -#if __WIN32__ - connect_listen_th = (HANDLE)_beginthreadex (NULL, 0, connect_listen_thread, (void *)(unsigned int)server_port, 0, NULL); - if (connect_listen_th == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Could not create AGW connect listening thread\n"); - return; - } -#else - e = pthread_create (&connect_listen_tid, NULL, connect_listen_thread, (void *)(long)server_port); - if (e != 0) { - text_color_set(DW_COLOR_ERROR); - perror("Could not create AGW connect listening thread"); - return; - } -#endif - -/* - * These read messages from client when client_sock[n] is valid. - * Currently we start up a separate thread for each potential connection. - * Possible later refinement. Start one now, others only as needed. - */ - for (client = 0; client < MAX_NET_CLIENTS; client++) { - -#if __WIN32__ - cmd_listen_th[client] = (HANDLE)_beginthreadex (NULL, 0, cmd_listen_thread, (void*)client, 0, NULL); - if (cmd_listen_th[client] == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Could not create AGW command listening thread\n"); - return; - } -#else - e = pthread_create (&cmd_listen_tid[client], NULL, cmd_listen_thread, (void *)(long)client); - if (e != 0) { - text_color_set(DW_COLOR_ERROR); - perror("Could not create AGW command listening thread"); - return; - } -#endif - } -} - - -/*------------------------------------------------------------------- - * - * Name: connect_listen_thread - * - * Purpose: Wait for a connection request from an application. - * - * Inputs: arg - TCP port for server. - * Main program has default of 8000 but allows - * an alternative to be specified on the command line - * - * Outputs: client_sock - File descriptor for communicating with client app. - * - * Description: Wait for connection request from client and establish - * communication. - * Note that the client can go away and come back again and - * re-establish communication without restarting this application. - * - *--------------------------------------------------------------------*/ - -static THREAD_F connect_listen_thread (void *arg) -{ -#if __WIN32__ - - struct addrinfo hints; - struct addrinfo *ai = NULL; - int err; - char server_port_str[12]; - - SOCKET listen_sock; - WSADATA wsadata; - - sprintf (server_port_str, "%d", (int)(long)arg); -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("DEBUG: serverport = %d = '%s'\n", (int)(long)arg, server_port_str); -#endif - err = WSAStartup (MAKEWORD(2,2), &wsadata); - if (err != 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf("WSAStartup failed: %d\n", err); - return (NULL); // TODO: what should this be for Windows? - } - - if (LOBYTE(wsadata.wVersion) != 2 || HIBYTE(wsadata.wVersion) != 2) { - text_color_set(DW_COLOR_ERROR); - dw_printf("Could not find a usable version of Winsock.dll\n"); - WSACleanup(); - //sleep (1); - return (NULL); - } - - memset (&hints, 0, sizeof(hints)); - hints.ai_family = AF_INET; - hints.ai_socktype = SOCK_STREAM; - hints.ai_protocol = IPPROTO_TCP; - hints.ai_flags = AI_PASSIVE; - - err = getaddrinfo(NULL, server_port_str, &hints, &ai); - if (err != 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf("getaddrinfo failed: %d\n", err); - //sleep (1); - WSACleanup(); - return (NULL); - } - - listen_sock= socket(ai->ai_family, ai->ai_socktype, ai->ai_protocol); - if (listen_sock == INVALID_SOCKET) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("connect_listen_thread: Socket creation failed, err=%d", WSAGetLastError()); - return (NULL); - } - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf("Binding to port %s ... \n", server_port_str); -#endif - - err = bind( listen_sock, ai->ai_addr, (int)ai->ai_addrlen); - if (err == SOCKET_ERROR) { - text_color_set(DW_COLOR_ERROR); - dw_printf("Bind failed with error: %d\n", WSAGetLastError()); - dw_printf("Some other application is probably already using port %s.\n", server_port_str); - freeaddrinfo(ai); - closesocket(listen_sock); - WSACleanup(); - return (NULL); - } - - freeaddrinfo(ai); - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf("opened socket as fd (%d) on port (%s) for stream i/o\n", listen_sock, server_port_str ); -#endif - - while (1) { - - int client; - int c; - - client = -1; - for (c = 0; c < MAX_NET_CLIENTS && client < 0; c++) { - if (client_sock[c] <= 0) { - client = c; - } - } - -/* - * Listen for connection if we have not reached maximum. - */ - if (client >= 0) { - - if(listen(listen_sock, MAX_NET_CLIENTS) == SOCKET_ERROR) - { - text_color_set(DW_COLOR_ERROR); - dw_printf("Listen failed with error: %d\n", WSAGetLastError()); - return (NULL); - } - - text_color_set(DW_COLOR_INFO); - dw_printf("Ready to accept AGW client application %d on port %s ...\n", client, server_port_str); - - client_sock[client] = accept(listen_sock, NULL, NULL); - - if (client_sock[client] == -1) { - text_color_set(DW_COLOR_ERROR); - dw_printf("Accept failed with error: %d\n", WSAGetLastError()); - closesocket(listen_sock); - WSACleanup(); - return (NULL); - } - - text_color_set(DW_COLOR_INFO); - dw_printf("\nConnected to AGW client application %d ...\n\n", client); - -/* - * The command to change this is actually a toggle, not explicit on or off. - * Make sure it has proper state when we get a new connection. - */ - enable_send_raw_to_client[client] = 0; - enable_send_monitor_to_client[client] = 0; - } - else { - SLEEP_SEC(1); /* wait then check again if more clients allowed. */ - } - } - -#else /* End of Windows case, now Linux */ - - - struct sockaddr_in sockaddr; /* Internet socket address stuct */ - socklen_t sockaddr_size = sizeof(struct sockaddr_in); - int server_port = (int)(long)arg; - int listen_sock; - - listen_sock= socket(AF_INET,SOCK_STREAM,0); - if (listen_sock == -1) { - text_color_set(DW_COLOR_ERROR); - perror ("connect_listen_thread: Socket creation failed"); - return (NULL); - } - - sockaddr.sin_addr.s_addr = INADDR_ANY; - sockaddr.sin_port = htons(server_port); - sockaddr.sin_family = AF_INET; - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf("Binding to port %d ... \n", server_port); -#endif - - if (bind(listen_sock,(struct sockaddr*)&sockaddr,sizeof(sockaddr)) == -1) { - text_color_set(DW_COLOR_ERROR); - perror ("connect_listen_thread: Bind failed"); - return (NULL); - } - - getsockname( listen_sock, (struct sockaddr *)(&sockaddr), &sockaddr_size); - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf("opened socket as fd (%d) on port (%d) for stream i/o\n", listen_sock, ntohs(sockaddr.sin_port) ); -#endif - - while (1) { - - int client; - int c; - - client = -1; - for (c = 0; c < MAX_NET_CLIENTS && client < 0; c++) { - if (client_sock[c] <= 0) { - client = c; - } - } - - if (client >= 0) { - - if(listen(listen_sock,MAX_NET_CLIENTS) == -1) - { - text_color_set(DW_COLOR_ERROR); - perror ("connect_listen_thread: Listen failed"); - return (NULL); - } - - text_color_set(DW_COLOR_INFO); - dw_printf("Ready to accept AGW client application %d on port %d ...\n", client, server_port); - - client_sock[client] = accept(listen_sock, (struct sockaddr*)(&sockaddr),&sockaddr_size); - - text_color_set(DW_COLOR_INFO); - dw_printf("\nConnected to AGW client application %d...\n\n", client); - -/* - * The command to change this is actually a toggle, not explicit on or off. - * Make sure it has proper state when we get a new connection. - */ - enable_send_raw_to_client[client] = 0; - enable_send_monitor_to_client[client] = 0; - } - else { - SLEEP_SEC(1); /* wait then check again if more clients allowed. */ - } - } -#endif -} - - -/*------------------------------------------------------------------- - * - * Name: server_send_rec_packet - * - * Purpose: Send a received packet to the client app. - * - * Inputs: chan - Channel number where packet was received. - * 0 = first, 1 = second if any. - * - * pp - Identifier for packet object. - * - * fbuf - Address of raw received frame buffer. - * flen - Length of raw received frame. - * - * - * Description: Send message to client if connected. - * Disconnect from client, and notify user, if any error. - * - * There are two different formats: - * RAW - the original received frame. - * MONITOR - just the information part. - * - *--------------------------------------------------------------------*/ - - -void server_send_rec_packet (int chan, packet_t pp, unsigned char *fbuf, int flen) -{ - struct { - struct agwpe_s hdr; - char data[1+AX25_MAX_PACKET_LEN]; - } agwpe_msg; - - int err; - int info_len; - unsigned char *pinfo; - int client; - - -/* - * RAW format - */ - for (client=0; client 0){ - - memset (&agwpe_msg.hdr, 0, sizeof(agwpe_msg.hdr)); - - agwpe_msg.hdr.portx = chan; - - agwpe_msg.hdr.kind_lo = 'K'; - - ax25_get_addr_with_ssid (pp, AX25_SOURCE, agwpe_msg.hdr.call_from); - - ax25_get_addr_with_ssid (pp, AX25_DESTINATION, agwpe_msg.hdr.call_to); - - agwpe_msg.hdr.data_len = flen + 1; - - /* Stick in extra byte for the "TNC" to use. */ - - agwpe_msg.data[0] = 0; - memcpy (agwpe_msg.data + 1, fbuf, (size_t)flen); - - if (debug_client) { - debug_print (TO_CLIENT, client, &agwpe_msg.hdr, sizeof(agwpe_msg.hdr) + agwpe_msg.hdr.data_len); - } - -#if __WIN32__ - err = send (client_sock[client], (char*)(&agwpe_msg), sizeof(agwpe_msg.hdr) + agwpe_msg.hdr.data_len, 0); - if (err == SOCKET_ERROR) - { - text_color_set(DW_COLOR_ERROR); - dw_printf ("\nError %d sending message to AGW client application. Closing connection.\n\n", WSAGetLastError()); - closesocket (client_sock[client]); - client_sock[client] = -1; - WSACleanup(); - } -#else - err = write (client_sock[client], &agwpe_msg, sizeof(agwpe_msg.hdr) + agwpe_msg.hdr.data_len); - if (err <= 0) - { - text_color_set(DW_COLOR_ERROR); - dw_printf ("\nError sending message to AGW client application. Closing connection.\n\n"); - close (client_sock[client]); - client_sock[client] = -1; - } -#endif - } - } - - -/* MONITOR format - only for UI frames. */ - - for (client=0; client 0 - && ax25_get_control(pp) == AX25_UI_FRAME){ - - time_t clock; - struct tm *tm; - - clock = time(NULL); - tm = localtime(&clock); - - memset (&agwpe_msg.hdr, 0, sizeof(agwpe_msg.hdr)); - - agwpe_msg.hdr.portx = chan; - - agwpe_msg.hdr.kind_lo = 'U'; - - ax25_get_addr_with_ssid (pp, AX25_SOURCE, agwpe_msg.hdr.call_from); - - ax25_get_addr_with_ssid (pp, AX25_DESTINATION, agwpe_msg.hdr.call_to); - - info_len = ax25_get_info (pp, &pinfo); - - /* http://uz7ho.org.ua/includes/agwpeapi.htm#_Toc500723812 */ - - /* Description mentions one CR character after timestamp but example has two. */ - /* Actual observed cases have only one. */ - /* Also need to add extra CR, CR, null at end. */ - /* The documentation example includes these 3 extra in the Len= value */ - /* but actual observed data uses only the packet info length. */ - - sprintf (agwpe_msg.data, " %d:Fm %s To %s [%02d:%02d:%02d]\r%s\r\r", - chan+1, agwpe_msg.hdr.call_from, agwpe_msg.hdr.call_to, - ax25_get_pid(pp), info_len, - tm->tm_hour, tm->tm_min, tm->tm_sec, - pinfo); - - agwpe_msg.hdr.data_len = strlen(agwpe_msg.data) + 1 /* include null */ ; - - if (debug_client) { - debug_print (TO_CLIENT, client, &agwpe_msg.hdr, sizeof(agwpe_msg.hdr) + agwpe_msg.hdr.data_len); - } - -#if __WIN32__ - err = send (client_sock[client], (char*)(&agwpe_msg), sizeof(agwpe_msg.hdr) + agwpe_msg.hdr.data_len, 0); - if (err == SOCKET_ERROR) - { - text_color_set(DW_COLOR_ERROR); - dw_printf ("\nError %d sending message to AGW client application %d. Closing connection.\n\n", WSAGetLastError(), client); - closesocket (client_sock[client]); - client_sock[client] = -1; - WSACleanup(); - } -#else - err = write (client_sock[client], &agwpe_msg, sizeof(agwpe_msg.hdr) + agwpe_msg.hdr.data_len); - if (err <= 0) - { - text_color_set(DW_COLOR_ERROR); - dw_printf ("\nError sending message to AGW client application %d. Closing connection.\n\n", client); - close (client_sock[client]); - client_sock[client] = -1; - } -#endif - } - } - -} /* server_send_rec_packet */ - - - -/*------------------------------------------------------------------- - * - * Name: read_from_socket - * - * Purpose: Read from socket until we have desired number of bytes. - * - * Inputs: fd - file descriptor. - * ptr - address where data should be placed. - * len - desired number of bytes. - * - * Description: Just a wrapper for the "read" system call but it should - * never return fewer than the desired number of bytes. - * - *--------------------------------------------------------------------*/ - -static int read_from_socket (int fd, char *ptr, int len) -{ - int got_bytes = 0; - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("read_from_socket (%d, %p, %d)\n", fd, ptr, len); -#endif - while (got_bytes < len) { - int n; - -#if __WIN32__ - -//TODO: any flags for send/recv? - - n = recv (fd, ptr + got_bytes, len - got_bytes, 0); -#else - n = read (fd, ptr + got_bytes, len - got_bytes); -#endif - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("read_from_socket: n = %d\n", n); -#endif - if (n <= 0) { - return (n); - } - - got_bytes += n; - } - assert (got_bytes >= 0 && got_bytes <= len); - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("read_from_socket: return %d\n", got_bytes); -#endif - return (got_bytes); -} - - -/*------------------------------------------------------------------- - * - * Name: cmd_listen_thread - * - * Purpose: Wait for command messages from an application. - * - * Inputs: arg - client number, 0 .. MAX_NET_CLIENTS-1 - * - * Outputs: client_sock[n] - File descriptor for communicating with client app. - * - * Description: Process messages from the client application. - * Note that the client can go away and come back again and - * re-establish communication without restarting this application. - * - *--------------------------------------------------------------------*/ - -static THREAD_F cmd_listen_thread (void *arg) -{ - int n; - - struct { - struct agwpe_s hdr; /* Command header. */ - - char data[512]; /* Additional data used by some commands. */ - /* Maximum for 'V': 1 + 8*10 + 256 */ - } cmd; - - int client = (int) arg; - - assert (client >= 0 && client < MAX_NET_CLIENTS); - - while (1) { - - while (client_sock[client] <= 0) { - SLEEP_SEC(1); /* Not connected. Try again later. */ - } - - n = read_from_socket (client_sock[client], (char *)(&cmd.hdr), sizeof(cmd.hdr)); - if (n != sizeof(cmd.hdr)) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("\nError getting message header from AGW client application %d.\n", client); - dw_printf ("Tried to read %d bytes but got only %d.\n", (int)sizeof(cmd.hdr), n); - dw_printf ("Closing connection.\n\n"); -#if __WIN32__ - closesocket (client_sock[client]); -#else - close (client_sock[client]); -#endif - client_sock[client] = -1; - continue; - } - -/* - * Take some precautions to guard against bad data - * which could cause problems later. - */ - -/* - * Call to/from must not exceeed 9 characters. - * It's not guaranteed that unused bytes will contain 0 so we - * don't issue error message in this case. - */ - - cmd.hdr.call_from[sizeof(cmd.hdr.call_from)-1] = '\0'; - cmd.hdr.call_to[sizeof(cmd.hdr.call_to)-1] = '\0'; - -/* - * Following data must fit in available buffer. - * Leave room for an extra nul byte terminator at end later. - */ - - if (cmd.hdr.data_len < 0 || cmd.hdr.data_len > sizeof(cmd.data) - 1) { - - text_color_set(DW_COLOR_ERROR); - dw_printf ("\nInvalid message from AGW client application %d.\n", client); - dw_printf ("Data Length of %d is out of range.\n", cmd.hdr.data_len); - - /* This is a bad situation. */ - /* If we tried to read again, the header probably won't be there. */ - /* No point in trying to continue reading. */ - - dw_printf ("Closing connection.\n\n"); -#if __WIN32__ - closesocket (client_sock[client]); -#else - close (client_sock[client]); -#endif - client_sock[client] = -1; - return NULL; - } - - cmd.data[0] = '\0'; - - if (cmd.hdr.data_len > 0) { - n = read_from_socket (client_sock[client], cmd.data, cmd.hdr.data_len); - if (n != cmd.hdr.data_len) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("\nError getting message data from AGW client application %d.\n", client); - dw_printf ("Tried to read %d bytes but got only %d.\n", cmd.hdr.data_len, n); - dw_printf ("Closing connection.\n\n"); -#if __WIN32__ - closesocket (client_sock[client]); -#else - close (client_sock[client]); -#endif - client_sock[client] = -1; - return NULL; - } - if (n > 0) { - cmd.data[cmd.hdr.data_len] = '\0'; - } - } - -/* - * print & process message from client. - */ - - if (debug_client) { - debug_print (FROM_CLIENT, client, &cmd.hdr, sizeof(cmd.hdr) + cmd.hdr.data_len); - } - - switch (cmd.hdr.kind_lo) { - - case 'R': /* Request for version number */ - { - struct { - struct agwpe_s hdr; - int major_version; - int minor_version; - } reply; - - - memset (&reply, 0, sizeof(reply)); - reply.hdr.kind_lo = 'R'; - reply.hdr.data_len = sizeof(reply.major_version) + sizeof(reply.minor_version); - assert (reply.hdr.data_len ==8); - - // Xastir only prints this and doesn't care otherwise. - // APRSIS32 doesn't seem to care. - // UI-View32 wants on 2000.15 or later. - - reply.major_version = 2005; - reply.minor_version = 127; - - assert (sizeof(reply) == 44); - - if (debug_client) { - debug_print (TO_CLIENT, client, &reply.hdr, sizeof(reply)); - } - -// TODO: Should have unified function instead of multiple versions everywhere. - -#if __WIN32__ - send (client_sock[client], (char*)(&reply), sizeof(reply), 0); -#else - n = write (client_sock[client], &reply, sizeof(reply)); -#endif - } - break; - - case 'G': /* Ask about radio ports */ - - { - struct { - struct agwpe_s hdr; - char info[100]; - } reply; - - - memset (&reply, 0, sizeof(reply)); - reply.hdr.kind_lo = 'G'; - reply.hdr.data_len = sizeof (reply.info); - - // Xastir only prints this and doesn't care otherwise. - // YAAC uses this to identify available channels. - - if (num_channels == 1) { - sprintf (reply.info, "1;Port1 Single channel;"); - } - else { - sprintf (reply.info, "2;Port1 Left channel;Port2 Right Channel;"); - } - - assert (reply.hdr.data_len == 100); - - if (debug_client) { - debug_print (TO_CLIENT, client, &reply.hdr, sizeof(reply)); - } - -#if __WIN32__ - send (client_sock[client], (char*)(&reply), sizeof(reply), 0); -#else - n = write (client_sock[client], &reply, sizeof(reply)); -#endif - } - break; - - - case 'g': /* Ask about capabilities of a port. */ - - { - struct { - struct agwpe_s hdr; - unsigned char on_air_baud_rate; /* 0=1200, 3=9600 */ - unsigned char traffic_level; /* 0xff if not in autoupdate mode */ - unsigned char tx_delay; - unsigned char tx_tail; - unsigned char persist; - unsigned char slottime; - unsigned char maxframe; - unsigned char active_connections; - int how_many_bytes; - } reply; - - - memset (&reply, 0, sizeof(reply)); - - reply.hdr.portx = cmd.hdr.portx; /* Reply with same port number ! */ - reply.hdr.kind_lo = 'g'; - reply.hdr.data_len = 12; - - // YAAC asks for this. - // Fake it to keep application happy. - - reply.on_air_baud_rate = 0; - reply.traffic_level = 1; - reply.tx_delay = 0x19; - reply.tx_tail = 4; - reply.persist = 0xc8; - reply.slottime = 4; - reply.maxframe = 7; - reply.active_connections = 0; - reply.how_many_bytes = 1; - - assert (sizeof(reply) == 48); - - if (debug_client) { - debug_print (TO_CLIENT, client, &reply.hdr, sizeof(reply)); - } - -#if __WIN32__ - send (client_sock[client], (char*)(&reply), sizeof(reply), 0); -#else - n = write (client_sock[client], &reply, sizeof(reply)); -#endif - } - break; - - - case 'H': /* Ask about recently heard stations. */ - - { -#if 0 - struct { - struct agwpe_s hdr; - char info[100]; - } reply; - - - memset (&reply.hdr, 0, sizeof(reply.hdr)); - reply.hdr.kind_lo = 'H'; - - // TODO: Implement properly. - - reply.hdr.portx = cmd.hdr.portx - - strcpy (reply.hdr.call_from, "WB2OSZ-15"); - - strcpy (agwpe_msg.data, ...); - - reply.hdr.data_len = strlen(reply.info); - - if (debug_client) { - debug_print (TO_CLIENT, client, &reply.hdr, sizeof(reply.hdr) + reply.hdr.data_len); - } - -#if __WIN32__ - send (client_sock[client], &reply, sizeof(reply.hdr) + reply.hdr.data_len, 0); -#else - write (client_sock[client], &reply, sizeof(reply.hdr) + reply.hdr.data_len); -#endif - -#endif - } - break; - - - - - case 'k': /* Ask to start receiving RAW AX25 frames */ - - // Actually it is a toggle so we must be sure to clear it for a new connection. - - enable_send_raw_to_client[client] = ! enable_send_raw_to_client[client]; - break; - - case 'm': /* Ask to start receiving Monitor frames */ - - // Actually it is a toggle so we must be sure to clear it for a new connection. - - enable_send_monitor_to_client[client] = ! enable_send_monitor_to_client[client]; - break; - - - case 'V': /* Transmit UI data frame */ - { - // Data format is: - // 1 byte for number of digipeaters. - // 10 bytes for each digipeater. - // data part of message. - - char stemp[512]; - char *p; - int ndigi; - int k; - - packet_t pp; - //unsigned char fbuf[AX25_MAX_PACKET_LEN+2]; - //int flen; - - // We have already assured these do not exceed 9 characters. - - strcpy (stemp, cmd.hdr.call_from); - strcat (stemp, ">"); - strcat (stemp, cmd.hdr.call_to); - - cmd.data[cmd.hdr.data_len] = '\0'; - ndigi = cmd.data[0]; - p = cmd.data + 1; - - for (k=0; k= 1 && - ax25_get_h(pp,AX25_REPEATER_1)) { - tq_append (cmd.hdr.portx, TQ_PRIO_0_HI, pp); - } - else { - tq_append (cmd.hdr.portx, TQ_PRIO_1_LO, pp); - } - } - } - - break; - - case 'X': /* Register CallSign */ - - /* Send success status. */ - - { - struct { - struct agwpe_s hdr; - char data; - } reply; - - - memset (&reply, 0, sizeof(reply)); - reply.hdr.kind_lo = 'X'; - memcpy (reply.hdr.call_from, cmd.hdr.call_from, sizeof(reply.hdr.call_from)); - reply.hdr.data_len = 1; - reply.data = 1; /* success */ - - // Version 1.0. - // Previously used sizeof(reply) but compiler rounded it up to next byte boundary. - // That's why more cumbersome size expression is used. - - if (debug_client) { - debug_print (TO_CLIENT, client, &reply.hdr, sizeof(reply.hdr) + sizeof(reply.data)); - } - -#if __WIN32__ - send (client_sock[client], (char*)(&reply), sizeof(reply.hdr) + sizeof(reply.data), 0); -#else - n = write (client_sock[client], &reply, sizeof(reply.hdr) + sizeof(reply.data)); -#endif - } - break; - - case 'x': /* Unregister CallSign */ - /* No reponse is expected. */ - break; - - case 'C': /* Connect, Start an AX.25 Connection */ - case 'v': /* Connect VIA, Start an AX.25 circuit thru digipeaters */ - case 'D': /* Send Connected Data */ - case 'd': /* Disconnect, Terminate an AX.25 Connection */ - - // Version 1.0. Better message instead of generic unexpected command. - - text_color_set(DW_COLOR_ERROR); - dw_printf ("\n"); - dw_printf ("Can't process command from AGW client app %d.\n", client); - dw_printf ("Connected packet mode is not implemented.\n"); - - break; - -#if 0 - case 'M': /* Send UNPROTO Information */ - - Not sure what we might want to do here. - AGWterminal sends this for beacon or ask QRA. - None of the other tested applications use it. - - - <<< Send UNPROTO Information from AGWPE client application 0, total length = 253 - portx = 0, port_hi_reserved = 0 - kind_lo = 77 = 'M', kind_hi = 0 - call_from = "SV2AGW-1", call_to = "BEACON" - data_len = 217, user_reserved = 588, data = - 000: 54 68 69 73 20 76 65 72 73 69 6f 6e 20 75 73 65 This version use - 010: 73 20 74 68 65 20 6e 65 77 20 41 47 57 20 50 61 s the new AGW Pa - 020: 63 6b 65 74 20 45 6e 67 69 6e 65 20 77 69 6e 73 cket Engine wins - - <<< Send UNPROTO Information from AGWPE client application 0, total length = 37 - portx = 0, port_hi_reserved = 0 - kind_lo = 77 = 'M', kind_hi = 0 - call_from = "SV2AGW-1", call_to = "QRA" - data_len = 1, user_reserved = 32218432, data = - 000: 0d . - - { - - packet_t pp; - int pid = cmd.datakind_hi & 0xff; - /* "AX.25 PID 0x00 or 0xF0 for AX.25 0xCF NETROM and others" */ - - - This is not right. - It needs to be more like "V" Transmit UI data frame - except there are no digipeaters involved. - - pp = ax25_from_frame ((unsigned char *)cmd.data, cmd.hdr.data_len, -1); - - if (pp != NULL) { - tq_append (cmd.hdr.portx, TQ_PRIO_1_LO, pp); - ax25_set_pid (pp, pid); - } - else { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Failed to create frame from AGW 'M' message.\n"); - } - } - break; - -#endif - default: - - text_color_set(DW_COLOR_ERROR); - dw_printf ("--- Unexpected Command from application %d using AGW protocol:\n", client); - debug_print (FROM_CLIENT, client, &cmd.hdr, sizeof(cmd.hdr) + cmd.hdr.data_len); - - break; - } - - - } - -} - -/* end server.c */ diff --git a/server.h b/server.h deleted file mode 100644 index 03514ac3..00000000 --- a/server.h +++ /dev/null @@ -1,19 +0,0 @@ - -/* - * Name: server.h - */ - - -#include "ax25_pad.h" /* for packet_t */ - -#include "config.h" - - -void server_set_debug (int n); - -void server_init (struct misc_config_s *misc_config); - -void server_send_rec_packet (int chan, packet_t pp, unsigned char *fbuf, int flen); - - -/* end server.h */ diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt new file mode 100644 index 00000000..a2c3963d --- /dev/null +++ b/src/CMakeLists.txt @@ -0,0 +1,573 @@ + +# global includes +# not ideal but not so slow +# otherwise use target_include_directories +include_directories( + ${GPSD_INCLUDE_DIRS} + ${HAMLIB_INCLUDE_DIRS} + ${ALSA_INCLUDE_DIRS} + ${UDEV_INCLUDE_DIRS} + ${PORTAUDIO_INCLUDE_DIRS} + ${SNDIO_INCLUDE_DIRS} + ${CUSTOM_GEOTRANZ_DIR} + ${CUSTOM_HIDAPI_DIR} + ) + +if(WIN32 OR CYGWIN) + include_directories( + ${CUSTOM_REGEX_DIR} + ) +endif() + + +# direwolf +list(APPEND direwolf_SOURCES + direwolf.c + ais.c + aprs_tt.c + audio_stats.c + ax25_link.c + ax25_pad.c + ax25_pad2.c + beacon.c + config.c + decode_aprs.c + dedupe.c + demod_9600.c + demod_afsk.c + demod_psk.c + demod.c + digipeater.c + cdigipeater.c + dlq.c + dsp.c + dtime_now.c + dtmf.c + dwgps.c + dwsock.c + encode_aprs.c + encode_aprs.c + fcs_calc.c + fcs_calc.c + fx25_encode.c + fx25_extract.c + fx25_init.c + fx25_rec.c + fx25_send.c + fx25_auto.c + gen_tone.c + hdlc_rec.c + hdlc_rec2.c + hdlc_send.c + igate.c + il2p_codec.c + il2p_scramble.c + il2p_rec.c + il2p_payload.c + il2p_init.c + il2p_header.c + il2p_send.c + kiss_frame.c + kiss.c + kissserial.c + kissnet.c + latlong.c + latlong.c + log.c + morse.c + multi_modem.c + waypoint.c + serial_port.c + pfilter.c + ptt.c + recv.c + rrbb.c + server.c + symbols.c + telemetry.c + textcolor.c + tq.c + tt_text.c + tt_user.c + xid.c + xmit.c + dwgps.c + dwgpsnmea.c + dwgpsd.c + mheard.c + ) + +if(LINUX) + list(APPEND direwolf_SOURCES + audio.c + ) + if(UDEV_FOUND) + list(APPEND direwolf_SOURCES + cm108.c + ) + endif() + if(AVAHI_CLIENT_FOUND) + list(APPEND direwolf_SOURCES + dns_sd_common.c + dns_sd_avahi.c + ) + endif() + elseif(WIN32 OR CYGWIN) # windows + list(APPEND direwolf_SOURCES + audio_win.c + cm108.c + + # icon + # require plain gcc binary or link + #${CMAKE_SOURCE_DIR}/cmake/cpack/direwolf.rc + ) + list(REMOVE_ITEM direwolf_SOURCES + dwgpsd.c + ) + elseif(HAVE_SNDIO) + list(APPEND direwolf_SOURCES + audio.c + ) + else() # macOS freebsd + list(APPEND direwolf_SOURCES + audio_portaudio.c + ) + if(USE_MACOS_DNSSD) + list(APPEND direwolf_SOURCES + dns_sd_common.c + dns_sd_macos.c + ) + endif() +endif() + +add_executable(direwolf + ${direwolf_SOURCES} + ) + +target_link_libraries(direwolf + ${GEOTRANZ_LIBRARIES} + ${MISC_LIBRARIES} + ${REGEX_LIBRARIES} + ${HIDAPI_LIBRARIES} + Threads::Threads + ${GPSD_LIBRARIES} + ${HAMLIB_LIBRARIES} + ${ALSA_LIBRARIES} + ${UDEV_LIBRARIES} + ${PORTAUDIO_LIBRARIES} + ${SNDIO_LIBRARIES} + ${AVAHI_LIBRARIES} + ) + +if(WIN32 OR CYGWIN) + set_target_properties(direwolf + PROPERTIES COMPILE_FLAGS "-DUSE_REGEX_STATIC" + ) + target_link_libraries(direwolf winmm ws2_32 setupapi) +endif() + +# decode_aprs +list(APPEND decode_aprs_SOURCES + decode_aprs.c + ais.c + kiss_frame.c + ax25_pad.c + dwgpsnmea.c + dwgps.c + dwgpsd.c + serial_port.c + symbols.c + textcolor.c + fcs_calc.c + latlong.c + log.c + telemetry.c + tt_text.c + ) + +if(WIN32 OR CYGWIN) + list(REMOVE_ITEM decode_aprs_SOURCES + dwgpsd.c + ) +endif() + +add_executable(decode_aprs + ${decode_aprs_SOURCES} + ) + +set_target_properties(decode_aprs + PROPERTIES COMPILE_FLAGS "-DDECAMAIN -DUSE_REGEX_STATIC" + ) + +target_link_libraries(decode_aprs + ${MISC_LIBRARIES} + ${REGEX_LIBRARIES} + Threads::Threads + ${GPSD_LIBRARIES} + ) + + +# Convert between text and touch tone representation. +# text2tt +list(APPEND text2tt_SOURCES + tt_text.c + ) + +add_executable(text2tt + ${text2tt_SOURCES} + ) + +set_target_properties(text2tt + PROPERTIES COMPILE_FLAGS "-DENC_MAIN" + ) + +target_link_libraries(text2tt + ${MISC_LIBRARIES} + ) + +# tt2text +list(APPEND tt2text_SOURCES + tt_text.c + ) + +add_executable(tt2text + ${tt2text_SOURCES} + ) + +set_target_properties(tt2text + PROPERTIES COMPILE_FLAGS "-DDEC_MAIN" + ) + +target_link_libraries(tt2text + ${MISC_LIBRARIES} + ) + + +# Convert between Latitude/Longitude and UTM coordinates. +# ll2utm +list(APPEND ll2utm_SOURCES + ll2utm.c + textcolor.c + ) + +add_executable(ll2utm + ${ll2utm_SOURCES} + ) + +target_link_libraries(ll2utm + ${GEOTRANZ_LIBRARIES} + ${MISC_LIBRARIES} + ) + +# utm2ll +list(APPEND utm2ll_SOURCES + utm2ll.c + textcolor.c + ) + +add_executable(utm2ll + ${utm2ll_SOURCES} + ) + +target_link_libraries(utm2ll + ${GEOTRANZ_LIBRARIES} + ${MISC_LIBRARIES} + ) + + +# Convert from log file to GPX. +# log2gpx +list(APPEND log2gpx_SOURCES + log2gpx.c + textcolor.c + ) + +add_executable(log2gpx + ${log2gpx_SOURCES} + ) + +target_link_libraries(log2gpx + ${MISC_LIBRARIES} + ) + + +# Test application to generate sound. +# gen_packets +list(APPEND gen_packets_SOURCES + gen_packets.c + ax25_pad.c + ax25_pad2.c + fx25_encode.c + fx25_extract.c + fx25_init.c + fx25_send.c + hdlc_send.c + fcs_calc.c + gen_tone.c + il2p_codec.c + il2p_scramble.c + il2p_payload.c + il2p_init.c + il2p_header.c + il2p_send.c + morse.c + dtmf.c + textcolor.c + dsp.c + ) + +add_executable(gen_packets + ${gen_packets_SOURCES} + ) + +target_link_libraries(gen_packets + ${MISC_LIBRARIES} + ) + + +# Unit test for AFSK demodulator +# atest +list(APPEND atest_SOURCES + atest.c + ais.c + demod.c + demod_afsk.c + demod_psk.c + demod_9600.c + dsp.c + fx25_extract.c + fx25_encode.c + fx25_init.c + fx25_rec.c + hdlc_rec.c + hdlc_rec2.c + il2p_codec.c + il2p_scramble.c + il2p_rec.c + il2p_payload.c + il2p_init.c + il2p_header.c + multi_modem.c + rrbb.c + fcs_calc.c + ax25_pad.c + ax25_pad2.c + decode_aprs.c + dwgpsnmea.c + dwgps.c + dwgpsd.c + serial_port.c + telemetry.c + dtime_now.c + latlong.c + symbols.c + tt_text.c + textcolor.c + ) + +if(WIN32 OR CYGWIN) + list(REMOVE_ITEM atest_SOURCES + dwgpsd.c + ) +endif() + +add_executable(atest + ${atest_SOURCES} + ) + +target_link_libraries(atest + ${MISC_LIBRARIES} + ${GPSD_LIBRARIES} + ${REGEX_LIBRARIES} + Threads::Threads + ) + +if(WIN32 OR CYGWIN) + set_target_properties(atest + PROPERTIES COMPILE_FLAGS "-DUSE_REGEX_STATIC" + ) +endif() + + +# Multiple AGWPE network or serial port clients to test TNCs side by side. +# aclients +list(APPEND aclients_SOURCES + aclients.c + ax25_pad.c + fcs_calc.c + textcolor.c + ) + +add_executable(aclients + ${aclients_SOURCES} + ) + +target_link_libraries(aclients + ${MISC_LIBRARIES} + Threads::Threads + ) + +if(WIN32 OR CYGWIN) + target_link_libraries(aclients ws2_32) +endif() + + +# Talk to a KISS TNC. +# Note: kiss_frame.c has conditional compilation on KISSUTIL. +# kissutil +list(APPEND kissutil_SOURCES + kissutil.c + kiss_frame.c + ax25_pad.c + fcs_calc.c + textcolor.c + serial_port.c + dtime_now.c + dwsock.c + ) + +add_executable(kissutil + ${kissutil_SOURCES} + ) + +set_target_properties(kissutil + PROPERTIES COMPILE_FLAGS "-DKISSUTIL" + ) + +target_link_libraries(kissutil + ${MISC_LIBRARIES} + Threads::Threads + ) + +if(WIN32 OR CYGWIN) + target_link_libraries(kissutil ws2_32) +endif() + + +# TNC interoperability testing for AX.25 connected mode. +# tnctest +list(APPEND tnctest_SOURCES + tnctest.c + textcolor.c + dtime_now.c + serial_port.c + ) + +add_executable(tnctest + ${tnctest_SOURCES} + ) + +target_link_libraries(tnctest + ${MISC_LIBRARIES} + Threads::Threads + ) + +if(WIN32 OR CYGWIN) + target_link_libraries(tnctest ws2_32) +endif() + + +# List USB audio adapters than can use GPIO for PTT. +# Originally for Linux only (using udev). +# Version 1.7 adds it for Windows. Needs hidapi library. + +# cm108 +if(UDEV_FOUND OR WIN32 OR CYGWIN) + list(APPEND cm108_SOURCES + cm108.c + textcolor.c + ) + + add_executable(cm108 + ${cm108_SOURCES} + ) + + set_target_properties(cm108 + PROPERTIES COMPILE_FLAGS "-DCM108_MAIN" + ) + + target_link_libraries(cm108 + ${MISC_LIBRARIES} + ) + + if (LINUX) + target_link_libraries(cm108 + ${UDEV_LIBRARIES} + ) + endif() + + if (WIN32 OR CYGWIN) + target_link_libraries(cm108 + ${HIDAPI_LIBRARIES} + ws2_32 + setupapi + ) + endif() +endif() + + +# Touch Tone to Speech sample application. +# ttcalc +list(APPEND ttcalc_SOURCES + ttcalc.c + ax25_pad.c + fcs_calc.c + textcolor.c + ) + +add_executable(ttcalc + ${ttcalc_SOURCES} + ) + +target_link_libraries(ttcalc + ${MISC_LIBRARIES} + ) + +if(WIN32 OR CYGWIN) + target_link_libraries(ttcalc ws2_32) +endif() + + +# Sample for packet radio server application. +# appserver +list(APPEND appserver_SOURCES + appserver.c + agwlib.c + dwsock.c + dtime_now.c + ax25_pad.c + fcs_calc.c + textcolor.c + ) + +add_executable(appserver + ${appserver_SOURCES} + ) + +target_link_libraries(appserver + ${MISC_LIBRARIES} + Threads::Threads + ) + +if(WIN32 OR CYGWIN) + target_link_libraries(appserver ws2_32) +endif() + + +install(TARGETS direwolf DESTINATION ${INSTALL_BIN_DIR}) +install(TARGETS decode_aprs DESTINATION ${INSTALL_BIN_DIR}) +install(TARGETS text2tt DESTINATION ${INSTALL_BIN_DIR}) +install(TARGETS tt2text DESTINATION ${INSTALL_BIN_DIR}) +install(TARGETS ll2utm DESTINATION ${INSTALL_BIN_DIR}) +install(TARGETS utm2ll DESTINATION ${INSTALL_BIN_DIR}) +install(TARGETS aclients DESTINATION ${INSTALL_BIN_DIR}) +install(TARGETS log2gpx DESTINATION ${INSTALL_BIN_DIR}) +install(TARGETS gen_packets DESTINATION ${INSTALL_BIN_DIR}) +install(TARGETS atest DESTINATION ${INSTALL_BIN_DIR}) +install(TARGETS ttcalc DESTINATION ${INSTALL_BIN_DIR}) +install(TARGETS kissutil DESTINATION ${INSTALL_BIN_DIR}) +install(TARGETS tnctest DESTINATION ${INSTALL_BIN_DIR}) +install(TARGETS appserver DESTINATION ${INSTALL_BIN_DIR}) +if(UDEV_FOUND OR WIN32 OR CYGWIN) + install(TARGETS cm108 DESTINATION ${INSTALL_BIN_DIR}) +endif() diff --git a/aclients.c b/src/aclients.c similarity index 86% rename from aclients.c rename to src/aclients.c index af6986d9..0d0c3e73 100644 --- a/aclients.c +++ b/src/aclients.c @@ -1,7 +1,7 @@ // // This file is part of Dire Wolf, an amateur radio packet TNC. // -// Copyright (C) 2013 John Langner, WB2OSZ +// Copyright (C) 2013, 2015 John Langner, WB2OSZ // // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by @@ -28,11 +28,20 @@ * Description: Establish connection with multiple servers and * compare results side by side. * - * Usage: aclients 8000=AGWPE 8002=DireWolf COM1=D710A + * Usage: aclients port1=name1 port2=name2 ... + * + * Example: aclients 8000=AGWPE 192.168.1.64:8002=DireWolf COM1=D710A * * This will connect to multiple physical or virtual * TNCs, read packets from them, and display results. * + * Each port can have the following forms: + * + * * host-name:tcp-port + * * ip-addr:tcp-port + * * tcp-port + * * serial port name (e.g. COM1, /dev/ttyS0) + * *---------------------------------------------------------------*/ @@ -40,40 +49,38 @@ /* * Native Windows: Use the Winsock interface. * Linux: Use the BSD socket interface. - * Cygwin: Can use either one. */ +#include "direwolf.h" // Sets _WIN32_WINNT for XP API level needed by ws2tcpip.h #if __WIN32__ #include -// default is 0x0400 -#undef _WIN32_WINNT -#define _WIN32_WINNT 0x0501 /* Minimum OS version is XP. */ -#include +#include // _WIN32_WINNT must be set to 0x0501 before including this + #else -//#define __USE_XOPEN2KXSI 1 -//#define __USE_XOPEN 1 #include #include #include #include #include +#include #include #include #include #include -#include +#include #endif #include #include #include #include +#include #include +#include -#include "direwolf.h" #include "ax25_pad.h" #include "textcolor.h" #include "version.h" @@ -115,7 +122,7 @@ static char * ia_to_text (int Family, void * pAddr, char * pStringBuf, size_t S case AF_INET: sa4 = (struct sockaddr_in *)pAddr; #if __WIN32__ - sprintf (pStringBuf, "%d.%d.%d.%d", sa4->sin_addr.S_un.S_un_b.s_b1, + snprintf (pStringBuf, StringBufSize, "%d.%d.%d.%d", sa4->sin_addr.S_un.S_un_b.s_b1, sa4->sin_addr.S_un.S_un_b.s_b2, sa4->sin_addr.S_un.S_un_b.s_b3, sa4->sin_addr.S_un.S_un_b.s_b4); @@ -126,7 +133,7 @@ static char * ia_to_text (int Family, void * pAddr, char * pStringBuf, size_t S case AF_INET6: sa6 = (struct sockaddr_in6 *)pAddr; #if __WIN32__ - sprintf (pStringBuf, "%x:%x:%x:%x:%x:%x:%x:%x", + snprintf (pStringBuf, StringBufSize, "%x:%x:%x:%x:%x:%x:%x:%x", ntohs(((unsigned short *)(&(sa6->sin6_addr)))[0]), ntohs(((unsigned short *)(&(sa6->sin6_addr)))[1]), ntohs(((unsigned short *)(&(sa6->sin6_addr)))[2]), @@ -140,7 +147,7 @@ static char * ia_to_text (int Family, void * pAddr, char * pStringBuf, size_t S #endif break; default: - sprintf (pStringBuf, "Invalid address family!"); + snprintf (pStringBuf, StringBufSize, "Invalid address family!"); } assert (strlen(pStringBuf) < StringBufSize); return pStringBuf; @@ -155,14 +162,7 @@ static char * ia_to_text (int Family, void * pAddr, char * pStringBuf, size_t S * Purpose: Start up multiple client threads listening to different * TNCs. Print packets. Tally up statistics. * - * Usage: aclients 8000=AGWPE 8002=DireWolf COM1=D710A - * - * Each command line argument is TCP port number or a - * serial port name. Follow by = and a text description - * of what is connected. - * - * For now, everything is assumed to be on localhost. - * Maybe someday we might recognize host:port=description. + * Usage: Described above. * *---------------------------------------------------------------*/ @@ -172,9 +172,17 @@ static char * ia_to_text (int Family, void * pAddr, char * pStringBuf, size_t S static int num_clients; -static char hostname[MAX_CLIENTS][50]; -static char port[MAX_CLIENTS][30]; -static char description[MAX_CLIENTS][50]; +static char hostname[MAX_CLIENTS][50]; /* DNS host name or IPv4 address. */ + /* Some of the code is there for IPv6 but */ + /* needs more work. */ + /* Defaults to "localhost" if not specified. */ + +static char port[MAX_CLIENTS][30]; /* If it begins with a digit, it is considered */ + /* a TCP port number at the hostname. */ + /* Otherwise, we treat it as a serial port name. */ + +static char description[MAX_CLIENTS][50]; /* Name used in the output. */ + #if __WIN32__ static HANDLE client_th[MAX_CLIENTS]; @@ -221,23 +229,41 @@ int main (int argc, char *argv[]) for (j=0; j= 0 && mon_cmd.data_len < sizeof(data)); + assert (mon_cmd.data_len >= 0 && mon_cmd.data_len < (int)(sizeof(data))); if (mon_cmd.data_len > 0) { -#if __WIN32__ - n = recv (server_sock, data, mon_cmd.data_len, 0); -#else - n = read (server_sock, data, mon_cmd.data_len); -#endif + n = SOCK_RECV (server_sock, data, mon_cmd.data_len); if (n != mon_cmd.data_len) { printf ("Read error, client %d received %d data bytes.\n", my_index, n); @@ -575,15 +596,18 @@ static void * client_thread_net (void *arg) char result[400]; char *p; int col, len; + alevel_t alevel; //printf ("server %d, portx = %d\n", my_index, mon_cmd.portx); - use_chan == mon_cmd.portx; - pp = ax25_from_frame ((unsigned char *)(data+1), mon_cmd.data_len-1, -1); + use_chan = mon_cmd.portx; + memset (&alevel, 0xff, sizeof(alevel)); + pp = ax25_from_frame ((unsigned char *)(data+1), mon_cmd.data_len-1, alevel); + assert (pp != NULL); ax25_format_addrs (pp, result); info_len = ax25_get_info (pp, (unsigned char **)(&pinfo)); pinfo[info_len] = '\0'; - strcat (result, pinfo); + strlcat (result, pinfo, sizeof(result)); for (p=result; *p!='\0'; p++) { if (! isprint(*p)) *p = ' '; } @@ -641,7 +665,7 @@ static unsigned __stdcall client_thread_serial (void *arg) static void * client_thread_serial (void *arg) #endif { - int my_index = (int)(long)arg; + int my_index = (int)(ptrdiff_t)arg; #if __WIN32__ diff --git a/src/agwlib.c b/src/agwlib.c new file mode 100644 index 00000000..2c03adaa --- /dev/null +++ b/src/agwlib.c @@ -0,0 +1,749 @@ + +// ****** PRELIMINARY - needs work ****** + +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// + + +/*------------------------------------------------------------------ + * + * Module: agwlib.c + * + * Purpose: Sample application Program Interface (API) to use network TNC with AGW protocol. + * + * Input: + * + * Outputs: + * + * Description: This file contains functions to attach to a TNC over a TCP socket and send + * commands to it. The current list includes some of the following: + * + * 'C' Connect, Start an AX.25 Connection + * 'v' Connect VIA, Start an AX.25 circuit thru digipeaters + * 'c' Connection with non-standard PID + * 'D' Send Connected Data + * 'd' Disconnect, Terminate an AX.25 Connection + * 'X' Register CallSign + * 'x' Unregister CallSign + * 'R' Request for version number. + * 'G' Ask about radio ports. + * 'g' Capabilities of a port. + * 'k' Ask to start receiving RAW AX25 frames. + * 'm' Ask to start receiving Monitor AX25 frames. + * 'V' Transmit UI data frame. + * 'H' Report recently heard stations. Not implemented yet in direwolf. + * 'K' Transmit raw AX.25 frame. + * 'y' Ask Outstanding frames waiting on a Port + * 'Y' How many frames waiting for transmit for a particular station + * + * + * The user supplied application must supply functions to handle or ignore + * messages that come from the TNC. Common examples: + * + * 'C' AX.25 Connection Received + * 'D' Connected AX.25 Data + * 'd' Disconnected + * 'R' Reply to Request for version number. + * 'G' Reply to Ask about radio ports. + * 'g' Reply to capabilities of a port. + * 'K' Received AX.25 frame in raw format. (Enabled with 'k' command.) + * 'U' Received AX.25 frame in monitor format. (Enabled with 'm' command.) + * 'y' Outstanding frames waiting on a Port + * 'Y' How many frames waiting for transmit for a particular station + * 'C' AX.25 Connection Received + * 'D' Connected AX.25 Data + * 'd' Disconnected + * + * + * + * References: AGWPE TCP/IP API Tutorial + * http://uz7ho.org.ua/includes/agwpeapi.htm + * + * Usage: See appclient.c and appserver.c for examples of how to use this. + * + *---------------------------------------------------------------*/ + + +#include "direwolf.h" // Sets _WIN32_WINNT for XP API level needed by ws2tcpip.h + +#if __WIN32__ +#include +#include // _WIN32_WINNT must be set to 0x0501 before including this +#else +#include +#include +#include +#include +#include +#include +#endif + +#include +#include +#include +#include +#include +#include + +#include "textcolor.h" +#include "dwsock.h" // socket helper functions. +#include "ax25_pad.h" // forAX25_MAX_PACKET_LEN +#include "agwlib.h" + + + + +/* + * Message header for AGW protocol. + * Multibyte numeric values require rearranging for big endian cpu. + */ + +/* + * With MinGW version 4.6, obviously x86. + * or Linux gcc version 4.9, Linux ARM. + * + * $ gcc -E -dM - < /dev/null | grep END + * #define __ORDER_LITTLE_ENDIAN__ 1234 + * #define __FLOAT_WORD_ORDER__ __ORDER_LITTLE_ENDIAN__ + * #define __ORDER_PDP_ENDIAN__ 3412 + * #define __ORDER_BIG_ENDIAN__ 4321 + * #define __BYTE_ORDER__ __ORDER_LITTLE_ENDIAN__ + * + * This is for standard OpenWRT on MIPS. + * + * #define __ORDER_LITTLE_ENDIAN__ 1234 + * #define __FLOAT_WORD_ORDER__ __ORDER_BIG_ENDIAN__ + * #define __ORDER_PDP_ENDIAN__ 3412 + * #define __ORDER_BIG_ENDIAN__ 4321 + * #define __BYTE_ORDER__ __ORDER_BIG_ENDIAN__ + * + * This was reported for an old Mac with PowerPC processor. + * (Newer versions have x86.) + * + * $ gcc -E -dM - < /dev/null | grep END + * #define __BIG_ENDIAN__ 1 + * #define _BIG_ENDIAN 1 + */ + + +#if defined(__BIG_ENDIAN__) || (defined(__BYTE_ORDER__) && defined(__ORDER_BIG_ENDIAN__) && __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__) + +// gcc >= 4.2 has __builtin_swap32() but might not be compatible with older versions or other compilers. + +#define host2netle(x) ( (((x)>>24)&0x000000ff) | (((x)>>8)&0x0000ff00) | (((x)<<8)&0x00ff0000) | (((x)<<24)&0xff000000) ) +#define netle2host(x) ( (((x)>>24)&0x000000ff) | (((x)>>8)&0x0000ff00) | (((x)<<8)&0x00ff0000) | (((x)<<24)&0xff000000) ) + +#else + +#define host2netle(x) (x) +#define netle2host(x) (x) + +#endif + + +struct agw_hdr_s { /* Command header. */ + + unsigned char portx; /* 0 for first, 1 for second, etc. */ + /* Dire Wolf uses the term "channel" to avoid confusion with TCP ports */ + /* or other places port might be used. */ + unsigned char reserved1; + unsigned char reserved2; + unsigned char reserved3; + + unsigned char datakind; /* Message type, usually written as a letter. */ + unsigned char reserved4; + unsigned char pid; + unsigned char reserved5; + + char call_from[10]; + + char call_to[10]; + + int data_len_NETLE; /* Number of data bytes following. */ + /* _NETLE suffix is reminder to convert for network byte order. */ + + int user_reserved_NETLE; +}; + + +struct agw_cmd_s { /* Complete command with header and data. */ + + struct agw_hdr_s hdr; /* Command header. */ + char data[AX25_MAX_PACKET_LEN]; /* Possible variable length data. */ +}; + + + +/*------------------------------------------------------------------- + * + * Name: agwlib_init + * + * Purpose: Attach to TNC over TCP. + * + * Inputs: host - Host name or address. Often "localhost". + * + * port - TCP port number as text. Usually "8000". + * + * init_func - Call this function after establishing communication + * with the TNC. We put it here, so that it can be done + * again automatically if the TNC disappears and we + * reattach to it. + * It must return 0 for success. + * Can be NULL if not needed. + * + * Returns: 0 for success, -1 for failure. + * + * Description: This starts up a thread which listens to the socket and + * dispatches the messages to the corresponding callback functions. + * It will also attempt to re-establish communication with the + * TNC if it goes away. + * + *--------------------------------------------------------------------*/ + + +static char s_tnc_host[80]; +static char s_tnc_port[8]; +static int s_tnc_sock; // Socket handle or file descriptor. +static int (*s_tnc_init_func)(void); // Call after establishing socket. + + +// TODO: define macros somewhere to hide platform specifics. + +#if __WIN32__ +#define THREAD_F unsigned __stdcall +#else +#define THREAD_F void * +#endif + +#if __WIN32__ +static HANDLE tnc_listen_th; +static THREAD_F tnc_listen_thread (void *arg); +#else +static pthread_t tnc_listen_tid; +static THREAD_F tnc_listen_thread (void *arg); +#endif + + +int agwlib_init (char *host, char *port, int (*init_func)(void)) +{ + char tncaddr[DWSOCK_IPADDR_LEN]; + int e; + + strlcpy (s_tnc_host, host, sizeof(s_tnc_host)); + strlcpy (s_tnc_port, port, sizeof(s_tnc_port)); + s_tnc_sock = -1; + s_tnc_init_func = init_func; + + dwsock_init(); + + s_tnc_sock = dwsock_connect (host, port, "TNC", 0, 0, tncaddr); + + if (s_tnc_sock == -1) { + return (-1); + } + + +/* + * Incoming messages are dispatched to application-supplied callback functions. + * If the TNC disappears, try to reestablish communication. + */ + + +#if __WIN32__ + tnc_listen_th = (HANDLE)_beginthreadex (NULL, 0, tnc_listen_thread, (void *)NULL, 0, NULL); + if (tnc_listen_th == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Internal error: Could not create TNC listening thread\n"); + return (-1); + } +#else + e = pthread_create (&tnc_listen_tid, NULL, tnc_listen_thread, (void *)NULL); + if (e != 0) { + text_color_set(DW_COLOR_ERROR); + perror("Internal error: Could not create TNC listening thread"); + return (-1); + } +#endif + +// TNC initialization if specified. + + if (s_tnc_init_func != NULL) { + e = (*s_tnc_init_func)(); + return (e); + } + + return (0); +} + + +/*------------------------------------------------------------------- + * + * Name: tnc_listen_thread + * + * Purpose: Listen for anything from TNC and process it. + * Reconnect if something goes wrong and we got disconnected. + * + * Inputs: s_tnc_host + * s_tnc_port + * + * Outputs: s_tnc_sock - File descriptor for communicating with TNC. + * Will be -1 if not connected. + * + *--------------------------------------------------------------------*/ + +static void process_from_tnc (struct agw_cmd_s *cmd); + + +#if __WIN32__ +static unsigned __stdcall tnc_listen_thread (void *arg) +#else +static void * tnc_listen_thread (void *arg) +#endif +{ + char tncaddr[DWSOCK_IPADDR_LEN]; + + struct agw_cmd_s cmd; + + while (1) { + +/* + * Connect to TNC if not currently connected. + */ + + if (s_tnc_sock == -1) { + + text_color_set(DW_COLOR_ERROR); + // I'm using the term "attach" here, in an attempt to + // avoid confusion with the AX.25 connect. + dw_printf ("Attempting to reattach to network TNC...\n"); + + s_tnc_sock = dwsock_connect (s_tnc_host, s_tnc_port, "TNC", 0, 0, tncaddr); + + if (s_tnc_sock != -1) { + dw_printf ("Successfully reattached to network TNC.\n"); + + // Might need to run TNC initialization again. + // For example, a server would register its callsigns. + + if (s_tnc_init_func != NULL) { + int e = (*s_tnc_init_func)(); + (void) e; + } + + } + SLEEP_SEC(5); + } + else { + int n = SOCK_RECV (s_tnc_sock, (char *)(&cmd.hdr), sizeof(cmd.hdr)); + + if (n == -1) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Lost communication with network TNC. Will try to reattach.\n"); + dwsock_close (s_tnc_sock); + s_tnc_sock = -1; + continue; + } + else if (n != sizeof(cmd.hdr)) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Error reading message header from network TNC.\n"); + dw_printf ("Tried to read %d bytes but got only %d.\n", (int)sizeof(cmd.hdr), n); + dw_printf ("Closing socket to TNC. Will try to reattach.\n"); + dwsock_close (s_tnc_sock); + s_tnc_sock = -1; + continue; + } + +/* + * Take some precautions to guard against bad data which could cause problems later. + */ + if (cmd.hdr.portx < 0 || cmd.hdr.portx >= MAX_CHANS) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Invalid channel number, %d, in command '%c', from network TNC.\n", + cmd.hdr.portx, cmd.hdr.datakind); + cmd.hdr.portx = 0; // avoid subscript out of bounds, try to keep going. + } + +/* + * Call to/from fields are 10 bytes but contents must not exceed 9 characters. + * It's not guaranteed that unused bytes will contain 0 so we + * don't issue error message in this case. + */ + cmd.hdr.call_from[sizeof(cmd.hdr.call_from)-1] = '\0'; + cmd.hdr.call_to[sizeof(cmd.hdr.call_to)-1] = '\0'; + +/* + * Following data must fit in available buffer. + * Leave room for an extra nul byte terminator at end later. + */ + + int data_len = netle2host(cmd.hdr.data_len_NETLE); + + if (data_len < 0 || data_len > (int)(sizeof(cmd.data) - 1)) { + + text_color_set(DW_COLOR_ERROR); + dw_printf ("Invalid message from network TNC.\n"); + dw_printf ("Data Length of %d is out of range.\n", data_len); + + /* This is a bad situation. */ + /* If we tried to read again, the header probably won't be there. */ + /* No point in trying to continue reading. */ + + dw_printf ("Closing connection to TNC.\n"); + dwsock_close (s_tnc_sock); + s_tnc_sock = -1; + continue; + } + + cmd.data[0] = '\0'; + + if (data_len > 0) { + n = SOCK_RECV (s_tnc_sock, cmd.data, data_len); + if (n != data_len) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Error getting message data from network TNC.\n"); + dw_printf ("Tried to read %d bytes but got only %d.\n", data_len, n); + dw_printf ("Closing socket to network TNC.\n\n"); + dwsock_close (s_tnc_sock); + s_tnc_sock = -1; + continue; + } + if (n >= 0) { + cmd.data[n] = '\0'; // Terminate so it can be used as a C string. + } + + process_from_tnc (&cmd); + + } // additional data after command header + } // s_tnc_sock != -1 + } // while (1) + + return (0); // unreachable but shutup warning. + +} // end tnc_listen_thread + + +/* + * The user supplied application must supply functions to handle or ignore + * messages that come from the TNC. + */ + +static void process_from_tnc (struct agw_cmd_s *cmd) +{ + int data_len = netle2host(cmd->hdr.data_len_NETLE); + //int session; + + + switch (cmd->hdr.datakind) { + + case 'C': // AX.25 Connection Received + { + //agw_cb_C_connection_received (cmd->hdr.portx, cmd->hdr.call_from, cmd->hdr.call_to, data_len, cmd->data); + // TODO: compute session id + // There are two different cases to consider here. + if (strncmp(cmd->data, "*** CONNECTED To Station", 24) == 0) { + // Incoming: Other station initiated the connect request. + on_C_connection_received (cmd->hdr.portx, cmd->hdr.call_from, cmd->hdr.call_to, 1, cmd->data); + } + else if (strncmp(cmd->data, "*** CONNECTED With Station", 26) == 0) { + // Outgoing: Other station accepted my connect request. + on_C_connection_received (cmd->hdr.portx, cmd->hdr.call_from, cmd->hdr.call_to, 0, cmd->data); + } + else { +// TBD + } + } + break; + + case 'D': // Connected AX.25 Data + // FIXME: should probably add pid here. + agw_cb_D_connected_data (cmd->hdr.portx, cmd->hdr.call_from, cmd->hdr.call_to, data_len, cmd->data); + break; + + case 'd': // Disconnected + agw_cb_d_disconnected (cmd->hdr.portx, cmd->hdr.call_from, cmd->hdr.call_to, data_len, cmd->data); + break; + + case 'R': // Reply to Request for version number. + break; + + case 'G': // Port Information. + // Data part should be fields separated by semicolon. + // First field is number of ports (we call them channels). + // Other fields are of the form "Port99 comment" where first is number 1. + { + int num_chan = 1; // FIXME: FIXME: actually parse it. + char *chans[20]; + chans[0] = "Port1 blah blah"; + chans[1] = "Port2 blah blah"; + agw_cb_G_port_information (num_chan, chans); + } + break; + +// TODO: Maybe fill in more someday. + + case 'g': // Reply to capabilities of a port. + break; + case 'K': // Received AX.25 frame in raw format. (Enabled with 'k' command.) + break; + case 'U': // Received AX.25 frame in monitor format. (Enabled with 'm' command.) + break; + case 'y': // Outstanding frames waiting on a Port + break; + + case 'Y': // How many frames waiting for transmit for a particular station + { + int *p = (int*)(cmd->data); + int frame_count = netle2host(*p); + agw_cb_Y_outstanding_frames_for_station (cmd->hdr.portx, cmd->hdr.call_from, cmd->hdr.call_to, frame_count); + } + break; + + default: + break; + } + +} // end process_from_tnc + + + +/*------------------------------------------------------------------- + * + * Name: agwlib_X_register_callsign + * + * Purpose: Tell TNC to accept incoming connect requests to given callsign. + * + * Inputs: chan - Radio channel number, first is 0. + * + * call_from - My callsign or alias. + * + * Returns: Number of bytes sent for success, -1 for error. + * + *--------------------------------------------------------------------*/ + +int agwlib_X_register_callsign (int chan, char *call_from) +{ + struct agw_cmd_s cmd; + + memset (&cmd.hdr, 0, sizeof(cmd.hdr)); + cmd.hdr.portx = chan; + cmd.hdr.datakind = 'X'; + strlcpy (cmd.hdr.call_from, call_from, sizeof(cmd.hdr.call_from)); + return (SOCK_SEND(s_tnc_sock, (char*)(&cmd), sizeof(cmd.hdr) + netle2host(cmd.hdr.data_len_NETLE))); +} + + +/*------------------------------------------------------------------- + * + * Name: agwlib_x_unregister_callsign + * + * Purpose: Tell TNC to stop accepting incoming connect requests to given callsign. + * + * Inputs: chan - Radio channel number, first is 0. + * + * call_from - My callsign or alias. + * + * Returns: Number of bytes sent for success, -1 for error. + * + * FIXME: question do we need channel here? + * + *--------------------------------------------------------------------*/ + +int agwlib_x_unregister_callsign (int chan, char *call_from) +{ + struct agw_cmd_s cmd; + + memset (&cmd.hdr, 0, sizeof(cmd.hdr)); + cmd.hdr.portx = chan; + cmd.hdr.datakind = 'x'; + strlcpy (cmd.hdr.call_from, call_from, sizeof(cmd.hdr.call_from)); + return (SOCK_SEND(s_tnc_sock, (char*)(&cmd), sizeof(cmd.hdr) + netle2host(cmd.hdr.data_len_NETLE))); +} + + +/*------------------------------------------------------------------- + * + * Name: agwlib_G_ask_port_information + * + * Purpose: Tell TNC to stop accepting incoming connect requests to given callsign. + * + * Inputs: call_from - My callsign or alias. + * + * Returns: 0 for success, -1 for error. TODO: all like this. + * + *--------------------------------------------------------------------*/ + +int agwlib_G_ask_port_information (void) +{ + struct agw_cmd_s cmd; + + memset (&cmd.hdr, 0, sizeof(cmd.hdr)); + cmd.hdr.datakind = 'G'; + int n = SOCK_SEND(s_tnc_sock, (char*)(&cmd), sizeof(cmd.hdr) + netle2host(cmd.hdr.data_len_NETLE)); + return (n > 0 ? 0 : -1); +} + + + +/*------------------------------------------------------------------- + * + * Name: agwlib_C_connect + * + * Purpose: Tell TNC to start sequence for connecting to remote station. + * + * Inputs: chan - Radio channel number, first is 0. + * + * call_from - My callsign. + * + * call_to - Callsign (or alias) of remote station. + * + * Returns: Number of bytes sent for success, -1 for error. + * + * Description: This only starts the sequence and does not wait. + * Success or failure will be indicated sometime later by ? + * + *--------------------------------------------------------------------*/ + +int agwlib_C_connect (int chan, char *call_from, char *call_to) +{ + struct agw_cmd_s cmd; + + memset (&cmd.hdr, 0, sizeof(cmd.hdr)); + cmd.hdr.portx = chan; + cmd.hdr.datakind = 'C'; + cmd.hdr.pid = 0xF0; // Shouldn't matter because this appears + // only in Information frame, not connect sequence. + strlcpy (cmd.hdr.call_from, call_from, sizeof(cmd.hdr.call_from)); + strlcpy (cmd.hdr.call_to, call_to, sizeof(cmd.hdr.call_to)); + return (SOCK_SEND(s_tnc_sock, (char*)(&cmd), sizeof(cmd.hdr) + netle2host(cmd.hdr.data_len_NETLE))); +} + + + +/*------------------------------------------------------------------- + * + * Name: agwlib_d_disconnect + * + * Purpose: Tell TNC to disconnect from remote station. + * + * Inputs: chan - Radio channel number, first is 0. + * + * call_from - My callsign. + * + * call_to - Callsign (or alias) of remote station. + * + * Returns: Number of bytes sent for success, -1 for error. + * + * Description: This only starts the sequence and does not wait. + * Success or failure will be indicated sometime later by ? + * + *--------------------------------------------------------------------*/ + +int agwlib_d_disconnect (int chan, char *call_from, char *call_to) +{ + struct agw_cmd_s cmd; + + memset (&cmd.hdr, 0, sizeof(cmd.hdr)); + cmd.hdr.portx = chan; + cmd.hdr.datakind = 'd'; + strlcpy (cmd.hdr.call_from, call_from, sizeof(cmd.hdr.call_from)); + strlcpy (cmd.hdr.call_to, call_to, sizeof(cmd.hdr.call_to)); + return (SOCK_SEND(s_tnc_sock, (char*)(&cmd), sizeof(cmd.hdr) + netle2host(cmd.hdr.data_len_NETLE))); +} + + + +/*------------------------------------------------------------------- + * + * Name: agwlib_D_send_connected_data + * + * Purpose: Send connected data to remote station. + * + * Inputs: chan - Radio channel number, first is 0. + * + * pid - Protocol ID. Normally 0xFo for Ax.25. + * + * call_from - My callsign. + * + * call_to - Callsign (or alias) of remote station. + * + * data_len - Number of bytes for Information part. + * + * data - Content for Information part. + * + * Returns: Number of bytes sent for success, -1 for error. + * + * Description: This should only be done when we are known to have + * an established link to other station. + * + *--------------------------------------------------------------------*/ + +int agwlib_D_send_connected_data (int chan, int pid, char *call_from, char *call_to, int data_len, char *data) +{ + struct agw_cmd_s cmd; + + memset (&cmd.hdr, 0, sizeof(cmd.hdr)); + cmd.hdr.portx = chan; + cmd.hdr.datakind = 'D'; + cmd.hdr.pid = pid; // Normally 0xF0 but other special cases are possible. + strlcpy (cmd.hdr.call_from, call_from, sizeof(cmd.hdr.call_from)); + strlcpy (cmd.hdr.call_to, call_to, sizeof(cmd.hdr.call_to)); + cmd.hdr.data_len_NETLE = host2netle(data_len); + +// FIXME: DANGER possible buffer overflow, Need checking. + + assert (data_len <= sizeof(cmd.data)); + + memcpy (cmd.data, data, data_len); + return (SOCK_SEND(s_tnc_sock, (char*)(&cmd), sizeof(cmd.hdr) + netle2host(cmd.hdr.data_len_NETLE))); +} + + +/*------------------------------------------------------------------- + * + * Name: agwlib_Y_outstanding_frames_for_station + * + * Purpose: Ask how many frames remain to be sent to station on other end of link. + * + * Inputs: chan - Radio channel number, first is 0. + * + * call_from - My call [ or is it Station which initiated the link? (sent SABM/SABME) ] + * + * call_to - Remote station call [ or is it Station which accepted the link? ] + * + * Returns: Number of bytes sent for success, -1 for error. + * + * Description: We expect to get a 'Y' frame response shortly. + * + * This would be useful for a couple different purposes. + * + * When sending bulk data, we want to keep a fair amount queued up to take + * advantage of large window sizes (MAXFRAME, EMAXFRAME). On the other + * hand we don't want to get TOO far ahead when transferring a large file. + * + * Before disconnecting from another station, it would be good to know + * that it actually received the last message we sent. For this reason, + * I think it would be good for this to include frames that were + * transmitted but not yet acknowledged. (Even if it was transmitted once, + * it could still be transmitted again, if lost, so you could say it is + * still waiting for transmission.) + * + * See server.c for a more precise definition of exactly how this is defined. + * + *--------------------------------------------------------------------*/ + +int agwlib_Y_outstanding_frames_for_station (int chan, char *call_from, char *call_to) +{ + struct agw_cmd_s cmd; + + memset (&cmd.hdr, 0, sizeof(cmd.hdr)); + cmd.hdr.portx = chan; + cmd.hdr.datakind = 'Y'; + strlcpy (cmd.hdr.call_from, call_from, sizeof(cmd.hdr.call_from)); + strlcpy (cmd.hdr.call_to, call_to, sizeof(cmd.hdr.call_to)); + return (SOCK_SEND(s_tnc_sock, (char*)(&cmd), sizeof(cmd.hdr) + netle2host(cmd.hdr.data_len_NETLE))); +} + + + +/* end agwlib.c */ diff --git a/src/agwlib.h b/src/agwlib.h new file mode 100644 index 00000000..688f9184 --- /dev/null +++ b/src/agwlib.h @@ -0,0 +1,45 @@ + +#ifndef AGWLIB_H +#define AGWLIB_H 1 + + +// Call at beginning to start it up. + +int agwlib_init (char *host, char *port, int (*init_func)(void)); + + + +// Send commands to TNC. + + +int agwlib_X_register_callsign (int chan, char *call_from); + +int agwlib_x_unregister_callsign (int chan, char *call_from); + +int agwlib_G_ask_port_information (void); + +int agwlib_C_connect (int chan, char *call_from, char *call_to); + +int agwlib_d_disconnect (int chan, char *call_from, char *call_to); + +int agwlib_D_send_connected_data (int chan, int pid, char *call_from, char *call_to, int data_len, char *data); + +int agwlib_Y_outstanding_frames_for_station (int chan, char *call_from, char *call_to); + + + +// The application must define these. + +void agw_cb_C_connection_received (int chan, char *call_from, char *call_to, int data_len, char *data); +void on_C_connection_received (int chan, char *call_from, char *call_to, int incoming, char *data); + +void agw_cb_d_disconnected (int chan, char *call_from, char *call_to, int data_len, char *data); + +void agw_cb_D_connected_data (int chan, char *call_from, char *call_to, int data_len, char *data); + +void agw_cb_G_port_information (int num_chan, char *chan_descriptions[]); + +void agw_cb_Y_outstanding_frames_for_station (int chan, char *call_from, char *call_to, int frame_count); + + +#endif \ No newline at end of file diff --git a/src/ais.c b/src/ais.c new file mode 100644 index 00000000..938fa012 --- /dev/null +++ b/src/ais.c @@ -0,0 +1,710 @@ + +// This file is part of Dire Wolf, an amateur radio packet TNC. +// +// Copyright (C) 2020 John Langner, WB2OSZ +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . +// + + +/******************************************************************************** + * + * File: ais.c + * + * Purpose: Functions for processing received AIS transmissions and + * converting to NMEA sentence representation. + * + * References: AIVDM/AIVDO protocol decoding by Eric S. Raymond + * https://gpsd.gitlab.io/gpsd/AIVDM.html + * + * Sample recording with about 100 messages. Test with "atest -B AIS xxx.wav" + * https://github.com/freerange/ais-on-sdr/wiki/example-data/long-beach-160-messages.wav + * + * Useful on-line decoder for AIS NMEA sentences. + * https://www.aggsoft.com/ais-decoder.htm + * + * Future? Add an interface to feed AIS data into aprs.fi. + * https://aprs.fi/page/ais_feeding + * + *******************************************************************************/ + +#include "direwolf.h" + +#include +#include +#include +#include +#include + +#include "textcolor.h" +#include "ais.h" + +// Lengths, in bits, for the AIS message types. + +#define NUM_TYPES 27 +static const struct { + short min; + short max; +} valid_len[NUM_TYPES+1] = { + { -1, -1 }, // 0 not used + { 168, 168 }, // 1 + { 168, 168 }, // 2 + { 168, 168 }, // 3 + { 168, 168 }, // 4 + { 424, 424 }, // 5 + { 72, 1008 }, // 6 multipurpose + { 72, 168 }, // 7 increments of 32 bits + { 168, 1008 }, // 8 multipurpose + { 168, 168 }, // 9 + { 72, 72 }, // 10 + { 168, 168 }, // 11 + { 72, 1008 }, // 12 + { 72, 168 }, // 13 increments of 32 bits + { 40, 1008 }, // 14 + { 88, 160 }, // 15 + { 96, 114 }, // 16 96 or 114, not range + { 80, 816 }, // 17 + { 168, 168 }, // 18 + { 312, 312 }, // 19 + { 72, 160 }, // 20 + { 272, 360 }, // 21 + { 168, 168 }, // 22 + { 160, 160 }, // 23 + { 160, 168 }, // 24 + { 40, 168 }, // 25 + { 60, 1064 }, // 26 + { 96, 168 } // 27 96 or 168, not range +}; + +static void save_ship_data(char *mssi, char *shipname, char *callsign, char *destination); +static void get_ship_data(char *mssi, char *comment, int comment_size); + + +/*------------------------------------------------------------------- + * + * Functions to get and set element of a bit vector. + * + *--------------------------------------------------------------------*/ + +static const unsigned char mask[8] = { 0x80, 0x40, 0x20, 0x10, 0x08, 0x04, 0x02, 0x01 }; + +static inline unsigned int get_bit (unsigned char *base, unsigned int offset) +{ + return ( (base[offset >> 3] & mask[offset & 0x7]) != 0); +} + +static inline void set_bit (unsigned char *base, unsigned int offset, int val) +{ + if (val) { + base[offset >> 3] |= mask[offset & 0x7]; + } + else { + base[offset >> 3] &= ~ mask[offset & 0x7]; + } +} + + +/*------------------------------------------------------------------- + * + * Extract a variable length field from a bit vector. + * + *--------------------------------------------------------------------*/ + +static unsigned int get_field (unsigned char *base, unsigned int start, unsigned int len) +{ + unsigned int result = 0; + for (int k = 0; k < len; k++) { + result <<= 1; + result |= get_bit (base, start + k); + } + return (result); +} + +static void set_field (unsigned char *base, unsigned int start, unsigned int len, unsigned int val) +{ + for (int k = 0; k < len; k++) { + set_bit (base, start + k, (val >> (len - 1 - k) ) & 1); + } +} + + +static int get_field_signed (unsigned char *base, unsigned int start, unsigned int len) +{ + int result = (int) get_field(base, start, len); + // Sign extend. + result <<= (32 - len); + result >>= (32 - len); + return (result); +} + +static double get_field_lat (unsigned char *base, unsigned int start, unsigned int len) +{ + // Latitude of 0x3412140 (91 deg) means not available. + // Message type 27 uses lower resolution, 17 bits rather than 27. + // It encodes minutes/10 rather than normal minutes/10000. + + int n = get_field_signed(base, start, len); + if (len == 17) { + return ((n == 91*600) ? G_UNKNOWN : (double)n / 600.0); + } + else { + return ((n == 91*600000) ? G_UNKNOWN : (double)n / 600000.0); + } +} + +static double get_field_lon (unsigned char *base, unsigned int start, unsigned int len) +{ + // Longitude of 0x6791AC0 (181 deg) means not available. + // Message type 27 uses lower resolution, 18 bits rather than 28. + // It encodes minutes/10 rather than normal minutes/10000. + + int n = get_field_signed(base, start, len); + if (len == 18) { + return ((n == 181*600) ? G_UNKNOWN : (double)n / 600.0); + } + else { + return ((n == 181*600000) ? G_UNKNOWN : (double)n / 600000.0); + } +} + +static float get_field_speed (unsigned char *base, unsigned int start, unsigned int len) +{ + // Raw 1023 means not available. + // Multiply by 0.1 to get knots. + // For aircraft it is knots, not deciknots. + + // Message type 27 uses lower resolution, 6 bits rather than 10. + // It encodes minutes/10 rather than normal minutes/10000. + + int n = get_field(base, start, len); + if (len == 6) { + return ((n == 63) ? G_UNKNOWN : (float)n); + } + else { + return ((n == 1023) ? G_UNKNOWN : (float)n * 0.1); + } +} + +static float get_field_course (unsigned char *base, unsigned int start, unsigned int len) +{ + // Raw 3600 means not available. + // Multiply by 0.1 to get degrees + // Message type 27 uses lower resolution, 9 bits rather than 12. + // It encodes degrees rather than normal degrees/10. + + int n = get_field(base, start, len); + if (len == 9) { + return ((n == 360) ? G_UNKNOWN : (float)n); + } + else { + return ((n == 3600) ? G_UNKNOWN : (float)n * 0.1); + } +} + +static int get_field_ascii (unsigned char *base, unsigned int start, unsigned int len) +{ + assert (len == 6); + int ch = get_field(base, start, len); + if (ch < 32) ch += 64; + return (ch); +} + +static void get_field_string (unsigned char *base, unsigned int start, unsigned int len, char *result) +{ + assert (len % 6 == 0); + int nc = len / 6; // Number of characters. + // Caller better provide space for at least this +1. + // No bounds checking here. + for (int i = 0; i < nc; i++) { + result[i] = get_field_ascii (base, start + i * 6, 6); + } + result[nc] = '\0'; + // Officially it should be terminated/padded with @ but we also see trailing spaces. + char *p = strchr(result, '@'); + if (p != NULL) *p = '\0'; + for (int k = strlen(result) - 1; k >= 0 && result[k] == ' '; k--) { + result[k] = '\0'; + } +} + + + +/*------------------------------------------------------------------- + * + * Convert between 6 bit values and printable characters used in + * in the AIS NMEA sentences. + * + *--------------------------------------------------------------------*/ + +// Characters '0' thru 'W' become values 0 thru 39. +// Characters '`' thru 'w' become values 40 thru 63. + +static int char_to_sextet (char ch) +{ + if (ch >= '0' && ch <= 'W') { + return (ch - '0'); + } + else if (ch >= '`' && ch <= 'w') { + return (ch - '`' + 40); + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Invalid character \"%c\" found in AIS NMEA sentence payload.\n", ch); + return (0); + } +} + + +// Values 0 thru 39 become characters '0' thru 'W'. +// Values 40 thru 63 become characters '`' thru 'w'. +// This is known as "Payload Armoring." + +static int sextet_to_char (int val) +{ + if (val >= 0 && val <= 39) { + return ('0' + val); + } + else if (val >= 40 && val <= 63) { + return ('`' + val - 40); + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Invalid 6 bit value %d from AIS HDLC payload.\n", val); + return ('0'); + } +} + + +/*------------------------------------------------------------------- + * + * Convert AIS binary block (from HDLC frame) to NMEA sentence. + * + * In: Pointer to AIS binary block and number of bytes. + * Out: NMEA sentence. Provide size to avoid string overflow. + * + *--------------------------------------------------------------------*/ + +void ais_to_nmea (unsigned char *ais, int ais_len, char *nmea, int nmea_size) +{ + char payload[256]; + // Number of resulting characters for payload. + int ns = (ais_len * 8 + 5) / 6; + if (ns+1 > sizeof(payload)) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("AIS HDLC payload of %d bytes is too large.\n", ais_len); + ns = sizeof(payload) - 1; + } + for (int k = 0; k < ns; k++) { + payload[k] = sextet_to_char(get_field(ais, k*6, 6)); + } + payload[ns] = '\0'; + + strlcpy (nmea, "!AIVDM,1,1,,A,", nmea_size); + strlcat (nmea, payload, nmea_size); + + // If the number of bytes in is not a multiple of 3, this does not + // produce a whole number of characters out. Extra padding bits were + // added to get the last character. Include this number so the + // decoding application can drop this number of bits from the end. + // At least, I think that is the way it should work. + // The examples all have 0. + char pad_bits[8]; + snprintf (pad_bits, sizeof(pad_bits), ",%d", ns * 6 - ais_len * 8); + strlcat (nmea, pad_bits, nmea_size); + + // Finally the NMEA style checksum. + int cs = 0; + for (char *p = nmea + 1; *p != '\0'; p++) { + cs ^= *p; + } + char checksum[8]; + snprintf (checksum, sizeof(checksum), "*%02X", cs & 0x7f); + strlcat (nmea, checksum, nmea_size); +} + + +/*------------------------------------------------------------------- + * + * Name: ais_parse + * + * Purpose: Parse AIS sentence and extract interesting parts. + * + * Inputs: sentence NMEA sentence. + * + * quiet Suppress printing of error messages. + * + * Outputs: descr Description of AIS message type. + * mssi 9 digit identifier. + * odlat latitude. + * odlon longitude. + * ofknots speed, knots. + * ofcourse direction of travel. + * ofalt_m altitude, meters. + * symtab APRS symbol table. + * symbol APRS symbol code. + * + * Returns: 0 for success, -1 for error. + * + *--------------------------------------------------------------------*/ + +// Maximum NMEA sentence length is 82, including CR/LF. +// Make buffer considerably larger to be safe. +#define NMEA_MAX_LEN 240 + +int ais_parse (char *sentence, int quiet, char *descr, int descr_size, char *mssi, int mssi_size, double *odlat, double *odlon, + float *ofknots, float *ofcourse, float *ofalt_m, char *symtab, char *symbol, char *comment, int comment_size) +{ + char stemp[NMEA_MAX_LEN]; /* Make copy because parsing is destructive. */ + + strlcpy (mssi, "?", mssi_size); + *odlat = G_UNKNOWN; + *odlon = G_UNKNOWN; + *ofknots = G_UNKNOWN; + *ofcourse = G_UNKNOWN; + *ofalt_m = G_UNKNOWN; + + strlcpy (stemp, sentence, sizeof(stemp)); + +// Verify and remove checksum. + + unsigned char cs = 0; + char *p; + + for (p = stemp+1; *p != '*' && *p != '\0'; p++) { + cs ^= *p; + } + + p = strchr (stemp, '*'); + if (p == NULL) { + if ( ! quiet) { + text_color_set (DW_COLOR_INFO); + dw_printf("Missing AIS sentence checksum.\n"); + } + return (-1); + } + if (cs != strtoul(p+1, NULL, 16)) { + if ( ! quiet) { + text_color_set (DW_COLOR_ERROR); + dw_printf("AIS sentence checksum error. Expected %02x but found %s.\n", cs, p+1); + } + return (-1); + } + *p = '\0'; // Remove the checksum. + +// Extract the comma separated fields. + + char *next; + + char *talker; /* Expecting !AIVDM */ + char *frag_count; /* ignored */ + char *frag_num; /* ignored */ + char *msg_id; /* ignored */ + char *radio_chan; /* ignored */ + char *payload; /* Encoded as 6 bits per character. */ + char *fill_bits; /* Number of bits to discard. */ + + next = stemp; + talker = strsep(&next, ","); + frag_count = strsep(&next, ","); + frag_num = strsep(&next, ","); + msg_id = strsep(&next, ","); + radio_chan = strsep(&next, ","); + payload = strsep(&next, ","); + fill_bits = strsep(&next, ","); + + /* Suppress the 'set but not used' compiler warnings. */ + /* Alternatively, we might use __attribute__((unused)) */ + + (void)(talker); + (void)(frag_count); + (void)(frag_num); + (void)(msg_id); + (void)(radio_chan); + + if (payload == NULL || strlen(payload) == 0) { + if ( ! quiet) { + text_color_set (DW_COLOR_ERROR); + dw_printf("Payload is missing from AIS sentence.\n"); + } + return (-1); + } + +// Convert character representation to bit vector. + + unsigned char ais[256]; + memset (ais, 0, sizeof(ais)); + + int plen = strlen(payload); + + for (int k = 0; k < plen; k++) { + set_field (ais, k*6, 6, char_to_sextet(payload[k])); + } + +// Verify number of filler bits. + + int nfill = atoi(fill_bits); + int nbytes = (plen * 6) / 8; + + if (nfill != plen * 6 - nbytes * 8) { + if ( ! quiet) { + text_color_set (DW_COLOR_ERROR); + dw_printf("Number of filler bits is %d when %d is expected.\n", + nfill, plen * 6 - nbytes * 8); + } + } + + +// Extract the fields of interest from a few message types. +// Don't get too carried away. + + int type = get_field(ais, 0, 6); + + if (type >= 1 && type <= 27) { + snprintf (mssi, mssi_size, "%09d", get_field(ais, 8, 30)); + } + switch (type) { + + case 1: // Position Report Class A + case 2: + case 3: + + snprintf (descr, descr_size, "AIS %d: Position Report Class A", type); + *symtab = '/'; + *symbol = 's'; // Power boat (ship) side view + *odlon = get_field_lon(ais, 61, 28); + *odlat = get_field_lat(ais, 89, 27); + *ofknots = get_field_speed(ais, 50, 10); + *ofcourse = get_field_course(ais, 116, 12); + get_ship_data(mssi, comment, comment_size); + break; + + case 4: // Base Station Report + + snprintf (descr, descr_size, "AIS %d: Base Station Report", type); + *symtab = '\\'; + *symbol = 'L'; // Lighthouse + //year = get_field(ais, 38, 14); + //month = get_field(ais, 52, 4); + //day = get_field(ais, 56, 5); + //hour = get_field(ais, 61, 5); + //minute = get_field(ais, 66, 6); + //second = get_field(ais, 72, 6); + *odlon = get_field_lon(ais, 79, 28); + *odlat = get_field_lat(ais, 107, 27); + // Is this suitable or not? Doesn't hurt, I suppose. + get_ship_data(mssi, comment, comment_size); + break; + + case 5: // Static and Voyage Related Data + + snprintf (descr, descr_size, "AIS %d: Static and Voyage Related Data", type); + *symtab = '/'; + *symbol = 's'; // Power boat (ship) side view + { + char callsign[12]; + char shipname[24]; + char destination[24]; + get_field_string(ais, 70, 42, callsign); + get_field_string(ais, 112, 120, shipname); + get_field_string(ais, 302, 120, destination); + save_ship_data(mssi, shipname, callsign, destination); + get_ship_data(mssi, comment, comment_size); + } + break; + + + case 9: // Standard SAR Aircraft Position Report + + snprintf (descr, descr_size, "AIS %d: SAR Aircraft Position Report", type); + *symtab = '/'; + *symbol = '\''; // Small AIRCRAFT + *ofalt_m = get_field(ais, 38, 12); // meters, 4095 means not available + *odlon = get_field_lon(ais, 61, 28); + *odlat = get_field_lat(ais, 89, 27); + *ofknots = get_field_speed(ais, 50, 10); // plane is knots, not knots/10 + if (*ofknots != G_UNKNOWN) *ofknots = *ofknots * 10.0; + *ofcourse = get_field_course(ais, 116, 12); + get_ship_data(mssi, comment, comment_size); + break; + + case 18: // Standard Class B CS Position Report + // As an oversimplification, Class A is commercial, B is recreational. + + snprintf (descr, descr_size, "AIS %d: Standard Class B CS Position Report", type); + *symtab = '/'; + *symbol = 'Y'; // YACHT (sail) + *odlon = get_field_lon(ais, 57, 28); + *odlat = get_field_lat(ais, 85, 27); + get_ship_data(mssi, comment, comment_size); + break; + + case 19: // Extended Class B CS Position Report + + snprintf (descr, descr_size, "AIS %d: Extended Class B CS Position Report", type); + *symtab = '/'; + *symbol = 'Y'; // YACHT (sail) + *odlon = get_field_lon(ais, 57, 28); + *odlat = get_field_lat(ais, 85, 27); + get_ship_data(mssi, comment, comment_size); + break; + + case 27: // Long Range AIS Broadcast message + + snprintf (descr, descr_size, "AIS %d: Long Range AIS Broadcast message", type); + *symtab = '\\'; + *symbol = 's'; // OVERLAY SHIP/boat (top view) + *odlon = get_field_lon(ais, 44, 18); // Note: minutes/10 rather than usual /10000. + *odlat = get_field_lat(ais, 62, 17); + *ofknots = get_field_speed(ais, 79, 6); // Note: knots, not deciknots. + *ofcourse = get_field_course(ais, 85, 9); // Note: degrees, not decidegrees. + get_ship_data(mssi, comment, comment_size); + break; + + default: + snprintf (descr, descr_size, "AIS message type %d", type); + break; + } + + return (0); + +} /* end ais_parse */ + + + +/*------------------------------------------------------------------- + * + * Name: ais_check_length + * + * Purpose: Verify frame length against expected. + * + * Inputs: type Message type, 1 - 27. + * + * length Number of data octets in in frame. + * + * Returns: -1 Invalid message type. + * 0 Good length. + * 1 Unexpected length. + * + *--------------------------------------------------------------------*/ + +int ais_check_length (int type, int length) +{ + if (type >= 1 && type <= NUM_TYPES) { + int b = length * 8; + if (b >= valid_len[type].min && b <= valid_len[type].max) { + return (0); // Good. + } + else { + //text_color_set (DW_COLOR_ERROR); + //dw_printf("AIS ERROR: type %d, has %d bits when %d to %d expected.\n", + // type, b, valid_len[type].min, valid_len[type].max); + return (1); // Length out of range. + } + } + else { + //text_color_set (DW_COLOR_ERROR); + //dw_printf("AIS ERROR: message type %d is invalid.\n", type); + return (-1); // Invalid type. + } + +} // end ais_check_length + + + +/*------------------------------------------------------------------- + * + * Name: save_ship_data + * + * Purpose: Save shipname, etc., from "Static and Voyage Related Data" + * so it can be combined later with the position reports. + * + * Inputs: mssi + * shipname + * callsign + * destination + * + *--------------------------------------------------------------------*/ + +struct ship_data_s { + struct ship_data_s *pnext; + char mssi[9+1]; + char shipname[20+1]; + char callsign[7+1]; + char destination[20+1]; +}; + +// Just use a single linked list for now. +// If I get ambitious, I might use a hash table. +// I don't think we need a critical region because all channels +// should be serialized thru the receive queue. + +static struct ship_data_s *ships = NULL; + + +static void save_ship_data(char *mssi, char *shipname, char *callsign, char *destination) +{ + // Get list node, either existing or new. + struct ship_data_s *p = ships; + while (p != NULL) { + if (strcmp(mssi, p->mssi) == 0) { + break; + } + p = p->pnext; + } + if (p == NULL) { + p = calloc(sizeof(struct ship_data_s),1); + p->pnext = ships; + ships = p; + } + + strlcpy (p->mssi, mssi, sizeof(p->mssi)); + strlcpy (p->shipname, shipname, sizeof(p->shipname)); + strlcpy (p->callsign, callsign, sizeof(p->callsign)); + strlcpy (p->destination, destination, sizeof(p->destination)); +} + +/*------------------------------------------------------------------- + * + * Name: save_ship_data + * + * Purpose: Get ship data for specified mssi. + * + * Inputs: mssi + * + * Outputs: comment - If mssi is found, return in single string here, + * suitable for the comment field. + * + *--------------------------------------------------------------------*/ + +static void get_ship_data(char *mssi, char *comment, int comment_size) +{ + struct ship_data_s *p = ships; + while (p != NULL) { + if (strcmp(mssi, p->mssi) == 0) { + break; + } + p = p->pnext; + } + if (p != NULL) { + if (strlen(p->destination) > 0) { + snprintf (comment, comment_size, "%s, %s, dest. %s", p->shipname, p->callsign, p->destination); + } + else { + snprintf (comment, comment_size, "%s, %s", p->shipname, p->callsign); + } + } +} + + +// end ais.c diff --git a/src/ais.h b/src/ais.h new file mode 100644 index 00000000..6b962884 --- /dev/null +++ b/src/ais.h @@ -0,0 +1,8 @@ + + +void ais_to_nmea (unsigned char *ais, int ais_len, char *nema, int nema_size); + +int ais_parse (char *sentence, int quiet, char *descr, int descr_size, char *mssi, int mssi_size, double *odlat, double *odlon, + float *ofknots, float *ofcourse, float *ofalt_m, char *symtab, char *symbol, char *comment, int comment_size); + +int ais_check_length (int type, int length); diff --git a/src/appserver.c b/src/appserver.c new file mode 100644 index 00000000..b0ef7d87 --- /dev/null +++ b/src/appserver.c @@ -0,0 +1,741 @@ +// ****** PRELIMINARY - needs work ****** + +#define DEBUG 1 + + +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// + + + +#include "direwolf.h" + +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include "ax25_pad.h" +#include "textcolor.h" +#include "agwlib.h" // Network TNC interface. + + +/*------------------------------------------------------------------ + * + * Module: appserver.c + * + * Purpose: Simple application server for connected mode AX.25. + * + * This demonstrates how you can write a application that will wait for + * a connection from another station and respond to commands. + * It can be used as a starting point for developing your own applications. + * + * Description: This attaches to an instance of Dire Wolf via the AGW network interface. + * It processes commands from other radio stations and responds. + * + *---------------------------------------------------------------*/ + + +static void usage() +{ + text_color_set(DW_COLOR_ERROR); + dw_printf ("Usage: \n"); + dw_printf (" \n"); + dw_printf ("appserver [ -h hostname ] [ -p port ] mycall \n"); + dw_printf (" \n"); + dw_printf (" -h hostname for TNC. Default is localhost. \n"); + dw_printf (" \n"); + dw_printf (" -p tcp port for TNC. Default is 8000. \n"); + dw_printf (" \n"); + dw_printf (" mycall is required because that is the callsign for \n"); + dw_printf (" which the TNC will accept connections. \n"); + dw_printf (" \n"); + exit (EXIT_FAILURE); +} + + + + + +static char mycall[AX25_MAX_ADDR_LEN]; /* Callsign, with SSID, for the application. */ + /* Future? Could have multiple applications, on the same */ + /* radio channel, each with its own SSID. */ + +static char tnc_hostname[80]; /* DNS host name or IPv4 address. */ + /* Some of the code is there for IPv6 but */ + /* needs more work. */ + /* Defaults to "localhost" if not specified. */ + +static char tnc_port[8]; /* a TCP port number. Default 8000. */ + + + +/* + * Maintain information about connections from users which we will call "sessions." + * It should be possible to have multiple users connected at the same time. + * + * This allows a "who" command to see who is currently connected and a place to keep + * possible state information for each user. + * + * Each combination of channel & callsign is a separate session. + * The same user (callsign), on a different channel, is a different session. + */ + + +struct session_s { + + char client_addr[AX25_MAX_ADDR_LEN]; // Callsign of other station. + // Clear to mean this table entry is not in use. + + int channel; // Radio channel. + + time_t login_time; // Time when connection established. + +// For the timing test. +// Send specified number of frames, optional length. +// When finished summarize with statistics. + + time_t tt_start_time; + volatile int tt_count; // Number to send. + int tt_length; // Bytes in info part. + int tt_next; // Next sequence to send. + + volatile int tx_queue_len; // Number in transmit queue. For flow control. +}; + +#define MAX_SESSIONS 12 + +static struct session_s session[MAX_SESSIONS]; + +static int find_session (int chan, char *addr, int create); +static void poll_timing_test (void); + + + +/*------------------------------------------------------------------ + * + * Name: main + * + * Purpose: Attach to Dire Wolf TNC, wait for requests from users. + * + * Usage: Described above. + * + *---------------------------------------------------------------*/ + + +int main (int argc, char *argv[]) +{ + int c; + char *p; + +#if __WIN32__ + setvbuf(stdout, NULL, _IONBF, 0); +#else + setlinebuf (stdout); +#endif + + memset (session, 0, sizeof(session)); + + strlcpy (tnc_hostname, "localhost", sizeof(tnc_hostname)); + strlcpy (tnc_port, "8000", sizeof(tnc_port)); + +/* + * Extract command line args. + */ + + while ((c = getopt (argc, argv, "h:p:")) != -1) { + switch (c) { + + case 'h': + strlcpy (tnc_hostname, optarg, sizeof(tnc_hostname)); + break; + + case 'p': + strlcpy (tnc_port, optarg, sizeof(tnc_port)); + break; + + default: + usage (); + } + } + + if (argv[optind] == NULL) { + usage (); + } + + strlcpy (mycall, argv[optind], sizeof(mycall)); + + // Force to upper case. + for (p = mycall; *p != '\0'; p++) { + if (islower(*p)) { + *p = toupper(*p); + } + } + +/* + * Establish a TCP socket to the network TNC. + * It starts up a thread, which listens for messages from the TNC, + * and calls the corresponding agw_cb_... callback functions. + * + * After attaching to the TNC, the specified init function is called. + * We pass it to the library, rather than doing it here, so it can + * repeated automatically if the TNC goes away and comes back again. + * We need to reestablish what it knows about the application. + */ + + if (agwlib_init (tnc_hostname, tnc_port, agwlib_G_ask_port_information) != 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Could not attach to network TNC %s:%s.\n", tnc_hostname, tnc_port); + exit (EXIT_FAILURE); + } + + +/* + * Send command to ask what channels are available. + * The response will be handled by agw_cb_G_port_information. + */ +// FIXME: Need to do this again if we lose TNC and reattach to it. + + /// should happen automatically now. agwlib_G_ask_port_information (); + + + while (1) { + SLEEP_SEC(1); // other places based on 1 second assumption. + poll_timing_test (); + } + + +} /* end main */ + + + +static void poll_timing_test (void) +{ + int s; + for (s = 0; s < MAX_SESSIONS; s++) { + + if (session[s].tt_count == 0) { + continue; // nothing to do + } + else if (session[s].tt_next <= session[s].tt_count) { + int rem = session[s].tt_count - session[s].tt_next + 1; // remaining to send. + agwlib_Y_outstanding_frames_for_station (session[s].channel, mycall, session[s].client_addr); + SLEEP_MS(10); + if (session[s].tx_queue_len > 128) continue; // enough queued up for now. + if (rem > 64) rem = 64; // add no more than 64 at a time. + int i; + for (i = 0; i < rem; i++) { + char c = 'a'; + char stuff[AX25_MAX_INFO_LEN+2]; + snprintf (stuff, sizeof(stuff), "%06d ", session[s].tt_next); + int k; + for (k = strlen(stuff); k < session[s].tt_length - 1; k++) { + stuff[k] = c; + c++; + if (c == 'z' + 1) c = 'A'; + if (c == 'Z' + 1) c = '0'; + if (c == '9' + 1) c = 'a'; + } + stuff[k++] = '\r'; + stuff[k++] = '\0'; + agwlib_D_send_connected_data (session[s].channel, 0xF0, mycall, session[s].client_addr, strlen(stuff), stuff); + session[s].tt_next++; + } + } + else { + // All done queuing up the packets. + // Wait until they have all been sent and ack'ed by other end. + + agwlib_Y_outstanding_frames_for_station (session[s].channel, mycall, session[s].client_addr); + SLEEP_MS(10); + + if (session[s].tx_queue_len > 0) continue; // not done yet. + + int elapsed = time(NULL) - session[s].tt_start_time; + if (elapsed <= 0) elapsed = 1; // avoid divide by 0 + + int byte_count = session[s].tt_count * session[s].tt_length; + char summary[100]; + snprintf (summary, sizeof(summary), "%d bytes in %d seconds, %d bytes/sec, efficiency %d%% at 1200, %d%% at 9600.\r", + byte_count, elapsed, byte_count/elapsed, + byte_count * 8 * 100 / elapsed / 1200, + byte_count * 8 * 100 / elapsed / 9600); + + agwlib_D_send_connected_data (session[s].channel, 0xF0, mycall, session[s].client_addr, strlen(summary), summary); + session[s].tt_count = 0; // all done. + } + } + +} // end poll_timing_test + + + +/*------------------------------------------------------------------- + * + * Name: agw_cb_C_connection_received + * + * Purpose: Callback for the "connection received" command from the TNC. + * + * Inputs: chan - Radio channel, first is 0. + * + * call_from - Address of other station. + * + * call_to - Callsign I responded to. (could be an alias.) + * + * data_len - Length of data field. + * + * data - Should look something like this for incoming: + * *** CONNECTED to Station xxx\r + * + * Description: Add to the sessions table. + * + *--------------------------------------------------------------------*/ + +/*------------------------------------------------------------------- + * + * Name: on_C_connection_received + * + * Purpose: Callback for the "connection received" command from the TNC. + * + * Inputs: chan - Radio channel, first is 0. + * + * call_from - Address of other station. + * + * call_to - My call. + * In the case of an incoming connect request (i.e. to + * a server) this is the callsign I responded to. + * It is possible to define additional aliases and respond + * to any one of them. It would be possible to have a server + * that responds to multiple names and behaves differently + * depending on the name. + * + * incoming - true(1) if other station made connect request. + * false(0) if I made request and other statio accepted. + * + * data - Should look something like this for incoming: + * *** CONNECTED to Station xxx\r + * and this for my request being accepted: + * *** CONNECTED With Station xxx\r + * + * session_id - Session id to be used in data transfer and + * other control functions related to this connection. + * Think of it like a file handle. Once it is open + * we usually don't care about the name anymore and + * and just refer to the handle. This is used to + * keep track of multiple connections at the same + * time. e.g. a server could be handling multiple + * clients at once on the same or different channels. + * + * Description: Add to the table of clients. + * + *--------------------------------------------------------------------*/ + + +// old void agw_cb_C_connection_received (int chan, char *call_from, char *call_to, int data_len, char *data) +void on_C_connection_received (int chan, char *call_from, char *call_to, int incoming, char *data) +{ + int s; + char *p; + char greeting[256]; + + + for (p = data; *p != '\0'; p++) { + if (! isprint(*p)) *p = '\0'; // Remove any \r character at end. + } + + s = find_session (chan, call_from, 1); + + if (s >= 0) { + + text_color_set(DW_COLOR_INFO); + dw_printf ("Begin session %d: %s\n", s, data); + +// Send greeting. + + snprintf (greeting, sizeof(greeting), "Welcome! Type ? for list of commands or HELP for details.\r"); + agwlib_D_send_connected_data (chan, 0xF0, mycall, call_from, strlen(greeting), greeting); + } + else { + + text_color_set(DW_COLOR_INFO); + dw_printf ("Too many users already: %s\n", data); + +// Sorry, too many users already. + + snprintf (greeting, sizeof(greeting), "Sorry, maximum number of users has been exceeded. Try again later.\r"); + agwlib_D_send_connected_data (chan, 0xF0, mycall, call_from, strlen(greeting), greeting); + + // FIXME: Ideally we'd want to wait until nothing in the outgoing queue + // to that station so we know the rejection message was received. + SLEEP_SEC (10); + agwlib_d_disconnect (chan, mycall, call_from); + } + +} /* end agw_cb_C_connection_received */ + + + +/*------------------------------------------------------------------- + * + * Name: agw_cb_d_disconnected + * + * Purpose: Process the "disconnected" command from the TNC. + * + * Inputs: chan - Radio channel. + * + * call_from - Address of other station. + * + * call_to - Callsign I responded to. (could be aliases.) + * + * data_len - Length of data field. + * + * data - Should look something like one of these: + * *** DISCONNECTED RETRYOUT With xxx\r + * *** DISCONNECTED From Station xxx\r + * + * Description: Remove from the sessions table. + * + *--------------------------------------------------------------------*/ + + + +void agw_cb_d_disconnected (int chan, char *call_from, char *call_to, int data_len, char *data) +{ + int s; + char *p; + + s = find_session (chan, call_from, 0); + + for (p = data; *p != '\0'; p++) { + if (! isprint(*p)) *p = '\0'; // Remove any \r character at end. + } + + text_color_set(DW_COLOR_INFO); + dw_printf ("End session %d: %s\n", s, data); + +// Remove from session table. + + if (s >= 0) { + memset (&(session[s]), 0, sizeof(struct session_s)); + } + +} /* end agw_cb_d_disconnected */ + + + +/*------------------------------------------------------------------- + * + * Name: agw_cb_D_connected_data + * + * Purpose: Process "connected ax.25 data" from the TNC. + * + * Inputs: chan - Radio channel. + * + * addr - Address of other station. + * + * msg - What the user sent us. Probably a command. + * + * Global In: tnc_sock - Socket for TNC. + * + * Description: Remove from the session table. + * + *--------------------------------------------------------------------*/ + + +void agw_cb_D_connected_data (int chan, char *call_from, char *call_to, int data_len, char *data) +{ + int s; + char *p; + char logit[AX25_MAX_INFO_LEN+100]; + char *pcmd; + char *save; + + s = find_session (chan, call_from, 0); + + for (p = data; *p != '\0'; p++) { + if (! isprint(*p)) *p = '\0'; // Remove any \r character at end. + } + + // TODO: Should timestamp to all output. + + snprintf (logit, sizeof(logit), "%d,%d,%s: %s\n", s, chan, call_from, data); + text_color_set(DW_COLOR_INFO); + dw_printf ("%s", logit); + + if (s < 0) { + // Uh oh. Data from some station when not connected. + text_color_set(DW_COLOR_ERROR); + dw_printf ("Internal error. Incoming data, no corresponding session.\n"); + return; + } + +// Process the command from user. + + pcmd = strtok_r (data, " ", &save); + if (pcmd == NULL || strlen(pcmd) == 0) { + + char greeting[80]; + strlcpy (greeting, "Type ? for list of commands or HELP for details.\r", sizeof(greeting)); + agwlib_D_send_connected_data (chan, 0xF0, mycall, call_from, strlen(greeting), greeting); + return; + } + + if (strcasecmp(pcmd, "who") == 0) { + +// who - list people currently logged in. + + int n; + char greeting[128]; + + snprintf (greeting, sizeof(greeting), "Session Channel User Since\r"); + agwlib_D_send_connected_data (chan, 0xF0, mycall, call_from, strlen(greeting), greeting); + + for (n = 0; n < MAX_SESSIONS; n++) { + if (session[n].client_addr[0]) { +// I think compiler is confused. It says up to 520 characters can be written. +#pragma GCC diagnostic push +#pragma GCC diagnostic ignored "-Wformat-truncation" + snprintf (greeting, sizeof(greeting), " %2d %d %-9s [time later]\r", + n, session[n].channel, session[n].client_addr); +#pragma GCC diagnostic pop + agwlib_D_send_connected_data (chan, 0xF0, mycall, call_from, strlen(greeting), greeting); + } + } + } + else if (strcasecmp(pcmd, "test") == 0) { + +// test - timing test +// Send specified number of frames with optional length. + + char *pcount = strtok_r (NULL, " ", &save); + char *plength = strtok_r (NULL, " ", &save); + + session[s].tt_start_time = time(NULL); + session[s].tt_next = 1; + session[s].tt_length = 256; + session[s].tt_count = 1; + + if (plength != NULL) { + session[s].tt_length = atoi(plength); + if (session[s].tt_length < 16) session[s].tt_length = 16; + if (session[s].tt_length > AX25_MAX_INFO_LEN) session[s].tt_length = AX25_MAX_INFO_LEN; + } + if (pcount != NULL) { + session[s].tt_count = atoi(pcount); + } + + // The background polling will take it from here. + } + else if (strcasecmp(pcmd, "bye") == 0) { + +// bye - disconnect. + + char greeting[80]; + strlcpy (greeting, "Thank you folks for kindly droppin' in. Y'all come on back now, ya hear?\r", sizeof(greeting)); + agwlib_D_send_connected_data (chan, 0xF0, mycall, call_from, strlen(greeting), greeting); + // Ideally we'd want to wait until nothing in the outgoing queue + // to that station so we know the message was received. + SLEEP_SEC (10); + agwlib_d_disconnect (chan, mycall, call_from); + } + else if (strcasecmp(pcmd, "help") == 0 || strcasecmp(pcmd, "?") == 0) { + +// help. + + char greeting[80]; + strlcpy (greeting, "Help not yet available.\r", sizeof(greeting)); + agwlib_D_send_connected_data (chan, 0xF0, mycall, call_from, strlen(greeting), greeting); + } + else { + +// command not recognized. + + char greeting[80]; + strlcpy (greeting, "Invalid command. Type ? for list of commands or HELP for details.\r", sizeof(greeting)); + agwlib_D_send_connected_data (chan, 0xF0, mycall, call_from, strlen(greeting), greeting); + } + +} /* end agw_cb_D_connected_data */ + + + + +/*------------------------------------------------------------------- + * + * Name: agw_cb_G_port_information + * + * Purpose: Process the port information "radio channels available" response from the TNC. + * + * + * Inputs: num_chan_avail - Number of radio channels available. + * + * chan_descriptions - Array of string pointers to form "Port99 description". + * Port1 is channel 0. + * + *--------------------------------------------------------------------*/ + +void agw_cb_G_port_information (int num_chan_avail, char *chan_descriptions[]) +{ + char *p; + int n; + + text_color_set(DW_COLOR_INFO); + dw_printf("TNC has %d radio channel%s available:\n", num_chan_avail, (num_chan_avail != 1) ? "s" : ""); + + for (n = 0; n < num_chan_avail; n++) { + + p = chan_descriptions[n]; + + // Expecting something like this: "Port1 first soundcard mono" + + if (strncasecmp(p, "Port", 4) == 0 && isdigit(p[4])) { + + int chan = atoi(p+4) - 1; // "Port1" is our channel 0. + if (chan >= 0 && chan < MAX_CHANS) { + + char *desc = p + 4; + while (*desc != '\0' && (*desc == ' ' || isdigit(*desc))) { + desc++; + } + + text_color_set(DW_COLOR_INFO); + dw_printf(" Channel %d: %s\n", chan, desc); + + // Later? Use 'g' to get speed and maybe other properties? + // Though I'm not sure why we would care here. + +/* + * Send command to register my callsign for incoming connect requests. + */ + + agwlib_X_register_callsign (chan, mycall); + + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf("Radio channel number is out of bounds: %s\n", p); + } + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf("Radio channel description not in expected format: %s\n", p); + } + } + +} /* end agw_cb_G_port_information */ + + +/*------------------------------------------------------------------- + * + * Name: agw_cb_Y_outstanding_frames_for_station + * + * Purpose: Process the "disconnected" command from the TNC. + * + * Inputs: chan - Radio channel. + * + * call_from - Should be my call. + * + * call_to - Callsign of other station. + * + * frame_count + * + * Description: Remove from the sessions table. + * + *--------------------------------------------------------------------*/ + + + +void agw_cb_Y_outstanding_frames_for_station (int chan, char *call_from, char *call_to, int frame_count) +{ + int s; + + s = find_session (chan, call_to, 0); + + text_color_set(DW_COLOR_DEBUG); // FIXME temporary + dw_printf ("debug ----------------------> session %d, callback Y outstanding frame_count %d\n", s, frame_count); + +// Update the transmit queue length + + if (s >= 0) { + session[s].tx_queue_len = frame_count; + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Oops! Did not expect to be here.\n"); + } + +} /* end agw_cb_Y_outstanding_frames_for_station */ + + + +/*------------------------------------------------------------------- + * + * Name: find_session + * + * Purpose: Given a channel number and address (callsign), find existing + * table entry or create a new one. + * + * Inputs: chan - Radio channel number. + * + * addr - Address of station contacting us. + * + * create - If true, try create a new entry if not already there. + * + * Returns: "session id" which is an index into "session" array or -1 for failure. + * + *--------------------------------------------------------------------*/ + +static int find_session (int chan, char *addr, int create) +{ + int i; + int s = -1; + +// Is it there already? + + +//#if DEBUG +// +// text_color_set(DW_COLOR_DEBUG); +// dw_printf("find_session (%d, %s, %d)\n", chan, addr, create); +//#endif + + for (i = 0; i < MAX_SESSIONS; i++) { + if (session[i].channel == chan && strcmp(session[i].client_addr, addr) == 0) { + s = i; + break; + } + } + + if (s >= 0) return (s); + + if (! create) return (-1); + +// No, and there is a request to add a new entry. +// See if we have any available space. + + s = -1; + for (i = 0; i < MAX_SESSIONS; i++) { + if (strlen(session[i].client_addr) == 0) { + s = i; + break; + } + } + + if (s < 0) return (-1); + + strlcpy (session[s].client_addr, addr, sizeof(session[s].client_addr)); + session[s].channel = chan; + session[s].login_time = time(NULL); + + return (s); + +} /* end find_session */ + + +/* end appserver.c */ diff --git a/src/aprs_tt.c b/src/aprs_tt.c new file mode 100644 index 00000000..7b125759 --- /dev/null +++ b/src/aprs_tt.c @@ -0,0 +1,2109 @@ +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// +// Copyright (C) 2013, 2014, 2015 John Langner, WB2OSZ +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . +// + +/*------------------------------------------------------------------ + * + * Module: aprs_tt.c + * + * Purpose: First half of APRStt gateway. + * + * Description: This file contains functions to parse the tone sequences + * and extract meaning from them. + * + * tt_user.c maintains information about users and + * generates the APRS Object Reports. + * + * + * References: This is based upon APRStt (TM) documents with some + * artistic freedom. + * + * http://www.aprs.org/aprstt.html + * + *---------------------------------------------------------------*/ + +#define APRS_TT_C 1 + +#include "direwolf.h" + + +// TODO: clean up terminolgy. +// "Message" has a specific meaning in APRS and this is not it. +// Touch Tone sequence should be appropriate. +// What do we call the parts separated by * key? Field. + + +#include +#include +#include +#include +#include +#include + +#include +#include + +#include "version.h" +#include "ax25_pad.h" +#include "hdlc_rec2.h" /* for process_rec_frame */ +#include "textcolor.h" +#include "aprs_tt.h" +#include "tt_text.h" +#include "tt_user.h" +#include "symbols.h" +#include "latlong.h" +#include "dlq.h" +#include "demod.h" /* for alevel_t & demod_get_audio_level() */ +#include "tq.h" + + + + +// geotranz + +#include "utm.h" +#include "mgrs.h" +#include "usng.h" +#include "error_string.h" + +/* Convert between degrees and radians. */ + +#define D2R(d) ((d) * M_PI / 180.) +#define R2D(r) ((r) * 180. / M_PI) + + +/* + * Touch Tone sequences are accumulated here until # terminator found. + * Kept separate for each audio channel so the gateway CAN be listening + * on multiple channels at the same time. + */ + +#define MAX_MSG_LEN 100 + +static char msg_str[MAX_CHANS][MAX_MSG_LEN+1]; +static int msg_len[MAX_CHANS]; + +static int parse_fields (char *msg); +static int parse_callsign (char *e); +static int parse_object_name (char *e); +static int parse_symbol (char *e); +static int parse_aprstt3_call (char *e); +static int parse_location (char *e); +static int parse_comment (char *e); +static int expand_macro (char *e); +#ifndef TT_MAIN +static void raw_tt_data_to_app (int chan, char *msg); +#endif +static int find_ttloc_match (char *e, char *xstr, char *ystr, char *zstr, char *bstr, char *dstr, size_t valstrsize); + +#if TT_MAIN +static void check_result (void); +#endif + +static int tt_debug = 0; + + +/*------------------------------------------------------------------ + * + * Name: aprs_tt_init + * + * Purpose: Initialize the APRStt gateway at system startup time. + * + * Inputs: P - Pointer to configuration options gathered by config.c. + * debug - Debug printing control. + * + * Global out: Make our own local copy of the structure here. + * + * Returns: None + * + * Description: The main program needs to call this at application + * start up time after reading the configuration file. + * + * TT_MAIN is defined for unit testing. + * + *----------------------------------------------------------------*/ + +static struct tt_config_s tt_config; + +#if TT_MAIN +#define NUM_TEST_CONFIG (sizeof(test_config) / sizeof (struct ttloc_s)) +static struct ttloc_s test_config[] = { + + { TTLOC_POINT, "B01", .point.lat = 12.25, .point.lon = 56.25 }, + { TTLOC_POINT, "B988", .point.lat = 12.50, .point.lon = 56.50 }, + + { TTLOC_VECTOR, "B5bbbdddd", .vector.lat = 53., .vector.lon = -1., .vector.scale = 1000. }, /* km units */ + + /* Hilltop Tower http://www.aprs.org/aprs-jamboree-2013.html */ + { TTLOC_VECTOR, "B5bbbddd", .vector.lat = 37+55.37/60., .vector.lon = -(81+7.86/60.), .vector.scale = 16.09344 }, /* .01 mile units */ + + { TTLOC_GRID, "B2xxyy", .grid.lat0 = 12.00, .grid.lon0 = 56.00, + .grid.lat9 = 12.99, .grid.lon9 = 56.99 }, + { TTLOC_GRID, "Byyyxxx", .grid.lat0 = 37 + 50./60.0, .grid.lon0 = 81, + .grid.lat9 = 37 + 59.99/60.0, .grid.lon9 = 81 + 9.99/60.0 }, + + { TTLOC_MHEAD, "BAxxxxxx", .mhead.prefix = "326129" }, + + { TTLOC_SATSQ, "BAxxxx" }, + + { TTLOC_MACRO, "xxyyy", .macro.definition = "B9xx*AB166*AA2B4C5B3B0Ayyy" }, + { TTLOC_MACRO, "xxxxzzzzzzzzzz", .macro.definition = "BAxxxx*ACzzzzzzzzzz" }, +}; +#endif + + +void aprs_tt_init (struct tt_config_s *p, int debug) +{ + int c; + tt_debug = debug; + +#if TT_MAIN + /* For unit testing. */ + + memset (&tt_config, 0, sizeof(struct tt_config_s)); + tt_config.ttloc_size = NUM_TEST_CONFIG; + tt_config.ttloc_ptr = test_config; + tt_config.ttloc_len = NUM_TEST_CONFIG; + + /* Don't care about xmit timing or corral here. */ +#else + // TODO: Keep ptr instead of making a copy. + memcpy (&tt_config, p, sizeof(struct tt_config_s)); +#endif + for (c=0; c= 0 && chan < MAX_CHANS); + + + //if (button != '.') { + // dw_printf ("aprs_tt_button (%d, '%c')\n", chan, button); + //} + + +// TODO: Might make more sense to put timeout here rather in the dtmf decoder. + + if (button == '$') { + +/* Timeout reset. */ + + msg_len[chan] = 0; + msg_str[chan][0] = '\0'; + } + else if (button != '.' && button != ' ') { + if (msg_len[chan] < MAX_MSG_LEN) { + msg_str[chan][msg_len[chan]++] = button; + msg_str[chan][msg_len[chan]] = '\0'; + } + if (button == '#') { + +/* + * Put into the receive queue like any other packet. + * This way they are all processed by the common receive thread + * rather than the thread associated with the particular audio device. + */ + raw_tt_data_to_app (chan, msg_str[chan]); + + msg_len[chan] = 0; + msg_str[chan][0] = '\0'; + } + } + else { + +/* + * Idle time. Poll occasionally for processing. + * Timing would be off we we are listening to more than + * one channel so do this only for the one specified + * in the TTOBJ command. + */ + + if (chan == tt_config.obj_recv_chan) { + poll_period++; + if (poll_period >= 39) { + poll_period = 0; + tt_user_background (); + } + } + } + +} /* end aprs_tt_button */ + +#endif + +/*------------------------------------------------------------------ + * + * Name: aprs_tt_sequence + * + * Purpose: Process complete received touch tone sequence + * terminated by #. + * + * Inputs: chan - Audio channel it came from. + * + * msg - String of DTMF buttons. + * # should be the final character. + * + * Returns: None + * + * Description: Process a complete tone sequence. + * It should have one or more fields separated by * + * and terminated by a final # like these: + * + * callsign # + * entry1 * callsign # + * entry1 * entry * callsign # + * + * Limitation: Has one set of static data for communication among + * group of functions. This shouldn't be a problem + * when receiving on multiple channels at once + * because they get serialized thru the receive packet queue. + * + *----------------------------------------------------------------*/ + +static char m_callsign[20]; /* really object name */ + +/* + * Standard APRStt has symbol code 'A' (box) with overlay of 0-9, A-Z. + * + * Dire Wolf extension allows: + * Symbol table '/' (primary), any symbol code. + * Symbol table '\' (alternate), any symbol code. + * Alternate table symbol code, overlay of 0-9, A-Z. + */ + +static char m_symtab_or_overlay; +static char m_symbol_code; // Default 'A' + +static char m_loc_text[24]; +static double m_longitude; // Set to G_UNKNOWN if not defined. +static double m_latitude; // Set to G_UNKNOWN if not defined. +static int m_ambiguity; +static char m_comment[200]; +static char m_freq[12]; +static char m_ctcss[8]; +static char m_mic_e; +static char m_dao[6]; +static int m_ssid; // Default 12 for APRStt user. + + + +void aprs_tt_sequence (int chan, char *msg) +{ + int err; + + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("\n\"%s\"\n", msg); +#endif + +/* + * Discard empty message. + * In case # is there as optional start. + */ + + if (msg[0] == '#') return; + +/* + * The parse functions will fill these in. + */ + strlcpy (m_callsign, "", sizeof(m_callsign)); + m_symtab_or_overlay = APRSTT_DEFAULT_SYMTAB; + m_symbol_code = APRSTT_DEFAULT_SYMBOL; + strlcpy (m_loc_text, "", sizeof(m_loc_text)); + m_longitude = G_UNKNOWN; + m_latitude = G_UNKNOWN; + m_ambiguity = 0; + strlcpy (m_comment, "", sizeof(m_comment)); + strlcpy (m_freq, "", sizeof(m_freq)); + strlcpy (m_ctcss, "", sizeof(m_ctcss)); + m_mic_e = ' '; + strlcpy (m_dao, "!T !", sizeof(m_dao)); /* start out unknown */ + m_ssid = 12; + +/* + * Parse the touch tone sequence. + */ + err = parse_fields (msg); + +#if defined(DEBUG) + text_color_set(DW_COLOR_DEBUG); + dw_printf ("callsign=\"%s\", ssid=%d, symbol=\"%c%c\", freq=\"%s\", ctcss=\"%s\", comment=\"%s\", lat=%.4f, lon=%.4f, dao=\"%s\"\n", + m_callsign, m_ssid, m_symtab_or_overlay, m_symbol_code, m_freq, m_ctcss, m_comment, m_latitude, m_longitude, m_dao); +#endif + +#if TT_MAIN + (void)err; // suppress variable set but not used warning. + check_result (); // for unit testing. +#else + +/* + * If digested successfully. Add to our list of users and schedule transmissions. + */ + + if (err == 0) { + + err = tt_user_heard (m_callsign, m_ssid, m_symtab_or_overlay, m_symbol_code, + m_loc_text, m_latitude, m_longitude, m_ambiguity, + m_freq, m_ctcss, m_comment, m_mic_e, m_dao); + } + + +/* + * If a command / script was supplied, run it now. + * This can do additional processing and provide a custom audible response. + * This is done only for the success case. + * It might be useful to run it for error cases as well but we currently + * don't pass in the success / failure code to know the difference. + */ + char script_response[1000]; + + strlcpy (script_response, "", sizeof(script_response)); + + if (err == 0 && strlen(tt_config.ttcmd) > 0) { + + dw_run_cmd (tt_config.ttcmd, 1, script_response, sizeof(script_response)); + + } + +/* + * Send response to user by constructing packet with SPEECH or MORSE as destination. + * Source shouldn't matter because it doesn't get transmitted as AX.25 frame. + * Use high priority queue for consistent timing. + * + * Anything from script, above, will override other predefined responses. + */ + + char audible_response[sizeof(script_response) + 16]; + + snprintf (audible_response, sizeof(audible_response), + "APRSTT>%s:%s", + tt_config.response[err].method, + (strlen(script_response) > 0) ? script_response : tt_config.response[err].mtext); + + packet_t pp; + + pp = ax25_from_text (audible_response, 0); + + if (pp == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Internal error. Couldn't make frame from \"%s\"\n", audible_response); + return; + } + + tq_append (chan, TQ_PRIO_0_HI, pp); + +#endif /* ifndef TT_MAIN */ + +} /* end aprs_tt_sequence */ + + +/*------------------------------------------------------------------ + * + * Name: parse_fields + * + * Purpose: Separate the complete string of touch tone characters + * into fields, delimited by *, and process each. + * + * Inputs: msg - String of DTMF buttons. + * + * Returns: None + * + * Description: It should have one or more fields separated by *. + * + * callsign # + * entry1 * callsign # + * entry1 * entry * callsign # + * + * Note that this will be used recursively when macros + * are expanded. + * + * "To iterate is human, to recurse divine." + * + * Returns: 0 for success or one of the TT_ERROR_... codes. + * + *----------------------------------------------------------------*/ + +static int parse_fields (char *msg) +{ + char stemp[MAX_MSG_LEN+1]; + char *e; + char *save; + int err; + + + //text_color_set(DW_COLOR_DEBUG); + //dw_printf ("parse_fields (%s).\n", msg); + +// Make a copy of msg because strtok corrupts the original. +// While we are at it, remove any blanks. +// This should not happen with DTMF reception but could happen +// in manually crafted strings for testing. + + int n = 0; + for (char *m = msg; *m != '\0' && n < sizeof(stemp)-1; m++) { + if (*m != ' ') { + stemp[n++] = *m; + } + } + stemp[n] = '\0'; + + e = strtok_r (stemp, "*#", &save); + while (e != NULL) { + + //text_color_set(DW_COLOR_DEBUG); + //dw_printf ("parse_fields () field = %s\n", e); + + switch (*e) { + + case 'A': + + switch (e[1]) { + + case 'A': /* AA object-name */ + err = parse_object_name (e); + if (err != 0) return (err); + break; + + case 'B': /* AB symbol */ + err = parse_symbol (e); + if (err != 0) return (err); + break; + + case 'C': /* AC new-style-callsign */ + + err = parse_aprstt3_call (e); + if (err != 0) return (err); + break; + + default: /* Traditional style call or suffix */ + err = parse_callsign (e); + if (err != 0) return (err); + break; + } + break; + + case 'B': + err = parse_location (e); + if (err != 0) return (err); + break; + + case 'C': + err = parse_comment (e); + if (err != 0) return (err); + break; + + case '0': + case '1': + case '2': + case '3': + case '4': + case '5': + case '6': + case '7': + case '8': + case '9': + err = expand_macro (e); + if (err != 0) return (err); + break; + + case '\0': + /* Empty field. Just ignore it. */ + /* This would happen if someone uses a leading *. */ + break; + + default: + + text_color_set(DW_COLOR_ERROR); + dw_printf ("Field does not start with A, B, C, or digit: \"%s\"\n", e); + return (TT_ERROR_D_MSG); + + } + + e = strtok_r (NULL, "*#", &save); + } + + //text_color_set(DW_COLOR_DEBUG); + //dw_printf ("parse_fields () normal return\n"); + + return (0); + +} /* end parse_fields */ + + +/*------------------------------------------------------------------ + * + * Name: expand_macro + * + * Purpose: Expand compact form "macro" to full format then process. + * + * Inputs: e - An "entry" extracted from a complete + * APRStt message. + * In this case, it should contain only digits. + * + * Returns: 0 for success or one of the TT_ERROR_... codes. + * + * Description: Separate out the fields, perform substitution, + * call parse_fields for processing. + * + * + * Future: Generalize this to allow any lower case letter for substitution? + * + *----------------------------------------------------------------*/ + +#define VALSTRSIZE 20 + +static int expand_macro (char *e) +{ + //int len; + int ipat; + char xstr[VALSTRSIZE], ystr[VALSTRSIZE], zstr[VALSTRSIZE], bstr[VALSTRSIZE], dstr[VALSTRSIZE]; + char stemp[MAX_MSG_LEN+1]; + char *d; + + + text_color_set(DW_COLOR_DEBUG); + dw_printf ("Macro tone sequence: '%s'\n", e); + + //len = strlen(e); + + ipat = find_ttloc_match (e, xstr, ystr, zstr, bstr, dstr, VALSTRSIZE); + + if (ipat >= 0) { + + // Why did we print b & d here? + // Documentation says only x, y, z can be used with macros. + // Only those 3 are processed below. + + //dw_printf ("Matched pattern %3d: '%s', x=%s, y=%s, z=%s, b=%s, d=%s\n", ipat, tt_config.ttloc_ptr[ipat].pattern, xstr, ystr, zstr, bstr, dstr); + dw_printf ("Matched pattern %3d: '%s', x=%s, y=%s, z=%s\n", ipat, tt_config.ttloc_ptr[ipat].pattern, xstr, ystr, zstr); + + dw_printf ("Replace with: '%s'\n", tt_config.ttloc_ptr[ipat].macro.definition); + + if (tt_config.ttloc_ptr[ipat].type != TTLOC_MACRO) { + + /* Found match to a different type. Really shouldn't be here. */ + /* Print internal error message... */ + dw_printf ("expand_macro: type != TTLOC_MACRO\n"); + return (TT_ERROR_INTERNAL); + } + +/* + * We found a match for the length and any fixed digits. + * Substitute values in to the definition. + */ + + strlcpy (stemp, "", sizeof(stemp)); + + for (d = tt_config.ttloc_ptr[ipat].macro.definition; *d != '\0'; d++) { + + while (( *d == 'x' || *d == 'y' || *d == 'z') && *d == d[1]) { + /* Collapse adjacent matching substitution characters. */ + d++; + } + + switch (*d) { + case 'x': + strlcat (stemp, xstr, sizeof(stemp)); + break; + case 'y': + strlcat (stemp, ystr, sizeof(stemp)); + break; + case 'z': + strlcat (stemp, zstr, sizeof(stemp)); + break; + default: + { + char c1[2]; + c1[0] = *d; + c1[1] = '\0'; + strlcat (stemp, c1, sizeof(stemp)); + } + break; + } + } +/* + * Process as if we heard this over the air. + */ + + dw_printf ("After substitution: '%s'\n", stemp); + return (parse_fields (stemp)); + } + + else { + + + /* Send reject sound. */ + /* Does not match any macro definitions. */ + text_color_set(DW_COLOR_ERROR); + dw_printf ("Tone sequence did not match any pattern\n"); + return (TT_ERROR_MACRO_NOMATCH); + } + + /* should be unreachable */ + return (0); +} + + + +/*------------------------------------------------------------------ + * + * Name: parse_callsign + * + * Purpose: Extract traditional format callsign or object name from touch tone sequence. + * + * Inputs: e - An "entry" extracted from a complete + * APRStt message. + * In this case, it should start with "A" then a digit. + * + * Outputs: m_callsign + * + * m_symtab_or_overlay - Set to 0-9 or A-Z if specified. + * + * m_symbol_code - Always set to 'A' (Box, DTMF or RFID) + * If you want a different symbol, use the new + * object name format and separate symbol specification. + * + * Returns: 0 for success or one of the TT_ERROR_... codes. + * + * Description: We recognize 3 different formats: + * + * Annn - 3 digits are a tactical callsign. No overlay. + * + * Annnvk - Abbreviation with 3 digits, numeric overlay, checksum. + * Annnvvk - Abbreviation with 3 digits, letter overlay, checksum. + * + * Att...ttvk - Full callsign in two key method, numeric overlay, checksum. + * Att...ttvvk - Full callsign in two key method, letter overlay, checksum. + * + * + *----------------------------------------------------------------*/ + +static int checksum_not_ok (char *str, int len, char found) +{ + int i; + int sum; + char expected; + + sum = 0; + for (i=0; i= 'A' && str[i] <= 'D') { + sum += str[i] - 'A' + 10; + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("aprs_tt: checksum: bad character \"%c\" in checksum calculation!\n", str[i]); + } + } + expected = '0' + (sum % 10); + + if (expected != found) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Bad checksum for \"%.*s\". Expected %c but received %c.\n", len, str, expected, found); + return (TT_ERROR_BAD_CHECKSUM); + } + return (0); +} + + +static int parse_callsign (char *e) +{ + int len; + char tttemp[40], stemp[30]; + + if (tt_debug) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("APRStt parse callsign (starts with A then digit): \"%s\"\n", e); + } + + assert (*e == 'A'); + + len = strlen(e); + +/* + * special case: 3 digit tactical call. + */ + + if (len == 4 && isdigit(e[1]) && isdigit(e[2]) && isdigit(e[3])) { + strlcpy (m_callsign, e+1, sizeof(m_callsign)); + if (tt_debug) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("Special case, 3 digit tactical call: \"%s\"\n", m_callsign); + } + return (0); + } + +/* + * 3 digit abbreviation: We only do the parsing here. + * Another part of application will try to find corresponding full call. + */ + + if ((len == 6 && isdigit(e[1]) && isdigit(e[2]) && isdigit(e[3]) && isdigit(e[4]) && isdigit(e[5])) || + (len == 7 && isdigit(e[1]) && isdigit(e[2]) && isdigit(e[3]) && isdigit(e[4]) && isupper(e[5]) && isdigit(e[6]))) { + + int cs_err = checksum_not_ok (e+1, len-2, e[len-1]); + + if (cs_err != 0) { + return (cs_err); + } + + memcpy (m_callsign, e+1, 3); + m_callsign[3] = '\0'; + + if (len == 7) { + tttemp[0] = e[len-3]; + tttemp[1] = e[len-2]; + tttemp[2] = '\0'; + tt_two_key_to_text (tttemp, 0, stemp); + m_symbol_code = APRSTT_DEFAULT_SYMBOL; + m_symtab_or_overlay = stemp[0]; + if (tt_debug) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("Three digit abbreviation1: callsign \"%s\", symbol code '%c (Box DTMF)', overlay '%c', checksum %c\n", + m_callsign, m_symbol_code, m_symtab_or_overlay, e[len-1]); + } + } + else { + m_symbol_code = APRSTT_DEFAULT_SYMBOL; + m_symtab_or_overlay = e[len-2]; + if (tt_debug) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("Three digit abbreviation2: callsign \"%s\", symbol code '%c' (Box DTMF), overlay '%c', checksum %c\n", + m_callsign, m_symbol_code, m_symtab_or_overlay, e[len-1]); + } + } + return (0); + } + +/* + * Callsign in two key format. + */ + + if (len >= 7 && len <= 24) { + + int cs_err = checksum_not_ok (e+1, len-2, e[len-1]); + + if (cs_err != 0) { + return (cs_err); + } + + if (isupper(e[len-2])) { + memcpy (tttemp, e+1, len-4); + tttemp[len-4] = '\0'; + tt_two_key_to_text (tttemp, 0, m_callsign); + + tttemp[0] = e[len-3]; + tttemp[1] = e[len-2]; + tttemp[2] = '\0'; + tt_two_key_to_text (tttemp, 0, stemp); + m_symbol_code = APRSTT_DEFAULT_SYMBOL; + m_symtab_or_overlay = stemp[0]; + if (tt_debug) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("Callsign in two key format1: callsign \"%s\", symbol code '%c' (Box DTMF), overlay '%c', checksum %c\n", + m_callsign, m_symbol_code, m_symtab_or_overlay, e[len-1]); + } + } + else { + memcpy (tttemp, e+1, len-3); + tttemp[len-3] = '\0'; + tt_two_key_to_text (tttemp, 0, m_callsign); + + m_symbol_code = APRSTT_DEFAULT_SYMBOL; + m_symtab_or_overlay = e[len-2]; + if (tt_debug) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("Callsign in two key format2: callsign \"%s\", symbol code '%c' (Box DTMF), overlay '%c', checksum %c\n", + m_callsign, m_symbol_code, m_symtab_or_overlay, e[len-1]); + } + } + return (0); + } + + text_color_set(DW_COLOR_ERROR); + dw_printf ("Touch tone callsign not valid: \"%s\"\n", e); + return (TT_ERROR_INVALID_CALL); +} + + +/*------------------------------------------------------------------ + * + * Name: parse_object_name + * + * Purpose: Extract object name from touch tone sequence. + * + * Inputs: e - An "entry" extracted from a complete + * APRStt message. + * In this case, it should start with "AA". + * + * Outputs: m_callsign + * + * m_ssid - Cleared to remove the default of 12. + * + * Returns: 0 for success or one of the TT_ERROR_... codes. + * + * Description: Data format + * + * AAtt...tt - Symbol name, two key method, up to 9 characters. + * + *----------------------------------------------------------------*/ + + +static int parse_object_name (char *e) +{ + int len; + + if (tt_debug) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("APRStt parse object name (starts with AA): \"%s\"\n", e); + } + + assert (e[0] == 'A'); + assert (e[1] == 'A'); + + len = strlen(e); + +/* + * Object name in two key format. + */ + + if (len >= 2 + 1 && len <= 30) { + + if (tt_two_key_to_text (e+2, 0, m_callsign) == 0) { + m_callsign[9] = '\0'; /* truncate to 9 */ + m_ssid = 0; /* No ssid for object name */ + if (tt_debug) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("Object name in two key format: \"%s\"\n", m_callsign); + } + return (0); + } + } + + text_color_set(DW_COLOR_ERROR); + dw_printf ("Touch tone object name not valid: \"%s\"\n", e); + + return (TT_ERROR_INVALID_OBJNAME); + +} /* end parse_oject_name */ + + +/*------------------------------------------------------------------ + * + * Name: parse_symbol + * + * Purpose: Extract symbol from touch tone sequence. + * + * Inputs: e - An "entry" extracted from a complete + * APRStt message. + * In this case, it should start with "AB". + * + * Outputs: m_symtab_or_overlay + * + * m_symbol_code + * + * Returns: 0 for success or one of the TT_ERROR_... codes. + * + * Description: Data format + * + * AB1nn - Symbol from primary symbol table. + * Two digits nn are the same as in the GPSCnn + * generic address used as a destination. + * + * AB2nn - Symbol from alternate symbol table. + * Two digits nn are the same as in the GPSEnn + * generic address used as a destination. + * + * AB0nnvv - Symbol from alternate symbol table. + * Two digits nn are the same as in the GPSEnn + * generic address used as a destination. + * vv is an overlay digit or letter in two key method. + * + *----------------------------------------------------------------*/ + + +static int parse_symbol (char *e) +{ + int len; + char nstr[3]; + int nn; + char stemp[10]; + + if (tt_debug) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("APRStt parse symbol (starts with AB): \"%s\"\n", e); + } + + assert (e[0] == 'A'); + assert (e[1] == 'B'); + + len = strlen(e); + + if (len >= 4 && len <= 10) { + + nstr[0] = e[3]; + nstr[1] = e[4]; + nstr[2] = '\0'; + + nn = atoi (nstr); + if (nn < 1) { + nn = 1; + } + else if (nn > 94) { + nn = 94; + } + + switch (e[2]) { + + case '1': + m_symtab_or_overlay = '/'; + m_symbol_code = 32 + nn; + if (tt_debug) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("symbol code '%c', primary symbol table '%c'\n", + m_symbol_code, m_symtab_or_overlay); + } + return (0); + break; + + case '2': + m_symtab_or_overlay = '\\'; + m_symbol_code = 32 + nn; + if (tt_debug) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("symbol code '%c', alternate symbol table '%c'\n", + m_symbol_code, m_symtab_or_overlay); + } + return (0); + break; + + case '0': + if (len >= 6) { + if (tt_two_key_to_text (e+5, 0, stemp) == 0) { + m_symbol_code = 32 + nn; + m_symtab_or_overlay = stemp[0]; + if (tt_debug) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("symbol code '%c', alternate symbol table with overlay '%c'\n", + m_symbol_code, m_symtab_or_overlay); + } + return (0); + } + } + break; + } + } + + text_color_set(DW_COLOR_ERROR); + dw_printf ("Touch tone symbol not valid: \"%s\"\n", e); + + return (TT_ERROR_INVALID_SYMBOL); + +} /* end parse_oject_name */ + + +/*------------------------------------------------------------------ + * + * Name: parse_aprstt3_call + * + * Purpose: Extract QIKcom-2 / APRStt 3 ten digit call or five digit suffix. + * + * Inputs: e - An "entry" extracted from a complete + * APRStt message. + * In this case, it should start with "AC". + * + * Outputs: m_callsign + * + * Returns: 0 for success or one of the TT_ERROR_... codes. + * + * Description: We recognize 3 different formats: + * + * ACxxxxxxxxxx - 10 digit full callsign. + * + * ACxxxxx - 5 digit suffix. If we can find a corresponding full + * callsign, that will be substituted. + * Error condition is returned if we can't find one. + * + *----------------------------------------------------------------*/ + +static int parse_aprstt3_call (char *e) +{ + + assert (e[0] == 'A'); + assert (e[1] == 'C'); + + if (tt_debug) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("APRStt parse QIKcom-2 / APRStt 3 ten digit call or five digit suffix (starts with AC): \"%s\"\n", e); + } + + if (strlen(e) == 2+10) { + char call[12]; + + if (tt_call10_to_text(e+2,1,call) == 0) { + strlcpy(m_callsign, call, sizeof(m_callsign)); + } + else { + return (TT_ERROR_INVALID_CALL); /* Could not convert to text */ + } + } + else if (strlen(e) == 2+5) { + char suffix[8]; + if (tt_call5_suffix_to_text(e+2,1,suffix) == 0) { + +#if TT_MAIN + /* For unit test, use suffix rather than trying lookup. */ + strlcpy (m_callsign, suffix, sizeof(m_callsign)); +#else + char call[12]; + + /* In normal operation, try to find full callsign for the suffix received. */ + + if (tt_3char_suffix_search (suffix, call) >= 0) { + text_color_set(DW_COLOR_INFO); + dw_printf ("Suffix \"%s\" was converted to full callsign \"%s\"\n", suffix, call); + + strlcpy(m_callsign, call, sizeof(m_callsign)); + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Couldn't find full callsign for suffix \"%s\"\n", suffix); + return (TT_ERROR_SUFFIX_NO_CALL); /* Don't know this user. */ + } +#endif + } + else { + return (TT_ERROR_INVALID_CALL); /* Could not convert to text */ + } + } + else { + return (TT_ERROR_INVALID_CALL); /* Invalid length, not 2+ (10 ir 5) */ + } + + return (0); + +} /* end parse_aprstt3_call */ + + +/*------------------------------------------------------------------ + * + * Name: parse_location + * + * Purpose: Extract location from touch tone sequence. + * + * Inputs: e - An "entry" extracted from a complete + * APRStt message. + * In this case, it should start with "B". + * + * Outputs: m_latitude + * m_longitude + * + * m_dao It should previously be "!T !" to mean unknown or none. + * We generally take the first two tones of the field. + * For example, "!TB5!" for the standard bearing & range. + * The point type is an exception where we use "!Tn !" for + * one of ten positions or "!Tnn" for one of a hundred. + * If this ever changes, be sure to update corresponding + * section in process_comment() in decode_aprs.c + * + * m_ambiguity + * + * Returns: 0 for success or one of the TT_ERROR_... codes. + * + * Description: There are many different formats recognizable + * by total number of digits and sometimes the first digit. + * + * We handle most of them in a general way, processing + * them in 5 groups: + * + * * points + * * vector + * * grid + * * utm + * * usng / mgrs + * + * Position ambiguity is also handled here. + * Latitude, Longitude, and DAO should not be touched in this case. + * We only record a position ambiguity value. + * + *----------------------------------------------------------------*/ + +/* Average radius of earth in meters. */ +#define R 6371000. + + +static int parse_location (char *e) +{ + int ipat; + char xstr[VALSTRSIZE], ystr[VALSTRSIZE], zstr[VALSTRSIZE], bstr[VALSTRSIZE], dstr[VALSTRSIZE]; + double x, y, dist, bearing; + double lat0, lon0; + double lat9, lon9; + long lerr; + double easting, northing; + char mh[20]; + char stemp[32]; + + if (tt_debug) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("APRStt parse location (starts with B): \"%s\"\n", e); + // TODO: more detail later... + } + + assert (*e == 'B'); + + + ipat = find_ttloc_match (e, xstr, ystr, zstr, bstr, dstr, VALSTRSIZE); + if (ipat >= 0) { + + //dw_printf ("ipat=%d, x=%s, y=%s, b=%s, d=%s\n", ipat, xstr, ystr, bstr, dstr); + + switch (tt_config.ttloc_ptr[ipat].type) { + case TTLOC_POINT: + + m_latitude = tt_config.ttloc_ptr[ipat].point.lat; + m_longitude = tt_config.ttloc_ptr[ipat].point.lon; + + /* Is it one of ten or a hundred positions? */ + /* It's not hardwired to always be B0n or B9nn. */ + /* This is a pretty good approximation. */ + + m_dao[2] = e[0]; + m_dao[3] = e[1]; + + if (strlen(e) == 3) { /* probably B0n --> !Tn ! */ + m_dao[2] = e[2]; + m_dao[3] = ' '; + } + if (strlen(e) == 4) { /* probably B9nn --> !Tnn! */ + m_dao[2] = e[2]; + m_dao[3] = e[3]; + } + break; + + case TTLOC_VECTOR: + + if (strlen(bstr) != 3) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Bearing \"%s\" should be 3 digits.\n", bstr); + // return error code? + } + if (strlen(dstr) < 1) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Distance \"%s\" should 1 or more digits.\n", dstr); + // return error code? + } + + lat0 = D2R(tt_config.ttloc_ptr[ipat].vector.lat); + lon0 = D2R(tt_config.ttloc_ptr[ipat].vector.lon); + dist = atof(dstr) * tt_config.ttloc_ptr[ipat].vector.scale; + bearing = D2R(atof(bstr)); + + /* Equations and caluculators found here: */ + /* http://movable-type.co.uk/scripts/latlong.html */ + /* This should probably be a function in latlong.c in case we have another use for it someday. */ + + m_latitude = R2D(asin(sin(lat0) * cos(dist/R) + cos(lat0) * sin(dist/R) * cos(bearing))); + + m_longitude = R2D(lon0 + atan2(sin(bearing) * sin(dist/R) * cos(lat0), + cos(dist/R) - sin(lat0) * sin(D2R(m_latitude)))); + + m_dao[2] = e[0]; + m_dao[3] = e[1]; + + break; + + case TTLOC_GRID: + + if (strlen(xstr) == 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Missing X coordinate.\n"); + strlcpy (xstr, "0", sizeof(xstr)); + } + if (strlen(ystr) == 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Missing Y coordinate.\n"); + strlcpy (ystr, "0", sizeof(ystr)); + } + + lat0 = tt_config.ttloc_ptr[ipat].grid.lat0; + lat9 = tt_config.ttloc_ptr[ipat].grid.lat9; + double yrange = lat9 - lat0; + y = atof(ystr); + double user_y_max = round(pow(10., strlen(ystr)) - 1.); // e.g. 999 for 3 digits + m_latitude = lat0 + yrange * y / user_y_max; +#if 0 + dw_printf ("TTLOC_GRID LAT min=%f, max=%f, range=%f\n", lat0, lat9, yrange); + dw_printf ("TTLOC_GRID LAT user_y=%f, user_y_max=%f\n", y, user_y_max); + dw_printf ("TTLOC_GRID LAT min + yrange * user_y / user_y_range = %f\n", m_latitude); +#endif + lon0 = tt_config.ttloc_ptr[ipat].grid.lon0; + lon9 = tt_config.ttloc_ptr[ipat].grid.lon9; + double xrange = lon9 - lon0; + x = atof(xstr); + double user_x_max = round(pow(10., strlen(xstr)) - 1.); + m_longitude = lon0 + xrange * x / user_x_max; +#if 0 + dw_printf ("TTLOC_GRID LON min=%f, max=%f, range=%f\n", lon0, lon9, xrange); + dw_printf ("TTLOC_GRID LON user_x=%f, user_x_max=%f\n", x, user_x_max); + dw_printf ("TTLOC_GRID LON min + xrange * user_x / user_x_range = %f\n", m_longitude); +#endif + + m_dao[2] = e[0]; + m_dao[3] = e[1]; + + break; + + case TTLOC_UTM: + + if (strlen(xstr) == 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Missing X coordinate.\n"); + /* Avoid divide by zero later. Put in middle of range. */ + strlcpy (xstr, "5", sizeof(xstr)); + } + if (strlen(ystr) == 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Missing Y coordinate.\n"); + /* Avoid divide by zero later. Put in middle of range. */ + strlcpy (ystr, "5", sizeof(ystr)); + } + + x = atof(xstr); + easting = x * tt_config.ttloc_ptr[ipat].utm.scale + tt_config.ttloc_ptr[ipat].utm.x_offset; + + y = atof(ystr); + northing = y * tt_config.ttloc_ptr[ipat].utm.scale + tt_config.ttloc_ptr[ipat].utm.y_offset; + + if (isalpha(tt_config.ttloc_ptr[ipat].utm.latband)) { + snprintf (m_loc_text, sizeof(m_loc_text), "%d%c %.0f %.0f", (int)(tt_config.ttloc_ptr[ipat].utm.lzone), tt_config.ttloc_ptr[ipat].utm.latband, easting, northing); + } + else if (tt_config.ttloc_ptr[ipat].utm.latband == '-') { + snprintf (m_loc_text, sizeof(m_loc_text), "%d %.0f %.0f", (int)(- tt_config.ttloc_ptr[ipat].utm.lzone), easting, northing); + } + else { + snprintf (m_loc_text, sizeof(m_loc_text), "%d %.0f %.0f", (int)(tt_config.ttloc_ptr[ipat].utm.lzone), easting, northing); + } + + lerr = Convert_UTM_To_Geodetic(tt_config.ttloc_ptr[ipat].utm.lzone, + tt_config.ttloc_ptr[ipat].utm.hemi, easting, northing, &lat0, &lon0); + + if (lerr == 0) { + m_latitude = R2D(lat0); + m_longitude = R2D(lon0); + + //dw_printf ("DEBUG: from UTM, latitude = %.6f, longitude = %.6f\n", m_latitude, m_longitude); + } + else { + char message[300]; + + text_color_set(DW_COLOR_ERROR); + utm_error_string (lerr, message); + dw_printf ("Conversion from UTM failed:\n%s\n\n", message); + } + + m_dao[2] = e[0]; + m_dao[3] = e[1]; + + break; + + + case TTLOC_MGRS: + case TTLOC_USNG: + + if (strlen(xstr) == 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("MGRS/USNG: Missing X (easting) coordinate.\n"); + /* Should not be possible to get here. Fake it and carry on. */ + strlcpy (xstr, "5", sizeof(xstr)); + } + if (strlen(ystr) == 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("MGRS/USNG: Missing Y (northing) coordinate.\n"); + /* Should not be possible to get here. Fake it and carry on. */ + strlcpy (ystr, "5", sizeof(ystr)); + } + + char loc[40]; + + strlcpy (loc, tt_config.ttloc_ptr[ipat].mgrs.zone, sizeof(loc)); + strlcat (loc, xstr, sizeof(loc)); + strlcat (loc, ystr, sizeof(loc)); + + //text_color_set(DW_COLOR_DEBUG); + //dw_printf ("MGRS/USNG location debug: %s\n", loc); + + strlcpy (m_loc_text, loc, sizeof(m_loc_text)); + + if (tt_config.ttloc_ptr[ipat].type == TTLOC_MGRS) + lerr = Convert_MGRS_To_Geodetic(loc, &lat0, &lon0); + else + lerr = Convert_USNG_To_Geodetic(loc, &lat0, &lon0); + + + if (lerr == 0) { + m_latitude = R2D(lat0); + m_longitude = R2D(lon0); + + //dw_printf ("DEBUG: from MGRS/USNG, latitude = %.6f, longitude = %.6f\n", m_latitude, m_longitude); + } + else { + char message[300]; + + text_color_set(DW_COLOR_ERROR); + mgrs_error_string (lerr, message); + dw_printf ("Conversion from MGRS/USNG failed:\n%s\n\n", message); + } + + m_dao[2] = e[0]; + m_dao[3] = e[1]; + + break; + + case TTLOC_MHEAD: + + + /* Combine prefix from configuration and digits from user. */ + + strlcpy (stemp, tt_config.ttloc_ptr[ipat].mhead.prefix, sizeof(stemp)); + strlcat (stemp, xstr, sizeof(stemp)); + + if (strlen(stemp) != 4 && strlen(stemp) != 6 && strlen(stemp) != 10 && strlen(stemp) != 12) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Expected total of 4, 6, 10, or 12 digits for the Maidenhead Locator \"%s\" + \"%s\"\n", + tt_config.ttloc_ptr[ipat].mhead.prefix, xstr); + return (TT_ERROR_INVALID_MHEAD); + } + + //text_color_set(DW_COLOR_DEBUG); + //dw_printf ("Case MHEAD: Convert to text \"%s\".\n", stemp); + + if (tt_mhead_to_text (stemp, 0, mh, sizeof(mh)) == 0) { + //text_color_set(DW_COLOR_DEBUG); + //dw_printf ("Case MHEAD: Resulting text \"%s\".\n", mh); + + strlcpy (m_loc_text, mh, sizeof(m_loc_text)); + + ll_from_grid_square (mh, &m_latitude, &m_longitude); + } + + m_dao[2] = e[0]; + m_dao[3] = e[1]; + + break; + + case TTLOC_SATSQ: + + if (strlen(xstr) != 4) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Expected 4 digits for the Satellite Square.\n"); + return (TT_ERROR_INVALID_SATSQ); + } + + /* Convert 4 digits to usual AA99 form, then to location. */ + + if (tt_satsq_to_text (xstr, 0, mh) == 0) { + + strlcpy (m_loc_text, mh, sizeof(m_loc_text)); + + ll_from_grid_square (mh, &m_latitude, &m_longitude); + } + + m_dao[2] = e[0]; + m_dao[3] = e[1]; + + break; + + case TTLOC_AMBIG: + + if (strlen(xstr) != 1) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Expected 1 digits for the position ambiguity.\n"); + return (TT_ERROR_INVALID_LOC); + } + + m_ambiguity = atoi(xstr); + + break; + + default: + assert (0); + } + return (0); + } + + /* Does not match any location specification. */ + + text_color_set(DW_COLOR_ERROR); + dw_printf ("Received location \"%s\" does not match any definitions.\n", e); + + /* Send reject sound. */ + + return (TT_ERROR_INVALID_LOC); + +} /* end parse_location */ + + +/*------------------------------------------------------------------ + * + * Name: find_ttloc_match + * + * Purpose: Try to match the received position report to a pattern + * defined in the configuration file. + * + * Inputs: e - An "entry" extracted from a complete + * APRStt message. + * In this case, it should start with "B". + * + * valstrsize - size of the outputs so we can check for buffer overflow. + * + * Outputs: xstr - All digits matching x positions in configuration. + * ystr - y + * zstr - z + * bstr - b + * dstr - d + * + * Returns: >= 0 for index into table if found. + * -1 if not found. + * + * Description: + * + *----------------------------------------------------------------*/ + +static int find_ttloc_match (char *e, char *xstr, char *ystr, char *zstr, char *bstr, char *dstr, size_t valstrsize) +{ + int ipat; /* Index into patterns from configuration file */ + int len; /* Length of pattern we are trying to match. */ + int match; + char mc; + int k; + + // debug dw_printf ("find_ttloc_match: e=%s\n", e); + + for (ipat=0; ipat%s:t%s", src, dest, msg); + + pp = ax25_from_text (raw_tt_msg, 1); + +/* + * Process like a normal received frame. + * NOTE: This goes directly to application rather than + * thru the multi modem duplicate processing. + * + * Should we use a different type so it can be easily + * distinguished later? + * + * We try to capture an overall audio level here. + * Mark and space do not apply in this case. + * This currently doesn't get displayed but we might want it someday. + */ + + if (pp != NULL) { + + alevel = demod_get_audio_level (chan, 0); + alevel.mark = -2; + alevel.space = -2; + + dlq_rec_frame (chan, -1, 0, pp, alevel, 0, RETRY_NONE, "tt"); + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Could not convert \"%s\" into APRS packet.\n", raw_tt_msg); + } + +#endif +} + +#endif + + +/*------------------------------------------------------------------ + * + * Name: dw_run_cmd + * + * Purpose: Run a command and capture the output. + * + * Inputs: cmd - The command. + * + * oneline - 0 = Keep original line separators. Caller + * must deal with operating system differences. + * 1 = Change CR, LF, TAB to space so result + * is one line of text. + * 2 = Also remove any trailing whitespace. + * + * resultsiz - Amount of space available for result. + * + * Outputs: result - Output captured from running command. + * + * Returns: -1 for any sort of error. + * >0 for number of characters returned (= strlen(result)) + * + * Description: This is currently used for running a user-specified + * script to generate a custom speech response. + * + * Future: There are potential other uses so it should probably + * be relocated to a file of other misc. utilities. + * + *----------------------------------------------------------------*/ + +int dw_run_cmd (char *cmd, int oneline, char *result, size_t resultsiz) +{ + FILE *fp; + + strlcpy (result, "", resultsiz); + + fp = popen (cmd, "r"); + if (fp != NULL) { + int remaining = (int)resultsiz; + char *pr = result; + int err; + + while (remaining > 2 && fgets(pr, remaining, fp) != NULL) { + pr = result + strlen(result); + remaining = (int)resultsiz - strlen(result); + } + + if ((err = pclose(fp)) != 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("ERROR: Unable to run \"%s\"\n", cmd); + // On Windows, non-existent file produces "Operation not permitted" + // Maybe we should put in a test for whether file exists. + dw_printf ("%s\n", strerror(err)); + + return (-1); + } + + // take out any newline characters. + + if (oneline) { + for (pr = result; *pr != '\0'; pr++) { + if (*pr == '\r' || *pr == '\n' || *pr == '\t') { + *pr = ' '; + } + } + + if (oneline > 1) { + pr = result + strlen(result) - 1; + while (pr >= result && *pr == ' ') { + *pr = '\0'; + pr--; + } + } + } + + //text_color_set(DW_COLOR_DEBUG); + //dw_printf ("%s returns \"%s\"\n", cmd, result); + + return (strlen(result)); + } + + else { + // explain_popen() would be nice but doesn't seem to be commonly available. + + // We get here only if fork or pipe fails. + // The command not existing must be caught above. + + text_color_set(DW_COLOR_ERROR); + dw_printf ("ERROR: Unable to run \"%s\"\n", cmd); + dw_printf ("%s\n", strerror(errno)); + + return (-1); + } + + +} /* end dw_run_cmd */ + + +/*------------------------------------------------------------------ + * + * Name: main + * + * Purpose: Unit test for this file. + * + * Description: Run unit test like this: + * + * rm a.exe ; gcc tt_text.c -DTT_MAIN -Igeotranz aprs_tt.c latlong.o textcolor.o geotranz.a misc.a ; ./a.exe + * or + * make ttest + * + *----------------------------------------------------------------*/ + + +#if TT_MAIN + +/* + * Regression test for the parsing. + * It does not maintain any history so abbreviation will not invoke previous full call. + */ + +/* Some examples are derived from http://www.aprs.org/aprstt/aprstt-coding24.txt */ + + +static const struct { + char *toneseq; /* Tone sequence in. */ + + char *callsign; /* Expected results... */ + char *ssid; + char *symbol; + char *freq; + char *comment; + char *lat; + char *lon; + char *dao; +} testcases[] = { + + /* Callsigns & abbreviations, traditional */ + + { "A9A2B42A7A7C71#", "WB4APR", "12", "7A", "", "", "-999999.0000", "-999999.0000", "!T !" }, /* WB4APR/7 */ + { "A27773#", "277", "12", "7A", "", "", "-999999.0000", "-999999.0000", "!T !" }, /* abbreviated form */ + + /* Intentionally wrong - Has 6 for checksum when it should be 3. */ + { "A27776#", "", "12", "\\A", "", "", "-999999.0000", "-999999.0000", "!T !" }, /* Expect error message. */ + + /* Example in spec is wrong. checksum should be 5 in this case. */ + { "A2A7A7C71#", "", "12", "\\A", "", "", "-999999.0000", "-999999.0000", "!T !" }, /* Spelled suffix, overlay, checksum */ + { "A2A7A7C75#", "APR", "12", "7A", "", "", "-999999.0000", "-999999.0000", "!T !" }, /* Spelled suffix, overlay, checksum */ + { "A27773#", "277", "12", "7A", "", "", "-999999.0000", "-999999.0000", "!T !" }, /* Suffix digits, overlay, checksum */ + + { "A9A2B26C7D9D71#", "WB2OSZ", "12", "7A", "", "", "-999999.0000", "-999999.0000", "!T !" }, /* WB2OSZ/7 numeric overlay */ + { "A67979#", "679", "12", "7A", "", "", "-999999.0000", "-999999.0000", "!T !" }, /* abbreviated form */ + + { "A9A2B26C7D9D5A9#", "WB2OSZ", "12", "JA", "", "", "-999999.0000", "-999999.0000", "!T !" }, /* WB2OSZ/J letter overlay */ + { "A6795A7#", "679", "12", "JA", "", "", "-999999.0000", "-999999.0000", "!T !" }, /* abbreviated form */ + + { "A277#", "277", "12", "\\A", "", "", "-999999.0000", "-999999.0000", "!T !" }, /* Tactical call "277" no overlay and no checksum */ + + /* QIKcom-2 style 10 digit call & 5 digit suffix */ + + { "AC9242771558#", "WB4APR", "12", "\\A", "", "", "-999999.0000", "-999999.0000", "!T !" }, + { "AC27722#", "APR", "12", "\\A", "", "", "-999999.0000", "-999999.0000", "!T !" }, + + /* Locations */ + + { "B01*A67979#", "679", "12", "7A", "", "", "12.2500", "56.2500", "!T1 !" }, + { "B988*A67979#", "679", "12", "7A", "", "", "12.5000", "56.5000", "!T88!" }, + + { "B51000125*A67979#", "679", "12", "7A", "", "", "52.7907", "0.8309", "!TB5!" }, /* expect about 52.79 +0.83 */ + + { "B5206070*A67979#", "679", "12", "7A", "", "", "37.9137", "-81.1366", "!TB5!" }, /* Try to get from Hilltop Tower to Archery & Target Range. */ + /* Latitude comes out ok, 37.9137 -> 55.82 min. */ + /* Longitude -81.1254 -> 8.20 min */ + { "B21234*A67979#", "679", "12", "7A", "", "", "12.3400", "56.1200", "!TB2!" }, + + { "B533686*A67979#", "679", "12", "7A", "", "", "37.9222", "81.1143", "!TB5!" }, + +// TODO: should test other coordinate systems. + + /* Comments */ + + { "C1", "", "12", "\\A", "", "", "-999999.0000", "-999999.0000", "!T !" }, + { "C2", "", "12", "\\A", "", "", "-999999.0000", "-999999.0000", "!T !" }, + { "C146520", "", "12", "\\A", "146.520MHz", "", "-999999.0000", "-999999.0000", "!T !" }, + { "C7788444222550227776669660333666990122223333", + "", "12", "\\A", "", "QUICK BROWN FOX 123", "-999999.0000", "-999999.0000", "!T !" }, + /* Macros */ + + { "88345", "BIKE 345", "0", "/b", "", "", "12.5000", "56.5000", "!T88!" }, + + /* 10 digit representation for callsign & satellite grid. WB4APR near 39.5, -77 */ + + { "AC9242771558*BA1819", "WB4APR", "12", "\\A", "", "", "39.5000", "-77.0000", "!TBA!" }, + { "18199242771558", "WB4APR", "12", "\\A", "", "", "39.5000", "-77.0000", "!TBA!" }, +}; + + +static int test_num; +static int error_count; + +static void check_result (void) +{ + char stemp[32]; + + text_color_set(DW_COLOR_DEBUG); + dw_printf ("callsign=\"%s\", ssid=%d, symbol=\"%c%c\", freq=\"%s\", comment=\"%s\", lat=%.4f, lon=%.4f, dao=\"%s\"\n", + m_callsign, m_ssid, m_symtab_or_overlay, m_symbol_code, m_freq, m_comment, m_latitude, m_longitude, m_dao); + + + if (strcmp(m_callsign, testcases[test_num].callsign) != 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("ERROR: Expected \"%s\" for callsign.\n", testcases[test_num].callsign); + error_count++; + } + + snprintf (stemp, sizeof(stemp), "%d", m_ssid); + if (strcmp(stemp, testcases[test_num].ssid) != 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("ERROR: Expected \"%s\" for SSID.\n", testcases[test_num].ssid); + error_count++; + } + + stemp[0] = m_symtab_or_overlay; + stemp[1] = m_symbol_code; + stemp[2] = '\0'; + if (strcmp(stemp, testcases[test_num].symbol) != 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("ERROR: Expected \"%s\" for Symbol.\n", testcases[test_num].symbol); + error_count++; + } + + if (strcmp(m_freq, testcases[test_num].freq) != 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("ERROR: Expected \"%s\" for Freq.\n", testcases[test_num].freq); + error_count++; + } + + if (strcmp(m_comment, testcases[test_num].comment) != 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("ERROR: Expected \"%s\" for Comment.\n", testcases[test_num].comment); + error_count++; + } + + snprintf (stemp, sizeof(stemp), "%.4f", m_latitude); + if (strcmp(stemp, testcases[test_num].lat) != 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("ERROR: Expected \"%s\" for Latitude.\n", testcases[test_num].lat); + error_count++; + } + + snprintf (stemp, sizeof(stemp), "%.4f", m_longitude); + if (strcmp(stemp, testcases[test_num].lon) != 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("ERROR: Expected \"%s\" for Longitude.\n", testcases[test_num].lon); + error_count++; + } + + if (strcmp(m_dao, testcases[test_num].dao) != 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("ERROR: Expected \"%s\" for DAO.\n", testcases[test_num].dao); + error_count++; + } +} + + +int main (int argc, char *argv[]) +{ + aprs_tt_init (NULL, 0); + + error_count = 0; + + for (test_num = 0; test_num < sizeof(testcases) / sizeof(testcases[0]); test_num++) { + + text_color_set(DW_COLOR_INFO); + dw_printf ("\nTest case %d: %s\n", test_num, testcases[test_num].toneseq); + + aprs_tt_sequence (0, testcases[test_num].toneseq); + } + + if (error_count != 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("\n\nTEST FAILED, Total of %d errors.\n", error_count); + return (EXIT_FAILURE); + } + + text_color_set(DW_COLOR_REC); + dw_printf ("\n\nAll tests passed.\n"); + return (EXIT_SUCCESS); + +} /* end main */ + + +#endif + +/* end aprs_tt.c */ + diff --git a/aprs_tt.h b/src/aprs_tt.h similarity index 50% rename from aprs_tt.h rename to src/aprs_tt.h index befe6c4a..4d33f487 100644 --- a/aprs_tt.h +++ b/src/aprs_tt.h @@ -5,6 +5,7 @@ #define APRS_TT_H 1 + /* * For holding location format specifications from config file. * Same thing is also useful for macro definitions. @@ -13,9 +14,9 @@ */ struct ttloc_s { - enum { TTLOC_POINT, TTLOC_VECTOR, TTLOC_GRID, TTLOC_UTM, TTLOC_MACRO } type; + enum { TTLOC_POINT, TTLOC_VECTOR, TTLOC_GRID, TTLOC_UTM, TTLOC_MGRS, TTLOC_USNG, TTLOC_MACRO, TTLOC_MHEAD, TTLOC_SATSQ, TTLOC_AMBIG } type; - char pattern[20]; /* e.g. B998, B5bbbdddd, B2xxyy, Byyyxxx */ + char pattern[20]; /* e.g. B998, B5bbbdddd, B2xxyy, Byyyxxx, BAxxxx */ /* For macros, it should be all fixed digits, */ /* and the letters x, y, z. e.g. 911, xxyyyz */ @@ -40,33 +41,106 @@ struct ttloc_s { } grid; struct { - char zone[8]; double scale; double x_offset; double y_offset; + long lzone; /* UTM zone, should be 1-60 */ + char latband; /* Latitude band if specified, otherwise space or - */ + char hemi; /* UTM Hemisphere, should be 'N' or 'S'. */ } utm; + struct { + char zone[8]; /* Zone and square for USNG/MGRS */ + } mgrs; + + struct { + char prefix[24]; /* should be 10, 6, or 4 digits to be */ + /* prepended to the received sequence. */ + } mhead; + struct { char *definition; } macro; + }; }; + +/* Error codes for sending responses to user. */ + +#define TT_ERROR_OK 0 /* Success. */ +#define TT_ERROR_D_MSG 1 /* D was first char of field. Not implemented yet. */ +#define TT_ERROR_INTERNAL 2 /* Internal error. Shouldn't be here. */ +#define TT_ERROR_MACRO_NOMATCH 3 /* No definition for digit sequence. */ +#define TT_ERROR_BAD_CHECKSUM 4 /* Bad checksum on call. */ +#define TT_ERROR_INVALID_CALL 5 /* Invalid callsign. */ +#define TT_ERROR_INVALID_OBJNAME 6 /* Invalid object name. */ +#define TT_ERROR_INVALID_SYMBOL 7 /* Invalid symbol specification. */ +#define TT_ERROR_INVALID_LOC 8 /* Invalid location. */ +#define TT_ERROR_NO_CALL 9 /* No call or object name included. */ +#define TT_ERROR_INVALID_MHEAD 10 /* Invalid Maidenhead Locator. */ +#define TT_ERROR_INVALID_SATSQ 11 /* Satellite square must be 4 digits. */ +#define TT_ERROR_SUFFIX_NO_CALL 12 /* No known callsign for suffix. */ + +#define TT_ERROR_MAXP1 13 /* Number of items above. i.e. Last number plus 1. */ + + +#if CONFIG_C /* Is this being included from config.c? */ + +/* Must keep in sync with above !!! */ + +static const char *tt_msg_id[TT_ERROR_MAXP1] = { + "OK", + "D_MSG", + "INTERNAL", + "MACRO_NOMATCH", + "BAD_CHECKSUM", + "INVALID_CALL", + "INVALID_OBJNAME", + "INVALID_SYMBOL", + "INVALID_LOC", + "NO_CALL", + "INVALID_MHEAD", + "INVALID_SATSQ", + "SUFFIX_NO_CALL" +}; + +#endif + /* * Configuration options for APRStt. */ #define TT_MAX_XMITS 10 +#define TT_MTEXT_LEN 64 + + struct tt_config_s { + int gateway_enabled; /* Send DTMF sequences to APRStt gateway. */ + + int obj_recv_chan; /* Channel to listen for tones. */ + int obj_xmit_chan; /* Channel to transmit object report. */ - char obj_xmit_header[AX25_MAX_ADDRS*AX25_MAX_ADDR_LEN]; - /* e.g. "WB2OSZ-5>APDW07,WIDE1-1" */ + /* -1 for none. This could happen if we */ + /* are only sending to application */ + /* and/or IGate. */ + + int obj_send_to_app; /* send to attached application(s). */ + + int obj_send_to_ig; /* send to IGate. */ + + char obj_xmit_via[AX25_MAX_REPEATERS * (AX25_MAX_ADDR_LEN+1)]; + /* e.g. empty or "WIDE2-1,WIDE1-1" */ int retain_time; /* Seconds to keep information about a user. */ + int num_xmits; /* Number of times to transmit object report. */ + int xmit_delay[TT_MAX_XMITS]; /* Delay between them. */ + /* e.g. 3 seconds before first transmission then */ + /* delays of 16, 32, seconds etc. in between repeats. */ struct ttloc_s *ttloc_ptr; /* Pointer to variable length array of above. */ int ttloc_size; /* Number of elements allocated. */ @@ -76,32 +150,42 @@ struct tt_config_s { double corral_lon; double corral_offset; int corral_ambiguity; + + char status[10][TT_MTEXT_LEN]; /* Up to 9 status messages. e.g. "/enroute" */ + /* Position 0 means none and can't be changed. */ + + struct { + char method[AX25_MAX_ADDR_LEN]; /* SPEECH or MORSE[-n] */ + char mtext[TT_MTEXT_LEN]; /* Message text. */ + } response[TT_ERROR_MAXP1]; + + char ttcmd[80]; /* Command to generate custom audible response. */ }; -void aprs_tt_init (struct tt_config_s *p_config); +void aprs_tt_init (struct tt_config_s *p_config, int debug); void aprs_tt_button (int chan, char button); -/* Error codes for sending responses to user. */ -#define TT_ERROR_D_MSG 1 /* D was first char of field. Not implemented yet. */ -#define TT_ERROR_INTERNAL 2 /* Internal error. Shouldn't be here. */ -#define TT_ERROR_MACRO_NOMATCH 3 /* No definition for digit sequence. */ -#define TT_ERROR_BAD_CHECKSUM 4 /* Bad checksum on call. */ -#define TT_ERROR_INVALID_CALL 5 /* Invalid callsign. */ -#define TT_ERROR_INVALID_OBJNAME 6 /* Invalid object name. */ -#define TT_ERROR_INVALID_SYMBOL 7 /* Invalid symbol specification. */ -#define TT_ERROR_INVALID_LOC 8 /* Invalid location. */ -#define TT_ERROR_NO_CALL 9 /* No call or object name included. */ + #define APRSTT_LOC_DESC_LEN 32 /* Need at least 26 */ +#define APRSTT_DEFAULT_SYMTAB '\\' +#define APRSTT_DEFAULT_SYMBOL 'A' + + void aprs_tt_dao_to_desc (char *dao, char *str); +void aprs_tt_sequence (int chan, char *msg); + +int dw_run_cmd (char *cmd, int oneline, char *result, size_t resultsiz); + + #endif /* end aprs_tt.h */ \ No newline at end of file diff --git a/src/atest.c b/src/atest.c new file mode 100644 index 00000000..c5f4ec50 --- /dev/null +++ b/src/atest.c @@ -0,0 +1,1040 @@ + +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// +// Copyright (C) 2011, 2012, 2013, 2014, 2015, 2016, 2019, 2021, 2022, 2023 John Langner, WB2OSZ +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . +// + + +/*------------------------------------------------------------------- + * + * Name: atest.c + * + * Purpose: Test fixture for the Dire Wolf demodulators. + * + * Inputs: Takes audio from a .WAV file instead of the audio device. + * + * Description: This can be used to test the demodulators under + * controlled and reproducible conditions for tweaking. + * + * For example + * + * (1) Download WA8LMF's TNC Test CD image file from + * http://wa8lmf.net/TNCtest/index.htm + * + * (2) Burn a physical CD. + * + * (3) "Rip" the desired tracks with Windows Media Player. + * Select .WAV file format. + * + * "Track 2" is used for most tests because that is more + * realistic for most people using the speaker output. + * + * + * Without ONE_CHAN defined: + * + * Notice that the number of packets decoded, as reported by + * this test program, will be twice the number expected because + * we are decoding the left and right audio channels separately. + * + * + * With ONE_CHAN defined: + * + * Only process one channel. + * + *--------------------------------------------------------------------*/ + +// #define X 1 + +#include "direwolf.h" + +#include +#include +#include +#include +#include +#include +#include +#include + + +#define ATEST_C 1 + +#include "audio.h" +#include "demod.h" +#include "multi_modem.h" +#include "textcolor.h" +#include "ax25_pad.h" +#include "hdlc_rec2.h" +#include "dlq.h" +#include "ptt.h" +#include "dtime_now.h" +#include "fx25.h" +#include "il2p.h" +#include "hdlc_rec.h" + + +#if 0 /* Typical but not flexible enough. */ + +struct wav_header { /* .WAV file header. */ + char riff[4]; /* "RIFF" */ + int filesize; /* file length - 8 */ + char wave[4]; /* "WAVE" */ + char fmt[4]; /* "fmt " */ + int fmtsize; /* 16. */ + short wformattag; /* 1 for PCM. */ + short nchannels; /* 1 for mono, 2 for stereo. */ + int nsamplespersec; /* sampling freq, Hz. */ + int navgbytespersec; /* = nblockalign*nsamplespersec. */ + short nblockalign; /* = wbitspersample/8 * nchannels. */ + short wbitspersample; /* 16 or 8. */ + char data[4]; /* "data" */ + int datasize; /* number of bytes following. */ +} ; +#endif + /* 8 bit samples are unsigned bytes */ + /* in range of 0 .. 255. */ + + /* 16 bit samples are little endian signed short */ + /* in range of -32768 .. +32767. */ + +static struct { + char riff[4]; /* "RIFF" */ + int filesize; /* file length - 8 */ + char wave[4]; /* "WAVE" */ +} header; + +static struct { + char id[4]; /* "LIST" or "fmt " */ + int datasize; +} chunk; + +static struct { + short wformattag; /* 1 for PCM. */ + short nchannels; /* 1 for mono, 2 for stereo. */ + int nsamplespersec; /* sampling freq, Hz. */ + int navgbytespersec; /* = nblockalign*nsamplespersec. */ + short nblockalign; /* = wbitspersample/8 * nchannels. */ + short wbitspersample; /* 16 or 8. */ + char extras[4]; +} format; + +static struct { + char data[4]; /* "data" */ + int datasize; +} wav_data; + + +static FILE *fp; +static int e_o_f; +static int packets_decoded_one = 0; +static int packets_decoded_total = 0; +static int decimate = 0; /* Reduce that sampling rate if set. */ + /* 1 = normal, 2 = half, 3 = 1/3, etc. */ + +static int upsample = 0; /* Upsample for G3RUH decoder. */ + /* Non-zero will override the default. */ + +static struct audio_s my_audio_config; + +static int error_if_less_than = -1; /* Exit with error status if this minimum not reached. */ + /* Can be used to check that performance has not decreased. */ + +static int error_if_greater_than = -1; /* Exit with error status if this maximum exceeded. */ + /* Can be used to check that duplicate removal is not broken. */ + + + +//#define EXPERIMENT_G 1 +//#define EXPERIMENT_H 1 + +#if defined(EXPERIMENT_G) || defined(EXPERIMENT_H) + +static int count[MAX_SUBCHANS]; + +#if EXPERIMENT_H +extern float space_gain[MAX_SUBCHANS]; +#endif + +#endif + +static void usage (void); + + +static int decode_only = 0; /* Set to 0 or 1 to decode only one channel. 2 for both. */ + +static int sample_number = -1; /* Sample number from the file. */ + /* Incremented only for channel 0. */ + /* Use to print timestamp, relative to beginning */ + /* of file, when frame was decoded. */ + +// command line options. + +static int B_opt = DEFAULT_BAUD; // Bits per second. Need to change all baud references to bps. +static int g_opt = 0; // G3RUH modem regardless of speed. +static int j_opt = 0; /* 2400 bps PSK compatible with direwolf <= 1.5 */ +static int J_opt = 0; /* 2400 bps PSK compatible MFJ-2400 and maybe others. */ +static int h_opt = 0; // Hexadecimal display of received packet. +static char P_opt[16] = ""; // Demodulator profiles. +static int d_x_opt = 1; // FX.25 debug. +static int d_o_opt = 0; // "-d o" option for DCD output control. */ +static int d_2_opt = 0; // "-d 2" option for IL2P details. */ +static int dcd_count = 0; +static int dcd_missing_errors = 0; + + +int main (int argc, char *argv[]) +{ + + int err; + int c; + int channel; + + double start_time; // Time when we started so we can measure elapsed time. + double one_filetime = 0; // Length of one audio file in seconds. + double total_filetime = 0; // Length of all audio files in seconds. + double elapsed; // Time it took us to process it. + + +#if defined(EXPERIMENT_G) || defined(EXPERIMENT_H) + int j; + + for (j=0; j 8) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Unreasonable value for -D.\n"); + exit (EXIT_FAILURE); + } + dw_printf ("Divide audio sample rate by %d\n", decimate); + my_audio_config.achan[0].decimate = decimate; + break; + + case 'U': /* -U upsample for G3RUH to improve performance */ + /* when the sample rate to baud ratio is low. */ + /* Actually it is set automatically and this will */ + /* override the normal calculation. */ + + upsample = atoi(optarg); + + dw_printf ("Multiply audio sample rate by %d\n", upsample); + if (upsample < 1 || upsample > 4) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Unreasonable value for -U.\n"); + exit (EXIT_FAILURE); + } + dw_printf ("Multiply audio sample rate by %d\n", upsample); + my_audio_config.achan[0].upsample = upsample; + break; + + case 'F': /* -F set "fix bits" level. */ + + my_audio_config.achan[0].fix_bits = atoi(optarg); + + if (my_audio_config.achan[0].fix_bits < RETRY_NONE || my_audio_config.achan[0].fix_bits >= RETRY_MAX) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Invalid Fix Bits level.\n"); + exit (EXIT_FAILURE); + } + break; + + case 'L': /* -L error if less than this number decoded. */ + + error_if_less_than = atoi(optarg); + break; + + case 'G': /* -G error if greater than this number decoded. */ + + error_if_greater_than = atoi(optarg); + break; + + case '0': /* channel 0, left from stereo */ + + decode_only = 0; + break; + + case '1': /* channel 1, right from stereo */ + + decode_only = 1; + break; + + case '2': /* decode both from stereo */ + + decode_only = 2; + break; + + case 'h': /* Hexadecimal display. */ + + h_opt = 1; + break; + + case 'e': /* Receive Bit Error Rate (BER). */ + + my_audio_config.recv_ber = atof(optarg); + break; + + case 'd': /* Debug message options. */ + + for (char *p=optarg; *p!='\0'; p++) { + switch (*p) { + case 'x': d_x_opt++; break; // FX.25 + case 'o': d_o_opt++; break; // DCD output control + case '2': d_2_opt++; break; // IL2P debug out + default: break; + } + } + break; + + case '?': + + /* Unknown option message was already printed. */ + usage (); + break; + + default: + + /* Should not be here. */ + text_color_set(DW_COLOR_ERROR); + dw_printf("?? getopt returned character code 0%o ??\n", c); + usage (); + } + } + +/* + * Set modem type based on data rate. + * (Could be overridden by -g, -j, or -J later.) + */ + /* 300 implies 1600/1800 AFSK. */ + /* 1200 implies 1200/2200 AFSK. */ + /* 2400 implies V.26 QPSK. */ + /* 4800 implies V.27 8PSK. */ + /* 9600 implies G3RUH baseband scrambled. */ + + my_audio_config.achan[0].baud = B_opt; + + + /* We have similar logic in direwolf.c, config.c, gen_packets.c, and atest.c, */ + /* that need to be kept in sync. Maybe it could be a common function someday. */ + + if (my_audio_config.achan[0].baud == 100) { // What was this for? + my_audio_config.achan[0].modem_type = MODEM_AFSK; + my_audio_config.achan[0].mark_freq = 1615; + my_audio_config.achan[0].space_freq = 1785; + } + else if (my_audio_config.achan[0].baud < 600) { // e.g. HF SSB packet + my_audio_config.achan[0].modem_type = MODEM_AFSK; + my_audio_config.achan[0].mark_freq = 1600; + my_audio_config.achan[0].space_freq = 1800; + // Previously we had a "D" which was fine tuned for 300 bps. + // In v1.7, it's not clear if we should use "B" or just stick with "A". + } + else if (my_audio_config.achan[0].baud < 1800) { // common 1200 + my_audio_config.achan[0].modem_type = MODEM_AFSK; + my_audio_config.achan[0].mark_freq = DEFAULT_MARK_FREQ; + my_audio_config.achan[0].space_freq = DEFAULT_SPACE_FREQ; + } + else if (my_audio_config.achan[0].baud < 3600) { + my_audio_config.achan[0].modem_type = MODEM_QPSK; + my_audio_config.achan[0].mark_freq = 0; + my_audio_config.achan[0].space_freq = 0; + strlcpy (my_audio_config.achan[0].profiles, "", sizeof(my_audio_config.achan[0].profiles)); + } + else if (my_audio_config.achan[0].baud < 7200) { + my_audio_config.achan[0].modem_type = MODEM_8PSK; + my_audio_config.achan[0].mark_freq = 0; + my_audio_config.achan[0].space_freq = 0; + strlcpy (my_audio_config.achan[0].profiles, "", sizeof(my_audio_config.achan[0].profiles)); + } + else if (my_audio_config.achan[0].baud == 0xA15A15) { // Hack for different use of 9600 + my_audio_config.achan[0].modem_type = MODEM_AIS; + my_audio_config.achan[0].baud = 9600; + my_audio_config.achan[0].mark_freq = 0; + my_audio_config.achan[0].space_freq = 0; + strlcpy (my_audio_config.achan[0].profiles, " ", sizeof(my_audio_config.achan[0].profiles)); // avoid getting default later. + } + else if (my_audio_config.achan[0].baud == 0xEA5EA5) { + my_audio_config.achan[0].modem_type = MODEM_EAS; + my_audio_config.achan[0].baud = 521; // Actually 520.83 but we have an integer field here. + // Will make more precise in afsk demod init. + my_audio_config.achan[0].mark_freq = 2083; // Actually 2083.3 - logic 1. + my_audio_config.achan[0].space_freq = 1563; // Actually 1562.5 - logic 0. + strlcpy (my_audio_config.achan[0].profiles, "A", sizeof(my_audio_config.achan[0].profiles)); + } + else { + my_audio_config.achan[0].modem_type = MODEM_SCRAMBLE; + my_audio_config.achan[0].mark_freq = 0; + my_audio_config.achan[0].space_freq = 0; + strlcpy (my_audio_config.achan[0].profiles, " ", sizeof(my_audio_config.achan[0].profiles)); // avoid getting default later. + } + + if (my_audio_config.achan[0].baud < MIN_BAUD || my_audio_config.achan[0].baud > MAX_BAUD) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Use a more reasonable bit rate in range of %d - %d.\n", MIN_BAUD, MAX_BAUD); + exit (EXIT_FAILURE); + } + +/* + * -g option means force g3RUH regardless of speed. + */ + + if (g_opt) { + my_audio_config.achan[0].modem_type = MODEM_SCRAMBLE; + my_audio_config.achan[0].mark_freq = 0; + my_audio_config.achan[0].space_freq = 0; + strlcpy (my_audio_config.achan[0].profiles, " ", sizeof(my_audio_config.achan[0].profiles)); // avoid getting default later. + } + +/* + * We have two different incompatible flavors of V.26. + */ + if (j_opt) { + + // V.26 compatible with earlier versions of direwolf. + // Example: -B 2400 -j or simply -j + + my_audio_config.achan[0].v26_alternative = V26_A; + my_audio_config.achan[0].modem_type = MODEM_QPSK; + my_audio_config.achan[0].mark_freq = 0; + my_audio_config.achan[0].space_freq = 0; + my_audio_config.achan[0].baud = 2400; + strlcpy (my_audio_config.achan[0].profiles, "", sizeof(my_audio_config.achan[0].profiles)); + } + if (J_opt) { + + // V.26 compatible with MFJ and maybe others. + // Example: -B 2400 -J or simply -J + + my_audio_config.achan[0].v26_alternative = V26_B; + my_audio_config.achan[0].modem_type = MODEM_QPSK; + my_audio_config.achan[0].mark_freq = 0; + my_audio_config.achan[0].space_freq = 0; + my_audio_config.achan[0].baud = 2400; + strlcpy (my_audio_config.achan[0].profiles, "", sizeof(my_audio_config.achan[0].profiles)); + } + + // Needs to be after -B, -j, -J. + if (strlen(P_opt) > 0) { + dw_printf ("Demodulator profile set to \"%s\"\n", P_opt); + strlcpy (my_audio_config.achan[0].profiles, P_opt, sizeof(my_audio_config.achan[0].profiles)); + } + + memcpy (&my_audio_config.achan[1], &my_audio_config.achan[0], sizeof(my_audio_config.achan[0])); + + + if (optind >= argc) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Specify .WAV file name on command line.\n"); + usage (); + } + + fx25_init (d_x_opt); + il2p_init (d_2_opt); + + start_time = dtime_now(); + + while (optind < argc) { + + fp = fopen(argv[optind], "rb"); + if (fp == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Couldn't open file for read: %s\n", argv[optind]); + //perror ("more info?"); + exit (EXIT_FAILURE); + } + +/* + * Read the file header. + * Doesn't handle all possible cases but good enough for our purposes. + */ + + err= fread (&header, (size_t)12, (size_t)1, fp); + (void)(err); + + if (strncmp(header.riff, "RIFF", 4) != 0 || strncmp(header.wave, "WAVE", 4) != 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("This is not a .WAV format file.\n"); + exit (EXIT_FAILURE); + } + + err = fread (&chunk, (size_t)8, (size_t)1, fp); + + if (strncmp(chunk.id, "LIST", 4) == 0) { + err = fseek (fp, (long)chunk.datasize, SEEK_CUR); + err = fread (&chunk, (size_t)8, (size_t)1, fp); + } + + if (strncmp(chunk.id, "fmt ", 4) != 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("WAV file error: Found \"%4.4s\" where \"fmt \" was expected.\n", chunk.id); + exit(EXIT_FAILURE); + } + if (chunk.datasize != 16 && chunk.datasize != 18) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("WAV file error: Need fmt chunk datasize of 16 or 18. Found %d.\n", chunk.datasize); + exit(EXIT_FAILURE); + } + + err = fread (&format, (size_t)chunk.datasize, (size_t)1, fp); + + err = fread (&wav_data, (size_t)8, (size_t)1, fp); + + if (strncmp(wav_data.data, "data", 4) != 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("WAV file error: Found \"%4.4s\" where \"data\" was expected.\n", wav_data.data); + exit(EXIT_FAILURE); + } + + if (format.wformattag != 1) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Sorry, I only understand audio format 1 (PCM). This file has %d.\n", format.wformattag); + exit (EXIT_FAILURE); + } + + if (format.nchannels != 1 && format.nchannels != 2) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Sorry, I only understand 1 or 2 channels. This file has %d.\n", format.nchannels); + exit (EXIT_FAILURE); + } + + if (format.wbitspersample != 8 && format.wbitspersample != 16) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Sorry, I only understand 8 or 16 bits per sample. This file has %d.\n", format.wbitspersample); + exit (EXIT_FAILURE); + } + + my_audio_config.adev[0].samples_per_sec = format.nsamplespersec; + my_audio_config.adev[0].bits_per_sample = format.wbitspersample; + my_audio_config.adev[0].num_channels = format.nchannels; + + my_audio_config.chan_medium[0] = MEDIUM_RADIO; + if (format.nchannels == 2) { + my_audio_config.chan_medium[1] = MEDIUM_RADIO; + } + + text_color_set(DW_COLOR_INFO); + dw_printf ("%d samples per second. %d bits per sample. %d audio channels.\n", + my_audio_config.adev[0].samples_per_sec, + my_audio_config.adev[0].bits_per_sample, + my_audio_config.adev[0].num_channels); + one_filetime = (double) wav_data.datasize / + ((my_audio_config.adev[0].bits_per_sample / 8) * my_audio_config.adev[0].num_channels * my_audio_config.adev[0].samples_per_sec); + total_filetime += one_filetime; + + dw_printf ("%d audio bytes in file. Duration = %.1f seconds.\n", + (int)(wav_data.datasize), + one_filetime); + dw_printf ("Fix Bits level = %d\n", my_audio_config.achan[0].fix_bits); + +/* + * Initialize the AFSK demodulator and HDLC decoder. + * Needs to be done for each file because they could have different sample rates. + */ + multi_modem_init (&my_audio_config); + packets_decoded_one = 0; + + + e_o_f = 0; + while ( ! e_o_f) + { + + + int audio_sample; + int c; + + for (c=0; c= 256 * 256) { + e_o_f = 1; + continue; + } + + if (c == 0) sample_number++; + + if (decode_only == 0 && c != 0) continue; + if (decode_only == 1 && c != 1) continue; + + multi_modem_process_sample(c,audio_sample); + } + + /* When a complete frame is accumulated, */ + /* process_rec_frame, below, is called. */ + + } + text_color_set(DW_COLOR_INFO); + dw_printf ("\n\n"); + +#if EXPERIMENT_G + + for (j=0; j error_if_greater_than) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("\n * * * TEST FAILED: number decoded is greater than %d * * * \n", error_if_greater_than); + exit (EXIT_FAILURE); + } + + exit (EXIT_SUCCESS); +} + + +/* + * Simulate sample from the audio device. + */ + +int audio_get (int a) +{ + int ch; + + if (wav_data.datasize <= 0) { + e_o_f = 1; + return (-1); + } + + ch = getc(fp); + wav_data.datasize--; + + if (ch < 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Unexpected end of file.\n"); + e_o_f = 1; + } + + return (ch); +} + + + +/* + * This is called when we have a good frame. + */ + +void dlq_rec_frame (int chan, int subchan, int slice, packet_t pp, alevel_t alevel, fec_type_t fec_type, retry_t retries, char *spectrum) +{ + + char stemp[500]; + unsigned char *pinfo; + int info_len; + int h; + char heard[2 * AX25_MAX_ADDR_LEN + 20]; + char alevel_text[AX25_ALEVEL_TO_TEXT_SIZE]; + + packets_decoded_one++; + if ( ! hdlc_rec_data_detect_any(chan)) dcd_missing_errors++; + + ax25_format_addrs (pp, stemp); + + info_len = ax25_get_info (pp, &pinfo); + + /* Print so we can see what is going on. */ + +//TODO: quiet option - suppress packet printing, only the count at the end. + +#if 1 + /* Display audio input level. */ + /* Who are we hearing? Original station or digipeater? */ + + if (ax25_get_num_addr(pp) == 0) { + /* Not AX.25. No station to display below. */ + h = -1; + strlcpy (heard, "", sizeof(heard)); + } + else { + h = ax25_get_heard(pp); + ax25_get_addr_with_ssid(pp, h, heard); + } + + text_color_set(DW_COLOR_DEBUG); + dw_printf ("\n"); + dw_printf("DECODED[%d] ", packets_decoded_one ); + + /* Insert time stamp relative to start of file. */ + + double sec = (double)sample_number / my_audio_config.adev[0].samples_per_sec; + int min = (int)(sec / 60.); + sec -= min * 60; + + dw_printf ("%d:%06.3f ", min, sec); + + if (h != AX25_SOURCE) { + dw_printf ("Digipeater "); + } + ax25_alevel_to_text (alevel, alevel_text); + + /* As suggested by KJ4ERJ, if we are receiving from */ + /* WIDEn-0, it is quite likely (but not guaranteed), that */ + /* we are actually hearing the preceding station in the path. */ + + if (h >= AX25_REPEATER_2 && + strncmp(heard, "WIDE", 4) == 0 && + isdigit(heard[4]) && + heard[5] == '\0') { + + char probably_really[AX25_MAX_ADDR_LEN]; + ax25_get_addr_with_ssid(pp, h-1, probably_really); + + strlcat (heard, " (probably ", sizeof(heard)); + strlcat (heard, probably_really, sizeof(heard)); + strlcat (heard, ")", sizeof(heard)); + } + + switch (fec_type) { + + case fec_type_fx25: + dw_printf ("%s audio level = %s FX.25 %s\n", heard, alevel_text, spectrum); + break; + + case fec_type_il2p: + dw_printf ("%s audio level = %s IL2P %s\n", heard, alevel_text, spectrum); + break; + + case fec_type_none: + default: + if (my_audio_config.achan[chan].fix_bits == RETRY_NONE && my_audio_config.achan[chan].passall == 0) { + // No fix_bits or passall specified. + dw_printf ("%s audio level = %s %s\n", heard, alevel_text, spectrum); + } + else { + assert (retries >= RETRY_NONE && retries <= RETRY_MAX); // validate array index. + dw_printf ("%s audio level = %s [%s] %s\n", heard, alevel_text, retry_text[(int)retries], spectrum); + } + break; + } + +#endif + + +// Display non-APRS packets in a different color. + +// Display channel with subchannel/slice if applicable. + + if (ax25_is_aprs(pp)) { + text_color_set(DW_COLOR_REC); + } + else { + text_color_set(DW_COLOR_DEBUG); + } + + if (my_audio_config.achan[chan].num_subchan > 1 && my_audio_config.achan[chan].num_slicers == 1) { + dw_printf ("[%d.%d] ", chan, subchan); + } + else if (my_audio_config.achan[chan].num_subchan == 1 && my_audio_config.achan[chan].num_slicers > 1) { + dw_printf ("[%d.%d] ", chan, slice); + } + else if (my_audio_config.achan[chan].num_subchan > 1 && my_audio_config.achan[chan].num_slicers > 1) { + dw_printf ("[%d.%d.%d] ", chan, subchan, slice); + } + else { + dw_printf ("[%d] ", chan); + } + + dw_printf ("%s", stemp); /* stations followed by : */ + ax25_safe_print ((char *)pinfo, info_len, 0); + dw_printf ("\n"); + +/* + * -h option for hexadecimal display. (new in 1.6) + */ + + if (h_opt) { + + text_color_set(DW_COLOR_DEBUG); + dw_printf ("------\n"); + ax25_hex_dump (pp); + dw_printf ("------\n"); + } + + + + +#if 0 // temp experiment + +#include "decode_aprs.h" +#include "log.h" + + if (ax25_is_aprs(pp)) { + + decode_aprs_t A; + + decode_aprs (&A, pp, 0, NULL); + + // Temp experiment to see how different systems set the RR bits in the source and destination. + // log_rr_bits (&A, pp); + + } +#endif + + + ax25_delete (pp); + +} /* end fake dlq_append */ + + +void ptt_set (int ot, int chan, int ptt_signal) +{ + // Should only get here for DCD output control. + static double dcd_start_time[MAX_CHANS]; + + if (d_o_opt) { + double t = (double)sample_number / my_audio_config.adev[0].samples_per_sec; + double sec1, sec2; + int min1, min2; + + text_color_set(DW_COLOR_INFO); + + if (ptt_signal) { + //sec1 = t; + //min1 = (int)(sec1 / 60.); + //sec1 -= min1 * 60; + //dw_printf ("DCD[%d] = ON %d:%06.3f\n", chan, min1, sec1); + dcd_count++; + dcd_start_time[chan] = t; + } + else { + //dw_printf ("DCD[%d] = off %d:%06.3f %3.0f\n", chan, min, sec, (t - dcd_start_time[chan]) * 1000.); + + sec1 = dcd_start_time[chan]; + min1 = (int)(sec1 / 60.); + sec1 -= min1 * 60; + + sec2 = t; + min2 = (int)(sec2 / 60.); + sec2 -= min2 * 60; + + dw_printf ("DCD[%d] %d:%06.3f - %d:%06.3f = %3.0f\n", chan, min1, sec1, min2, sec2, (t - dcd_start_time[chan]) * 1000.); + } + } + return; +} + +int get_input (int it, int chan) +{ + return -1; +} + +static void usage (void) { + + text_color_set(DW_COLOR_ERROR); + + dw_printf ("\n"); + dw_printf ("atest is a test application which decodes AX.25 frames from an audio\n"); + dw_printf ("recording. This provides an easy way to test Dire Wolf decoding\n"); + dw_printf ("performance much quicker than normal real-time. \n"); + dw_printf ("\n"); + dw_printf ("usage:\n"); + dw_printf ("\n"); + dw_printf (" atest [ options ] wav-file-in\n"); + dw_printf ("\n"); + dw_printf (" -B n Bits/second for data. Proper modem automatically selected for speed.\n"); + dw_printf (" 300 bps defaults to AFSK tones of 1600 & 1800.\n"); + dw_printf (" 1200 bps uses AFSK tones of 1200 & 2200.\n"); + dw_printf (" 2400 bps uses QPSK based on V.26 standard.\n"); + dw_printf (" 4800 bps uses 8PSK based on V.27 standard.\n"); + dw_printf (" 9600 bps and up uses K9NG/G3RUH standard.\n"); + dw_printf (" AIS for ship Automatic Identification System.\n"); + dw_printf (" EAS for Emergency Alert System (EAS) Specific Area Message Encoding (SAME).\n"); + dw_printf ("\n"); + dw_printf (" -g Use G3RUH modem rather rather than default for data rate.\n"); + dw_printf (" -j 2400 bps QPSK compatible with direwolf <= 1.5.\n"); + dw_printf (" -J 2400 bps QPSK compatible with MFJ-2400.\n"); + dw_printf ("\n"); + dw_printf (" -D n Divide audio sample rate by n.\n"); + dw_printf ("\n"); + dw_printf (" -h Print frame contents as hexadecimal bytes.\n"); + dw_printf ("\n"); + dw_printf (" -F n Amount of effort to try fixing frames with an invalid CRC. \n"); + dw_printf (" 0 (default) = consider only correct frames. \n"); + dw_printf (" 1 = Try to fix only a single bit. \n"); + dw_printf (" more = Try modifying more bits to get a good CRC.\n"); + dw_printf ("\n"); + dw_printf (" -d x Debug information for FX.25. Repeat for more detail.\n"); + dw_printf ("\n"); + dw_printf (" -L Error if less than this number decoded.\n"); + dw_printf ("\n"); + dw_printf (" -G Error if greater than this number decoded.\n"); + dw_printf ("\n"); + dw_printf (" -P m Select the demodulator type such as D (default for 300 bps),\n"); + dw_printf (" E+ (default for 1200 bps), PQRS for 2400 bps, etc.\n"); + dw_printf ("\n"); + dw_printf (" -0 Use channel 0 (left) of stereo audio (default).\n"); + dw_printf (" -1 use channel 1 (right) of stereo audio.\n"); + dw_printf (" -2 decode both channels of stereo audio.\n"); + dw_printf ("\n"); + dw_printf (" wav-file-in is a WAV format audio file.\n"); + dw_printf ("\n"); + dw_printf ("Examples:\n"); + dw_printf ("\n"); + dw_printf (" gen_packets -o test1.wav\n"); + dw_printf (" atest test1.wav\n"); + dw_printf ("\n"); + dw_printf (" gen_packets -B 300 -o test3.wav\n"); + dw_printf (" atest -B 300 test3.wav\n"); + dw_printf ("\n"); + dw_printf (" gen_packets -B 9600 -o test9.wav\n"); + dw_printf (" atest -B 9600 test9.wav\n"); + dw_printf ("\n"); + dw_printf (" This generates and decodes 3 test files with 1200, 300, and 9600\n"); + dw_printf (" bits per second.\n"); + dw_printf ("\n"); + dw_printf (" atest 02_Track_2.wav\n"); + dw_printf (" atest -P E- 02_Track_2.wav\n"); + dw_printf (" atest -F 1 02_Track_2.wav\n"); + dw_printf (" atest -P E- -F 1 02_Track_2.wav\n"); + dw_printf ("\n"); + dw_printf (" Try different combinations of options to compare decoding\n"); + dw_printf (" performance.\n"); + + exit (1); +} + + + +/* end atest.c */ diff --git a/src/audio.c b/src/audio.c new file mode 100644 index 00000000..82dec22a --- /dev/null +++ b/src/audio.c @@ -0,0 +1,1670 @@ + + +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// +// Copyright (C) 2011, 2012, 2013, 2014, 2015 John Langner, WB2OSZ +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . +// + + +/*------------------------------------------------------------------ + * + * Module: audio.c + * + * Purpose: Interface to audio device commonly called a "sound card" for + * historical reasons. + * + * This version is for Linux and Cygwin. + * + * Two different types of sound interfaces are supported: + * + * * OSS - For Cygwin or Linux versions with /dev/dsp. + * + * * ALSA - For Linux versions without /dev/dsp. + * In this case, define preprocessor symbol USE_ALSA. + * + * References: Some tips on on using Linux sound devices. + * + * http://www.oreilly.de/catalog/multilinux/excerpt/ch14-05.htm + * http://cygwin.com/ml/cygwin-patches/2004-q1/msg00116/devdsp.c + * http://manuals.opensound.com/developer/fulldup.c.html + * + * "Introduction to Sound Programming with ALSA" + * http://www.linuxjournal.com/article/6735?page=0,1 + * + * http://www.alsa-project.org/main/index.php/Asoundrc + * + * Credits: Release 1.0: Fabrice FAURE contributed code for the SDR UDP interface. + * + * Discussion here: http://gqrx.dk/doc/streaming-audio-over-udp + * + * Release 1.1: Gabor Berczi provided fixes for the OSS code + * which had fallen into decay. + * + * Major Revisions: + * + * 1.2 - Add ability to use more than one audio device. + * + *---------------------------------------------------------------*/ + +#include "direwolf.h" + +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include + + +#if USE_ALSA +#include +#elif USE_SNDIO +#include +#include +#else +#include +#endif + + +#include "audio.h" +#include "audio_stats.h" +#include "textcolor.h" +#include "dtime_now.h" +#include "demod.h" /* for alevel_t & demod_get_audio_level() */ + + +/* Audio configuration. */ + +static struct audio_s *save_audio_config_p; + + +/* Current state for each of the audio devices. */ + +static struct adev_s { + +#if USE_ALSA + snd_pcm_t *audio_in_handle; + snd_pcm_t *audio_out_handle; + + int bytes_per_frame; /* number of bytes for a sample from all channels. */ + /* e.g. 4 for stereo 16 bit. */ +#elif USE_SNDIO + struct sio_hdl *sndio_in_handle; + struct sio_hdl *sndio_out_handle; + +#else + int oss_audio_device_fd; /* Single device, both directions. */ + +#endif + + int inbuf_size_in_bytes; /* number of bytes allocated */ + unsigned char *inbuf_ptr; + int inbuf_len; /* number byte of actual data available. */ + int inbuf_next; /* index of next to remove. */ + + int outbuf_size_in_bytes; + unsigned char *outbuf_ptr; + int outbuf_len; + + enum audio_in_type_e g_audio_in_type; + + int udp_sock; /* UDP socket for receiving data */ + +} adev[MAX_ADEVS]; + + +// Originally 40. Version 1.2, try 10 for lower latency. + +#define ONE_BUF_TIME 10 + + +#if USE_ALSA +static int set_alsa_params (int a, snd_pcm_t *handle, struct audio_s *pa, char *name, char *dir); +//static void alsa_select_device (char *pick_dev, int direction, char *result); +#elif USE_SNDIO +static int set_sndio_params (int a, struct sio_hdl *handle, struct audio_s *pa, char *devname, char *inout); +static int poll_sndio (struct sio_hdl *hdl, int events); +#else +static int set_oss_params (int a, int fd, struct audio_s *pa); +#endif + + +#define roundup1k(n) (((n) + 0x3ff) & ~0x3ff) + +static int calcbufsize(int rate, int chans, int bits) +{ + int size1 = (rate * chans * bits / 8 * ONE_BUF_TIME) / 1000; + int size2 = roundup1k(size1); +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("audio_open: calcbufsize (rate=%d, chans=%d, bits=%d) calc size=%d, round up to %d\n", + rate, chans, bits, size1, size2); +#endif + return (size2); +} + + +/*------------------------------------------------------------------ + * + * Name: audio_open + * + * Purpose: Open the digital audio device. + * For "OSS", the device name is typically "/dev/dsp". + * For "ALSA", it's a lot more complicated. See User Guide. + * + * New in version 1.0, we recognize "udp:" optionally + * followed by a port number. + * + * Inputs: pa - Address of structure of type audio_s. + * + * Using a structure, rather than separate arguments + * seemed to make sense because we often pass around + * the same set of parameters various places. + * + * The fields that we care about are: + * num_channels + * samples_per_sec + * bits_per_sample + * If zero, reasonable defaults will be provided. + * + * The device names are in adevice_in and adevice_out. + * - For "OSS", the device name is typically "/dev/dsp". + * - For "ALSA", the device names are hw:c,d + * where c is the "card" (for historical purposes) + * and d is the "device" within the "card." + * + * + * Outputs: pa - The ACTUAL values are returned here. + * + * These might not be exactly the same as what was requested. + * + * Example: ask for stereo, 16 bits, 22050 per second. + * An ordinary desktop/laptop PC should be able to handle this. + * However, some other sort of smaller device might be + * more restrictive in its capabilities. + * It might say, the best I can do is mono, 8 bit, 8000/sec. + * + * The software modem must use this ACTUAL information + * that the device is supplying, that could be different + * than what the user specified. + * + * Returns: 0 for success, -1 for failure. + * + * + *----------------------------------------------------------------*/ + +int audio_open (struct audio_s *pa) +{ +#if !USE_SNDIO + int err; +#endif + int chan; + int a; + char audio_in_name[30]; + char audio_out_name[30]; + + + save_audio_config_p = pa; + + memset (adev, 0, sizeof(adev)); + + for (a=0; aadev[a].num_channels == 0) + pa->adev[a].num_channels = DEFAULT_NUM_CHANNELS; + + if (pa->adev[a].samples_per_sec == 0) + pa->adev[a].samples_per_sec = DEFAULT_SAMPLES_PER_SEC; + + if (pa->adev[a].bits_per_sample == 0) + pa->adev[a].bits_per_sample = DEFAULT_BITS_PER_SAMPLE; + + for (chan=0; chanachan[chan].mark_freq == 0) + pa->achan[chan].mark_freq = DEFAULT_MARK_FREQ; + + if (pa->achan[chan].space_freq == 0) + pa->achan[chan].space_freq = DEFAULT_SPACE_FREQ; + + if (pa->achan[chan].baud == 0) + pa->achan[chan].baud = DEFAULT_BAUD; + + if (pa->achan[chan].num_subchan == 0) + pa->achan[chan].num_subchan = 1; + } + } + +/* + * Open audio device(s). + */ + + for (a=0; aadev[a].defined) { + + adev[a].inbuf_size_in_bytes = 0; + adev[a].inbuf_ptr = NULL; + adev[a].inbuf_len = 0; + adev[a].inbuf_next = 0; + + adev[a].outbuf_size_in_bytes = 0; + adev[a].outbuf_ptr = NULL; + adev[a].outbuf_len = 0; + +/* + * Determine the type of audio input. + */ + + adev[a].g_audio_in_type = AUDIO_IN_TYPE_SOUNDCARD; + + if (strcasecmp(pa->adev[a].adevice_in, "stdin") == 0 || strcmp(pa->adev[a].adevice_in, "-") == 0) { + adev[a].g_audio_in_type = AUDIO_IN_TYPE_STDIN; + /* Change "-" to stdin for readability. */ + strlcpy (pa->adev[a].adevice_in, "stdin", sizeof(pa->adev[a].adevice_in)); + } + if (strncasecmp(pa->adev[a].adevice_in, "udp:", 4) == 0) { + adev[a].g_audio_in_type = AUDIO_IN_TYPE_SDR_UDP; + /* Supply default port if none specified. */ + if (strcasecmp(pa->adev[a].adevice_in,"udp") == 0 || + strcasecmp(pa->adev[a].adevice_in,"udp:") == 0) { + snprintf (pa->adev[a].adevice_in, sizeof(pa->adev[a].adevice_in), "udp:%d", DEFAULT_UDP_AUDIO_PORT); + } + } + +/* Let user know what is going on. */ + + /* If not specified, the device names should be "default". */ + + strlcpy (audio_in_name, pa->adev[a].adevice_in, sizeof(audio_in_name)); + strlcpy (audio_out_name, pa->adev[a].adevice_out, sizeof(audio_out_name)); + + char ctemp[40]; + + if (pa->adev[a].num_channels == 2) { + snprintf (ctemp, sizeof(ctemp), " (channels %d & %d)", ADEVFIRSTCHAN(a), ADEVFIRSTCHAN(a)+1); + } + else { + snprintf (ctemp, sizeof(ctemp), " (channel %d)", ADEVFIRSTCHAN(a)); + } + + text_color_set(DW_COLOR_INFO); + + if (strcmp(audio_in_name,audio_out_name) == 0) { + dw_printf ("Audio device for both receive and transmit: %s %s\n", audio_in_name, ctemp); + } + else { + dw_printf ("Audio input device for receive: %s %s\n", audio_in_name, ctemp); + dw_printf ("Audio out device for transmit: %s %s\n", audio_out_name, ctemp); + } + +/* + * Now attempt actual opens. + */ + +/* + * Input device. + */ + + switch (adev[a].g_audio_in_type) { + +/* + * Soundcard - ALSA. + */ + case AUDIO_IN_TYPE_SOUNDCARD: +#if USE_ALSA + err = snd_pcm_open (&(adev[a].audio_in_handle), audio_in_name, SND_PCM_STREAM_CAPTURE, 0); + if (err < 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Could not open audio device %s for input\n%s\n", + audio_in_name, snd_strerror(err)); + if (err == -EBUSY) { + dw_printf ("This means that some other application is using that device.\n"); + dw_printf ("The solution is to identify that other application and stop it.\n"); + } + return (-1); + } + + adev[a].inbuf_size_in_bytes = set_alsa_params (a, adev[a].audio_in_handle, pa, audio_in_name, "input"); + +#elif USE_SNDIO + adev[a].sndio_in_handle = sio_open (audio_in_name, SIO_REC, 0); + if (adev[a].sndio_in_handle == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Could not open audio device %s for input\n", + audio_in_name); + return (-1); + } + + adev[a].inbuf_size_in_bytes = set_sndio_params (a, adev[a].sndio_in_handle, pa, audio_in_name, "input"); + + if (!sio_start (adev[a].sndio_in_handle)) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Could not start audio device %s for input\n", + audio_in_name); + return (-1); + } + +#else // OSS + adev[a].oss_audio_device_fd = open (pa->adev[a].adevice_in, O_RDWR); + + if (adev[a].oss_audio_device_fd < 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("%s:\n", pa->adev[a].adevice_in); +// snprintf (message, sizeof(message), "Could not open audio device %s", pa->adev[a].adevice_in); +// perror (message); + return (-1); + } + + adev[a].outbuf_size_in_bytes = adev[a].inbuf_size_in_bytes = set_oss_params (a, adev[a].oss_audio_device_fd, pa); + + if (adev[a].inbuf_size_in_bytes <= 0 || adev[a].outbuf_size_in_bytes <= 0) { + return (-1); + } +#endif + break; +/* + * UDP. + */ + case AUDIO_IN_TYPE_SDR_UDP: + + //Create socket and bind socket + + { + struct sockaddr_in si_me; + //int slen=sizeof(si_me); + //int data_size = 0; + + //Create UDP Socket + if ((adev[a].udp_sock=socket(AF_INET, SOCK_DGRAM, IPPROTO_UDP))==-1) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Couldn't create socket, errno %d\n", errno); + return -1; + } + + memset((char *) &si_me, 0, sizeof(si_me)); + si_me.sin_family = AF_INET; + si_me.sin_port = htons((short)atoi(audio_in_name+4)); + si_me.sin_addr.s_addr = htonl(INADDR_ANY); + + //Bind to the socket + if (bind(adev[a].udp_sock, (const struct sockaddr *) &si_me, sizeof(si_me))==-1) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Couldn't bind socket, errno %d\n", errno); + return -1; + } + } + adev[a].inbuf_size_in_bytes = SDR_UDP_BUF_MAXLEN; + + break; + +/* + * stdin. + */ + case AUDIO_IN_TYPE_STDIN: + + /* Do we need to adjust any properties of stdin? */ + + adev[a].inbuf_size_in_bytes = 1024; + + break; + + default: + + text_color_set(DW_COLOR_ERROR); + dw_printf ("Internal error, invalid audio_in_type\n"); + return (-1); + } + +/* + * Output device. Only "soundcard" is supported at this time. + */ + +#if USE_ALSA + err = snd_pcm_open (&(adev[a].audio_out_handle), audio_out_name, SND_PCM_STREAM_PLAYBACK, 0); + + if (err < 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Could not open audio device %s for output\n%s\n", + audio_out_name, snd_strerror(err)); + if (err == -EBUSY) { + dw_printf ("This means that some other application is using that device.\n"); + dw_printf ("The solution is to identify that other application and stop it.\n"); + } + return (-1); + } + + adev[a].outbuf_size_in_bytes = set_alsa_params (a, adev[a].audio_out_handle, pa, audio_out_name, "output"); + + if (adev[a].inbuf_size_in_bytes <= 0 || adev[a].outbuf_size_in_bytes <= 0) { + return (-1); + } + +#elif USE_SNDIO + adev[a].sndio_out_handle = sio_open (audio_out_name, SIO_PLAY, 0); + if (adev[a].sndio_out_handle == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Could not open audio device %s for output\n", + audio_out_name); + return (-1); + } + + adev[a].outbuf_size_in_bytes = set_sndio_params (a, adev[a].sndio_out_handle, pa, audio_out_name, "output"); + + if (adev[a].inbuf_size_in_bytes <= 0 || adev[a].outbuf_size_in_bytes <= 0) { + return (-1); + } + + if (!sio_start (adev[a].sndio_out_handle)) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Could not start audio device %s for output\n", + audio_out_name); + return (-1); + } +#endif + +/* + * Finally allocate buffer for each direction. + */ + adev[a].inbuf_ptr = malloc(adev[a].inbuf_size_in_bytes); + assert (adev[a].inbuf_ptr != NULL); + adev[a].inbuf_len = 0; + adev[a].inbuf_next = 0; + + adev[a].outbuf_ptr = malloc(adev[a].outbuf_size_in_bytes); + assert (adev[a].outbuf_ptr != NULL); + adev[a].outbuf_len = 0; + + } /* end of audio device defined */ + + } /* end of for each audio device */ + + return (0); + +} /* end audio_open */ + + + + +#if USE_ALSA + +/* + * Set parameters for sound card. + * + * See ?? for details. + */ +/* + * Terminology: + * Sample - for one channel. e.g. 2 bytes for 16 bit. + * Frame - one sample for all channels. e.g. 4 bytes for 16 bit stereo + * Period - size of one transfer. + */ + +static int set_alsa_params (int a, snd_pcm_t *handle, struct audio_s *pa, char *devname, char *inout) +{ + + snd_pcm_hw_params_t *hw_params; + snd_pcm_uframes_t fpp; /* Frames per period. */ + + unsigned int val; + + int dir; + int err; + + int buf_size_in_bytes; /* result, number of bytes per transfer. */ + + + err = snd_pcm_hw_params_malloc (&hw_params); + if (err < 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Could not alloc hw param structure.\n%s\n", + snd_strerror(err)); + dw_printf ("for %s %s.\n", devname, inout); + return (-1); + } + + err = snd_pcm_hw_params_any (handle, hw_params); + if (err < 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Could not init hw param structure.\n%s\n", + snd_strerror(err)); + dw_printf ("for %s %s.\n", devname, inout); + return (-1); + } + + /* Interleaved data: L, R, L, R, ... */ + + err = snd_pcm_hw_params_set_access (handle, hw_params, SND_PCM_ACCESS_RW_INTERLEAVED); + + if (err < 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Could not set interleaved mode.\n%s\n", + snd_strerror(err)); + dw_printf ("for %s %s.\n", devname, inout); + return (-1); + } + + /* Signed 16 bit little endian or unsigned 8 bit. */ + + + err = snd_pcm_hw_params_set_format (handle, hw_params, + pa->adev[a].bits_per_sample == 8 ? SND_PCM_FORMAT_U8 : SND_PCM_FORMAT_S16_LE); + if (err < 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Could not set bits per sample.\n%s\n", + snd_strerror(err)); + dw_printf ("for %s %s.\n", devname, inout); + return (-1); + } + + /* Number of audio channels. */ + + + err = snd_pcm_hw_params_set_channels (handle, hw_params, pa->adev[a].num_channels); + if (err < 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Could not set number of audio channels.\n%s\n", + snd_strerror(err)); + dw_printf ("for %s %s.\n", devname, inout); + return (-1); + } + + /* Audio sample rate. */ + + + val = pa->adev[a].samples_per_sec; + + dir = 0; + + + err = snd_pcm_hw_params_set_rate_near (handle, hw_params, &val, &dir); + if (err < 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Could not set audio sample rate.\n%s\n", + snd_strerror(err)); + dw_printf ("for %s %s.\n", devname, inout); + return (-1); + } + + if (val != pa->adev[a].samples_per_sec) { + + text_color_set(DW_COLOR_INFO); + dw_printf ("Asked for %d samples/sec but got %d.\n", + + pa->adev[a].samples_per_sec, val); + dw_printf ("for %s %s.\n", devname, inout); + + pa->adev[a].samples_per_sec = val; + + } + + /* Original: */ + /* Guessed around 20 reads/sec might be good. */ + /* Period too long = too much latency. */ + /* Period too short = more overhead of many small transfers. */ + + /* fpp = pa->adev[a].samples_per_sec / 20; */ + + /* The suggested period size was 2205 frames. */ + /* I thought the later "...set_period_size_near" might adjust it to be */ + /* some more optimal nearby value based hardware buffer sizes but */ + /* that didn't happen. We ended up with a buffer size of 4410 bytes. */ + + /* In version 1.2, let's take a different approach. */ + /* Reduce the latency and round up to a multiple of 1 Kbyte. */ + + /* For the typical case of 44100 sample rate, 1 channel, 16 bits, we calculate */ + /* a buffer size of 882 and round it up to 1k. This results in 512 frames per period. */ + /* A period comes out to be about 80 periods per second or about 12.5 mSec each. */ + + buf_size_in_bytes = calcbufsize(pa->adev[a].samples_per_sec, pa->adev[a].num_channels, pa->adev[a].bits_per_sample); + +#if __arm__ + /* Ugly hack for RPi. */ + /* Reducing buffer size is fine for input but not so good for output. */ + + if (*inout == 'o') { + buf_size_in_bytes = buf_size_in_bytes * 4; + } +#endif + + fpp = buf_size_in_bytes / (pa->adev[a].num_channels * pa->adev[a].bits_per_sample / 8); + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + + dw_printf ("suggest period size of %d frames\n", (int)fpp); +#endif + dir = 0; + err = snd_pcm_hw_params_set_period_size_near (handle, hw_params, &fpp, &dir); + + if (err < 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Could not set period size\n%s\n", snd_strerror(err)); + dw_printf ("for %s %s.\n", devname, inout); + return (-1); + } + + err = snd_pcm_hw_params (handle, hw_params); + if (err < 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Could not set hw params\n%s\n", snd_strerror(err)); + dw_printf ("for %s %s.\n", devname, inout); + return (-1); + } + + /* Driver might not like our suggested period size */ + /* and might have another idea. */ + + err = snd_pcm_hw_params_get_period_size (hw_params, &fpp, NULL); + if (err < 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Could not get audio period size.\n%s\n", snd_strerror(err)); + dw_printf ("for %s %s.\n", devname, inout); + return (-1); + } + + snd_pcm_hw_params_free (hw_params); + + /* A "frame" is one sample for all channels. */ + + /* The read and write use units of frames, not bytes. */ + + adev[a].bytes_per_frame = snd_pcm_frames_to_bytes (handle, 1); + + assert (adev[a].bytes_per_frame == pa->adev[a].num_channels * pa->adev[a].bits_per_sample / 8); + + buf_size_in_bytes = fpp * adev[a].bytes_per_frame; + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("audio buffer size = %d (bytes per frame) x %d (frames per period) = %d \n", adev[a].bytes_per_frame, (int)fpp, buf_size_in_bytes); +#endif + + /* Version 1.3 - after a report of this situation for Mac OSX version. */ + if (buf_size_in_bytes < 256 || buf_size_in_bytes > 32768) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Audio buffer has unexpected extreme size of %d bytes.\n", buf_size_in_bytes); + dw_printf ("Detected at %s, line %d.\n", __FILE__, __LINE__); + dw_printf ("This might be caused by unusual audio device configuration values.\n"); + buf_size_in_bytes = 2048; + dw_printf ("Using %d to attempt recovery.\n", buf_size_in_bytes); + } + + return (buf_size_in_bytes); + + +} /* end alsa_set_params */ + + +#elif USE_SNDIO + +/* + * Set parameters for sound card. (sndio) + * + * See /usr/include/sndio.h for details. + */ + +static int set_sndio_params (int a, struct sio_hdl *handle, struct audio_s *pa, char *devname, char *inout) +{ + + struct sio_par q, r; + + /* Signed 16 bit little endian or unsigned 8 bit. */ + sio_initpar (&q); + q.bits = pa->adev[a].bits_per_sample; + q.bps = (q.bits + 7) / 8; + q.sig = (q.bits == 8) ? 0 : 1; + q.le = 1; /* always little endian */ + q.msb = 0; /* LSB aligned */ + q.rchan = q.pchan = pa->adev[a].num_channels; + q.rate = pa->adev[a].samples_per_sec; + q.xrun = SIO_IGNORE; + q.appbufsz = calcbufsize(pa->adev[a].samples_per_sec, pa->adev[a].num_channels, pa->adev[a].bits_per_sample); + + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("suggest buffer size %d bytes for %s %s.\n", + q.appbufsz, devname, inout); +#endif + + /* challenge new setting */ + if (!sio_setpar (handle, &q)) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Could not set hardware parameter for %s %s.\n", + devname, inout); + return (-1); + } + + /* get response */ + if (!sio_getpar (handle, &r)) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Could not obtain current hardware setting for %s %s.\n", + devname, inout); + return (-1); + } + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("audio buffer size %d bytes for %s %s.\n", + r.appbufsz, devname, inout); +#endif + if (q.rate != r.rate) { + text_color_set(DW_COLOR_INFO); + dw_printf ("Asked for %d samples/sec but got %d for %s %s.", + pa->adev[a].samples_per_sec, r.rate, devname, inout); + pa->adev[a].samples_per_sec = r.rate; + } + + /* not supported */ + if (q.bits != r.bits || q.bps != r.bps || q.sig != r.sig || + (q.bits > 8 && q.le != r.le) || + (*inout == 'o' && q.pchan != r.pchan) || + (*inout == 'i' && q.rchan != r.rchan)) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Unsupported format for %s %s.\n", devname, inout); + return (-1); + } + + return r.appbufsz; + +} /* end set_sndio_params */ + +static int poll_sndio (struct sio_hdl *hdl, int events) +{ + struct pollfd *pfds; + int nfds, revents; + + nfds = sio_nfds (hdl); + pfds = alloca (nfds * sizeof(struct pollfd)); + + do { + nfds = sio_pollfd (hdl, pfds, events); + if (nfds < 1) { + /* no need to wait */ + return (0); + } + if (poll (pfds, nfds, -1) < 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("poll %d\n", errno); + return (-1); + } + revents = sio_revents (hdl, pfds); + } while (!(revents & (events | POLLHUP))); + + /* unrecoverable error occurred */ + if (revents & POLLHUP) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("waited for %s, POLLHUP received\n", (events & POLLIN) ? "POLLIN" : "POLLOUT"); + return (-1); + } + + return (0); +} + +#else + + +/* + * Set parameters for sound card. (OSS only) + * + * See /usr/include/sys/soundcard.h for details. + */ + +static int set_oss_params (int a, int fd, struct audio_s *pa) +{ + int err; + int devcaps; + int asked_for; + char message[100]; + int ossbuf_size_in_bytes; + + + err = ioctl (fd, SNDCTL_DSP_CHANNELS, &(pa->adev[a].num_channels)); + if (err == -1) { + text_color_set(DW_COLOR_ERROR); + perror("Not able to set audio device number of channels"); + return (-1); + } + + asked_for = pa->adev[a].samples_per_sec; + + err = ioctl (fd, SNDCTL_DSP_SPEED, &(pa->adev[a].samples_per_sec)); + if (err == -1) { + text_color_set(DW_COLOR_ERROR); + perror("Not able to set audio device sample rate"); + return (-1); + } + + if (pa->adev[a].samples_per_sec != asked_for) { + text_color_set(DW_COLOR_INFO); + dw_printf ("Asked for %d samples/sec but actually using %d.\n", + asked_for, pa->adev[a].samples_per_sec); + } + + /* This is actually a bit mask but it happens that */ + /* 0x8 is unsigned 8 bit samples and */ + /* 0x10 is signed 16 bit little endian. */ + + err = ioctl (fd, SNDCTL_DSP_SETFMT, &(pa->adev[a].bits_per_sample)); + if (err == -1) { + text_color_set(DW_COLOR_ERROR); + perror("Not able to set audio device sample size"); + return (-1); + } + +/* + * Determine capabilities. + */ + err = ioctl (fd, SNDCTL_DSP_GETCAPS, &devcaps); + if (err == -1) { + text_color_set(DW_COLOR_ERROR); + perror("Not able to get audio device capabilities"); + // Is this fatal? // return (-1); + } + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("audio_open(): devcaps = %08x\n", devcaps); + if (devcaps & DSP_CAP_DUPLEX) dw_printf ("Full duplex record/playback.\n"); + if (devcaps & DSP_CAP_BATCH) dw_printf ("Device has some kind of internal buffers which may cause delays.\n"); + if (devcaps & ~ (DSP_CAP_DUPLEX | DSP_CAP_BATCH)) dw_printf ("Others...\n"); +#endif + + if (!(devcaps & DSP_CAP_DUPLEX)) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Audio device does not support full duplex\n"); + // Do we care? // return (-1); + } + + err = ioctl (fd, SNDCTL_DSP_SETDUPLEX, NULL); + if (err == -1) { + // text_color_set(DW_COLOR_ERROR); + // perror("Not able to set audio full duplex mode"); + // Unfortunate but not a disaster. + } + +/* + * Get preferred block size. + * Presumably this will provide the most efficient transfer. + * + * In my particular situation, this turned out to be + * 2816 for 11025 Hz 16 bit mono + * 5568 for 11025 Hz 16 bit stereo + * 11072 for 44100 Hz 16 bit mono + * + * This was long ago under different conditions. + * Should study this again some day. + * + * Your mileage may vary. + */ + err = ioctl (fd, SNDCTL_DSP_GETBLKSIZE, &ossbuf_size_in_bytes); + if (err == -1) { + text_color_set(DW_COLOR_ERROR); + perror("Not able to get audio block size"); + ossbuf_size_in_bytes = 2048; /* pick something reasonable */ + } + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("audio_open(): suggestd block size is %d\n", ossbuf_size_in_bytes); +#endif + +/* + * That's 1/8 of a second which seems rather long if we want to + * respond quickly. + */ + + ossbuf_size_in_bytes = calcbufsize(pa->adev[a].samples_per_sec, pa->adev[a].num_channels, pa->adev[a].bits_per_sample); + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("audio_open(): using block size of %d\n", ossbuf_size_in_bytes); +#endif + +#if 0 + /* Original - dies without good explanation. */ + assert (ossbuf_size_in_bytes >= 256 && ossbuf_size_in_bytes <= 32768); +#else + /* Version 1.3 - after a report of this situation for Mac OSX version. */ + if (ossbuf_size_in_bytes < 256 || ossbuf_size_in_bytes > 32768) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Audio buffer has unexpected extreme size of %d bytes.\n", ossbuf_size_in_bytes); + dw_printf ("Detected at %s, line %d.\n", __FILE__, __LINE__); + dw_printf ("This might be caused by unusual audio device configuration values.\n"); + ossbuf_size_in_bytes = 2048; + dw_printf ("Using %d to attempt recovery.\n", ossbuf_size_in_bytes); + } +#endif + return (ossbuf_size_in_bytes); + +} /* end set_oss_params */ + + +#endif + + + +/*------------------------------------------------------------------ + * + * Name: audio_get + * + * Purpose: Get one byte from the audio device. + * + * Inputs: a - Our number for audio device. + * + * Returns: 0 - 255 for a valid sample. + * -1 for any type of error. + * + * Description: The caller must deal with the details of mono/stereo + * and number of bytes per sample. + * + * This will wait if no data is currently available. + * + *----------------------------------------------------------------*/ + +// Use hot attribute for all functions called for every audio sample. + +__attribute__((hot)) +int audio_get (int a) +{ + int n; +#if USE_ALSA + int retries = 0; +#endif + +#if STATISTICS + /* Gather numbers for read from audio device. */ + +#define duration 100 /* report every 100 seconds. */ + static time_t last_time[MAX_ADEVS]; + time_t this_time[MAX_ADEVS]; + static int sample_count[MAX_ADEVS]; + static int error_count[MAX_ADEVS]; +#endif + +#if DEBUGx + text_color_set(DW_COLOR_DEBUG); + + dw_printf ("audio_get():\n"); + +#endif + + assert (adev[a].inbuf_size_in_bytes >= 100 && adev[a].inbuf_size_in_bytes <= 32768); + + + + switch (adev[a].g_audio_in_type) { + +/* + * Soundcard - ALSA + */ + case AUDIO_IN_TYPE_SOUNDCARD: + + +#if USE_ALSA + + + while (adev[a].inbuf_next >= adev[a].inbuf_len) { + + assert (adev[a].audio_in_handle != NULL); +#if DEBUGx + text_color_set(DW_COLOR_DEBUG); + dw_printf ("audio_get(): readi asking for %d frames\n", adev[a].inbuf_size_in_bytes / adev[a].bytes_per_frame); +#endif + n = snd_pcm_readi (adev[a].audio_in_handle, adev[a].inbuf_ptr, adev[a].inbuf_size_in_bytes / adev[a].bytes_per_frame); + +#if DEBUGx + text_color_set(DW_COLOR_DEBUG); + dw_printf ("audio_get(): readi asked for %d and got %d frames\n", + adev[a].inbuf_size_in_bytes / adev[a].bytes_per_frame, n); +#endif + + + if (n > 0) { + + /* Success */ + + adev[a].inbuf_len = n * adev[a].bytes_per_frame; /* convert to number of bytes */ + adev[a].inbuf_next = 0; + + audio_stats (a, + save_audio_config_p->adev[a].num_channels, + n, + save_audio_config_p->statistics_interval); + + } + else if (n == 0) { + + /* Didn't expect this, but it's not a problem. */ + /* Wait a little while and try again. */ + + text_color_set(DW_COLOR_ERROR); + dw_printf ("Audio input got zero bytes: %s\n", snd_strerror(n)); + SLEEP_MS(10); + + adev[a].inbuf_len = 0; + adev[a].inbuf_next = 0; + } + else { + /* Error */ + // TODO: Needs more study and testing. + + // Only expected error conditions: + // -EBADFD PCM is not in the right state (SND_PCM_STATE_PREPARED or SND_PCM_STATE_RUNNING) + // -EPIPE an overrun occurred + // -ESTRPIPE a suspend event occurred (stream is suspended and waiting for an application recovery) + + // Data overrun is displayed as "broken pipe" which seems a little misleading. + // Add our own message which says something about CPU being too slow. + + text_color_set(DW_COLOR_ERROR); + dw_printf ("Audio input device %d error code %d: %s\n", a, n, snd_strerror(n)); + + if (n == (-EPIPE)) { + dw_printf ("This is most likely caused by the CPU being too slow to keep up with the audio stream.\n"); + dw_printf ("Use the \"top\" command, in another command window, to look at CPU usage.\n"); + dw_printf ("This might be a temporary condition so we will attempt to recover a few times before giving up.\n"); + dw_printf ("If using a very slow CPU, try reducing the CPU load by using -P- command\n"); + dw_printf ("line option for 9600 bps or -D3 for slower AFSK .\n"); + } + + audio_stats (a, + save_audio_config_p->adev[a].num_channels, + 0, + save_audio_config_p->statistics_interval); + + /* Try to recover a few times and eventually give up. */ + if (++retries > 10) { + adev[a].inbuf_len = 0; + adev[a].inbuf_next = 0; + return (-1); + } + + if (n == -EPIPE) { + + /* EPIPE means overrun */ + + snd_pcm_recover (adev[a].audio_in_handle, n, 1); + + } + else { + /* Could be some temporary condition. */ + /* Wait a little then try again. */ + /* Sometimes I get "Resource temporarily available" */ + /* when the Update Manager decides to run. */ + + SLEEP_MS (250); + snd_pcm_recover (adev[a].audio_in_handle, n, 1); + } + } + } + + +#elif USE_SNDIO + + while (adev[a].inbuf_next >= adev[a].inbuf_len) { + + assert (adev[a].sndio_in_handle != NULL); + if (poll_sndio (adev[a].sndio_in_handle, POLLIN) < 0) { + adev[a].inbuf_len = 0; + adev[a].inbuf_next = 0; + return (-1); + } + + n = sio_read (adev[a].sndio_in_handle, adev[a].inbuf_ptr, adev[a].inbuf_size_in_bytes); + adev[a].inbuf_len = n; + adev[a].inbuf_next = 0; + + audio_stats (a, + save_audio_config_p->adev[a].num_channels, + n / (save_audio_config_p->adev[a].num_channels * save_audio_config_p->adev[a].bits_per_sample / 8), + save_audio_config_p->statistics_interval); + } + +#else /* begin OSS */ + + /* Fixed in 1.2. This was formerly outside of the switch */ + /* so the OSS version did not process stdin or UDP. */ + + while (adev[a].g_audio_in_type == AUDIO_IN_TYPE_SOUNDCARD && adev[a].inbuf_next >= adev[a].inbuf_len) { + assert (adev[a].oss_audio_device_fd > 0); + n = read (adev[a].oss_audio_device_fd, adev[a].inbuf_ptr, adev[a].inbuf_size_in_bytes); + //text_color_set(DW_COLOR_DEBUG); + // dw_printf ("audio_get(): read %d returns %d\n", adev[a].inbuf_size_in_bytes, n); + if (n < 0) { + text_color_set(DW_COLOR_ERROR); + perror("Can't read from audio device"); + adev[a].inbuf_len = 0; + adev[a].inbuf_next = 0; + + audio_stats (a, + save_audio_config_p->adev[a].num_channels, + 0, + save_audio_config_p->statistics_interval); + + return (-1); + } + adev[a].inbuf_len = n; + adev[a].inbuf_next = 0; + + audio_stats (a, + save_audio_config_p->adev[a].num_channels, + n / (save_audio_config_p->adev[a].num_channels * save_audio_config_p->adev[a].bits_per_sample / 8), + save_audio_config_p->statistics_interval); + } + +#endif /* USE_ALSA */ + + + break; + +/* + * UDP. + */ + + case AUDIO_IN_TYPE_SDR_UDP: + + while (adev[a].inbuf_next >= adev[a].inbuf_len) { + int res; + + assert (adev[a].udp_sock > 0); + res = recv(adev[a].udp_sock, adev[a].inbuf_ptr, adev[a].inbuf_size_in_bytes, 0); + if (res < 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Can't read from udp socket, res=%d", res); + adev[a].inbuf_len = 0; + adev[a].inbuf_next = 0; + + audio_stats (a, + save_audio_config_p->adev[a].num_channels, + 0, + save_audio_config_p->statistics_interval); + + return (-1); + } + + adev[a].inbuf_len = res; + adev[a].inbuf_next = 0; + + audio_stats (a, + save_audio_config_p->adev[a].num_channels, + res / (save_audio_config_p->adev[a].num_channels * save_audio_config_p->adev[a].bits_per_sample / 8), + save_audio_config_p->statistics_interval); + + } + break; + +/* + * stdin. + */ + case AUDIO_IN_TYPE_STDIN: + + while (adev[a].inbuf_next >= adev[a].inbuf_len) { + //int ch, res,i; + int res; + + res = read(STDIN_FILENO, adev[a].inbuf_ptr, (size_t)adev[a].inbuf_size_in_bytes); + if (res <= 0) { + text_color_set(DW_COLOR_INFO); + dw_printf ("\nEnd of file on stdin. Exiting.\n"); + exit (0); + } + + audio_stats (a, + save_audio_config_p->adev[a].num_channels, + res / (save_audio_config_p->adev[a].num_channels * save_audio_config_p->adev[a].bits_per_sample / 8), + save_audio_config_p->statistics_interval); + + adev[a].inbuf_len = res; + adev[a].inbuf_next = 0; + } + + break; + } + + + if (adev[a].inbuf_next < adev[a].inbuf_len) + n = adev[a].inbuf_ptr[adev[a].inbuf_next++]; + //No data to read, avoid reading outside buffer + else + n = 0; + +#if DEBUGx + + text_color_set(DW_COLOR_DEBUG); + dw_printf ("audio_get(): returns %d\n", n); + +#endif + + + return (n); + +} /* end audio_get */ + + +/*------------------------------------------------------------------ + * + * Name: audio_put + * + * Purpose: Send one byte to the audio device. + * + * Inputs: a + * + * c - One byte in range of 0 - 255. + * + * Returns: Normally non-negative. + * -1 for any type of error. + * + * Description: The caller must deal with the details of mono/stereo + * and number of bytes per sample. + * + * See Also: audio_flush + * audio_wait + * + *----------------------------------------------------------------*/ + +int audio_put (int a, int c) +{ + /* Should never be full at this point. */ + assert (adev[a].outbuf_len < adev[a].outbuf_size_in_bytes); + + adev[a].outbuf_ptr[adev[a].outbuf_len++] = c; + + if (adev[a].outbuf_len == adev[a].outbuf_size_in_bytes) { + return (audio_flush(a)); + } + + return (0); + +} /* end audio_put */ + + +/*------------------------------------------------------------------ + * + * Name: audio_flush + * + * Purpose: Push out any partially filled output buffer. + * + * Returns: Normally non-negative. + * -1 for any type of error. + * + * See Also: audio_flush + * audio_wait + * + *----------------------------------------------------------------*/ + +int audio_flush (int a) +{ +#if USE_ALSA + int k; + unsigned char *psound; + int retries = 10; + snd_pcm_status_t *status; + + assert (adev[a].audio_out_handle != NULL); + + +/* + * Trying to set the automatic start threshold didn't have the desired + * effect. After the first transmitted packet, they are saved up + * for a few minutes and then all come out together. + * + * "Prepare" it if not already in the running state. + * We stop it at the end of each transmitted packet. + */ + + + snd_pcm_status_alloca(&status); + + k = snd_pcm_status (adev[a].audio_out_handle, status); + if (k != 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Audio output get status error.\n%s\n", snd_strerror(k)); + } + + if ((k = snd_pcm_status_get_state(status)) != SND_PCM_STATE_RUNNING) { + + //text_color_set(DW_COLOR_DEBUG); + //dw_printf ("Audio output state = %d. Try to start.\n", k); + + k = snd_pcm_prepare (adev[a].audio_out_handle); + + if (k != 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Audio output start error.\n%s\n", snd_strerror(k)); + } + } + + + psound = adev[a].outbuf_ptr; + + while (retries-- > 0) { + + k = snd_pcm_writei (adev[a].audio_out_handle, psound, adev[a].outbuf_len / adev[a].bytes_per_frame); +#if DEBUGx + text_color_set(DW_COLOR_DEBUG); + dw_printf ("audio_flush(): snd_pcm_writei %d frames returns %d\n", + adev[a].outbuf_len / adev[a].bytes_per_frame, k); + fflush (stdout); +#endif + if (k == -EPIPE) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Audio output data underrun.\n"); + + /* No problemo. Recover and go around again. */ + + snd_pcm_recover (adev[a].audio_out_handle, k, 1); + } + else if (k == -ESTRPIPE) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Driver suspended, recovering\n"); + snd_pcm_recover(adev[a].audio_out_handle, k, 1); + } + else if (k == -EBADFD) { + k = snd_pcm_prepare (adev[a].audio_out_handle); + if(k < 0) { + dw_printf ("Error preparing after bad state: %s\n", snd_strerror(k)); + } + } + else if (k < 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Audio write error: %s\n", snd_strerror(k)); + + /* Some other error condition. */ + /* Try again. What do we have to lose? */ + + k = snd_pcm_prepare (adev[a].audio_out_handle); + if(k < 0) { + dw_printf ("Error preparing after error: %s\n", snd_strerror(k)); + } + } + else if (k != adev[a].outbuf_len / adev[a].bytes_per_frame) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Audio write took %d frames rather than %d.\n", + k, adev[a].outbuf_len / adev[a].bytes_per_frame); + + /* Go around again with the rest of it. */ + + psound += k * adev[a].bytes_per_frame; + adev[a].outbuf_len -= k * adev[a].bytes_per_frame; + } + else { + /* Success! */ + adev[a].outbuf_len = 0; + return (0); + } + } + + text_color_set(DW_COLOR_ERROR); + dw_printf ("Audio write error retry count exceeded.\n"); + + adev[a].outbuf_len = 0; + return (-1); + +#elif USE_SNDIO + + int k; + unsigned char *ptr; + int len; + + ptr = adev[a].outbuf_ptr; + len = adev[a].outbuf_len; + + while (len > 0) { + assert (adev[a].sndio_out_handle != NULL); + if (poll_sndio (adev[a].sndio_out_handle, POLLOUT) < 0) { + text_color_set(DW_COLOR_ERROR); + perror("Can't write to audio device"); + adev[a].outbuf_len = 0; + return (-1); + } + + k = sio_write (adev[a].sndio_out_handle, ptr, len); +#if DEBUGx + text_color_set(DW_COLOR_DEBUG); + dw_printf ("audio_flush(): write %d returns %d\n", len, k); + fflush (stdout); +#endif + ptr += k; + len -= k; + } + + adev[a].outbuf_len = 0; + return (0); + +#else /* OSS */ + + int k; + unsigned char *ptr; + int len; + + ptr = adev[a].outbuf_ptr; + len = adev[a].outbuf_len; + + while (len > 0) { + assert (adev[a].oss_audio_device_fd > 0); + k = write (adev[a].oss_audio_device_fd, ptr, len); +#if DEBUGx + text_color_set(DW_COLOR_DEBUG); + dw_printf ("audio_flush(): write %d returns %d\n", len, k); + fflush (stdout); +#endif + if (k < 0) { + text_color_set(DW_COLOR_ERROR); + perror("Can't write to audio device"); + adev[a].outbuf_len = 0; + return (-1); + } + if (k < len) { + /* presumably full but didn't block. */ + usleep (10000); + } + ptr += k; + len -= k; + } + + adev[a].outbuf_len = 0; + return (0); +#endif + +} /* end audio_flush */ + + +/*------------------------------------------------------------------ + * + * Name: audio_wait + * + * Purpose: Finish up audio output before turning PTT off. + * + * Inputs: a - Index for audio device (not channel!) + * + * Returns: None. + * + * Description: Flush out any partially filled audio output buffer. + * Wait until all the queued up audio out has been played. + * Take any other necessary actions to stop audio output. + * + * In an ideal world: + * + * We would like to ask the hardware when all the queued + * up sound has actually come out the speaker. + * + * In reality: + * + * This has been found to be less than reliable in practice. + * + * Caller does the following: + * + * (1) Make note of when PTT is turned on. + * (2) Calculate how long it will take to transmit the + * frame including TXDELAY, frame (including + * "flags", data, FCS and bit stuffing), and TXTAIL. + * (3) Call this function, which might or might not wait long enough. + * (4) Add (1) and (2) resulting in when PTT should be turned off. + * (5) Take difference between current time and desired PPT off time + * and wait for additional time if required. + * + *----------------------------------------------------------------*/ + +void audio_wait (int a) +{ + + audio_flush (a); + +#if USE_ALSA + + /* For playback, this should wait for all pending frames */ + /* to be played and then stop. */ + + snd_pcm_drain (adev[a].audio_out_handle); + + /* + * When this was first implemented, I observed: + * + * "Experimentation reveals that snd_pcm_drain doesn't + * actually wait. It returns immediately. + * However it does serve a useful purpose of stopping + * the playback after all the queued up data is used." + * + * + * Now that I take a closer look at the transmit timing, for + * version 1.2, it seems that snd_pcm_drain DOES wait until all + * all pending frames have been played. + * Either way, the caller will now compensate for it. + */ + +#elif USE_SNDIO + + poll_sndio (adev[a].sndio_out_handle, POLLOUT); + +#else + + assert (adev[a].oss_audio_device_fd > 0); + + // This caused a crash later on Cygwin. + // Haven't tried it on other (non-Linux) Unix yet. + + // err = ioctl (adev[a].oss_audio_device_fd, SNDCTL_DSP_SYNC, NULL); + +#endif + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("audio_wait(): after sync, status=%d\n", err); +#endif + +} /* end audio_wait */ + + +/*------------------------------------------------------------------ + * + * Name: audio_close + * + * Purpose: Close the audio device(s). + * + * Returns: Normally non-negative. + * -1 for any type of error. + * + * + *----------------------------------------------------------------*/ + +int audio_close (void) +{ + int err = 0; + int a; + + for (a = 0; a < MAX_ADEVS; a++) { + +#if USE_ALSA + if (adev[a].audio_in_handle != NULL && adev[a].audio_out_handle != NULL) { + + audio_wait (a); + + snd_pcm_close (adev[a].audio_in_handle); + snd_pcm_close (adev[a].audio_out_handle); + + adev[a].audio_in_handle = adev[a].audio_out_handle = NULL; + +#elif USE_SNDIO + + if (adev[a].sndio_in_handle != NULL && adev[a].sndio_out_handle != NULL) { + + audio_wait (a); + + sio_stop (adev[a].sndio_in_handle); + sio_stop (adev[a].sndio_out_handle); + sio_close (adev[a].sndio_in_handle); + sio_close (adev[a].sndio_out_handle); + + adev[a].sndio_in_handle = adev[a].sndio_out_handle = NULL; + +#else + + if (adev[a].oss_audio_device_fd > 0) { + + audio_wait (a); + + close (adev[a].oss_audio_device_fd); + + adev[a].oss_audio_device_fd = -1; +#endif + + free (adev[a].inbuf_ptr); + free (adev[a].outbuf_ptr); + + adev[a].inbuf_size_in_bytes = 0; + adev[a].inbuf_ptr = NULL; + adev[a].inbuf_len = 0; + adev[a].inbuf_next = 0; + + adev[a].outbuf_size_in_bytes = 0; + adev[a].outbuf_ptr = NULL; + adev[a].outbuf_len = 0; + } + } + + return (err); + +} /* end audio_close */ + + +/* end audio.c */ + diff --git a/src/audio.h b/src/audio.h new file mode 100644 index 00000000..cb5ca94e --- /dev/null +++ b/src/audio.h @@ -0,0 +1,488 @@ + +/*------------------------------------------------------------------ + * + * Module: audio.h + * + * Purpose: Interface to audio device commonly called a "sound card" + * for historical reasons. + * + *---------------------------------------------------------------*/ + + +#ifndef AUDIO_H +#define AUDIO_H 1 + +#ifdef USE_HAMLIB +#include +#endif + +#include "direwolf.h" /* for MAX_CHANS used throughout the application. */ +#include "ax25_pad.h" /* for AX25_MAX_ADDR_LEN */ +#include "version.h" + + +/* + * PTT control. + */ + +enum ptt_method_e { + PTT_METHOD_NONE, /* VOX or no transmit. */ + PTT_METHOD_SERIAL, /* Serial port RTS or DTR. */ + PTT_METHOD_GPIO, /* General purpose I/O, Linux only. */ + PTT_METHOD_LPT, /* Parallel printer port, Linux only. */ + PTT_METHOD_HAMLIB, /* HAMLib, Linux only. */ + PTT_METHOD_CM108 }; /* GPIO pin of CM108/CM119/etc. Linux only. */ + +typedef enum ptt_method_e ptt_method_t; + +enum ptt_line_e { PTT_LINE_NONE = 0, PTT_LINE_RTS = 1, PTT_LINE_DTR = 2 }; // Important: 0 for neither. +typedef enum ptt_line_e ptt_line_t; + +enum audio_in_type_e { + AUDIO_IN_TYPE_SOUNDCARD, + AUDIO_IN_TYPE_SDR_UDP, + AUDIO_IN_TYPE_STDIN }; + +/* For option to try fixing frames with bad CRC. */ + +typedef enum retry_e { + RETRY_NONE=0, + RETRY_INVERT_SINGLE=1, + RETRY_INVERT_DOUBLE=2, + RETRY_INVERT_TRIPLE=3, + RETRY_INVERT_TWO_SEP=4, + RETRY_MAX = 5} retry_t; + +// Type of communication medium associated with the channel. + +enum medium_e { MEDIUM_NONE = 0, // Channel is not valid for use. + MEDIUM_RADIO, // Internal modem for radio. + MEDIUM_IGATE, // Access IGate as ordinary channel. + MEDIUM_NETTNC }; // Remote network TNC. (possible future) + + +typedef enum sanity_e { SANITY_APRS, SANITY_AX25, SANITY_NONE } sanity_t; + + +struct audio_s { + + /* Previously we could handle only a single audio device. */ + /* In version 1.2, we generalize this to handle multiple devices. */ + /* This means we can now have more than 2 radio channels. */ + + struct adev_param_s { + + /* Properties of the sound device. */ + + int defined; /* Was device defined? */ + /* First one defaults to yes. */ + + char adevice_in[80]; /* Name of the audio input device (or file?). */ + /* TODO: Can be "-" to read from stdin. */ + + char adevice_out[80]; /* Name of the audio output device (or file?). */ + + int num_channels; /* Should be 1 for mono or 2 for stereo. */ + int samples_per_sec; /* Audio sampling rate. Typically 11025, 22050, or 44100. */ + int bits_per_sample; /* 8 (unsigned char) or 16 (signed short). */ + + } adev[MAX_ADEVS]; + + + /* Common to all channels. */ + + char tts_script[80]; /* Script for text to speech. */ + + int statistics_interval; /* Number of seconds between the audio */ + /* statistics reports. This is set by */ + /* the "-a" option. 0 to disable feature. */ + + int xmit_error_rate; /* For testing purposes, we can generate frames with an invalid CRC */ + /* to simulate corruption while going over the air. */ + /* This is the probability, in per cent, of randomly corrupting it. */ + /* Normally this is 0. 25 would mean corrupt it 25% of the time. */ + + int recv_error_rate; /* Similar but the % probability of dropping a received frame. */ + + float recv_ber; /* Receive Bit Error Rate (BER). */ + /* Probability of inverting a bit coming out of the modem. */ + + //int fx25_xmit_enable; /* Enable transmission of FX.25. */ + /* See fx25_init.c for explanation of values. */ + /* Initially this applies to all channels. */ + /* This should probably be per channel. One step at a time. */ + /* v1.7 - replaced by layer2_xmit==LAYER2_FX25 */ + + int fx25_auto_enable; /* Turn on FX.25 for current connected mode session */ + /* under poor conditions. */ + /* Set to 0 to disable feature. */ + /* I put it here, rather than with the rest of the link layer */ + /* parameters because it is really a part of the HDLC layer */ + /* and is part of the KISS TNC functionality rather than our data link layer. */ + /* Future: not used yet. */ + + + char timestamp_format[40]; /* -T option */ + /* Precede received & transmitted frames with timestamp. */ + /* Command line option uses "strftime" format string. */ + + + + /* originally a "channel" was always connected to an internal modem. */ + /* In version 1.6, this is generalized so that a channel (as seen by client application) */ + /* can be connected to something else. Initially, this will allow application */ + /* access to the IGate. Later we might have network TNCs or other internal functions. */ + + // Properties for all channels. + + enum medium_e chan_medium[MAX_TOTAL_CHANS]; + // MEDIUM_NONE for invalid. + // MEDIUM_RADIO for internal modem. (only possibility earlier) + // MEDIUM_IGATE allows application access to IGate. + // MEDIUM_NETTNC for external TNC via TCP. + + int igate_vchannel; /* Virtual channel mapped to APRS-IS. */ + /* -1 for none. */ + /* Redundant but it makes things quicker and simpler */ + /* than always searching thru above. */ + + /* Properties for each radio channel, common to receive and transmit. */ + /* Can be different for each radio channel. */ + + struct achan_param_s { + + // Currently, we have a fixed mapping from audio sources to channel. + // + // ADEVICE CHANNEL (mono) (stereo) + // 0 0 0, 1 + // 1 2 2, 3 + // 2 4 4, 5 + // + // A future feauture might allow the user to specify a different audio source. + // This would allow multiple modems (with associated channel) to share an audio source. + // int audio_source; // Default would be [0,1,2,3,4,5] + + // What else should be moved out of structure and enlarged when NETTNC is implemented. ??? + char mycall[AX25_MAX_ADDR_LEN]; /* Call associated with this radio channel. */ + /* Could all be the same or different. */ + + + enum modem_t { MODEM_AFSK, MODEM_BASEBAND, MODEM_SCRAMBLE, MODEM_QPSK, MODEM_8PSK, MODEM_OFF, MODEM_16_QAM, MODEM_64_QAM, MODEM_AIS, MODEM_EAS } modem_type; + + /* Usual AFSK. */ + /* Baseband signal. Not used yet. */ + /* Scrambled http://www.amsat.org/amsat/articles/g3ruh/109/fig03.gif */ + /* Might try MFJ-2400 / CCITT v.26 / Bell 201 someday. */ + /* No modem. Might want this for DTMF only channel. */ + + enum layer2_t { LAYER2_AX25 = 0, LAYER2_FX25, LAYER2_IL2P } layer2_xmit; + + // IL2P - New for version 1.7. + // New layer 2 with FEC. Much less overhead than FX.25 but no longer backward compatible. + // Only applies to transmit. + // Listening for FEC sync word should add negligible overhead so + // we leave reception enabled all the time as we do with FX.25. + // TODO: FX.25 should probably be put here rather than global for all channels. + + int fx25_strength; // Strength of FX.25 FEC. + // 16, 23, 64 for specific number of parity symbols. + // 1 for automatic selection based on frame size. + + int il2p_max_fec; // 1 for max FEC length, 0 for automatic based on size. + + int il2p_invert_polarity; // 1 means invert on transmit. Receive handles either automatically. + + enum v26_e { V26_UNSPECIFIED=0, V26_A, V26_B } v26_alternative; + + // Original implementation used alternative A for 2400 bbps PSK. + // Years later, we discover that MFJ-2400 used alternative B. + // It's likely the others did too. it also works a little better. + // Default to MFJ compatible and print warning if user did not + // pick one explicitly. + +#define V26_DEFAULT V26_B + + enum dtmf_decode_t { DTMF_DECODE_OFF, DTMF_DECODE_ON } dtmf_decode; + + /* Originally the DTMF ("Touch Tone") decoder was always */ + /* enabled because it took a negligible amount of CPU. */ + /* There were complaints about the false positives when */ + /* hearing other modulation schemes on HF SSB so now it */ + /* is enabled only when needed. */ + + /* "On" will send special "t" packet to attached applications */ + /* and process as APRStt. Someday we might want to separate */ + /* these but for now, we have a single off/on. */ + + int decimate; /* Reduce AFSK sample rate by this factor to */ + /* decrease computational requirements. */ + + int upsample; /* Upsample by this factor for G3RUH. */ + + int mark_freq; /* Two tones for AFSK modulation, in Hz. */ + int space_freq; /* Standard tones are 1200 and 2200 for 1200 baud. */ + + int baud; /* Data bits per second. */ + /* Standard rates are 1200 for VHF and 300 for HF. */ + /* This should really be called bits per second. */ + + /* Next 3 come from config file or command line. */ + + char profiles[16]; /* zero or more of ABC etc, optional + */ + + int num_freq; /* Number of different frequency pairs for decoders. */ + + int offset; /* Spacing between filter frequencies. */ + + int num_slicers; /* Number of different threshold points to decide */ + /* between mark or space. */ + + /* This is derived from above by demod_init. */ + + int num_subchan; /* Total number of modems for each channel. */ + + + /* These are for dealing with imperfect frames. */ + + enum retry_e fix_bits; /* Level of effort to recover from */ + /* a bad FCS on the frame. */ + /* 0 = no effort */ + /* 1 = try fixing a single bit */ + /* 2... = more techniques... */ + + enum sanity_e sanity_test; /* Sanity test to apply when finding a good */ + /* CRC after making a change. */ + /* Must look like APRS, AX.25, or anything. */ + + int passall; /* Allow thru even with bad CRC. */ + + + + /* Additional properties for transmit. */ + + /* Originally we had control outputs only for PTT. */ + /* In version 1.2, we generalize this to allow others such as DCD. */ + /* In version 1.4 we add CON for connected to another station. */ + /* Index following structure by one of these: */ + + +#define OCTYPE_PTT 0 +#define OCTYPE_DCD 1 +#define OCTYPE_CON 2 + +#define NUM_OCTYPES 3 /* number of values above. i.e. last value +1. */ + + struct { + + ptt_method_t ptt_method; /* none, serial port, GPIO, LPT, HAMLIB, CM108. */ + + char ptt_device[128]; /* Serial device name for PTT. e.g. COM1 or /dev/ttyS0 */ + /* Also used for HAMLIB. Could be host:port when model is 1. */ + /* For years, 20 characters was plenty then we start getting extreme names like this: */ + /* /dev/serial/by-id/usb-FTDI_Navigator__CAT___2nd_PTT__00000000-if00-port0 */ + /* /dev/serial/by-id/usb-Prolific_Technology_Inc._USB-Serial_Controller_D-if00-port0 */ + /* Issue 104, changed to 100 bytes in version 1.5. */ + + /* This same field is also used for CM108/CM119 GPIO PTT which will */ + /* have a name like /dev/hidraw1 for Linux or */ + /* \\?\hid#vid_0d8c&pid_0008&mi_03#8&39d3555&0&0000#{4d1e55b2-f16f-11cf-88cb-001111000030} */ + /* for Windows. Largest observed was 95 but add some extra to be safe. */ + + ptt_line_t ptt_line; /* Control line when using serial port. PTT_LINE_RTS, PTT_LINE_DTR. */ + ptt_line_t ptt_line2; /* Optional second one: PTT_LINE_NONE when not used. */ + + int out_gpio_num; /* GPIO number. Originally this was only for PTT. */ + /* It is now more general. */ + /* octrl array is indexed by PTT, DCD, or CONnected indicator. */ + /* For CM108/CM119, this should be in range of 1-8. */ + +#define MAX_GPIO_NAME_LEN 20 // 12 would cover any case I've seen so this should be safe + + char out_gpio_name[MAX_GPIO_NAME_LEN]; + /* originally, gpio number NN was assumed to simply */ + /* have the name gpioNN but this turned out not to be */ + /* the case for CubieBoard where it was longer. */ + /* This is filled in by ptt_init so we don't have to */ + /* recalculate it each time we access it. */ + + /* This could probably be collapsed into ptt_device instead of being separate. */ + + int ptt_lpt_bit; /* Bit number for parallel printer port. */ + /* Bit 0 = pin 2, ..., bit 7 = pin 9. */ + + int ptt_invert; /* Invert the output. */ + int ptt_invert2; /* Invert the secondary output. */ + +#ifdef USE_HAMLIB + + int ptt_model; /* HAMLIB model. -1 for AUTO. 2 for rigctld. Others are radio model. */ + int ptt_rate; /* Serial port speed when using hamlib CAT control for PTT. */ + /* If zero, hamlib will come up with a default for pariticular rig. */ +#endif + + } octrl[NUM_OCTYPES]; + + + /* Each channel can also have associated input lines. */ + /* So far, we just have one for transmit inhibit. */ + +#define ICTYPE_TXINH 0 + +#define NUM_ICTYPES 1 /* number of values above. i.e. last value +1. */ + + struct { + ptt_method_t method; /* none, serial port, GPIO, LPT. */ + + int in_gpio_num; /* GPIO number */ + + char in_gpio_name[MAX_GPIO_NAME_LEN]; + /* originally, gpio number NN was assumed to simply */ + /* have the name gpioNN but this turned out not to be */ + /* the case for CubieBoard where it was longer. */ + /* This is filled in by ptt_init so we don't have to */ + /* recalculate it each time we access it. */ + + int invert; /* 1 = active low */ + } ictrl[NUM_ICTYPES]; + + /* Transmit timing. */ + + int dwait; /* First wait extra time for receiver squelch. */ + /* Default 0 units of 10 mS each . */ + + int slottime; /* Slot time in 10 mS units for persistence algorithm. */ + /* Typical value is 10 meaning 100 milliseconds. */ + + int persist; /* Sets probability for transmitting after each */ + /* slot time delay. Transmit if a random number */ + /* in range of 0 - 255 <= persist value. */ + /* Otherwise wait another slot time and try again. */ + /* Default value is 63 for 25% probability. */ + + int txdelay; /* After turning on the transmitter, */ + /* send "flags" for txdelay * 10 mS. */ + /* Default value is 30 meaning 300 milliseconds. */ + + int txtail; /* Amount of time to keep transmitting after we */ + /* are done sending the data. This is to avoid */ + /* dropping PTT too soon and chopping off the end */ + /* of the frame. Again 10 mS units. */ + /* At this point, I'm thinking of 10 (= 100 mS) as the default */ + /* because we're not quite sure when the soundcard audio stops. */ + + int fulldup; /* Full Duplex. */ + + } achan[MAX_CHANS]; + +#ifdef USE_HAMLIB + int rigs; /* Total number of configured rigs */ + RIG *rig[MAX_RIGS]; /* HAMLib rig instances */ +#endif + +}; + + +#if __WIN32__ +#define DEFAULT_ADEVICE "" /* Windows: Empty string = default audio device. */ +#elif __APPLE__ +#define DEFAULT_ADEVICE "" /* Mac OSX: Empty string = default audio device. */ +#elif USE_ALSA +#define DEFAULT_ADEVICE "default" /* Use default device for ALSA. */ +#elif USE_SNDIO +#define DEFAULT_ADEVICE "default" /* Use default device for sndio. */ +#else +#define DEFAULT_ADEVICE "/dev/dsp" /* First audio device for OSS. (FreeBSD) */ +#endif + + + +/* + * UDP audio receiving port. Couldn't find any standard or usage precedent. + * Got the number from this example: http://gqrx.dk/doc/streaming-audio-over-udp + * Any better suggestions? + */ + +#define DEFAULT_UDP_AUDIO_PORT 7355 + + +// Maximum size of the UDP buffer (for allowing IP routing, udp packets are often limited to 1472 bytes) + +#define SDR_UDP_BUF_MAXLEN 2000 + + + +#define DEFAULT_NUM_CHANNELS 1 +#define DEFAULT_SAMPLES_PER_SEC 44100 /* Very early observations. Might no longer be valid. */ + /* 22050 works a lot better than 11025. */ + /* 44100 works a little better than 22050. */ + /* If you have a reasonable machine, use the highest rate. */ +#define MIN_SAMPLES_PER_SEC 8000 +//#define MAX_SAMPLES_PER_SEC 48000 /* Originally 44100. Later increased because */ + /* Software Defined Radio often uses 48000. */ + +#define MAX_SAMPLES_PER_SEC 192000 /* The cheap USB-audio adapters (e.g. CM108) can handle 44100 and 48000. */ + /* The "soundcard" in my desktop PC can do 96kHz or even 192kHz. */ + /* We will probably need to increase the sample rate to go much above 9600 baud. */ + +#define DEFAULT_BITS_PER_SAMPLE 16 + +#define DEFAULT_FIX_BITS RETRY_NONE // Interesting research project but even a single bit fix up + // will occasionally let corrupted packets through. + +/* + * Standard for AFSK on VHF FM. + * Reversing mark and space makes no difference because + * NRZI encoding only cares about change or lack of change + * between the two tones. + * + * HF SSB uses 300 baud and 200 Hz shift. + * 1600 & 1800 Hz is a popular tone pair, sometimes + * called the KAM tones. + */ + +#define DEFAULT_MARK_FREQ 1200 +#define DEFAULT_SPACE_FREQ 2200 +#define DEFAULT_BAUD 1200 + +/* Used for sanity checking in config file and command line options. */ +/* 9600 baud is known to work. */ +/* TODO: Is 19200 possible with a soundcard at 44100 samples/sec or do we need a higher sample rate? */ + +#define MIN_BAUD 100 +//#define MAX_BAUD 10000 +#define MAX_BAUD 40000 // Anyone want to try 38.4 k baud? + +/* + * Typical transmit timings for VHF. + */ + +#define DEFAULT_DWAIT 0 +#define DEFAULT_SLOTTIME 10 // *10mS = 100mS +#define DEFAULT_PERSIST 63 +#define DEFAULT_TXDELAY 30 // *10mS = 300mS +#define DEFAULT_TXTAIL 10 // *10mS = 100mS +#define DEFAULT_FULLDUP 0 // false = half duplex + +/* + * Note that we have two versions of these in audio.c and audio_win.c. + * Use one or the other depending on the platform. + */ + +int audio_open (struct audio_s *pa); + +int audio_get (int a); /* a = audio device, 0 for first */ + +int audio_put (int a, int c); + +int audio_flush (int a); + +void audio_wait (int a); + +int audio_close (void); + + +#endif /* ifdef AUDIO_H */ + + +/* end audio.h */ + diff --git a/src/audio_portaudio.c b/src/audio_portaudio.c new file mode 100644 index 00000000..cb6ccf10 --- /dev/null +++ b/src/audio_portaudio.c @@ -0,0 +1,1341 @@ + +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// +// Copyright (C) 2011, 2012, 2013, 2014, 2015 John Langner, WB2OSZ +// Copyright (C) 2015 Robert Stiles, KK5VD +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . +// + +/*------------------------------------------------------------------ + * + * Module: audio_portaudio.c + * + * Purpose: Interface to audio device commonly called a "sound card" for + * historical reasons. + * + * This version is for Various OS' using Port Audio + * + * Major Revisions: + * + * 1.2 - Add ability to use more than one audio device. + * 1.3 - New file added for Port Audio for Mac and possibly others. + * + *---------------------------------------------------------------*/ + +#if defined(USE_PORTAUDIO) + +#include "direwolf.h" + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include + +#include "audio.h" +#include "audio_stats.h" +#include "textcolor.h" +#include "dtime_now.h" +#include "demod.h" /* for alevel_t & demod_get_audio_level() */ + +#include "portaudio.h" + +/* Audio configuration. */ + +static struct audio_s *save_audio_config_p; + +/* Current state for each of the audio devices. */ + +static struct adev_s { + + pthread_mutex_t input_mutex; + pthread_cond_t input_cond; + + PaStream *inStream; + PaStreamParameters inputParameters; + int pa_input_device_number; + int no_of_input_channels; + int input_finished; + int input_pause; + int input_flush; + + void *audio_in_handle; + int inbuf_size_in_bytes; /* number of bytes allocated */ + unsigned char *inbuf_ptr; + int inbuf_len; /* number byte of actual data available. */ + int inbuf_next; /* index of next to remove. */ + int inbuf_bytes_per_frame; /* number of bytes for a sample from all channels. */ + int inbuf_frames_per_buffer; /* number of frames in a buffer. */ + + pthread_mutex_t output_mutex; + pthread_cond_t output_cond; + + PaStream *outStream; + PaStreamParameters outputParameters; + int pa_output_device_number; + int no_of_output_channels; + int output_pause; + int output_finished; + int output_flush; + int output_wait_flag; + + void *audio_out_handle; + int outbuf_size_in_bytes; + unsigned char *outbuf_ptr; + int outbuf_len; + int outbuf_next; /* index of next to remove. */ + int outbuf_bytes_per_frame; /* number of bytes for a sample from all channels. */ + int outbuf_frames_per_buffer; /* number of frames in a buffer. */ + + enum audio_in_type_e g_audio_in_type; + + int udp_sock; /* UDP socket for receiving data */ + +} adev[MAX_ADEVS]; + +// Originally 40. Version 1.2, try 10 for lower latency. + +#define ONE_BUF_TIME 10 +#define SAMPLE_SILENCE 0 + +#define PA_INPUT 1 +#define PA_OUTPUT 2 + +#define roundup1k(n) (((n) + 0x3ff) & ~0x3ff) + +#undef FOR_FUTURE_USE + +static int set_portaudio_params (int a, struct adev_s *dev, struct audio_s *pa, char *devname, char *inout); +static void print_pa_devices(void); +static int check_pa_configure(struct adev_s *dev, int sample_rate); +static void list_supported_sample_rates(struct adev_s *dev); +static int pa_devNN(char *deviceStr, char *_devName, size_t length, int *_devNo); +static int searchPADevice(struct adev_s *dev, char *_devName, int reqDeviceNo, int io_flag); +static int calcbufsize(int rate, int chans, int bits); + + +static int calcbufsize(int rate, int chans, int bits) +{ + int size1 = (rate * chans * bits / 8 * ONE_BUF_TIME) / 1000; + int size2 = roundup1k(size1); +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("audio_open: calcbufsize (rate=%d, chans=%d, bits=%d) calc size=%d, round up to %d\n", + rate, chans, bits, size1, size2); +#endif + return (size2); +} + +/*------------------------------------------------------------------ + * Search the portaudio device tree looking for the request device. + * One of the issues with portaudio has to do with devices returning + * the same device name for more then one connected device + * (ie two SignaLinks). Appending a Portaudio device index to the + * the device name ensure we can find the correct one. And if it's not + * available return the first occurrence that matches the device name. + *----------------------------------------------------------------*/ +static int searchPADevice(struct adev_s *dev, char *_devName, int reqDeviceNo, int io_flag) +{ + int numDevices = Pa_GetDeviceCount(); + const PaDeviceInfo * di = (PaDeviceInfo *)0; + int i = 0; + + // First check to see if the requested index matches the device name. + if(reqDeviceNo < numDevices) { + di = Pa_GetDeviceInfo((PaDeviceIndex) reqDeviceNo); + if(strncmp(di->name, _devName, 80) == 0) { + if((io_flag == PA_INPUT) && di->maxInputChannels) + return reqDeviceNo; + if((io_flag == PA_OUTPUT) && di->maxOutputChannels) + return reqDeviceNo; + } + } + + // Requested device index doesn't match device name. Search for one. + for(i = 0; i < numDevices; i++) { + di = Pa_GetDeviceInfo((PaDeviceIndex) i); + if(strncmp(di->name, _devName, 80) == 0) { + if((io_flag == PA_INPUT) && di->maxInputChannels) + return i; + if((io_flag == PA_OUTPUT) && di->maxOutputChannels) + return i; + } + } + + // No Matches found + return -1; +} + +/*------------------------------------------------------------------ + * Extract device name and number. + *----------------------------------------------------------------*/ +static int pa_devNN(char *deviceStr, char *_devName, size_t length, int *_devNo) +{ + char *cPtr = (char *)0; + char cVal = 0; + int count = 0; + char numStr[8]; + + if(!deviceStr || !_devName || !_devNo) { + dw_printf( "Internal Error: Func %s passed null pointer.\n", __func__); + return -1; + } + + cPtr = deviceStr; + + memset(_devName, 0, length); + memset(numStr, 0, sizeof(numStr)); + + while(*cPtr) { + cVal = *cPtr++; + if(cVal == ':') break; + + // See Issue 417. + // Originally this copied only printable ASCII characters (space thru ~). + // That is a problem for some locales that use UTF-8 characters in the device name. + // original: if(((cVal >= ' ') && (cVal <= '~')) && (count < length)) { + + // At first I was thinking we should keep the test for < ' ' but then I + // remembered that char type can be signed or unsigned depending on implementation. + // If characters are signed then a value above 0x7f would be considered negative. + + // It seems to me that the test for buffer full is off by one. + // count could reach length, leaving no room for a nul terminator. + // Compare has been changed so count is limited to length minus 1. + + if(count < length - 1) { + _devName[count++] = cVal; + } + + } + + count = 0; + + while(*cPtr) { + cVal = *cPtr++; + if(isdigit(cVal) && (count < (sizeof(numStr) - 1))) { + numStr[count++] = cVal; + } + } + + if(numStr[0] == 0) { + *_devNo = 0; + } else { + sscanf(numStr, "%d", _devNo); + } + + return 0; +} + +/*------------------------------------------------------------------ + * List the supported sample rates. + *----------------------------------------------------------------*/ +static void list_supported_sample_rates(struct adev_s *dev) +{ + static double standardSampleRates[] = { + 8000.0, 9600.0, 11025.0, 12000.0, 16000.0, 22050.0, 24000.0, 32000.0, + 44100.0, 48000.0, 88200.0, 96000.0, 192000.0, -1 /* negative terminated list */ + }; + int i, printCount; + PaError err; + + printCount = 0; + for(i = 0; standardSampleRates[i] > 0; i++ ) { + err = Pa_IsFormatSupported(&dev->inputParameters, &dev->outputParameters, standardSampleRates[i] ); + if( err == paFormatIsSupported ) { + if( printCount == 0 ) { + dw_printf( "\t%8.2f", standardSampleRates[i] ); + printCount = 1; + } + else if( printCount == 4 ) { + dw_printf( ",\n\t%8.2f", standardSampleRates[i] ); + printCount = 1; + } + else { + dw_printf( ", %8.2f", standardSampleRates[i] ); + ++printCount; + } + } + } + + if( !printCount ) + dw_printf( "None\n" ); + else + dw_printf( "\n" ); +} + +/*------------------------------------------------------------------ + * Check PA Configure parameters. + *----------------------------------------------------------------*/ +static int check_pa_configure(struct adev_s *dev, int sample_rate) +{ + if(!dev) { + dw_printf( "Internal Error: Func %s struct adev_s *dev null pointer.\n", __func__); + return -1; + } + + PaError err = 0; + err = Pa_IsFormatSupported(&dev->inputParameters, &dev->outputParameters, sample_rate); + if(err == paFormatIsSupported) return 0; + dw_printf( "PortAudio Config Error: %s\n", Pa_GetErrorText(err)); + return err; +} + +/*------------------------------------------------------------------ + * Print a list of device names and parameters + *----------------------------------------------------------------*/ +static void print_pa_devices(void) +{ + int i, numDevices, defaultDisplayed; + const PaDeviceInfo *deviceInfo; + + numDevices = Pa_GetDeviceCount(); + + if( numDevices < 0 ) { + dw_printf( "ERROR: Pa_GetDeviceCount returned 0x%x\n", numDevices ); + return; + } + + dw_printf( "Number of devices = %d\n", numDevices ); + + for(i = 0; i < numDevices; i++ ) { + deviceInfo = Pa_GetDeviceInfo( i ); + dw_printf( "--------------------------------------- device #%d\n", i ); + + /* Mark global and API specific default devices */ + defaultDisplayed = 0; + if( i == Pa_GetDefaultInputDevice() ) { + dw_printf( "[ Default Input" ); + defaultDisplayed = 1; + } + else if( i == Pa_GetHostApiInfo( deviceInfo->hostApi )->defaultInputDevice ) { + const PaHostApiInfo *hostInfo = Pa_GetHostApiInfo( deviceInfo->hostApi ); + dw_printf( "[ Default %s Input", hostInfo->name ); + defaultDisplayed = 1; + } + + if( i == Pa_GetDefaultOutputDevice() ) { + dw_printf( (defaultDisplayed ? "," : "[") ); + dw_printf( " Default Output" ); + defaultDisplayed = 1; + } + else if( i == Pa_GetHostApiInfo( deviceInfo->hostApi )->defaultOutputDevice ) { + const PaHostApiInfo *hostInfo = Pa_GetHostApiInfo( deviceInfo->hostApi ); + dw_printf( (defaultDisplayed ? "," : "[") ); + dw_printf( " Default %s Output", hostInfo->name ); + defaultDisplayed = 1; + } + + if( defaultDisplayed ) + dw_printf( " ]\n" ); + + /* print device info fields */ + dw_printf( "Name = \"%s\"\n", deviceInfo->name ); + dw_printf( "Host API = %s\n", Pa_GetHostApiInfo( deviceInfo->hostApi )->name ); + dw_printf( "Max inputs = %d\n", deviceInfo->maxInputChannels ); + dw_printf( "Max outputs = %d\n", deviceInfo->maxOutputChannels ); + } +} + +/*------------------------------------------------------------------ + * Port Audio Input Callback + *----------------------------------------------------------------*/ +static int paInput16CB( const void *inputBuffer, void *outputBuffer, + unsigned long framesPerBuffer, + const PaStreamCallbackTimeInfo* timeInfo, + PaStreamCallbackFlags statusFlags, + void *userData ) +{ + struct adev_s *data = (struct adev_s *) userData; + const int16_t *rptr = (const int16_t *) inputBuffer; + size_t framesToCalc = 0; + size_t i = 0; + int finished = 0; + int word = 0; + size_t bytes_left = data->inbuf_size_in_bytes - data->inbuf_len; + size_t framesLeft = bytes_left / data->inbuf_bytes_per_frame; + + (void) outputBuffer; /* Prevent unused variable warnings. */ + (void) timeInfo; + (void) statusFlags; + (void) userData; + + if( framesLeft < framesPerBuffer ) { + framesToCalc = framesLeft; + finished = paComplete; + } else { + framesToCalc = framesPerBuffer; + finished = paContinue; + } + + if( inputBuffer == NULL || data->input_flush) { + for(i = 0; i < framesToCalc; i++) { + data->inbuf_ptr[data->inbuf_len++] = SAMPLE_SILENCE; + data->inbuf_ptr[data->inbuf_len++] = SAMPLE_SILENCE; + if(data->no_of_input_channels == 2) { + data->inbuf_ptr[data->inbuf_len++] = SAMPLE_SILENCE; + data->inbuf_ptr[data->inbuf_len++] = SAMPLE_SILENCE; + } + } + } else { + for(i = 0; i < framesToCalc; i++) { + word = *rptr++; /* left */ + data->inbuf_ptr[data->inbuf_len++] = word & 0xff; + data->inbuf_ptr[data->inbuf_len++] = (word >> 8) & 0xff; + + if(data->no_of_input_channels == 2) { + word = *rptr++; /* right */ + data->inbuf_ptr[data->inbuf_len++] = word & 0xff; + data->inbuf_ptr[data->inbuf_len++] = (word >> 8) & 0xff; + } + } + } + + if((finished == paComplete) || + (data->inbuf_len >= data->inbuf_size_in_bytes)) { + pthread_cond_signal(&data->input_cond); + finished = data->input_finished; + } + + return finished; +} + +#if FOR_FUTURE_USE +/*------------------------------------------------------------------ + * Port Audio Output Callback + *----------------------------------------------------------------*/ +static int paOutput16CB( const void *inputBuffer, void *outputBuffer, + unsigned long framesPerBuffer, + const PaStreamCallbackTimeInfo* timeInfo, + PaStreamCallbackFlags statusFlags, + void *userData) +{ + struct adev_s *data = (struct adev_s *) userData; + int16_t *wptr = (int16_t *) outputBuffer; + size_t i = 0; + int finished = 0; + size_t bytes_left = data->outbuf_size_in_bytes - data->outbuf_len; + size_t framesLeft = bytes_left / data->outbuf_bytes_per_frame; + int word = 0; + + (void) inputBuffer; /* Prevent unused variable warnings. */ + (void) timeInfo; + (void) statusFlags; + (void) userData; + + if(framesLeft && (framesLeft < framesPerBuffer)) { + /* final buffer... */ + for(i = 0; i < framesLeft; i++ ) { + word = data->outbuf_ptr[data->outbuf_len++] & 0xff; + word |= (data->outbuf_ptr[data->outbuf_len++] << 8) & 0xff; + *wptr++ = word; /* left */ + if(data->no_of_output_channels == 2 ) { + word = data->outbuf_ptr[data->outbuf_len++] & 0xff; + word |= (data->outbuf_ptr[data->outbuf_len++] << 8) & 0xff; + *wptr++ = word; /* right */ + } + } + for( ; i < framesPerBuffer; i++ ) { + *wptr++ = 0; /* left */ + if(data->no_of_output_channels == 2 ) + *wptr++ = 0; /* right */ + } + finished = paContinue; + } else { + for(i = 0; i < framesPerBuffer; i++ ) { + word = data->outbuf_ptr[data->outbuf_len++] & 0xff; + word |= (data->outbuf_ptr[data->outbuf_len++] << 8) & 0xff; + *wptr++ = word; /* left */ + if(data->no_of_output_channels == 2) { + word = data->outbuf_ptr[data->outbuf_len++] & 0xff; + word |= (data->outbuf_ptr[data->outbuf_len++] << 8) & 0xff; + *wptr++ = word; /* right */ + } + } + finished = paComplete; + } + + if(data->output_flush) { + data->output_flush = 0; + finished = paComplete; + } + + pthread_cond_signal(&data->output_cond); + finished = data->output_finished; + + return finished; +} +#endif + +/*------------------------------------------------------------------ + * + * Name: audio_open + * + * Purpose: Open the digital audio device. + * + * New in version 1.0, we recognize "udp:" optionally + * followed by a port number. + * + * Inputs: pa - Address of structure of type audio_s. + * + * Using a structure, rather than separate arguments + * seemed to make sense because we often pass around + * the same set of parameters various places. + * + * The fields that we care about are: + * num_channels + * samples_per_sec + * bits_per_sample + * If zero, reasonable defaults will be provided. + * + * The device names are in adevice_in and adevice_out. + * where c is the "card" (for historical purposes) + * and d is the "device" within the "card." + * + * + * Outputs: pa - The ACTUAL values are returned here. + * + * These might not be exactly the same as what was requested. + * + * Example: ask for stereo, 16 bits, 22050 per second. + * An ordinary desktop/laptop PC should be able to handle this. + * However, some other sort of smaller device might be + * more restrictive in its capabilities. + * It might say, the best I can do is mono, 8 bit, 8000/sec. + * + * The software modem must use this ACTUAL information + * that the device is supplying, that could be different + * than what the user specified. + * + * Returns: 0 for success, -1 for failure. + * + * + *----------------------------------------------------------------*/ + +int audio_open (struct audio_s *pa) +{ + int err = 0; + int chan = 0; + int a = 0; + int clear_value = 0; + char audio_in_name[80]; + char audio_out_name[80]; + static int initalize_flag = 0; + PaError paerr = paNoError; + + if(!initalize_flag) { + paerr = Pa_Initialize(); + initalize_flag = -1; + } + + if(paerr != paNoError ) return -1; + + save_audio_config_p = pa; + + memset (adev, 0, sizeof(adev)); + memset (audio_in_name, 0, sizeof(audio_in_name)); + memset (audio_out_name, 0, sizeof(audio_out_name)); + + for (a = 0; a < MAX_ADEVS; a++) { + adev[a].udp_sock = -1; + } + + /* + * Fill in defaults for any missing values. + */ + + for (a = 0; a < MAX_ADEVS; a++) { + if (pa->adev[a].num_channels == 0) + pa->adev[a].num_channels = DEFAULT_NUM_CHANNELS; + + if (pa->adev[a].samples_per_sec == 0) + pa->adev[a].samples_per_sec = DEFAULT_SAMPLES_PER_SEC; + + if (pa->adev[a].bits_per_sample == 0) + pa->adev[a].bits_per_sample = DEFAULT_BITS_PER_SAMPLE; + + for (chan = 0; chan < MAX_CHANS; chan++) { + if (pa->achan[chan].mark_freq == 0) + pa->achan[chan].mark_freq = DEFAULT_MARK_FREQ; + + if (pa->achan[chan].space_freq == 0) + pa->achan[chan].space_freq = DEFAULT_SPACE_FREQ; + + if (pa->achan[chan].baud == 0) + pa->achan[chan].baud = DEFAULT_BAUD; + + if (pa->achan[chan].num_subchan == 0) + pa->achan[chan].num_subchan = 1; + } + } + + /* + * Open audio device(s). + */ + + for (a = 0; a < MAX_ADEVS; a++) { + if (pa->adev[a].defined) { + + adev[a].inbuf_size_in_bytes = 0; + adev[a].outbuf_size_in_bytes = 0; + + /* + * Determine the type of audio input. + */ + + adev[a].g_audio_in_type = AUDIO_IN_TYPE_SOUNDCARD; + + if (strcasecmp(pa->adev[a].adevice_in, "stdin") == 0 || strcmp(pa->adev[a].adevice_in, "-") == 0) { + adev[a].g_audio_in_type = AUDIO_IN_TYPE_STDIN; + /* Change "-" to stdin for readability. */ + strlcpy (pa->adev[a].adevice_in, "stdin", sizeof(pa->adev[a].adevice_in)); + } + + if (strncasecmp(pa->adev[a].adevice_in, "udp:", 4) == 0) { + adev[a].g_audio_in_type = AUDIO_IN_TYPE_SDR_UDP; + /* Supply default port if none specified. */ + if (strcasecmp(pa->adev[a].adevice_in,"udp") == 0 || + strcasecmp(pa->adev[a].adevice_in,"udp:") == 0) { + snprintf (pa->adev[a].adevice_in, sizeof(pa->adev[a].adevice_in), "udp:%d", DEFAULT_UDP_AUDIO_PORT); + } + } + + /* Let user know what is going on. */ + /* If not specified, the device names should be "default". */ + + strlcpy (audio_in_name, pa->adev[a].adevice_in, sizeof(audio_in_name)); + strlcpy (audio_out_name, pa->adev[a].adevice_out, sizeof(audio_out_name)); + + char ctemp[40]; + + if (pa->adev[a].num_channels == 2) { + snprintf (ctemp, sizeof(ctemp), " (channels %d & %d)", ADEVFIRSTCHAN(a), ADEVFIRSTCHAN(a)+1); + } else { + snprintf (ctemp, sizeof(ctemp), " (channel %d)", ADEVFIRSTCHAN(a)); + } + + text_color_set(DW_COLOR_INFO); + + if (strcmp(audio_in_name,audio_out_name) == 0) { + dw_printf ("Audio device for both receive and transmit: %s %s\n", audio_in_name, ctemp); + } else { + dw_printf ("Audio input device for receive: %s %s\n", audio_in_name, ctemp); + dw_printf ("Audio out device for transmit: %s %s\n", audio_out_name, ctemp); + } + + /* + * Now attempt actual opens. + */ + + /* + * Input device. + */ + + switch (adev[a].g_audio_in_type) { + + case AUDIO_IN_TYPE_SOUNDCARD: + print_pa_devices(); + err = set_portaudio_params (a, &adev[a], pa, audio_in_name, audio_out_name); + if(err < 0) return -1; + + pthread_mutex_init(&adev[a].input_mutex, NULL); + pthread_cond_init(&adev[a].input_cond, NULL); + + pthread_mutex_init(&adev[a].output_mutex, NULL); + pthread_cond_init(&adev[a].output_cond, NULL); + + if(pa->adev[a].bits_per_sample == 8) + clear_value = 128; + else + clear_value = 0; + + break; + + /* + * UDP. + */ + case AUDIO_IN_TYPE_SDR_UDP: + + // Create socket and bind socket + + { + struct sockaddr_in si_me; + //Create UDP Socket + if ((adev[a].udp_sock=socket(AF_INET, SOCK_DGRAM, IPPROTO_UDP))==-1) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Couldn't create socket, errno %d\n", errno); + return -1; + } + + memset((char *) &si_me, 0, sizeof(si_me)); + si_me.sin_family = AF_INET; + si_me.sin_port = htons((short)atoi(audio_in_name+4)); + si_me.sin_addr.s_addr = htonl(INADDR_ANY); + + //Bind to the socket + if (bind(adev[a].udp_sock, (const struct sockaddr *) &si_me, sizeof(si_me))==-1) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Couldn't bind socket, errno %d\n", errno); + return -1; + } + } + //adev[a].inbuf_size_in_bytes = SDR_UDP_BUF_MAXLEN; + + break; + + /* + * stdin. + */ + case AUDIO_IN_TYPE_STDIN: + + /* Do we need to adjust any properties of stdin? */ + + //adev[a].inbuf_size_in_bytes = 1024; + + break; + + default: + + text_color_set(DW_COLOR_ERROR); + dw_printf ("Internal error, invalid audio_in_type\n"); + return (-1); + } + + /* + * Finally allocate buffer for each direction. + */ + + /* Version 1.3 - Add sanity check on buffer size. */ + /* There was a reported case of assert failure on buffer size in audio_get(). */ + + if (adev[a].inbuf_size_in_bytes < 256 || adev[a].inbuf_size_in_bytes > 32768) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Audio input buffer has unexpected extreme size of %d bytes.\n", adev[a].inbuf_size_in_bytes); + dw_printf ("Detected at %s, line %d.\n", __FILE__, __LINE__); + dw_printf ("This might be caused by unusual audio device configuration values.\n"); + adev[a].inbuf_size_in_bytes = 2048; + dw_printf ("Using %d to attempt recovery.\n", adev[a].inbuf_size_in_bytes); + } + + if (adev[a].outbuf_size_in_bytes < 256 || adev[a].outbuf_size_in_bytes > 32768) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Audio output buffer has unexpected extreme size of %d bytes.\n", adev[a].outbuf_size_in_bytes); + dw_printf ("Detected at %s, line %d.\n", __FILE__, __LINE__); + dw_printf ("This might be caused by unusual audio device configuration values.\n"); + adev[a].outbuf_size_in_bytes = 2048; + dw_printf ("Using %d to attempt recovery.\n", adev[a].outbuf_size_in_bytes); + } + + adev[a].inbuf_ptr = malloc(adev[a].inbuf_size_in_bytes); + assert (adev[a].inbuf_ptr != NULL); + adev[a].inbuf_len = 0; + adev[a].inbuf_next = 0; + memset(adev[a].inbuf_ptr, clear_value, adev[a].inbuf_size_in_bytes); + + adev[a].outbuf_ptr = malloc(adev[a].outbuf_size_in_bytes); + assert (adev[a].outbuf_ptr != NULL); + adev[a].outbuf_len = 0; + adev[a].outbuf_next = 0; + memset(adev[a].outbuf_ptr, clear_value, adev[a].outbuf_size_in_bytes); + + if(adev[a].inStream) { + err = Pa_StartStream(adev[a].inStream); + if(err != paNoError) { + dw_printf ("Input stream start Error %s\n", Pa_GetErrorText(err)); + } + } + + if(adev[a].outStream) { + err = Pa_StartStream(adev[a].outStream); + if(err != paNoError) { + dw_printf ("Output stream start Error %s\n", Pa_GetErrorText(err)); + } + } + } /* end of audio device defined */ + } /* end of for each audio device */ + + return (0); + +} /* end audio_open */ + + +/* + * Set parameters for sound card. + * + * See ?? for details. + */ +static int set_portaudio_params (int a, struct adev_s *dev, struct audio_s *pa, char *_audio_in_name, char *_audio_out_name) +{ + int numDevices = 0; + int err = 0; + int buffer_size = 0; + int sampleFormat = 0; + int no_of_bytes_per_sample = 0; + int reqInDeviceNo = 0; + int reqOutDeviceNo = 0; + char input_devName[80]; + char output_devName[80]; + + text_color_set(DW_COLOR_ERROR); + + if(!dev || !pa || !_audio_in_name || !_audio_out_name) { + dw_printf ("Internal error, invalid function parameter pointer(s) (null)\n"); + return -1; + } + + if(_audio_in_name[0] == 0) { + dw_printf ("Input device name null\n"); + return -1; + } + + if(_audio_out_name[0] == 0) { + dw_printf ("Output device name null\n"); + return -1; + } + + numDevices = Pa_GetDeviceCount(); + if( numDevices < 0 ) { + dw_printf( "ERROR: Pa_GetDeviceCount returned 0x%x\n", numDevices ); + return -1; + } + + err = pa_devNN(_audio_in_name, input_devName, sizeof(input_devName), &reqInDeviceNo); + if(err < 0) return -1; + + reqInDeviceNo = searchPADevice(dev, input_devName, reqInDeviceNo, PA_INPUT); + if(reqInDeviceNo < 0) { + dw_printf ("Requested Input Audio Device not found %s.\n", input_devName); + return -1; + } + + err = pa_devNN(_audio_out_name, output_devName, sizeof(output_devName), &reqOutDeviceNo); + if(err < 0) return -1; + + reqOutDeviceNo = searchPADevice(dev, output_devName, reqOutDeviceNo, PA_OUTPUT); + if(reqOutDeviceNo < 0) { + dw_printf ("Requested Output Audio Device not found %s.\n", output_devName); + return -1; + } + + dev->pa_input_device_number = reqInDeviceNo; + dev->pa_output_device_number = reqOutDeviceNo; + + switch(pa->adev[a].bits_per_sample) { + case 8: + sampleFormat = paInt8; + no_of_bytes_per_sample = sizeof(int8_t); + assert("int8_t size not equal to 1" && sizeof(int8_t) == 1); + break; + + case 16: + sampleFormat = paInt16; + no_of_bytes_per_sample = sizeof(int16_t); + assert("int16_t size not equal to 2" && sizeof(int16_t) == 2); + break; + + default: + dw_printf ("Unsupported Sample Size %s.\n", output_devName); + return -1; + } + + + buffer_size = calcbufsize(pa->adev[a].samples_per_sec, pa->adev[a].num_channels, pa->adev[a].bits_per_sample); + + dev->inbuf_size_in_bytes = buffer_size; + dev->inbuf_bytes_per_frame = no_of_bytes_per_sample * pa->adev[a].num_channels; + dev->inbuf_frames_per_buffer = dev->inbuf_size_in_bytes / dev->inbuf_bytes_per_frame; + + dev->inputParameters.device = dev->pa_input_device_number; + dev->inputParameters.channelCount = pa->adev[a].num_channels; + dev->inputParameters.sampleFormat = sampleFormat; + dev->inputParameters.suggestedLatency = Pa_GetDeviceInfo(dev->inputParameters.device)->defaultLowInputLatency; + dev->inputParameters.hostApiSpecificStreamInfo = NULL; + + dev->outbuf_size_in_bytes = buffer_size; + dev->outbuf_bytes_per_frame = no_of_bytes_per_sample * pa->adev[a].num_channels; + dev->outbuf_frames_per_buffer = dev->outbuf_size_in_bytes / dev->outbuf_bytes_per_frame; + + dev->outputParameters.device = dev->pa_output_device_number; + dev->outputParameters.channelCount = pa->adev[a].num_channels; + dev->outputParameters.sampleFormat = sampleFormat; + dev->outputParameters.suggestedLatency = Pa_GetDeviceInfo(dev->outputParameters.device)->defaultHighOutputLatency; + dev->outputParameters.hostApiSpecificStreamInfo = NULL; + + err = check_pa_configure(dev, pa->adev[a].samples_per_sec); + if(err) { + if(err == paInvalidSampleRate) + list_supported_sample_rates(dev); + return -1; + } + + err = Pa_OpenStream(&dev->inStream, &dev->inputParameters, NULL, + pa->adev[a].samples_per_sec, dev->inbuf_frames_per_buffer, 0, paInput16CB, dev ); + + if( err != paNoError ) { + dw_printf( "PortAudio OpenStream (input) Error: %s\n", Pa_GetErrorText(err)); + return -1; + } + + err = Pa_OpenStream(&dev->outStream, NULL, &dev->outputParameters, + // pa->adev[a].samples_per_sec, framesPerBuffer, 0, paOutput16CB, dev ); + pa->adev[a].samples_per_sec, dev->outbuf_frames_per_buffer, 0, NULL, dev ); + + if( err != paNoError ) { + dw_printf( "PortAudio OpenStream (output) Error: %s\n", Pa_GetErrorText(err)); + return -1; + } + + dev->input_finished = paContinue; + dev->output_finished = paContinue; + + return buffer_size; +} + + +/*------------------------------------------------------------------ + * + * Name: audio_get + * + * Purpose: Get one byte from the audio device. + * + * Inputs: a - Our number for audio device. + * + * Returns: 0 - 255 for a valid sample. + * -1 for any type of error. + * + * Description: The caller must deal with the details of mono/stereo + * and number of bytes per sample. + * + * This will wait if no data is currently available. + * + *----------------------------------------------------------------*/ + +// Use hot attribute for all functions called for every audio sample. + +__attribute__((hot)) +int audio_get (int a) +{ + int n; + int retries = 0; + + +#if DEBUGx + text_color_set(DW_COLOR_DEBUG); + + dw_printf ("audio_get():\n"); + +#endif + + assert (adev[a].inbuf_size_in_bytes >= 100 && adev[a].inbuf_size_in_bytes <= 32768); + + switch (adev[a].g_audio_in_type) { + + /* + * Soundcard - PortAudio + */ + case AUDIO_IN_TYPE_SOUNDCARD: + + while (adev[a].inbuf_next >= adev[a].inbuf_len) { + + assert (adev[a].inStream != NULL); +#if DEBUGx + text_color_set(DW_COLOR_DEBUG); + dw_printf ("audio_get(): readi asking for %d frames\n", adev[a].inbuf_size_in_bytes / adev[a].bytes_per_frame); +#endif + if(adev[a].inbuf_len >= adev[a].inbuf_size_in_bytes) { + adev[a].inbuf_len = 0; + adev[a].inbuf_next = 0; + } + + pthread_mutex_lock(&adev[a].input_mutex); + pthread_cond_wait(&adev[a].input_cond, &adev[a].input_mutex); + pthread_mutex_unlock(&adev[a].input_mutex); + + n = adev[a].inbuf_len / adev[a].inbuf_bytes_per_frame; +#if DEBUGx + text_color_set(DW_COLOR_DEBUG); + dw_printf ("audio_get(): readi asked for %d and got %d frames\n", + adev[a].inbuf_size_in_bytes / adev[a].bytes_per_frame, n); +#endif + + + if (n > 0) { + + /* Success */ + + adev[a].inbuf_len = n * adev[a].inbuf_bytes_per_frame; /* convert to number of bytes */ + adev[a].inbuf_next = 0; + + audio_stats (a, + save_audio_config_p->adev[a].num_channels, + n, + save_audio_config_p->statistics_interval); + + } + else if (n == 0) { + + /* Didn't expect this, but it's not a problem. */ + /* Wait a little while and try again. */ + + text_color_set(DW_COLOR_ERROR); + dw_printf ("[%s], Audio input got zero bytes\n", __func__); + SLEEP_MS(10); + + adev[a].inbuf_len = 0; + adev[a].inbuf_next = 0; + } + else { + /* Error */ + // TODO: Needs more study and testing. + + // TODO: print n. should snd_strerror use n or errno? + // Audio input device error: Unknown error + + text_color_set(DW_COLOR_ERROR); + dw_printf ("Audio input device %d error\n", a); + + audio_stats (a, + save_audio_config_p->adev[a].num_channels, + 0, + save_audio_config_p->statistics_interval); + + /* Try to recover a few times and eventually give up. */ + if (++retries > 10) { + adev[a].inbuf_len = 0; + adev[a].inbuf_next = 0; + return (-1); + } + + if (n == -EPIPE) { + + /* EPIPE means overrun */ + + //snd_pcm_recover (adev[a].audio_in_handle, n, 1); + + } + else { + /* Could be some temporary condition. */ + /* Wait a little then try again. */ + /* Sometimes I get "Resource temporarily available" */ + /* when the Update Manager decides to run. */ + + SLEEP_MS (250); + //snd_pcm_recover (adev[a].audio_in_handle, n, 1); + } + } + } + + break; + + /* + * UDP. + */ + + case AUDIO_IN_TYPE_SDR_UDP: + + while (adev[a].inbuf_next >= adev[a].inbuf_len) { + int res; + + assert (adev[a].udp_sock > 0); + res = recv(adev[a].udp_sock, adev[a].inbuf_ptr, adev[a].inbuf_size_in_bytes, 0); + if (res < 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Can't read from udp socket, res=%d", res); + adev[a].inbuf_len = 0; + adev[a].inbuf_next = 0; + + audio_stats (a, + save_audio_config_p->adev[a].num_channels, + 0, + save_audio_config_p->statistics_interval); + + return (-1); + } + + adev[a].inbuf_len = res; + adev[a].inbuf_next = 0; + + audio_stats (a, + save_audio_config_p->adev[a].num_channels, + res / (save_audio_config_p->adev[a].num_channels * save_audio_config_p->adev[a].bits_per_sample / 8), + save_audio_config_p->statistics_interval); + } + break; + + /* + * stdin. + */ + case AUDIO_IN_TYPE_STDIN: + + while (adev[a].inbuf_next >= adev[a].inbuf_len) { + int res; + + res = read(STDIN_FILENO, adev[a].inbuf_ptr, (size_t)adev[a].inbuf_size_in_bytes); + if (res <= 0) { + text_color_set(DW_COLOR_INFO); + dw_printf ("\nEnd of file on stdin. Exiting.\n"); + exit (0); + } + + audio_stats (a, + save_audio_config_p->adev[a].num_channels, + res / (save_audio_config_p->adev[a].num_channels * save_audio_config_p->adev[a].bits_per_sample / 8), + save_audio_config_p->statistics_interval); + + adev[a].inbuf_len = res; + adev[a].inbuf_next = 0; + } + + break; + } + + + if (adev[a].inbuf_next < adev[a].inbuf_len) + n = adev[a].inbuf_ptr[adev[a].inbuf_next++]; + else + n = 0; + +#if DEBUGx + + text_color_set(DW_COLOR_DEBUG); + dw_printf ("audio_get(): returns %d\n", n); + +#endif + + + return (n); + +} /* end audio_get */ + + +/*------------------------------------------------------------------ + * + * Name: audio_put + * + * Purpose: Send one byte to the audio device. + * + * Inputs: a + * + * c - One byte in range of 0 - 255. + * + * Returns: Normally non-negative. + * -1 for any type of error. + * + * Description: The caller must deal with the details of mono/stereo + * and number of bytes per sample. + * + * See Also: audio_flush + * audio_wait + * + *----------------------------------------------------------------*/ +int audio_put (int a, int c) +{ + int err = 0; + size_t frames = 0; + + //#define __TIMED__ +#ifdef __TIMED__ + static int count = 0; + static double start = 0, end = 0, diff = 0; + + if(adev[a].outbuf_len == 0) + start = dtime_monotonic(); +#endif + + if(c >= 0) { + adev[a].outbuf_ptr[adev[a].outbuf_len++] = c; + } + + if ((adev[a].outbuf_len >= adev[a].outbuf_size_in_bytes) || (c < 0)) { + + frames = adev[a].outbuf_len / adev[a].outbuf_bytes_per_frame; + + if(frames > 0) { + err = Pa_WriteStream(adev[a].outStream, adev[a].outbuf_ptr, frames); + } + + // Getting underflow error for some reason on the first pass. Upon examination of the + // audio data revealed no discontinuity in the signal. Time measurements indicate this routine + // on this machine (2.8Ghz/Xeon E5462/2008 vintage) can handle ~6 times the current + // sample rate (44100/2 bytes per frame). For now, mask the error. + // Transfer Time:0.184750080 No of Frames:56264 Per frame:0.000003284 speed:6.905695 + + if ((err != paNoError) && (err != paOutputUnderflowed)) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("[%s] Audio Output Error: %s\n", __func__, Pa_GetErrorText(err)); + } + +#ifdef __TIMED__ + count += frames; + if(c < 0) { // When the Ax25 frames are flushed. + end = dtime_monotonic(); + diff = end - start; + if(count) + dw_printf ("Transfer Time:%3.9f No of Frames:%d Per frame:%3.9f speed:%f\n", + diff, count, diff/(count * 1.0), (1.0/44100.0)/(diff/(count * 1.0))); + count = 0; + } +#endif + adev[a].outbuf_len = 0; + adev[a].outbuf_next = 0; + } + + return (0); +} + +/*------------------------------------------------------------------ + * + * Name: audio_flush + * + * Purpose: Push out any partially filled output buffer. + * + * Returns: Normally non-negative. + * -1 for any type of error. + * + * See Also: audio_flush + * audio_wait + * + *----------------------------------------------------------------*/ + +int audio_flush (int a) +{ + audio_put(a, -1); + return 0; +} /* end audio_flush */ + + +/*------------------------------------------------------------------ + * + * Name: audio_wait + * + * Purpose: Finish up audio output before turning PTT off. + * + * Inputs: a - Index for audio device (not channel!) + * + * Returns: None. + * + * Description: Flush out any partially filled audio output buffer. + * Wait until all the queued up audio out has been played. + * Take any other necessary actions to stop audio output. + * + * In an ideal world: + * + * We would like to ask the hardware when all the queued + * up sound has actually come out the speaker. + * + * In reality: + * + * This has been found to be less than reliable in practice. + * + * Caller does the following: + * + * (1) Make note of when PTT is turned on. + * (2) Calculate how long it will take to transmit the + * frame including TXDELAY, frame (including + * "flags", data, FCS and bit stuffing), and TXTAIL. + * (3) Call this function, which might or might not wait long enough. + * (4) Add (1) and (2) resulting in when PTT should be turned off. + * (5) Take difference between current time and desired PPT off time + * and wait for additional time if required. + * + *----------------------------------------------------------------*/ + +void audio_wait (int a) +{ + audio_flush(a); + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("audio_wait(): after sync, status=%d\n", err); +#endif +} /* end audio_wait */ + + +/*------------------------------------------------------------------ + * + * Name: audio_close + * + * Purpose: Close the audio device(s). + * + * Returns: Normally non-negative. + * -1 for any type of error. + * + * + *----------------------------------------------------------------*/ + +int audio_close (void) +{ + int err = 0; + int a; + + for (a = 0; a < MAX_ADEVS; a++) { + if(adev[a].g_audio_in_type == AUDIO_IN_TYPE_SOUNDCARD) { + + audio_wait (a); + + if (adev[a].inStream != NULL) { + pthread_mutex_destroy(&adev[a].input_mutex); + pthread_cond_destroy(&adev[a].input_cond); + err |= (int) Pa_CloseStream(adev[a].inStream); + } + + if(adev[a].outStream != NULL) { + pthread_mutex_destroy(&adev[a].output_mutex); + pthread_cond_destroy(&adev[a].output_cond); + err |= (int) Pa_CloseStream(adev[a].outStream); + } + + err |= (int) Pa_Terminate(); + } + + if(adev[a].inbuf_ptr) + free (adev[a].inbuf_ptr); + + if(adev[a].outbuf_ptr) + free (adev[a].outbuf_ptr); + + adev[a].inbuf_size_in_bytes = 0; + adev[a].inbuf_ptr = NULL; + adev[a].inbuf_len = 0; + adev[a].inbuf_next = 0; + + adev[a].outbuf_size_in_bytes = 0; + adev[a].outbuf_ptr = NULL; + adev[a].outbuf_len = 0; + adev[a].outbuf_next = 0; + } + + if(err < 0) + err = -1; + + return (err); + +} /* end audio_close */ + +/* end audio_portaudio.c */ + +#endif // USE_PORTAUDIO diff --git a/src/audio_stats.c b/src/audio_stats.c new file mode 100644 index 00000000..7b94b1ee --- /dev/null +++ b/src/audio_stats.c @@ -0,0 +1,181 @@ + +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// +// Copyright (C) 2015 John Langner, WB2OSZ +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . +// + + +/*------------------------------------------------------------------ + * + * Module: audio_stats.c + * + * Purpose: Print statistics for audio input stream. + * + * A common complaint is that there is no indication of + * audio input level until a packet is received correctly. + * That's true for the Windows version but the Linux version + * prints something like this each 100 seconds: + * + * ADEVICE0: Sample rate approx. 44.1 k, 0 errors, receive audio level CH0 73 + * + * Some complain about the clutter but it has been a useful + * troubleshooting tool. In the earlier RPi days, the sample + * rate was quite low due to a device driver issue. + * Using a USB hub on the RPi also caused audio problems. + * One adapter, that I tried, produces samples at the + * right rate but all the samples are 0. + * + * Here we pull the code out of the Linux version of audio.c + * so we have a common function for all the platforms. + * + * We also add a command line option to adjust the time + * between reports or turn them off entirely. + * + * Revisions: This is new in version 1.3. + * + *---------------------------------------------------------------*/ + + +#include "direwolf.h" + + +#include +#include +#include +#include +#include +#include +#include +#include + + +#include "audio_stats.h" +#include "textcolor.h" +#include "demod.h" /* for alevel_t & demod_get_audio_level() */ + + + +/*------------------------------------------------------------------ + * + * Name: audio_stats + * + * Purpose: Add sample count from one buffer to the statistics. + * Print if specified amount of time has passed. + * + * Inputs: adev - Audio device number: 0, 1, ..., MAX_ADEVS-1 + * + nchan - Number of channels for this device, 1 or 2. + * + * nsamp - How many audio samples were read. + * + * interval - How many seconds between reports. + * 0 to turn off. + * + * Returns: none + * + * Description: ... + * + *----------------------------------------------------------------*/ + + +void audio_stats (int adev, int nchan, int nsamp, int interval) +{ + + /* Gather numbers for read from audio device. */ + + + static time_t last_time[MAX_ADEVS] = { 0, 0, 0 }; + time_t this_time[MAX_ADEVS]; + static int sample_count[MAX_ADEVS]; + static int error_count[MAX_ADEVS]; + static int suppress_first[MAX_ADEVS]; + + + if (interval <= 0) { + return; + } + + assert (adev >= 0 && adev < MAX_ADEVS); + +/* + * Print information about the sample rate as a troubleshooting aid. + * I've never seen an issue with Windows or x86 Linux but the Raspberry Pi + * has a very troublesome audio input system where many samples got lost. + * + * While we are at it we can also print the current audio level(s) providing + * more clues if nothing is being decoded. + */ + + if (last_time[adev] == 0) { + last_time[adev] = time(NULL); + sample_count[adev] = 0; + error_count[adev] = 0; + suppress_first[adev] = 1; + /* suppressing the first one could mean a rather */ + /* long wait for the first message. We make the */ + /* first collection interval 3 seconds. */ + last_time[adev] -= (interval - 3); + } + else { + if (nsamp > 0) { + sample_count[adev] += nsamp; + } + else { + error_count[adev]++; + } + this_time[adev] = time(NULL); + if (this_time[adev] >= last_time[adev] + interval) { + + if (suppress_first[adev]) { + + /* The issue we had is that the first time the rate */ + /* would be off considerably because we didn't start */ + /* on a second boundary. So we will suppress printing */ + /* of the first one. */ + + suppress_first[adev] = 0; + } + else { + float ave_rate = (sample_count[adev] / 1000.0) / interval; + + text_color_set(DW_COLOR_DEBUG); + + if (nchan > 1) { + int ch0 = ADEVFIRSTCHAN(adev); + alevel_t alevel0 = demod_get_audio_level(ch0,0); + int ch1 = ADEVFIRSTCHAN(adev) + 1; + alevel_t alevel1 = demod_get_audio_level(ch1,0); + + dw_printf ("\nADEVICE%d: Sample rate approx. %.1f k, %d errors, receive audio levels CH%d %d, CH%d %d\n\n", + adev, ave_rate, error_count[adev], ch0, alevel0.rec, ch1, alevel1.rec); + } + else { + int ch0 = ADEVFIRSTCHAN(adev); + alevel_t alevel0 = demod_get_audio_level(ch0,0); + + dw_printf ("\nADEVICE%d: Sample rate approx. %.1f k, %d errors, receive audio level CH%d %d\n\n", + adev, ave_rate, error_count[adev], ch0, alevel0.rec); + } + } + last_time[adev] = this_time[adev]; + sample_count[adev] = 0; + error_count[adev] = 0; + } + } + +} /* end audio_stats.c */ + diff --git a/src/audio_stats.h b/src/audio_stats.h new file mode 100644 index 00000000..4cf8ad03 --- /dev/null +++ b/src/audio_stats.h @@ -0,0 +1,7 @@ + + +/* audio_stats.h */ + + +extern void audio_stats (int adev, int nchan, int nsamp, int interval); + diff --git a/src/audio_win.c b/src/audio_win.c new file mode 100644 index 00000000..85a1548b --- /dev/null +++ b/src/audio_win.c @@ -0,0 +1,1174 @@ + +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// +// Copyright (C) 2011, 2012, 2013, 2014, 2015 John Langner, WB2OSZ +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . +// + + +/*------------------------------------------------------------------ + * + * Module: audio_win.c + * + * Purpose: Interface to audio device commonly called a "sound card" for + * historical reasons. + * + * This version uses the native Windows sound interface. + * + * Credits: Fabrice FAURE contributed Linux code for the SDR UDP interface. + * + * Discussion here: http://gqrx.dk/doc/streaming-audio-over-udp + * + * Major revisions: + * + * 1.2 - Add ability to use more than one audio device. + * + *---------------------------------------------------------------*/ + + +#include "direwolf.h" // Sets _WIN32_WINNT for XP API level needed by ws2tcpip.h + // Also includes windows.h. + + +#include +#include +#include +#include +#include +#include +#include +#include + +#include + +#ifndef WAVE_FORMAT_96M16 +#define WAVE_FORMAT_96M16 0x40000 +#define WAVE_FORMAT_96S16 0x80000 +#endif + +#include +#include // _WIN32_WINNT must be set to 0x0501 before including this + + +#include "audio.h" +#include "audio_stats.h" +#include "textcolor.h" +#include "ptt.h" +#include "demod.h" /* for alevel_t & demod_get_audio_level() */ + + + +/* Audio configuration. */ + +static struct audio_s *save_audio_config_p; + + +/* + * Allocate enough buffers for 1 second each direction. + * Each buffer size is a trade off between being responsive + * to activity on the channel vs. overhead of having too + * many little transfers. + */ + +/* + * Originally, we had an arbitrary buf time of 40 mS. + * + * For mono, the buffer size was rounded up from 3528 to 4k so + * it was really about 50 mS per buffer or about 20 per second. + * For stereo, the buffer size was rounded up from 7056 to 7k so + * it was really about 43.7 mS per buffer or about 23 per second. + * + * In version 1.2, let's try changing it to 10 to reduce the latency. + * For mono, the buffer size was rounded up from 882 to 1k so it + * was really about 12.5 mS per buffer or about 80 per second. + */ + +#define TOTAL_BUF_TIME 1000 +#define ONE_BUF_TIME 10 + +#define NUM_IN_BUF ((TOTAL_BUF_TIME)/(ONE_BUF_TIME)) +#define NUM_OUT_BUF ((TOTAL_BUF_TIME)/(ONE_BUF_TIME)) + + +#define roundup1k(n) (((n) + 0x3ff) & ~0x3ff) + +static int calcbufsize(int rate, int chans, int bits) +{ + int size1 = (rate * chans * bits / 8 * ONE_BUF_TIME) / 1000; + int size2 = roundup1k(size1); +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("audio_open: calcbufsize (rate=%d, chans=%d, bits=%d) calc size=%d, round up to %d\n", + rate, chans, bits, size1, size2); +#endif + + /* Version 1.3 - add a sanity check. */ + if (size2 < 256 || size2 > 32768) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Audio buffer has unexpected extreme size of %d bytes.\n", size2); + dw_printf ("Detected at %s, line %d.\n", __FILE__, __LINE__); + dw_printf ("This might be caused by unusual audio device configuration values.\n"); + size2 = 2048; + dw_printf ("Using %d to attempt recovery.\n", size2); + } + + return (size2); +} + + +/* Information for each audio stream (soundcard, stdin, or UDP) */ + +static struct adev_s { + + enum audio_in_type_e g_audio_in_type; + +/* + * UDP socket for receiving audio stream. + * Buffer, length, and pointer for UDP or stdin. + */ + + + SOCKET udp_sock; + char stream_data[SDR_UDP_BUF_MAXLEN]; + int stream_len; + int stream_next; + + +/* For sound output. */ +/* out_wavehdr.dwUser is used to keep track of output buffer state. */ + +#define DWU_FILLING 1 /* Ready to use or in process of being filled. */ +#define DWU_PLAYING 2 /* Was given to sound system for playing. */ +#define DWU_DONE 3 /* Sound system is done with it. */ + + HWAVEOUT audio_out_handle; + + volatile WAVEHDR out_wavehdr[NUM_OUT_BUF]; + int out_current; /* index to above. */ + int outbuf_size; + + +/* For sound input. */ +/* In this case dwUser is index of next available byte to remove. */ + + HWAVEIN audio_in_handle; + WAVEHDR in_wavehdr[NUM_IN_BUF]; + volatile WAVEHDR *in_headp; /* head of queue to process. */ + CRITICAL_SECTION in_cs; + +} adev[MAX_ADEVS]; + + +/*------------------------------------------------------------------ + * + * Name: audio_open + * + * Purpose: Open the digital audio device. + * + * New in version 1.0, we recognize "udp:" optionally + * followed by a port number. + * + * Inputs: pa - Address of structure of type audio_s. + * + * Using a structure, rather than separate arguments + * seemed to make sense because we often pass around + * the same set of parameters various places. + * + * The fields that we care about are: + * num_channels + * samples_per_sec + * bits_per_sample + * If zero, reasonable defaults will be provided. + * + * Outputs: pa - The ACTUAL values are returned here. + * + * The Linux version adjusts strange values to the + * nearest valid value. Don't know, yet, if Windows + * does the same or just fails. Or performs some + * expensive resampling from a rate supported by + * hardware. + * + * These might not be exactly the same as what was requested. + * + * Example: ask for stereo, 16 bits, 22050 per second. + * An ordinary desktop/laptop PC should be able to handle this. + * However, some other sort of smaller device might be + * more restrictive in its capabilities. + * It might say, the best I can do is mono, 8 bit, 8000/sec. + * + * The software modem must use this ACTUAL information + * that the device is supplying, that could be different + * than what the user specified. + * + * Returns: 0 for success, -1 for failure. + * + * References: Multimedia Reference + * + * http://msdn.microsoft.com/en-us/library/windows/desktop/dd743606%28v=vs.85%29.aspx + * + *----------------------------------------------------------------*/ + + +static void CALLBACK in_callback (HWAVEIN handle, UINT msg, DWORD_PTR instance, DWORD_PTR param1, DWORD_PTR param2); +static void CALLBACK out_callback (HWAVEOUT handle, UINT msg, DWORD_PTR instance, DWORD_PTR param1, DWORD_PTR param2); + +int audio_open (struct audio_s *pa) +{ + int a; + + int err; + int chan; + int n; + int in_dev_no[MAX_ADEVS]; + int out_dev_no[MAX_ADEVS]; + + + int num_devices; + WAVEINCAPS wic; + WAVEOUTCAPS woc; + + save_audio_config_p = pa; + + + for (a=0; aadev[a].defined) { + + struct adev_s *A = &(adev[a]); + + assert (A->audio_in_handle == 0); + assert (A->audio_out_handle == 0); + + //text_color_set(DW_COLOR_DEBUG); + //dw_printf ("pa->adev[a].adevice_in = '%s'\n", pa->adev[a].adevice_in); + //dw_printf ("pa->adev[a].adevice_out = '%s'\n", pa->adev[a].adevice_out); + + +/* + * Fill in defaults for any missing values. + */ + if (pa -> adev[a].num_channels == 0) + pa -> adev[a].num_channels = DEFAULT_NUM_CHANNELS; + + if (pa -> adev[a].samples_per_sec == 0) + pa -> adev[a].samples_per_sec = DEFAULT_SAMPLES_PER_SEC; + + if (pa -> adev[a].bits_per_sample == 0) + pa -> adev[a].bits_per_sample = DEFAULT_BITS_PER_SAMPLE; + + A->g_audio_in_type = AUDIO_IN_TYPE_SOUNDCARD; + + for (chan=0; chan achan[chan].mark_freq == 0) + pa -> achan[chan].mark_freq = DEFAULT_MARK_FREQ; + + if (pa -> achan[chan].space_freq == 0) + pa -> achan[chan].space_freq = DEFAULT_SPACE_FREQ; + + if (pa -> achan[chan].baud == 0) + pa -> achan[chan].baud = DEFAULT_BAUD; + + if (pa->achan[chan].num_subchan == 0) + pa->achan[chan].num_subchan = 1; + } + + + A->udp_sock = INVALID_SOCKET; + + in_dev_no[a] = WAVE_MAPPER; /* = ((UINT)-1) in mmsystem.h */ + out_dev_no[a] = WAVE_MAPPER; + +/* + * Determine the type of audio input and select device. + * This can be soundcard, UDP stream, or stdin. + */ + + if (strcasecmp(pa->adev[a].adevice_in, "stdin") == 0 || strcmp(pa->adev[a].adevice_in, "-") == 0) { + A->g_audio_in_type = AUDIO_IN_TYPE_STDIN; + /* Change - to stdin for readability. */ + strlcpy (pa->adev[a].adevice_in, "stdin", sizeof(pa->adev[a].adevice_in)); + } + else if (strncasecmp(pa->adev[a].adevice_in, "udp:", 4) == 0) { + A->g_audio_in_type = AUDIO_IN_TYPE_SDR_UDP; + /* Supply default port if none specified. */ + if (strcasecmp(pa->adev[a].adevice_in,"udp") == 0 || + strcasecmp(pa->adev[a].adevice_in,"udp:") == 0) { + snprintf (pa->adev[a].adevice_in, sizeof(pa->adev[a].adevice_in), "udp:%d", DEFAULT_UDP_AUDIO_PORT); + } + } + else { + A->g_audio_in_type = AUDIO_IN_TYPE_SOUNDCARD; + + /* Does config file have a number? */ + /* If so, it is an index into list of devices. */ + /* Originally only a single digit was recognized. */ + /* v 1.5 also recognizes two digits. (Issue 116) */ + + if (strlen(pa->adev[a].adevice_in) == 1 && isdigit(pa->adev[a].adevice_in[0])) { + in_dev_no[a] = atoi(pa->adev[a].adevice_in); + } + else if (strlen(pa->adev[a].adevice_in) == 2 && isdigit(pa->adev[a].adevice_in[0]) && isdigit(pa->adev[a].adevice_in[1])) { + in_dev_no[a] = atoi(pa->adev[a].adevice_in); + } + + /* Otherwise, does it have search string? */ + + if ((UINT)(in_dev_no[a]) == WAVE_MAPPER && strlen(pa->adev[a].adevice_in) >= 1) { + num_devices = waveInGetNumDevs(); + for (n=0 ; nadev[a].adevice_in) != NULL) { + in_dev_no[a] = n; + } + } + } + if ((UINT)(in_dev_no[a]) == WAVE_MAPPER) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("\"%s\" doesn't match any of the input devices.\n", pa->adev[a].adevice_in); + } + } + } + +/* + * Select output device. + * Only soundcard at this point. + * Purhaps we'd like to add UDP for an SDR transmitter. + */ + if (strlen(pa->adev[a].adevice_out) == 1 && isdigit(pa->adev[a].adevice_out[0])) { + out_dev_no[a] = atoi(pa->adev[a].adevice_out); + } + else if (strlen(pa->adev[a].adevice_out) == 2 && isdigit(pa->adev[a].adevice_out[0]) && isdigit(pa->adev[a].adevice_out[1])) { + out_dev_no[a] = atoi(pa->adev[a].adevice_out); + } + + if ((UINT)(out_dev_no[a]) == WAVE_MAPPER && strlen(pa->adev[a].adevice_out) >= 1) { + num_devices = waveOutGetNumDevs(); + for (n=0 ; nadev[a].adevice_out) != NULL) { + out_dev_no[a] = n; + } + } + } + if ((UINT)(out_dev_no[a]) == WAVE_MAPPER) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("\"%s\" doesn't match any of the output devices.\n", pa->adev[a].adevice_out); + } + } + } /* if defined */ + } /* for each device */ + + +/* + * Display the input devices (soundcards) available and what is selected. + */ + + text_color_set(DW_COLOR_INFO); + dw_printf ("Available audio input devices for receive (*=selected):\n"); + + num_devices = waveInGetNumDevs(); + + for (a=0; aadev[a].defined) { + + if (in_dev_no[a] < -1 || in_dev_no[a] >= num_devices) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Invalid input (receive) audio device number %d.\n", in_dev_no[a]); + in_dev_no[a] = WAVE_MAPPER; + } + } + } + + text_color_set(DW_COLOR_INFO); + for (n=0; nadev[a].defined) { + dw_printf (" %c", n==in_dev_no[a] ? '*' : ' '); + + } + } + dw_printf (" %d: %s", n, wic.szPname); + + for (a=0; aadev[a].defined && n==in_dev_no[a]) { + if (pa->adev[a].num_channels == 2) { + dw_printf (" (channels %d & %d)", ADEVFIRSTCHAN(a), ADEVFIRSTCHAN(a)+1); + } + else { + dw_printf (" (channel %d)", ADEVFIRSTCHAN(a)); + } + } + } + dw_printf ("\n"); + } + } + +// Add UDP or stdin to end of device list if used. + + for (a=0; aadev[a].defined) { + + struct adev_s *A = &(adev[a]); + + /* Display stdin or udp:port if appropriate. */ + + if (A->g_audio_in_type != AUDIO_IN_TYPE_SOUNDCARD) { + + int aaa; + for (aaa=0; aaaadev[aaa].defined) { + dw_printf (" %c", a == aaa ? '*' : ' '); + + } + } + dw_printf (" %s ", pa->adev[a].adevice_in); /* should be UDP:nnnn or stdin */ + + if (pa->adev[a].num_channels == 2) { + dw_printf (" (channels %d & %d)", ADEVFIRSTCHAN(a), ADEVFIRSTCHAN(a)+1); + } + else { + dw_printf (" (channel %d)", ADEVFIRSTCHAN(a)); + } + dw_printf ("\n"); + } + } + } + + +/* + * Display the output devices (soundcards) available and what is selected. + */ + + dw_printf ("Available audio output devices for transmit (*=selected):\n"); + + /* TODO? */ + /* No "*" is currently displayed when using the default device. */ + /* Should we put "*" next to the default device when using it? */ + /* Which is the default? The first one? */ + + num_devices = waveOutGetNumDevs(); + + for (a=0; aadev[a].defined) { + if (out_dev_no[a] < -1 || out_dev_no[a] >= num_devices) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Invalid output (transmit) audio device number %d.\n", out_dev_no[a]); + out_dev_no[a] = WAVE_MAPPER; + } + } + } + + text_color_set(DW_COLOR_INFO); + for (n=0; nadev[a].defined) { + dw_printf (" %c", n==out_dev_no[a] ? '*' : ' '); + + } + } + dw_printf (" %d: %s", n, woc.szPname); + + for (a=0; aadev[a].defined && n==out_dev_no[a]) { + if (pa->adev[a].num_channels == 2) { + dw_printf (" (channels %d & %d)", ADEVFIRSTCHAN(a), ADEVFIRSTCHAN(a)+1); + } + else { + dw_printf (" (channel %d)", ADEVFIRSTCHAN(a)); + } + } + } + dw_printf ("\n"); + } + } + + +/* + * Open for each audio device input/output pair. + */ + + for (a=0; aadev[a].defined) { + + struct adev_s *A = &(adev[a]); + + WAVEFORMATEX wf; + + wf.wFormatTag = WAVE_FORMAT_PCM; + wf.nChannels = pa -> adev[a].num_channels; + wf.nSamplesPerSec = pa -> adev[a].samples_per_sec; + wf.wBitsPerSample = pa -> adev[a].bits_per_sample; + wf.nBlockAlign = (wf.wBitsPerSample / 8) * wf.nChannels; + wf.nAvgBytesPerSec = wf.nBlockAlign * wf.nSamplesPerSec; + wf.cbSize = 0; + + A->outbuf_size = calcbufsize(wf.nSamplesPerSec,wf.nChannels,wf.wBitsPerSample); + + +/* + * Open the audio output device. + * Soundcard is only possibility at this time. + */ + + err = waveOutOpen (&(A->audio_out_handle), out_dev_no[a], &wf, (DWORD_PTR)out_callback, a, CALLBACK_FUNCTION); + if (err != MMSYSERR_NOERROR) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Could not open audio device for output.\n"); + return (-1); + } + + +/* + * Set up the output buffers. + * We use dwUser to indicate it is available for filling. + */ + + memset ((void*)(A->out_wavehdr), 0, sizeof(A->out_wavehdr)); + + for (n = 0; n < NUM_OUT_BUF; n++) { + A->out_wavehdr[n].lpData = malloc(A->outbuf_size); + A->out_wavehdr[n].dwUser = DWU_FILLING; + A->out_wavehdr[n].dwBufferLength = 0; + } + A->out_current = 0; + + +/* + * Open audio input device. + * More possibilities here: soundcard, UDP port, stdin. + */ + + switch (A->g_audio_in_type) { + +/* + * Soundcard. + */ + case AUDIO_IN_TYPE_SOUNDCARD: + + // Use InitializeCriticalSectionAndSpinCount to avoid exceptions in low memory situations? + + InitializeCriticalSection (&(A->in_cs)); + + err = waveInOpen (&(A->audio_in_handle), in_dev_no[a], &wf, (DWORD_PTR)in_callback, a, CALLBACK_FUNCTION); + if (err != MMSYSERR_NOERROR) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Could not open audio device for input.\n"); + return (-1); + } + + + /* + * Set up the input buffers. + */ + + memset ((void*)(A->in_wavehdr), 0, sizeof(A->in_wavehdr)); + + for (n = 0; n < NUM_OUT_BUF; n++) { + A->in_wavehdr[n].dwBufferLength = A->outbuf_size; /* all the same size */ + A->in_wavehdr[n].lpData = malloc(A->outbuf_size); + } + A->in_headp = NULL; + + /* + * Give them to the sound input system. + */ + + for (n = 0; n < NUM_OUT_BUF; n++) { + waveInPrepareHeader(A->audio_in_handle, &(A->in_wavehdr[n]), sizeof(WAVEHDR)); + waveInAddBuffer(A->audio_in_handle, &(A->in_wavehdr[n]), sizeof(WAVEHDR)); + } + + /* + * Start it up. + * The callback function is called when one is filled. + */ + + waveInStart (A->audio_in_handle); + break; + +/* + * UDP. + */ + case AUDIO_IN_TYPE_SDR_UDP: + + { + WSADATA wsadata; + struct sockaddr_in si_me; + //int slen=sizeof(si_me); + //int data_size = 0; + int err; + + err = WSAStartup (MAKEWORD(2,2), &wsadata); + if (err != 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf("WSAStartup failed: %d\n", err); + return (-1); + } + + if (LOBYTE(wsadata.wVersion) != 2 || HIBYTE(wsadata.wVersion) != 2) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Could not find a usable version of Winsock.dll\n"); + WSACleanup(); + return (-1); + } + + // Create UDP Socket + + A->udp_sock = socket(AF_INET, SOCK_DGRAM, IPPROTO_UDP); + if (A->udp_sock == INVALID_SOCKET) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Couldn't create socket, errno %d\n", WSAGetLastError()); + return -1; + } + + memset((char *) &si_me, 0, sizeof(si_me)); + si_me.sin_family = AF_INET; + si_me.sin_port = htons((short)atoi(pa->adev[a].adevice_in + 4)); + si_me.sin_addr.s_addr = htonl(INADDR_ANY); + + // Bind to the socket + + if (bind(A->udp_sock, (SOCKADDR *) &si_me, sizeof(si_me)) != 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Couldn't bind socket, errno %d\n", WSAGetLastError()); + return -1; + } + A->stream_next= 0; + A->stream_len = 0; + } + + break; + +/* + * stdin. + */ + case AUDIO_IN_TYPE_STDIN: + + setmode (STDIN_FILENO, _O_BINARY); + A->stream_next= 0; + A->stream_len = 0; + + break; + + default: + + text_color_set(DW_COLOR_ERROR); + dw_printf ("Internal error, invalid audio_in_type\n"); + return (-1); + } + + } + } + + return (0); + +} /* end audio_open */ + + + +/* + * Called when input audio block is ready. + */ + +static void CALLBACK in_callback (HWAVEIN handle, UINT msg, DWORD_PTR instance, DWORD_PTR param1, DWORD_PTR param2) +{ + + //dw_printf ("in_callback, handle = %p, msg = %d, instance = %I64d\n", handle, msg, instance); + + int a = instance; + assert (a >= 0 && a < MAX_ADEVS); + struct adev_s *A = &(adev[a]); + + if (msg == WIM_DATA) { + + WAVEHDR *p = (WAVEHDR*)param1; + + p->dwUser = 0x5a5a5a5a; /* needs to be unprepared. */ + /* dwUser can be 32 or 64 bit unsigned int. */ + p->lpNext = NULL; + + // dw_printf ("dwBytesRecorded = %ld\n", p->dwBytesRecorded); + + EnterCriticalSection (&(A->in_cs)); + + if (A->in_headp == NULL) { + A->in_headp = p; /* first one in list */ + } + else { + WAVEHDR *last = (WAVEHDR*)(A->in_headp); + + while (last->lpNext != NULL) { + last = last->lpNext; + } + last->lpNext = p; /* append to last one */ + } + + LeaveCriticalSection (&(A->in_cs)); + } +} + +/* + * Called when output system is done with a block and it + * is again available for us to fill. + */ + + +static void CALLBACK out_callback (HWAVEOUT handle, UINT msg, DWORD_PTR instance, DWORD_PTR param1, DWORD_PTR param2) +{ + if (msg == WOM_DONE) { + + WAVEHDR *p = (WAVEHDR*)param1; + + p->dwBufferLength = 0; + p->dwUser = DWU_DONE; + } +} + + +/*------------------------------------------------------------------ + * + * Name: audio_get + * + * Purpose: Get one byte from the audio device. + * + * + * Inputs: a - Audio soundcard number. + * + * Returns: 0 - 255 for a valid sample. + * -1 for any type of error. + * + * Description: The caller must deal with the details of mono/stereo + * and number of bytes per sample. + * + * This will wait if no data is currently available. + * + *----------------------------------------------------------------*/ + +// Use hot attribute for all functions called for every audio sample. + +__attribute__((hot)) +int audio_get (int a) +{ + struct adev_s *A; + + WAVEHDR *p; + int n; + int sample; + + A = &(adev[a]); + + switch (A->g_audio_in_type) { + +/* + * Soundcard. + */ + case AUDIO_IN_TYPE_SOUNDCARD: + + while (1) { + + /* + * Wait if nothing available. + * Could use an event to wake up but this is adequate. + */ + int timeout = 25; + + while (A->in_headp == NULL) { + //SLEEP_MS (ONE_BUF_TIME / 5); + SLEEP_MS (ONE_BUF_TIME); + timeout--; + if (timeout <= 0) { + text_color_set(DW_COLOR_ERROR); + +// TODO1.2: Need more details. Can we keep going? + + dw_printf ("Timeout waiting for input from audio device %d.\n", a); + + audio_stats (a, + save_audio_config_p->adev[a].num_channels, + 0, + save_audio_config_p->statistics_interval); + + return (-1); + } + } + + p = (WAVEHDR*)(A->in_headp); /* no need to be volatile at this point */ + + if (p->dwUser == 0x5a5a5a5a) { // dwUser can be 32 or bit unsigned. + waveInUnprepareHeader(A->audio_in_handle, p, sizeof(WAVEHDR)); + p->dwUser = 0; /* Index for next byte. */ + + audio_stats (a, + save_audio_config_p->adev[a].num_channels, + p->dwBytesRecorded / (save_audio_config_p->adev[a].num_channels * save_audio_config_p->adev[a].bits_per_sample / 8), + save_audio_config_p->statistics_interval); + } + + if (p->dwUser < p->dwBytesRecorded) { + n = ((unsigned char*)(p->lpData))[p->dwUser++]; +#if DEBUGx + + text_color_set(DW_COLOR_DEBUG); + dw_printf ("audio_get(): returns %d\n", n); + +#endif + return (n); + } + /* + * Buffer is all used up. Give it back to sound input system. + */ + + EnterCriticalSection (&(A->in_cs)); + A->in_headp = p->lpNext; + LeaveCriticalSection (&(A->in_cs)); + + p->dwFlags = 0; + waveInPrepareHeader(A->audio_in_handle, p, sizeof(WAVEHDR)); + waveInAddBuffer(A->audio_in_handle, p, sizeof(WAVEHDR)); + } + break; +/* + * UDP. + */ + case AUDIO_IN_TYPE_SDR_UDP: + + while (A->stream_next >= A->stream_len) { + int res; + + assert (A->udp_sock > 0); + + res = SOCK_RECV (A->udp_sock, A->stream_data, SDR_UDP_BUF_MAXLEN); + if (res <= 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Can't read from udp socket, errno %d", WSAGetLastError()); + A->stream_len = 0; + A->stream_next = 0; + + audio_stats (a, + save_audio_config_p->adev[a].num_channels, + 0, + save_audio_config_p->statistics_interval); + + return (-1); + } + + audio_stats (a, + save_audio_config_p->adev[a].num_channels, + res / (save_audio_config_p->adev[a].num_channels * save_audio_config_p->adev[a].bits_per_sample / 8), + save_audio_config_p->statistics_interval); + + A->stream_len = res; + A->stream_next = 0; + } + sample = A->stream_data[A->stream_next] & 0xff; + A->stream_next++; + return (sample); + break; +/* + * stdin. + */ + case AUDIO_IN_TYPE_STDIN: + + while (A->stream_next >= A->stream_len) { + int res; + + res = read(STDIN_FILENO, A->stream_data, 1024); + if (res <= 0) { + text_color_set(DW_COLOR_INFO); + dw_printf ("\nEnd of file on stdin. Exiting.\n"); + exit (0); + } + + audio_stats (a, + save_audio_config_p->adev[a].num_channels, + res / (save_audio_config_p->adev[a].num_channels * save_audio_config_p->adev[a].bits_per_sample / 8), + save_audio_config_p->statistics_interval); + + A->stream_len = res; + A->stream_next = 0; + } + return (A->stream_data[A->stream_next++] & 0xff); + break; + } + + return (-1); + +} /* end audio_get */ + + +/*------------------------------------------------------------------ + * + * Name: audio_put + * + * Purpose: Send one byte to the audio device. + * + * Inputs: a - Index for audio device. + * + * c - One byte in range of 0 - 255. + * + * + * Global In: out_current - index of output buffer currently being filled. + * + * Returns: Normally non-negative. + * -1 for any type of error. + * + * Description: The caller must deal with the details of mono/stereo + * and number of bytes per sample. + * + * See Also: audio_flush + * audio_wait + * + *----------------------------------------------------------------*/ + +int audio_put (int a, int c) +{ + WAVEHDR *p; + + struct adev_s *A; + A = &(adev[a]); + +/* + * Wait if no buffers are available. + * Don't use p yet because compiler might might consider dwFlags a loop invariant. + */ + + int timeout = 10; + while ( A->out_wavehdr[A->out_current].dwUser == DWU_PLAYING) { + SLEEP_MS (ONE_BUF_TIME); + timeout--; + if (timeout <= 0) { + text_color_set(DW_COLOR_ERROR); + +// TODO: open issues 78 & 165. How can we avoid/improve this? + + dw_printf ("Audio output failure waiting for buffer.\n"); + dw_printf ("This can occur when we are producing audio output for\n"); + dw_printf ("transmit and the operating system doesn't provide buffer\n"); + dw_printf ("space after waiting and retrying many times.\n"); + //dw_printf ("In recent years, this has been reported only when running the\n"); + //dw_printf ("Windows version with VMWare on a Macintosh.\n"); + ptt_term (); + return (-1); + } + } + + p = (LPWAVEHDR)(&(A->out_wavehdr[A->out_current])); + + if (p->dwUser == DWU_DONE) { + waveOutUnprepareHeader (A->audio_out_handle, p, sizeof(WAVEHDR)); + p->dwBufferLength = 0; + p->dwUser = DWU_FILLING; + } + + /* Should never be full at this point. */ + + assert (p->dwBufferLength >= 0); + assert (p->dwBufferLength < (DWORD)(A->outbuf_size)); + + p->lpData[p->dwBufferLength++] = c; + + if (p->dwBufferLength == (DWORD)(A->outbuf_size)) { + return (audio_flush(a)); + } + + return (0); + +} /* end audio_put */ + + +/*------------------------------------------------------------------ + * + * Name: audio_flush + * + * Purpose: Send current buffer to the audio output system. + * + * Inputs: a - Index for audio device. + * + * Returns: Normally non-negative. + * -1 for any type of error. + * + * See Also: audio_flush + * audio_wait + * + *----------------------------------------------------------------*/ + +int audio_flush (int a) +{ + WAVEHDR *p; + MMRESULT e; + struct adev_s *A; + + A = &(adev[a]); + + p = (LPWAVEHDR)(&(A->out_wavehdr[A->out_current])); + + if (p->dwUser == DWU_FILLING && p->dwBufferLength > 0) { + + p->dwUser = DWU_PLAYING; + + waveOutPrepareHeader(A->audio_out_handle, p, sizeof(WAVEHDR)); + + e = waveOutWrite(A->audio_out_handle, p, sizeof(WAVEHDR)); + if (e != MMSYSERR_NOERROR) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("audio out write error %d\n", e); + + /* I don't expect this to ever happen but if it */ + /* does, make the buffer available for filling. */ + + p->dwUser = DWU_DONE; + return (-1); + } + A->out_current = (A->out_current + 1) % NUM_OUT_BUF; + } + return (0); + +} /* end audio_flush */ + + +/*------------------------------------------------------------------ + * + * Name: audio_wait + * + * Purpose: Finish up audio output before turning PTT off. + * + * Inputs: a - Index for audio device (not channel!) + * + * Returns: None. + * + * Description: Flush out any partially filled audio output buffer. + * Wait until all the queued up audio out has been played. + * Take any other necessary actions to stop audio output. + * + * In an ideal world: + * + * We would like to ask the hardware when all the queued + * up sound has actually come out the speaker. + * + * In reality: + * + * This has been found to be less than reliable in practice. + * + * Caller does the following: + * + * (1) Make note of when PTT is turned on. + * (2) Calculate how long it will take to transmit the + * frame including TXDELAY, frame (including + * "flags", data, FCS and bit stuffing), and TXTAIL. + * (3) Call this function, which might or might not wait long enough. + * (4) Add (1) and (2) resulting in when PTT should be turned off. + * (5) Take difference between current time and desired PPT off time + * and wait for additional time if required. + * + *----------------------------------------------------------------*/ + +void audio_wait (int a) +{ + + audio_flush (a); + +} /* end audio_wait */ + + +/*------------------------------------------------------------------ + * + * Name: audio_close + * + * + * Purpose: Close all of the audio devices. + * + * Returns: Normally non-negative. + * -1 for any type of error. + * + * + *----------------------------------------------------------------*/ + +int audio_close (void) +{ + int err = 0; + + int n; + + int a; + + for (a=0; aadev[a].defined) { + + struct adev_s *A = &(adev[a]); + + assert (A->audio_in_handle != 0); + assert (A->audio_out_handle != 0); + + audio_wait (a); + +/* Shutdown audio input. */ + + waveInReset(A->audio_in_handle); + waveInStop(A->audio_in_handle); + waveInClose(A->audio_in_handle); + A->audio_in_handle = 0; + + for (n = 0; n < NUM_IN_BUF; n++) { + + waveInUnprepareHeader (A->audio_in_handle, (LPWAVEHDR)(&(A->in_wavehdr[n])), sizeof(WAVEHDR)); + A->in_wavehdr[n].dwFlags = 0; + free (A->in_wavehdr[n].lpData); + A->in_wavehdr[n].lpData = NULL; + } + + DeleteCriticalSection (&(A->in_cs)); + + +/* Make sure all output buffers have been played then free them. */ + + for (n = 0; n < NUM_OUT_BUF; n++) { + if (A->out_wavehdr[n].dwUser == DWU_PLAYING) { + + int timeout = 2 * NUM_OUT_BUF; + while (A->out_wavehdr[n].dwUser == DWU_PLAYING) { + SLEEP_MS (ONE_BUF_TIME); + timeout--; + if (timeout <= 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Audio output failure on close.\n"); + } + } + + waveOutUnprepareHeader (A->audio_out_handle, (LPWAVEHDR)(&(A->out_wavehdr[n])), sizeof(WAVEHDR)); + + A->out_wavehdr[n].dwUser = DWU_DONE; + } + free (A->out_wavehdr[n].lpData); + A->out_wavehdr[n].lpData = NULL; + } + + waveOutClose (A->audio_out_handle); + A->audio_out_handle = 0; + + } /* if device configured */ + } /* for each device. */ + + /* Not right. always returns 0 but at this point, doesn't matter. */ + + return (err); + +} /* end audio_close */ + +/* end audio_win.c */ + diff --git a/src/ax25_link.c b/src/ax25_link.c new file mode 100644 index 00000000..3043a046 --- /dev/null +++ b/src/ax25_link.c @@ -0,0 +1,7152 @@ +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// +// Copyright (C) 2016, 2017, 2018, 2023 John Langner, WB2OSZ +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . +// + + +/*------------------------------------------------------------------ + * + * Name: ax25_link + * + * Purpose: Data Link State Machine. + * Establish connections and transfer data in the proper + * order with retries. + * + * Using the term "data link" is rather unfortunate because it causes + * confusion to someone familiar with the OSI networking model. + * This corresponds to the layer 4 transport, not layer 2 data link. + * + * Description: + * + * Typical sequence for establishing a connection + * initiated by a client application. Try version 2.2, + * get refused, and fall back to trying version 2.0. + * + * + * State Client App State Machine Peer + * ----- ---------- ------------- ---- + * + * 0 disc + * Conn. Req ---> + * SABME ---> + * 5 await 2.2 + * <--- FRMR or DM *note + * SABM ---> + * 1 await 2.0 + * <--- UA + * <--- CONN Ind. + * 3 conn + * + * + * Typical sequence when other end initiates connection. + * + * + * State Client App State Machine Peer + * ----- ---------- ------------- ---- + * + * 0 disc + * <--- SABME or SABM + * UA ---> + * <--- CONN Ind. + * 3 conn + * + * + * *note: + * + * After carefully studying the v2.2 spec, I expected a 2.0 implementation to send + * FRMR in response to SABME. This is important. If a v2.2 implementation + * gets FRMR, in response to SABME, it switches to v2.0 and sends SABM instead. + * + * The v2.0 protocol spec, section 2.3.4.3.3.1, states that FRMR should be sent when + * an invalid or not implemented command is received. That all fits together. + * + * In testing, I found that the KPC-3+ sent DM. + * + * I can see where they might get that idea. + * The v2.0 spec says that when in disconnected mode, it should respond to any + * command other than SABM or UI frame with a DM response with P/F set to 1. + * I think it was implemented wrong. 2.3.4.3.3.1 should take precedence. + * + * The TM-D710 does absolutely nothing in response to SABME. + * Not responding at all is just plain wrong. To work around this, I put + * in a special hack to start sending SABM after a certain number of + * SABME go unanswered. There is more discussion in the User Guide. + * + * References: + * * AX.25 Amateur Packet-Radio Link-Layer Protocol Version 2.0, October 1984 + * + * https://www.tapr.org/pub_ax25.html + * http://lea.hamradio.si/~s53mv/nbp/nbp/AX25V20.pdf + * + * At first glance, they look pretty much the same, but the second one + * is more complete with 4 appendices, including a state table. + * + * * AX.25 Link Access Protocol for Amateur Packet Radio Version 2.2 Revision: July 1998 + * + * https://www.tapr.org/pdf/AX25.2.2.pdf + * + * * AX.25 Link Access Protocol for Amateur Packet Radio Version 2.2 Revision: July 1998 + * + * http://www.ax25.net/AX25.2.2-Jul%2098-2.pdf + * + * I accidentally stumbled across this one when searching for some sort of errata + * list for the original protocol specification. + * + * "This is a new version of the 1998 standard. It has had all figures + * redone using Microsoft Visio. Errors in the SDL have been corrected." + * + * The SDL diagrams are dated 2006. I wish I had known about this version, with + * several corrections, before doing most of the implementation. :-( + * + * The title page still says July 1998 so it's not immediately obvious this + * is different than the one on the TAPR site. + * + * * AX.25 ... Latest revision, in progress. + * + * http://www.nj7p.org/ + * + * This is currently being revised in cooperation with software authors + * who have noticed some issues during implementation. + * + * The functions here are based on the SDL diagrams but turned inside out. + * It seems more intuitive to have a function for each type of input and then decide + * what to do depending on the state. This also reduces duplicate code because we + * often see the same flow chart segments, for the same input, appearing in multiple states. + * + * Errata: The protocol spec has many places that appear to be errors or are ambiguous so I wasn't + * sure what to do. These should be annotated with "erratum" comments so we can easily go + * back and revisit them. + * + * X.25: The AX.25 protocol is based on, but does not necessarily adhere to, the X.25 protocol. + * Consulting this might provide some insights where the AX.25 spec is not clear. + * + * http://www.itu.int/rec/T-REC-X.25-199610-I/en/ + * + * Version 1.4, released April 2017: + * + * Features tested reasonably well: + * + * Connect to/from a KPC-3+ and send I frames in both directions. + * Same with TM-D710A. + * v2.2 connect between two instances of direwolf. (Can't find another v2.2 for testing.) + * Modulo 8 & 128 sequence numbers. + * Recovery from simulated transmission errors using either REJ or SREJ. + * XID frame for parameter negotiation. + * Segments to allow data larger than max info part size. + * + * Implemented but not tested properly: + * + * Connecting thru digipeater(s). + * Acting as a digipeater. + * T3 timer. + * Compatibility with additional types of TNC. + * + * Version 1.5, December 2017: + * + * Implemented Multi Selective Reject. + * More efficient generation of SREJ frames. + * Reduced number of duplicate I frames sent for both REJ and SREJ cases. + * Avoided unnecessary RR when I frame could take care of the ack. + * (This led to issue 132 where outgoing data sometimes got stuck in the queue.) + * + *------------------------------------------------------------------*/ + +#include "direwolf.h" + + +#include +#include +#include +#include +#include +#include + + +#include "ax25_pad.h" +#include "ax25_pad2.h" +#include "xid.h" +#include "textcolor.h" +#include "dlq.h" +#include "tq.h" +#include "ax25_link.h" +#include "dtime_now.h" +#include "server.h" +#include "ptt.h" + + +#define MIN(a,b) ((a)<(b)?(a):(b)) +#define MAX(a,b) ((a)>(b)?(a):(b)) + +// Debug switches for different types of information. +// Should have command line options instead of changing source and recompiling. + +static int s_debug_protocol_errors = 0; // Less serious Protocol errors. + // Useful for debugging but unnecessarily alarming other times. + // Was it intentially left on for release 1.6? + +static int s_debug_client_app = 0; // Interaction with client application. + // dl_connect_request, dl_data_request, dl_data_indication, etc. + +static int s_debug_radio = 0; // Received frames and channel busy status. + // lm_data_indication, lm_channel_busy + +static int s_debug_variables = 0; // Variables, state changes. + +static int s_debug_retry = 0; // Related to lost I frames, REJ, SREJ, timeout, resending. + +static int s_debug_timers = 0; // Timer details. + +static int s_debug_link_handle = 0; // Create data link state machine or pick existing one, + // based on my address, peer address, client app index, and radio channel. + +static int s_debug_stats = 0; // Statistics when connection is closed. + +static int s_debug_misc = 0; // Anything left over that might be interesting. + + +/* + * AX.25 data link state machine. + * + * One instance for each link identified by + * [ client, channel, owncall, peercall ] + */ + +enum dlsm_state_e { + state_0_disconnected = 0, + state_1_awaiting_connection = 1, + state_2_awaiting_release = 2, + state_3_connected = 3, + state_4_timer_recovery = 4, + state_5_awaiting_v22_connection = 5 }; + + +typedef struct ax25_dlsm_s { + + int magic1; // Look out for bad pointer or corruption. +#define MAGIC1 0x11592201 + + struct ax25_dlsm_s *next; // Next in linked list. + + int stream_id; // Unique number for each stream. + // Internally we use a pointer but this is more user-friendly. + + int chan; // Radio channel being used. + + int client; // We have have multiple client applications, + // each with their own links. We need to know + // which client should receive the data or + // notifications about state changes. + + + char addrs[AX25_MAX_ADDRS][AX25_MAX_ADDR_LEN]; + // Up to 10 addresses, same order as in frame. + + int num_addr; // Number of addresses. Should be in range 2 .. 10. + +#define OWNCALL AX25_SOURCE + // addrs[OWNCALL] is owncall for this end of link. + // Note that we are acting on behalf of + // a client application so the APRS mycall + // might not be relevant. + +#define PEERCALL AX25_DESTINATION + // addrs[PEERCALL] is call for other end. + + + double start_time; // Clock time when this was allocated. Used only for + // debug output for timestamps relative to start. + + enum dlsm_state_e state; // Current state. + + int modulo; // 8 or 128. + // Determines whether we have one or two control + // octets. 128 allows a much larger window size. + + enum srej_e srej_enable; // Is other end capable of processing SREJ? (Am I allowed to send it?) + // Starts out as 'srej_none' for v2.0 or 'srej_single' for v2.2. + // Can be changed to 'srej_multi' with XID exchange. + // Should be used only with modulo 128. (Is this enforced?) + + int n1_paclen; // Maximum length of information field, in bytes. + // Starts out as 256 but can be negotiated higher. + // (Protocol Spec has this in bits. It is in bytes here.) + // "PACLEN" in configuration file. + + int n2_retry; // Maximum number of retries permitted. + // Typically 10. + // "RETRY" parameter in configuration file. + + + int k_maxframe; // Window size. Defaults to 4 (mod 8) or 32 (mod 128). + // Maximum number of unacknowledged information + // frames that can be outstanding. + // "MAXFRAME" or "EMAXFRAME" parameter in configuration file. + + int rc; // Retry count. Give up after n2. + + int vs; // 4.2.4.1. Send State Variable V(S) + // The send state variable exists within the TNC and is never sent. + // It contains the next sequential number to be assigned to the next + // transmitted I frame. + // This variable is updated with the transmission of each I frame. + + int va; // 4.2.4.5. Acknowledge State Variable V(A) + // The acknowledge state variable exists within the TNC and is never sent. + // It contains the sequence number of the last frame acknowledged by + // its peer [V(A)-1 equals the N(S) of the last acknowledged I frame]. + + int vr; // 4.2.4.3. Receive State Variable V(R) + // The receive state variable exists within the TNC. + // It contains the sequence number of the next expected received I frame + // This variable is updated upon the reception of an error-free I frame + // whose send sequence number equals the present received state variable value. + + int layer_3_initiated; // SABM(E) was sent by request of Layer 3; i.e. DL-CONNECT request primitive. + // I think this means that it is set only if we initiated the connection. + // It would not be set if we are in the middle of accepting a connection from the other station. + +// Next 5 are called exception conditions. + + int peer_receiver_busy; // Remote station is busy and can't receive I frames. + + int reject_exception; // A REJ frame has been sent to the remote station. (boolean) + + // This is used only when receiving an I frame, in states 3 & 4, SREJ not enabled. + // When an I frame has an unexpected N(S), + // - if not already set, set it and send REJ. + // When an I frame with expected N(S) is received, clear it. + // This would prevent us from sending additional REJ while + // waiting for result from first one. + // What happens if the REJ gets lost? Is it resent somehow? + + int own_receiver_busy; // Layer 3 is busy and can't receive I frames. + // We have no API to convey this information so it should always be 0. + + int acknowledge_pending; // I frames have been successfully received but not yet + // acknowledged TO the remote station. + // Set when receiving the next expected I frame and P=0. + // This gets cleared by sending any I, RR, RNR, REJ. + // Cleared when sending SREJ with F=1. + +// Timing. + + float srt; // Smoothed roundtrip time in seconds. + // This is used to dynamically adjust t1v. + // Sometimes the flow chart has SAT instead of SRT. + // I think that is a typographical error. + + float t1v; // How long to wait for an acknowledgement before resending. + // Value used when starting timer T1, in seconds. + // "FRACK" parameter in some implementations. + // Typically it might be 3 seconds after frame has been + // sent. Add more for each digipeater in path. + // Here it is dynamically adjusted. + +// Set initial value for T1V. +// Multiply FRACK by 2*m+1, where m is number of digipeaters. + +#define INIT_T1V_SRT \ + S->t1v = g_misc_config_p->frack * (2 * (S->num_addr - 2) + 1); \ + S->srt = S->t1v / 2.0; + + + int radio_channel_busy; // Either due to DCD or PTT. + + +// Timer T1. + +// Timer values all use the usual unix time() value but double precision +// so we can have fractions of seconds. + +// T1 is used for retries along with the retry counter, "rc." +// When timer T1 is started, the value is obtained from t1v plus the current time. + + +// Appropriate functions should be used rather than accessing the values directly. + + + +// This gets a little tricky because we need to pause the timers when the radio +// channel is busy. Suppose we sent an I frame and set T1 to 4 seconds so we could +// take corrective action if there is no response in a reasonable amount of time. +// What if some other station has the channel tied up for 10 seconds? We don't want +// T1 to timeout and start a retry sequence. The solution is to pause the timers while +// the channel is busy. We don't want to get a timer expiry event when t1_exp is in +// the past if it is currently paused. When it is un-paused, the expiration time is adjusted +// for the amount of time it was paused. + + + double t1_exp; // This is the time when T1 will expire or 0 if not running. + + double t1_paused_at; // Time when it was paused or 0 if not paused. + + float t1_remaining_when_last_stopped; // Number of seconds that were left on T1 when it was stopped. + // This is used to fine tune t1v. + // Set to negative initially to mean invalid, don't use in calculation. + + int t1_had_expired; // Set when T1 expires. + // Cleared for start & stop. + + +// Timer T3. + +// T3 is used to terminate connection after extended inactivity. + + +// Similar to T1 except there is not mechanism to capture the remaining time when it is stopped +// and it is not paused when the channel is busy. + + + double t3_exp; // When it expires or 0 if not running. + +#define T3_DEFAULT 300.0 // Copied 5 minutes from Ax.25 for Linux. + // http://www.linux-ax25.org/wiki/Run_time_configurable_parameters + // D710A also defaults to 30*10 = 300 seconds. + // Should it be user-configurable? + // KPC-3+ and TM-D710A have "CHECK" command for this purpose. + +// Statistics for testing purposes. + +// Count how many frames of each type we received. +// This is easy to do because they all come in thru lm_data_indication. +// Counting outgoing could probably be done in lm_data_request so +// it would not have to be scattered all over the place. TBD + + int count_recv_frame_type[frame_not_AX25+1]; + + int peak_rc_value; // Peak value of retry count (rc). + + +// For sending data. + + cdata_t *i_frame_queue; // Connected data from client which has not been transmitted yet. + // Linked list. + // The name is misleading because these are just blocks of + // data, not "I frames" at this point. The name comes from + // the protocol specification. + + cdata_t *txdata_by_ns[128]; // Data which has already been transmitted. + // Indexed by N(S) in case it gets lost and needs to be sent again. + // Cleared out when we get ACK for it. + + int magic3; // Look out for out of bounds for above. +#define MAGIC3 0x03331301 + + cdata_t *rxdata_by_ns[128]; // "Receive buffer" + // Data which has been received out of sequence. + // Indexed by N(S). + + int magic2; // Look out for out of bounds for above. +#define MAGIC2 0x02221201 + + + +// "Management Data Link" (MDL) state machine for XID exchange. + + + enum mdl_state_e { mdl_state_0_ready=0, mdl_state_1_negotiating=1 } mdl_state; + + int mdl_rc; // Retry count, waiting to get XID response. + // The spec has provision for a separate maximum, NM201, but we + // just use the regular N2 same as other retries. + + double tm201_exp; // Timer. Similar to T1. + // The spec mentions a separate timeout value but + // we will just use the same as T1. + + double tm201_paused_at; // Time when it was paused or 0 if not paused. + +// Segment reassembler. + + cdata_t *ra_buff; // Reassembler buffer. NULL when in ready state. + + int ra_following; // Most recent number following to predict next expected. + + +} ax25_dlsm_t; + + +/* + * List of current state machines for each link. + * There is potential many client apps, each with multiple links + * connected all at the same time. + * + * Everything coming thru here should be from a single thread. + * The Data Link Queue should serialize all processing. + * Therefore, we don't have to worry about critical regions. + */ + +static ax25_dlsm_t *list_head = NULL; + + +/* + * Registered callsigns for incoming connections. + */ + +#define RC_MAGIC 0x08291951 + +typedef struct reg_callsign_s { + char callsign[AX25_MAX_ADDR_LEN]; + int chan; + int client; + struct reg_callsign_s *next; + int magic; +} reg_callsign_t; + +static reg_callsign_t *reg_callsign_list = NULL; + + +// Use these, rather than setting variables directly, to make debug out easier. + +#define SET_VS(n) { S->vs = (n); \ + if (s_debug_variables) { \ + text_color_set(DW_COLOR_DEBUG); \ + dw_printf ("V(S) = %d at %s %d\n", S->vs, __func__, __LINE__); \ + } \ + assert (S->vs >= 0 && S->vs < S->modulo); \ + } + +// If other guy acks reception of an I frame, we should never get an REJ or SREJ +// asking for it again. When we update V(A), we should be able to remove the saved +// transmitted data, and everything preceding it, from S->txdata_by_ns[]. + +#define SET_VA(n) { S->va = (n); \ + if (s_debug_variables) { \ + text_color_set(DW_COLOR_DEBUG); \ + dw_printf ("V(A) = %d at %s %d\n", S->va, __func__, __LINE__); \ + } \ + assert (S->va >= 0 && S->va < S->modulo); \ + int x = AX25MODULO(n-1, S->modulo, __FILE__, __func__, __LINE__); \ + while (S->txdata_by_ns[x] != NULL) { \ + cdata_delete (S->txdata_by_ns[x]); \ + S->txdata_by_ns[x] = NULL; \ + x = AX25MODULO(x-1, S->modulo, __FILE__, __func__, __LINE__); \ + } \ + } + +#define SET_VR(n) { S->vr = (n); \ + if (s_debug_variables) { \ + text_color_set(DW_COLOR_DEBUG); \ + dw_printf ("V(R) = %d at %s %d\n", S->vr, __func__, __LINE__); \ + } \ + assert (S->vr >= 0 && S->vr < S->modulo); \ + } + +#define SET_RC(n) { S->rc = (n); \ + if (s_debug_variables) { \ + text_color_set(DW_COLOR_DEBUG); \ + dw_printf ("rc = %d at %s %d, state = %d\n", S->rc, __func__, __LINE__, S->state); \ + } \ + } + + +//TODO: Make this a macro so we can simplify calls yet keep debug output if something goes wrong. + +#if 0 +#define AX25MODULO(n) ax25modulo((n), S->modulo, __FILE__, __func__, __LINE__) +static int ax25modulo(int n, int m, const char *file, const char *func, int line) +#else +static int AX25MODULO(int n, int m, const char *file, const char *func, int line) +#endif +{ + if (m != 8 && m != 128) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("INTERNAL ERROR: %d modulo %d, %s, %s, %d\n", n, m, file, func, line); + m = 8; + } + // Use masking, rather than % operator, so negative numbers are handled properly. + return (n & (m-1)); +} + + +// Test whether we can send more or if we need to wait +// because we have reached 'maxframe' outstanding frames. +// Argument must be 'S'. + +#define WITHIN_WINDOW_SIZE(x) (x->vs != AX25MODULO(x->va + x->k_maxframe, x->modulo, __FILE__, __func__, __LINE__)) + + +// Timer macros to provide debug output with location from where they are called. + +#define START_T1 start_t1(S, __func__, __LINE__) +#define IS_T1_RUNNING is_t1_running(S, __func__, __LINE__) +#define STOP_T1 stop_t1(S, __func__, __LINE__) +#define PAUSE_T1 pause_t1(S, __func__, __LINE__) +#define RESUME_T1 resume_t1(S, __func__, __LINE__) + +#define START_T3 start_t3(S, __func__, __LINE__) +#define STOP_T3 stop_t3(S, __func__, __LINE__) + +#define START_TM201 start_tm201(S, __func__, __LINE__) +#define STOP_TM201 stop_tm201(S, __func__, __LINE__) +#define PAUSE_TM201 pause_tm201(S, __func__, __LINE__) +#define RESUME_TM201 resume_tm201(S, __func__, __LINE__) + +// TODO: add SELECT_T1_VALUE for debugging. + + +static void dl_data_indication (ax25_dlsm_t *S, int pid, char *data, int len); + +static void i_frame (ax25_dlsm_t *S, cmdres_t cr, int p, int nr, int ns, int pid, char *info_ptr, int info_len); +static void i_frame_continued (ax25_dlsm_t *S, int p, int ns, int pid, char *info_ptr, int info_len); +static int is_ns_in_window (ax25_dlsm_t *S, int ns); +static void send_srej_frames (ax25_dlsm_t *S, int *resend, int count, int allow_f1); +static void rr_rnr_frame (ax25_dlsm_t *S, int ready, cmdres_t cr, int pf, int nr); +static void rej_frame (ax25_dlsm_t *S, cmdres_t cr, int pf, int nr); +static void srej_frame (ax25_dlsm_t *S, cmdres_t cr, int pf, int nr, unsigned char *info_ptr, int info_len); + +static void sabm_e_frame (ax25_dlsm_t *S, int extended, int p); +static void disc_frame (ax25_dlsm_t *S, int f); +static void dm_frame (ax25_dlsm_t *S, int f); +static void ua_frame (ax25_dlsm_t *S, int f); +static void frmr_frame (ax25_dlsm_t *S); +static void ui_frame (ax25_dlsm_t *S, cmdres_t cr, int pf); +static void xid_frame (ax25_dlsm_t *S, cmdres_t cr, int pf, unsigned char *info_ptr, int info_len); +static void test_frame (ax25_dlsm_t *S, cmdres_t cr, int pf, unsigned char *info_ptr, int info_len); + +static void t1_expiry (ax25_dlsm_t *S); +static void t3_expiry (ax25_dlsm_t *S); +static void tm201_expiry (ax25_dlsm_t *S); + +static void nr_error_recovery (ax25_dlsm_t *S); +static void clear_exception_conditions (ax25_dlsm_t *S); +static void transmit_enquiry (ax25_dlsm_t *S); +static void select_t1_value (ax25_dlsm_t *S); +static void establish_data_link (ax25_dlsm_t *S); +static void set_version_2_0 (ax25_dlsm_t *S); +static void set_version_2_2 (ax25_dlsm_t *S); +static int is_good_nr (ax25_dlsm_t *S, int nr); +static void i_frame_pop_off_queue (ax25_dlsm_t *S); +static void discard_i_queue (ax25_dlsm_t *S); +static void invoke_retransmission (ax25_dlsm_t *S, int nr_input); +static void check_i_frame_ackd (ax25_dlsm_t *S, int nr); +static void check_need_for_response (ax25_dlsm_t *S, ax25_frame_type_t frame_type, cmdres_t cr, int pf); +static void enquiry_response (ax25_dlsm_t *S, ax25_frame_type_t frame_type, int f); + +static void enter_new_state(ax25_dlsm_t *S, enum dlsm_state_e new_state, const char *from_func, int from_line); + +static void mdl_negotiate_request (ax25_dlsm_t *S); +static void initiate_negotiation (ax25_dlsm_t *S, struct xid_param_s *param); +static void negotiation_response (ax25_dlsm_t *S, struct xid_param_s *param); +static void complete_negotiation (ax25_dlsm_t *S, struct xid_param_s *param); + + +// Use macros above rather than calling these directly. + +static void start_t1 (ax25_dlsm_t *S, const char *from_func, int from_line); +static void stop_t1 (ax25_dlsm_t *S, const char *from_func, int from_line); +static int is_t1_running (ax25_dlsm_t *S, const char *from_func, int from_line); +static void pause_t1 (ax25_dlsm_t *S, const char *from_func, int from_line); +static void resume_t1 (ax25_dlsm_t *S, const char *from_func, int from_line); + +static void start_t3 (ax25_dlsm_t *S, const char *from_func, int from_line); +static void stop_t3 (ax25_dlsm_t *S, const char *from_func, int from_line); + +static void start_tm201 (ax25_dlsm_t *S, const char *from_func, int from_line); +static void stop_tm201 (ax25_dlsm_t *S, const char *from_func, int from_line); +static void pause_tm201 (ax25_dlsm_t *S, const char *from_func, int from_line); +static void resume_tm201 (ax25_dlsm_t *S, const char *from_func, int from_line); + + + +/* + * Configuration settings from file or command line. + */ + +static struct misc_config_s *g_misc_config_p; + + +/*------------------------------------------------------------------- + * + * Name: ax25_link_init + * + * Purpose: Initialize the ax25_link module. + * + * Inputs: pconfig - misc. configuration from config file or command line. + * Beacon stuff ended up here. + * + * Outputs: Remember required information for future use. That's all. + * + *--------------------------------------------------------------------*/ + +void ax25_link_init (struct misc_config_s *pconfig) +{ + +/* + * Save parameters for later use. + */ + g_misc_config_p = pconfig; + +} /* end ax25_link_init */ + + + + +/*------------------------------------------------------------------------------ + * + * Name: get_link_handle + * + * Purpose: Find existing (or possibly create) state machine for a given link. + * It should be possible to have a large number of links active at the + * same time. They are uniquely identified by + * (owncall, peercall, client id, radio channel) + * Note that we could have multiple client applications, all sharing one + * TNC, on the same or different radio channels, completely unware of each other. + * + * Inputs: addrs - Owncall, peercall, and optional digipeaters. + * For ease of passing this around, it is an array in the + * same order as in the frame. + * + * num_addr - Number of addresses, 2 thru 10. + * + * chan - Radio channel number. + * + * client - Client app number. + * We allow multiple concurrent applications with the + * AGW network protocol. These are identified as 0, 1, ... + * We don't know this for an incoming frame from the radio + * so it is -1 at this point. At a later time will will + * associate the stream with the right client. + * + * create - True if OK to create a new one. + * Otherwise, return only one already existing. + * + * This should always be true for outgoing frames. + * For incoming frames this would be true only for SABM(e) + * with all digipeater fields marked as used. + * + * Here, we will also check to see if it is in our + * registered callsign list. + * + * Returns: Handle for data link state machine. + * NULL if not found and 'create' is false. + * + * Description: Try to find an existing entry matching owncall, peercall, channel, + * and client. If not found create a new one. + * + *------------------------------------------------------------------------------*/ + +static int next_stream_id = 0; + +static ax25_dlsm_t *get_link_handle (char addrs[AX25_MAX_ADDRS][AX25_MAX_ADDR_LEN], int num_addr, int chan, int client, int create) +{ + + ax25_dlsm_t *p; + + + if (s_debug_link_handle) { + text_color_set(DW_COLOR_DECODED); + dw_printf ("get_link_handle (%s>%s, chan=%d, client=%d, create=%d)\n", + addrs[AX25_SOURCE], addrs[AX25_DESTINATION], chan, client, create); + } + + +// Look for existing. + + if (client == -1) { // from the radio. + // address order is reversed for compare. + for (p = list_head; p != NULL; p = p->next) { + + if (p->chan == chan && + strcmp(addrs[AX25_DESTINATION], p->addrs[OWNCALL]) == 0 && + strcmp(addrs[AX25_SOURCE], p->addrs[PEERCALL]) == 0) { + + if (s_debug_link_handle) { + text_color_set(DW_COLOR_DECODED); + dw_printf ("get_link_handle returns existing stream id %d for incoming.\n", p->stream_id); + } + return (p); + } + } + } + else { // from client app + for (p = list_head; p != NULL; p = p->next) { + + if (p->chan == chan && + p->client == client && + strcmp(addrs[AX25_SOURCE], p->addrs[OWNCALL]) == 0 && + strcmp(addrs[AX25_DESTINATION], p->addrs[PEERCALL]) == 0) { + + if (s_debug_link_handle) { + text_color_set(DW_COLOR_DECODED); + dw_printf ("get_link_handle returns existing stream id %d for outgoing.\n", p->stream_id); + } + return (p); + } + } + } + + +// Could not find existing. Should we create a new one? + + if ( ! create) { + if (s_debug_link_handle) { + text_color_set(DW_COLOR_DECODED); + dw_printf ("get_link_handle: Search failed. Do not create new.\n"); + } + return (NULL); + } + + +// If it came from the radio, search for destination our registered callsign list. + + int incoming_for_client = -1; // which client app registered the callsign? + + + if (client == -1) { // from the radio. + + reg_callsign_t *r, *found; + + found = NULL; + for (r = reg_callsign_list; r != NULL && found == NULL; r = r->next) { + + if (strcmp(addrs[AX25_DESTINATION], r->callsign) == 0 && chan == r->chan) { + found = r; + incoming_for_client = r->client; + } + } + + if (found == NULL) { + if (s_debug_link_handle) { + text_color_set(DW_COLOR_DECODED); + dw_printf ("get_link_handle: not for me. Ignore it.\n"); + } + return (NULL); + } + } + +// Create new data link state machine. + + p = calloc (sizeof(ax25_dlsm_t), 1); + if (p == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("FATAL ERROR: Out of memory.\n"); + exit (EXIT_FAILURE); + } + p->magic1 = MAGIC1; + p->start_time = dtime_now(); + p->stream_id = next_stream_id++; + p->modulo = 8; + + p->chan = chan; + p->num_addr = num_addr; + +// If it came in over the radio, we need to swap source/destination and reverse any digi path. + + if (incoming_for_client >= 0) { + strlcpy (p->addrs[AX25_SOURCE], addrs[AX25_DESTINATION], sizeof(p->addrs[AX25_SOURCE])); + strlcpy (p->addrs[AX25_DESTINATION], addrs[AX25_SOURCE], sizeof(p->addrs[AX25_DESTINATION])); + + int j = AX25_REPEATER_1; + int k = num_addr - 1; + while (k >= AX25_REPEATER_1) { + strlcpy (p->addrs[j], addrs[k], sizeof(p->addrs[j])); + j++; + k--; + } + + p->client = incoming_for_client; + } + else { + memcpy (p->addrs, addrs, sizeof(p->addrs)); + p->client = client; + } + + p->state = state_0_disconnected; + p->t1_remaining_when_last_stopped = -999; // Invalid, don't use. + + p->magic2 = MAGIC2; + p->magic3 = MAGIC3; + + // No need for critical region because this should all be in one thread. + p->next = list_head; + list_head = p; + + if (s_debug_link_handle) { + text_color_set(DW_COLOR_DECODED); + dw_printf ("get_link_handle returns NEW stream id %d\n", p->stream_id); + } + + return (p); +} + + + + + + +//################################################################################### +//################################################################################### +// +// Data Link state machine for sending data in connected mode. +// +// Incoming: +// +// Requests from the client application. Set s_debug_client_app for debugging. +// +// dl_connect_request +// dl_disconnect_request +// dl_outstanding_frames_request - (mine) Ask about outgoing queue for a link. +// dl_data_request - send connected data +// dl_unit_data_request - not implemented. APRS & KISS bypass this +// dl_flow_off - not implemented. Not in AGW API. +// dl_flow_on - not implemented. Not in AGW API. +// dl_register_callsign - Register callsigns(s) for incoming connection requests. +// dl_unregister_callsign - Unregister callsigns(s) ... +// dl_client_cleanup - Clean up after client which has disappeared. +// +// Stuff from the radio channel. Set s_debug_radio for debugging. +// +// lm_data_indication - Received frame. +// lm_channel_busy - Change in PTT or DCD. +// lm_seize_confirm - We have started to transmit. +// +// Timer expiration. Set s_debug_timers for debugging. +// +// dl_timer_expiry +// +// Outgoing: +// +// To the client application: +// +// dl_data_indication - received connected data. +// +// To the transmitter: +// +// lm_data_request - Queue up a frame for transmission. +// +// lm_seize_request - Start transmitter when possible. +// lm_seize_confirm will be called when it has. +// +// +// It is important that all requests come thru the data link queue so +// everything is serialized. +// We don't have to worry about being reentrant or critical regions. +// Nothing here should consume a significant amount of time. +// i.e. There should be no sleep delay or anything that would block waiting on someone else. +// +//################################################################################### +//################################################################################### + + + +/*------------------------------------------------------------------------------ + * + * Name: dl_connect_request + * + * Purpose: Client app wants to connect to another station. + * + * Inputs: E - Event from the queue. + * The caller will free it. + * + * Description: + * + *------------------------------------------------------------------------------*/ + +void dl_connect_request (dlq_item_t *E) +{ + ax25_dlsm_t *S; + int ok_to_create = 1; + int old_version; + int n; + + if (s_debug_client_app) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("dl_connect_request ()\n"); + } + + text_color_set(DW_COLOR_INFO); + dw_printf ("Attempting connect to %s ...\n", E->addrs[PEERCALL]); + + S = get_link_handle (E->addrs, E->num_addr, E->chan, E->client, ok_to_create); + + switch (S->state) { + + case state_0_disconnected: + + INIT_T1V_SRT; + +// See if destination station is in list for v2.0 only. + + old_version = 0; + for (n = 0; n < g_misc_config_p->v20_count && ! old_version; n++) { + if (strcmp(E->addrs[AX25_DESTINATION],g_misc_config_p->v20_addrs[n]) == 0) { + old_version = 1; + } + } + + if (old_version || g_misc_config_p->maxv22 == 0) { // Don't attempt v2.2. + + set_version_2_0 (S); + + establish_data_link (S); + S->layer_3_initiated = 1; + enter_new_state (S, state_1_awaiting_connection, __func__, __LINE__); + } + else { // Try v2.2 first, then fall back if appropriate. + + set_version_2_2 (S); + + establish_data_link (S); + S->layer_3_initiated = 1; + enter_new_state (S, state_5_awaiting_v22_connection, __func__, __LINE__); + } + break; + + case state_1_awaiting_connection: + case state_5_awaiting_v22_connection: + + discard_i_queue(S); + S->layer_3_initiated = 1; + // Keep current state. + break; + + case state_2_awaiting_release: + + // Keep current state. + break; + + case state_3_connected: + case state_4_timer_recovery: + + discard_i_queue(S); + establish_data_link(S); + S->layer_3_initiated = 1; + // My enhancement. Original always sent SABM and went to state 1. + // If we were using v2.2, why not reestablish with that? + enter_new_state (S, S->modulo == 128 ? state_5_awaiting_v22_connection : state_1_awaiting_connection, __func__, __LINE__); + break; + } + +} /* end dl_connect_request */ + + +/*------------------------------------------------------------------------------ + * + * Name: dl_disconnect_request + * + * Purpose: Client app wants to terminate connection with another station. + * + * Inputs: E - Event from the queue. + * The caller will free it. + * + * Outputs: + * + * Description: + * + *------------------------------------------------------------------------------*/ + +void dl_disconnect_request (dlq_item_t *E) +{ + ax25_dlsm_t *S; + int ok_to_create = 1; + + + if (s_debug_client_app) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("dl_disconnect_request ()\n"); + } + + text_color_set(DW_COLOR_INFO); + dw_printf ("Disconnect from %s ...\n", E->addrs[PEERCALL]); + + S = get_link_handle (E->addrs, E->num_addr, E->chan, E->client, ok_to_create); + + switch (S->state) { + + case state_0_disconnected: + + // DL-DISCONNECT *confirm* + text_color_set(DW_COLOR_INFO); + dw_printf ("Stream %d: Disconnected from %s.\n", S->stream_id, S->addrs[PEERCALL]); + server_link_terminated (S->chan, S->client, S->addrs[PEERCALL], S->addrs[OWNCALL], 0); + break; + + case state_1_awaiting_connection: + case state_5_awaiting_v22_connection: + +// Erratum: The protocol spec says "requeue." If we put disconnect req back in the +// queue we will probably get it back again here while still in same state. +// I don't think we would want to delay it until the next state transition. + +// Suppose someone tried to connect to another station, which is not responding, and decided to cancel +// before all of the SABMe retries were used up. I think we would want to transmit a DISC, send a disc +// notice to the user, and go directly into disconnected state, rather than into awaiting release. + +// New code v1.7 dev, May 6 2023 + + text_color_set(DW_COLOR_INFO); + dw_printf ("Stream %d: In progress connection attempt to %s terminated by user.\n", S->stream_id, S->addrs[PEERCALL]); + discard_i_queue (S); + SET_RC(0); + int p1 = 1; + int nopid0 = 0; + packet_t pp15 = ax25_u_frame (S->addrs, S->num_addr, cr_cmd, frame_type_U_DISC, p1, nopid0, NULL, 0); + lm_data_request (S->chan, TQ_PRIO_1_LO, pp15); + + STOP_T1; // started in establish_data_link. + STOP_T3; // probably don't need. + enter_new_state (S, state_0_disconnected, __func__, __LINE__); + server_link_terminated (S->chan, S->client, S->addrs[PEERCALL], S->addrs[OWNCALL], 0); + break; + + case state_2_awaiting_release: + { + // We have previously started the disconnect sequence and are waiting + // for a UA from the other guy. Meanwhile, the application got + // impatient and sent us another disconnect request. What should + // we do? Ignore it and let the disconnect sequence run its + // course? Or should we complete the sequence without waiting + // for the other guy to ack? + + // Erratum. Flow chart simply says "DM (expedited)." + // This is the only place we have expedited. Is this correct? + + cmdres_t cr = cr_res; // DM can only be response. + int p = 0; + int nopid = 0; // PID applies only to I and UI frames. + + packet_t pp = ax25_u_frame (S->addrs, S->num_addr, cr, frame_type_U_DM, p, nopid, NULL, 0); + lm_data_request (S->chan, TQ_PRIO_0_HI, pp); // HI means expedited. + + // Erratum: Shouldn't we inform the user when going to disconnected state? + // Notifying the application, here, is my own enhancement. + + text_color_set(DW_COLOR_INFO); + dw_printf ("Stream %d: Disconnected from %s.\n", S->stream_id, S->addrs[PEERCALL]); + server_link_terminated (S->chan, S->client, S->addrs[PEERCALL], S->addrs[OWNCALL], 0); + + STOP_T1; + enter_new_state (S, state_0_disconnected, __func__, __LINE__); + } + break; + + case state_3_connected: + case state_4_timer_recovery: + + discard_i_queue (S); + SET_RC(0); // I think this should be 1 but I'm not that worried about it. + + cmdres_t cmd = cr_cmd; + int p = 1; + int nopid = 0; + + packet_t pp = ax25_u_frame (S->addrs, S->num_addr, cmd, frame_type_U_DISC, p, nopid, NULL, 0); + lm_data_request (S->chan, TQ_PRIO_1_LO, pp); + + STOP_T3; + START_T1; + enter_new_state (S, state_2_awaiting_release, __func__, __LINE__); + + break; + } + +} /* end dl_disconnect_request */ + + +/*------------------------------------------------------------------------------ + * + * Name: dl_data_request + * + * Purpose: Client app wants to send data to another station. + * + * Inputs: E - Event from the queue. + * The caller will free it. + * + * Description: Append the transmit data block to the I frame queue for later processing. + * + * We also perform the segmentation handling here. + * + * C6.1 Segmenter State Machine + * Only the following DL primitives will be candidates for modification by the segmented + * state machine: + + * * DL-DATA Request. The user employs this primitive to provide information to be + * transmitted using connection-oriented procedures; i.e., using I frames. The + * segmenter state machine examines the quantity of data to be transmitted. If the + * quantity of data to be transmitted is less than or equal to the data link parameter + * N1, the segmenter state machine passes the primitive through transparently. If the + * quantity of data to be transmitted exceeds the data link parameter N1, the + * segmenter chops up the data into segments of length N1-2 octets. Each segment is + * prepended with a two octet header. (See Figures 3.1 and 3.2.) The segments are + * then turned over to the Data-link State Machine for transmission, using multiple DL + * Data Request primitives. All segments are turned over immediately; therefore the + * Data-link State Machine will transmit them consecutively on the data link. + * + * Erratum: Not sure how to interpret that. See example below for how it was implemented. + * + * Version 1.6: Bug 252. Segmentation was occurring for a V2.0 link. From the spec: + * "The receipt of an XID response from the other station establishes that both + * stations are using AX.25 version 2.2 or higher and enables the use of the + * segmenter/reassembler and selective reject." + * "The segmenter/reassembler procedure is only enabled if both stations on the + * link are using AX.25 version 2.2 or higher." + * + * The Segmenter Ready State SDL has no decision based on protocol version. + * + *------------------------------------------------------------------------------*/ + +static void data_request_good_size (ax25_dlsm_t *S, cdata_t *txdata); + + +void dl_data_request (dlq_item_t *E) +{ + ax25_dlsm_t *S; + int ok_to_create = 1; + + + S = get_link_handle (E->addrs, E->num_addr, E->chan, E->client, ok_to_create); + + if (s_debug_client_app) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("dl_data_request (\""); + ax25_safe_print (E->txdata->data, E->txdata->len, 1); + dw_printf ("\") state=%d\n", S->state); + } + + if (E->txdata->len <= S->n1_paclen) { + data_request_good_size (S, E->txdata); + E->txdata = NULL; // Now part of transmit I frame queue. + return; + } + +#define DIVROUNDUP(a,b) (((a)+(b)-1) / (b)) + +// Erratum: Don't do V2.2 segmentation for a V2.0 link. +// In this case, we can just split it into multiple frames not exceeding the specified max size. +// Hopefully the receiving end treats it like a stream and doesn't care about length of each frame. + + if (S->modulo == 8) { + + int num_frames = 0; + int remaining_len = E->txdata->len; + int offset = 0; + + while (remaining_len > 0) { + int this_len = MIN(remaining_len, S->n1_paclen); + + cdata_t *new_txdata = cdata_new(E->txdata->pid, E->txdata->data + offset, this_len); + data_request_good_size (S, new_txdata); + + offset += this_len; + remaining_len -= this_len; + num_frames++; + } + + if (num_frames != DIVROUNDUP(E->txdata->len, S->n1_paclen) || remaining_len != 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("INTERNAL ERROR, Segmentation line %d, data length = %d, N1 = %d, num frames = %d, remaining len = %d\n", + __LINE__, E->txdata->len, S->n1_paclen, num_frames, remaining_len); + } + cdata_delete (E->txdata); + E->txdata = NULL; + return; + } + +// More interesting case. +// It is too large to fit in one frame so we segment it. + +// As an example, suppose we had 6 bytes of data "ABCDEF". + +// If N1 >= 6, it would be sent normally. + +// (addresses) +// (control bytes) +// PID, typically 0xF0 +// 'A' - first byte of information field +// 'B' +// 'C' +// 'D' +// 'E' +// 'F' + +// Now consider the case where it would not fit. +// We would change the PID to 0x08 meaning a segment. +// The information part is the segment identifier of this format: +// +// x xxxxxxx +// | ---+--- +// | | +// | +- Number of additional segments to follow. +// | +// +- '1' means it is the first segment. + +// If N1 = 4, it would be split up like this: + +// (addresses) +// (control bytes) +// PID = 0x08 means segment +// 0x82 - Start of info field. +// MSB set indicates FIRST segment. +// 2, in lower 7 bits, means 2 more segments to follow. +// 0xF0 - original PID, typical value. +// 'A' - For the FIRST segment, we have PID and N1-2 data bytes. +// 'B' + +// (addresses) +// (control bytes) +// PID = 0x08 means segment +// 0x01 - Means 1 more segment follows. +// 'C' - For subsequent (not first) segments, we have up to N1-1 data bytes. +// 'D' +// 'E' + +// (addresses) +// (control bytes) +// PID = 0x08 +// 0x00 - 0 means no more to follow. i.e. This is the last. +// 'E' + + +// Number of segments is ceiling( (datalen + 1 ) / (N1 - 1)) + +// we add one to datalen for the original PID. +// We subtract one from N1 for the segment identifier header. + +#define DIVROUNDUP(a,b) (((a)+(b)-1) / (b)) + +// Compute number of segments. +// We will decrement this before putting it in the frame so the first +// will have one less than this number. + + int nseg_to_follow = DIVROUNDUP(E->txdata->len + 1, S->n1_paclen - 1); + + if (nseg_to_follow < 2 || nseg_to_follow > 128) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("INTERNAL ERROR, Segmentation line %d, data length = %d, N1 = %d, number of segments = %d\n", + __LINE__, E->txdata->len, S->n1_paclen, nseg_to_follow); + cdata_delete (E->txdata); + E->txdata = NULL; + return; + } + + int orig_offset = 0; + int remaining_len = E->txdata->len; + +// First segment. + + int seglen; + struct { + char header; // 0x80 + number of segments to follow. + char original_pid; + char segdata[AX25_N1_PACLEN_MAX]; + } first_segment; + cdata_t *new_txdata; + + nseg_to_follow--; + + first_segment.header = 0x80 | nseg_to_follow; + first_segment.original_pid = E->txdata->pid; + seglen = MIN(S->n1_paclen - 2, remaining_len); + + if (seglen < 1 || seglen > S->n1_paclen - 2 || seglen > remaining_len || seglen > (int)(sizeof(first_segment.segdata))) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("INTERNAL ERROR, Segmentation line %d, data length = %d, N1 = %d, segment length = %d, number to follow = %d\n", + __LINE__, E->txdata->len, S->n1_paclen, seglen, nseg_to_follow); + cdata_delete (E->txdata); + E->txdata = NULL; + return; + } + + memcpy (first_segment.segdata, E->txdata->data + orig_offset, seglen); + + new_txdata = cdata_new(AX25_PID_SEGMENTATION_FRAGMENT, (char*)(&first_segment), seglen+2); + + data_request_good_size (S, new_txdata); + + orig_offset += seglen; + remaining_len -= seglen; + + +// Subsequent segments. + + do { + struct { + char header; // Number of segments to follow. + char segdata[AX25_N1_PACLEN_MAX]; + } subsequent_segment; + + nseg_to_follow--; + + subsequent_segment.header = nseg_to_follow; + seglen = MIN(S->n1_paclen - 1, remaining_len); + + if (seglen < 1 || seglen > S->n1_paclen - 1 || seglen > remaining_len || seglen > (int)(sizeof(subsequent_segment.segdata))) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("INTERNAL ERROR, Segmentation line %d, data length = %d, N1 = %d, segment length = %d, number to follow = %d\n", + __LINE__, E->txdata->len, S->n1_paclen, seglen, nseg_to_follow); + cdata_delete (E->txdata); + E->txdata = NULL; + return; + } + + memcpy (subsequent_segment.segdata, E->txdata->data + orig_offset, seglen); + + new_txdata = cdata_new(AX25_PID_SEGMENTATION_FRAGMENT, (char*)(&subsequent_segment), seglen+1); + + data_request_good_size (S, new_txdata); + + orig_offset += seglen; + remaining_len -= seglen; + + } while (nseg_to_follow > 0); + + if (remaining_len != 0 || orig_offset != E->txdata->len) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("INTERNAL ERROR, Segmentation line %d, data length = %d, N1 = %d, remaining length = %d (not 0), orig offset = %d (not %d)\n", + __LINE__, E->txdata->len, S->n1_paclen, remaining_len, orig_offset, E->txdata->len); + } + + cdata_delete (E->txdata); + E->txdata = NULL; + +} /* end dl_data_request */ + + +static void data_request_good_size (ax25_dlsm_t *S, cdata_t *txdata) +{ + switch (S->state) { + + case state_0_disconnected: + case state_2_awaiting_release: +/* + * Discard it. + */ + cdata_delete (txdata); + break; + + case state_1_awaiting_connection: + case state_5_awaiting_v22_connection: +/* + * Erratum? + * The flow chart shows "push on I frame queue" if layer 3 initiated + * is NOT set. This seems backwards but I don't understand enough yet + * to make a compelling argument that it is wrong. + * Implemented as in flow chart. + * TODO: Get better understanding of what'layer_3_initiated' means. + */ + if (S->layer_3_initiated) { + cdata_delete (txdata); + break; + } + // otherwise fall thru. + + case state_3_connected: + case state_4_timer_recovery: +/* + * "push on I frame queue" + * Append to the end would have been a better description because push implies a stack. + */ + + if (S->i_frame_queue == NULL) { + txdata->next = NULL; + S->i_frame_queue = txdata; + } + else { + cdata_t *plast = S->i_frame_queue; + while (plast->next != NULL) { + plast = plast->next; + } + txdata->next = NULL; + plast->next = txdata; + } + break; + } + + // v1.5 change in strategy. + // New I frames, not sent yet, are delayed until after processing anything in the received transmission. + // Give the transmit process a kick unless other side is busy or we have reached our window size. + // Previously we had i_frame_pop_off_queue here which would start sending new stuff before we + // finished dealing with stuff already in progress. + + switch (S->state) { + + case state_3_connected: + case state_4_timer_recovery: + + if ( ( ! S->peer_receiver_busy ) && + WITHIN_WINDOW_SIZE(S) ) { + S->acknowledge_pending = 1; + lm_seize_request (S->chan); + } + break; + + default: + break; + } + +} /* end data_request_good_size */ + + +/*------------------------------------------------------------------------------ + * + * Name: dl_register_callsign + * dl_unregister_callsign + * + * Purpose: Register / Unregister callsigns that we will accept connections for. + * + * Inputs: E - Event from the queue. + * The caller will free it. + * + * Outputs: New item is pushed on the head of the reg_callsign_list. + * We don't bother checking for duplicates so the most recent wins. + * + * Description: The data link state machine does not use MYCALL from the APRS configuration. + * For outgoing frames, the client supplies the source callsign. + * For incoming connection requests, we need to know what address(es) to respond to. + * + * Note that one client application can register multiple callsigns for + * multiple channels. + * Different clients can register different different addresses on the same channel. + * + *------------------------------------------------------------------------------*/ + +void dl_register_callsign (dlq_item_t *E) +{ + reg_callsign_t *r; + + if (s_debug_client_app) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("dl_register_callsign (%s, chan=%d, client=%d)\n", E->addrs[0], E->chan, E->client); + } + + r = calloc(sizeof(reg_callsign_t),1); + if (r == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("FATAL ERROR: Out of memory.\n"); + exit (EXIT_FAILURE); + } + strlcpy (r->callsign, E->addrs[0], sizeof(r->callsign)); + r->chan = E->chan; + r->client = E->client; + r->next = reg_callsign_list; + r->magic = RC_MAGIC; + + reg_callsign_list = r; + +} /* end dl_register_callsign */ + + +void dl_unregister_callsign (dlq_item_t *E) +{ + reg_callsign_t *r, *prev; + + if (s_debug_client_app) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("dl_unregister_callsign (%s, chan=%d, client=%d)\n", E->addrs[0], E->chan, E->client); + } + + prev = NULL; + r = reg_callsign_list; + while (r != NULL) { + + assert (r->magic == RC_MAGIC); + + if (strcmp(r->callsign,E->addrs[0]) == 0 && r->chan == E->chan && r->client == E->client) { + + if (r == reg_callsign_list) { + + reg_callsign_list = r->next; + memset (r, 0, sizeof(reg_callsign_t)); + free (r); + r = reg_callsign_list; + } + else { + + prev->next = r->next; + memset (r, 0, sizeof(reg_callsign_t)); + free (r); + r = prev->next; + } + } + else { + prev = r; + r = r->next; + } + } + +} /* end dl_unregister_callsign */ + + + +/*------------------------------------------------------------------------------ + * + * Name: dl_outstanding_frames_request + * + * Purpose: Client app wants to know how many frames are still on their way + * to other station. This is handy for flow control. We would like + * to keep the pipeline filled sufficiently to take advantage of a + * large window size (MAXFRAMES). It is also good to know that the + * the last packet sent was actually received before we commence + * the disconnect. + * + * Inputs: E - Event from the queue. + * The caller will free it. + * + * Outputs: This gets back to the AGW server which sends the 'Y' reply. + * + * Description: This is the sum of: + * - Incoming connected data, from application still in the queue. + * - I frames which have been transmitted but not yet acknowledged. + * + * Confusion: https://github.com/wb2osz/direwolf/issues/427 + * + * There are different, inconsistent versions of the protocol spec. + * + * One of them simply has: + * + * CallFrom is our call + * CallTo is the call of the other station + * + * A more detailed version has the same thing in the table of fields: + * + * CallFrom 10 bytes Our CallSign + * CallTo 10 bytes Other CallSign + * + * (My first implementation went with that.) + * + * HOWEVER, shortly after that, is contradictory information: + * + * Careful must be exercised to fill correctly both the CallFrom + * and CallTo fields to match the ones of an existing connection, + * otherwise AGWPE won’t return any information at all from this query. + * + * The order of the CallFrom and CallTo is not trivial, it should + * reflect the order used to start the connection, so + * + * * If we started the connection CallFrom=US and CallTo=THEM + * * If the other end started the connection CallFrom=THEM and CallTo=US + * + * This seems to make everything unnecessarily more complicated. + * We should only care about the stream going from the local station to the + * remote station. Why would it matter who reqested the link? The state + * machine doesn't even contain this information so the TNC doesn't know. + * The client app interface needs to behave differently for the two cases. + * + * The new code, below, May 2023, should handle both of those cases. + * + *------------------------------------------------------------------------------*/ + +void dl_outstanding_frames_request (dlq_item_t *E) +{ + ax25_dlsm_t *S; + const int ok_to_create = 0; // must exist already. + int reversed_addrs = 0; + + if (s_debug_client_app) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("dl_outstanding_frames_request ( to %s )\n", E->addrs[PEERCALL]); + } + + S = get_link_handle (E->addrs, E->num_addr, E->chan, E->client, ok_to_create); + if (S != NULL) { + reversed_addrs = 0; + } + else { + // Try swapping the addresses. + // this is communicating with the client app, not over the air, + // so we don't need to worry about digipeaters. + + char swapped[AX25_MAX_ADDRS][AX25_MAX_ADDR_LEN]; + memset (swapped, 0, sizeof(swapped)); + strlcpy (swapped[PEERCALL], E->addrs[OWNCALL], sizeof(swapped[PEERCALL])); + strlcpy (swapped[OWNCALL], E->addrs[PEERCALL], sizeof(swapped[OWNCALL])); + S = get_link_handle (swapped, E->num_addr, E->chan, E->client, ok_to_create); + if (S != NULL) { + reversed_addrs = 1; + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Can't get outstanding frames for %s -> %s, chan %d\n", E->addrs[OWNCALL], E->addrs[PEERCALL], E->chan); + server_outstanding_frames_reply (E->chan, E->client, E->addrs[OWNCALL], E->addrs[PEERCALL], 0); + return; + } + } + +// Add up these +// +// cdata_t *i_frame_queue; // Connected data from client which has not been transmitted yet. +// // Linked list. +// // The name is misleading because these are just blocks of +// // data, not "I frames" at this point. The name comes from +// // the protocol specification. +// +// cdata_t *txdata_by_ns[128]; // Data which has already been transmitted. +// // Indexed by N(S) in case it gets lost and needs to be sent again. +// // Cleared out when we get ACK for it. + + int count1 = 0; + cdata_t *incoming; + for (incoming = S->i_frame_queue; incoming != NULL; incoming = incoming->next) { + count1++; + } + + int count2 = 0; + int k; + for (k = 0; k < S->modulo; k++) { + if (S->txdata_by_ns[k] != NULL) { + count2++; + } + } + + if (reversed_addrs) { + // Other end initiated the link. + server_outstanding_frames_reply (S->chan, S->client, S->addrs[PEERCALL], S->addrs[OWNCALL], count1 + count2); + } + else { + server_outstanding_frames_reply (S->chan, S->client, S->addrs[OWNCALL], S->addrs[PEERCALL], count1 + count2); + } + +} // end dl_outstanding_frames_request + + + +/*------------------------------------------------------------------------------ + * + * Name: dl_client_cleanup + * + * Purpose: Client app has gone away. Clean up any data associated with it. + * + * Inputs: E - Event from the queue. + * The caller will free it. + * + + * Description: By client application we mean something that attached with the + * AGW network protocol. + * + * Clean out anything related to the specified client application. + * This would include state machines and registered callsigns. + * + *------------------------------------------------------------------------------*/ + +void dl_client_cleanup (dlq_item_t *E) +{ + ax25_dlsm_t *S; + ax25_dlsm_t *dlprev; + reg_callsign_t *r, *rcprev; + + + if (s_debug_client_app) { + text_color_set(DW_COLOR_INFO); + dw_printf ("dl_client_cleanup (%d)\n", E->client); + } + + + dlprev = NULL; + S = list_head; + while (S != NULL) { + + // Look for corruption or double freeing. + + assert (S->magic1 == MAGIC1); + assert (S->magic2 == MAGIC2); + assert (S->magic3 == MAGIC3); + + if (S->client == E->client ) { + + int n; + + if (s_debug_stats) { + text_color_set(DW_COLOR_INFO); + dw_printf ("%d I frames received\n", S->count_recv_frame_type[frame_type_I]); + + dw_printf ("%d RR frames received\n", S->count_recv_frame_type[frame_type_S_RR]); + dw_printf ("%d RNR frames received\n", S->count_recv_frame_type[frame_type_S_RNR]); + dw_printf ("%d REJ frames received\n", S->count_recv_frame_type[frame_type_S_REJ]); + dw_printf ("%d SREJ frames received\n", S->count_recv_frame_type[frame_type_S_SREJ]); + + dw_printf ("%d SABME frames received\n", S->count_recv_frame_type[frame_type_U_SABME]); + dw_printf ("%d SABM frames received\n", S->count_recv_frame_type[frame_type_U_SABM]); + dw_printf ("%d DISC frames received\n", S->count_recv_frame_type[frame_type_U_DISC]); + dw_printf ("%d DM frames received\n", S->count_recv_frame_type[frame_type_U_DM]); + dw_printf ("%d UA frames received\n", S->count_recv_frame_type[frame_type_U_UA]); + dw_printf ("%d FRMR frames received\n", S->count_recv_frame_type[frame_type_U_FRMR]); + dw_printf ("%d UI frames received\n", S->count_recv_frame_type[frame_type_U_UI]); + dw_printf ("%d XID frames received\n", S->count_recv_frame_type[frame_type_U_XID]); + dw_printf ("%d TEST frames received\n", S->count_recv_frame_type[frame_type_U_TEST]); + + dw_printf ("%d peak retry count\n", S->peak_rc_value); + } + + if (s_debug_client_app) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("dl_client_cleanup: remove %s>%s\n", S->addrs[AX25_SOURCE], S->addrs[AX25_DESTINATION]); + } + + discard_i_queue (S); + + for (n = 0; n < 128; n++) { + if (S->txdata_by_ns[n] != NULL) { + cdata_delete (S->txdata_by_ns[n]); + S->txdata_by_ns[n] = NULL; + } + } + + for (n = 0; n < 128; n++) { + if (S->rxdata_by_ns[n] != NULL) { + cdata_delete (S->rxdata_by_ns[n]); + S->rxdata_by_ns[n] = NULL; + } + } + + if (S->ra_buff != NULL) { + cdata_delete (S->ra_buff); + S->ra_buff = NULL; + } + + // Put into disconnected state. + // If "connected" indicator (e.g. LED) was on, this will turn it off. + + enter_new_state (S, state_0_disconnected, __func__, __LINE__); + + // Take S out of list. + + S->magic1 = 0; + S->magic2 = 0; + S->magic3 = 0; + + if (S == list_head) { // first one on list. + + list_head = S->next; + free (S); + S = list_head; + } + else { // not the first one. + dlprev->next = S->next; + free (S); + S = dlprev->next; + } + } + else { + dlprev = S; + S = S->next; + } + } + +/* + * If there are no link state machines (streams) remaining, there should be no txdata items still allocated. + */ + if (list_head == NULL) { + cdata_check_leak(); + } + +/* + * Remove registered callsigns for this client. + */ + + rcprev = NULL; + r = reg_callsign_list; + while (r != NULL) { + + assert (r->magic == RC_MAGIC); + + if (r->client == E->client) { + + if (r == reg_callsign_list) { + + reg_callsign_list = r->next; + memset (r, 0, sizeof(reg_callsign_t)); + free (r); + r = reg_callsign_list; + } + else { + + rcprev->next = r->next; + memset (r, 0, sizeof(reg_callsign_t)); + free (r); + r = rcprev->next; + } + } + else { + rcprev = r; + r = r->next; + } + } + +} /* end dl_client_cleanup */ + + + +/*------------------------------------------------------------------------------ + * + * Name: dl_data_indication + * + * Purpose: send connected data to client application. + * + * Inputs: pid - Protocol ID. + * + * data - Pointer to array of bytes. + * + * len - Number of bytes in data. + * + * + * Description: TODO: We perform reassembly of segments here if necessary. + * + *------------------------------------------------------------------------------*/ + +static void dl_data_indication (ax25_dlsm_t *S, int pid, char *data, int len) +{ + + + +// Now it gets more interesting. We need to combine segments before passing it along. + +// See example in dl_data_request. + + if (S->ra_buff == NULL) { + +// Ready state. + + if (pid != AX25_PID_SEGMENTATION_FRAGMENT) { + server_rec_conn_data (S->chan, S->client, S->addrs[PEERCALL], S->addrs[OWNCALL], pid, data, len); + return; + } + else if (data[0] & 0x80) { + +// Ready state, First segment. + + S->ra_following = data[0] & 0x7f; + int total = (S->ra_following + 1) * (len - 1) - 1; // len should be other side's N1 + S->ra_buff = cdata_new(data[1], NULL, total); + S->ra_buff->size = total; // max that we are expecting. + S->ra_buff->len = len - 2; // how much accumulated so far. + memcpy (S->ra_buff->data, data + 2, len - 2); + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Stream %d: AX.25 Reassembler Protocol Error Z: Not first segment in ready state.\n", S->stream_id); + } + } + else { + +// Reassembling data state + + if (pid != AX25_PID_SEGMENTATION_FRAGMENT) { + + server_rec_conn_data (S->chan, S->client, S->addrs[PEERCALL], S->addrs[OWNCALL], pid, data, len); + + text_color_set(DW_COLOR_ERROR); + dw_printf ("Stream %d: AX.25 Reassembler Protocol Error Z: Not segment in reassembling state.\n", S->stream_id); + cdata_delete(S->ra_buff); + S->ra_buff = NULL; + return; + } + else if (data[0] & 0x80) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Stream %d: AX.25 Reassembler Protocol Error Z: First segment in reassembling state.\n", S->stream_id); + cdata_delete(S->ra_buff); + S->ra_buff = NULL; + return; + } + else if ((data[0] & 0x7f) != S->ra_following - 1) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Stream %d: AX.25 Reassembler Protocol Error Z: Segments out of sequence.\n", S->stream_id); + cdata_delete(S->ra_buff); + S->ra_buff = NULL; + return; + } + else { + +// Reassembling data state, Not first segment. + + S->ra_following = data[0] & 0x7f; + if (S->ra_buff->len + len - 1 <= S->ra_buff->size) { + memcpy (S->ra_buff->data + S->ra_buff->len, data + 1, len - 1); + S->ra_buff->len += len - 1; + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Stream %d: AX.25 Reassembler Protocol Error Z: Segments exceed buffer space.\n", S->stream_id); + cdata_delete(S->ra_buff); + S->ra_buff = NULL; + return; + } + + if (S->ra_following == 0) { +// Last one. + server_rec_conn_data (S->chan, S->client, S->addrs[PEERCALL], S->addrs[OWNCALL], S->ra_buff->pid, S->ra_buff->data, S->ra_buff->len); + cdata_delete(S->ra_buff); + S->ra_buff = NULL; + } + } + } + + +} /* end dl_data_indication */ + + + +/*------------------------------------------------------------------------------ + * + * Name: lm_channel_busy + * + * Purpose: Change in DCD or PTT status for channel so we know when it is busy. + * + * Inputs: E - Event from the queue. + * + * E->chan - Radio channel number. + * + * E->activity - OCTYPE_PTT for my transmission start/end. + * - OCTYPE_DCD if we hear someone else. + * + * E->status - 1 for active or 0 for quiet. + * + * Outputs: S->radio_channel_busy + * + * T1 & TM201 paused/resumed if running. + * + * Description: We need to pause the timers when the channel is busy. + * + *------------------------------------------------------------------------------*/ + +static int dcd_status[MAX_CHANS]; +static int ptt_status[MAX_CHANS]; + +void lm_channel_busy (dlq_item_t *E) +{ + int busy; + + assert (E->chan >= 0 && E->chan < MAX_CHANS); + assert (E->activity == OCTYPE_PTT || E->activity == OCTYPE_DCD); + assert (E->status == 1 || E->status == 0); + + switch (E->activity) { + + case OCTYPE_DCD: + + if (s_debug_radio) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("lm_channel_busy: DCD chan %d = %d\n", E->chan, E->status); + } + + dcd_status[E->chan] = E->status; + break; + + case OCTYPE_PTT: + + if (s_debug_radio) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("lm_channel_busy: PTT chan %d = %d\n", E->chan, E->status); + } + + ptt_status[E->chan] = E->status; + break; + + default: + break; + } + + busy = dcd_status[E->chan] | ptt_status[E->chan]; + +/* + * We know if the given radio channel is busy or not. + * This must be applied to all data link state machines associated with that radio channel. + */ + + ax25_dlsm_t *S; + + for (S = list_head; S != NULL; S = S->next) { + + if (E->chan == S->chan) { + + if (busy && ! S->radio_channel_busy) { + S->radio_channel_busy = 1; + PAUSE_T1; + PAUSE_TM201; + } + else if ( ! busy && S->radio_channel_busy) { + S->radio_channel_busy = 0; + RESUME_T1; + RESUME_TM201; + } + } + } + +} /* end lm_channel_busy */ + + + + +/*------------------------------------------------------------------------------ + * + * Name: lm_seize_confirm + * + * Purpose: Notification the the channel is clear. + * + * Description: C4.2. This primitive indicates to the Data-link State Machine that + * the transmission opportunity has arrived. + * + * Version 1.5: Originally this only invoked inquiry_response to provide an ack if not already + * taken care of by an earlier frame in this transmission. + * After noticing the unnecessary I frame duplication and differing N(R) in the same + * transmission, I came to the conclusion that we should delay sending of new + * (not resends as a result of rej or srej) frames until after after processing + * of everything in the incoming transmission. + * The protocol spec simply has "I frame pops off queue" without any indication about + * what might trigger this event. + * + *------------------------------------------------------------------------------*/ + +void lm_seize_confirm (dlq_item_t *E) +{ + + assert (E->chan >= 0 && E->chan < MAX_CHANS); + + ax25_dlsm_t *S; + + for (S = list_head; S != NULL; S = S->next) { + + if (E->chan == S->chan) { + + + switch (S->state) { + + case state_0_disconnected: + case state_1_awaiting_connection: + case state_2_awaiting_release: + case state_5_awaiting_v22_connection: + + break; + + case state_3_connected: + case state_4_timer_recovery: + + // v1.5 change in strategy. + // New I frames, not sent yet, are delayed until after processing anything in the received transmission. + // Previously we started sending new frames, from the client app, as soon as they arrived. + // Now, we first take care of those in progress before throwing more into the mix. + + i_frame_pop_off_queue(S); + + // Need an RR if we didn't have I frame send the necessary ack. + + if (S->acknowledge_pending) { + S->acknowledge_pending = 0; + enquiry_response (S, frame_not_AX25, 0); + } + +// Implementation difference: The flow chart for state 3 has LM-RELEASE Request here. +// I don't think I need it because the transmitter will turn off +// automatically once the queue is empty. + +// Erratum: The original spec had LM-SEIZE request here, for state 4, which didn't seem right. +// The 2006 revision has LM-RELEASE Request so states 3 & 4 are the same. + + break; + } + } + } + +} /* lm_seize_confirm */ + + + +/*------------------------------------------------------------------------------ + * + * Name: lm_data_indication + * + * Purpose: We received some sort of frame over the radio. + * + * Inputs: E - Event from the queue. + * Caller is responsible for freeing it. + * + * Description: First determine if is of interest to me. Two cases: + * + * (1) We already have a link handle for (from-addr, to-addr, channel). + * This could have been set up by an outgoing connect request. + * + * (2) It is addressed to one of the registered callsigns. This would + * catch the case of incoming connect requests. The APRS MYCALL + * is not involved at all. The attached client app might have + * much different ideas about what the station is called or + * aliases it might respond to. + * + *------------------------------------------------------------------------------*/ + +void lm_data_indication (dlq_item_t *E) +{ + ax25_frame_type_t ftype; + char desc[80]; + cmdres_t cr; + int pf; + int nr; + int ns; + ax25_dlsm_t *S; + int client_not_applicable = -1; + int n; + int any_unused_digi; + + + if (E->pp == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Internal Error, packet pointer is null. %s %s %d\n", __FILE__, __func__, __LINE__); + return; + } + + E->num_addr = ax25_get_num_addr(E->pp); + +// Digipeating is not done here so consider only those with no unused digipeater addresses. + + any_unused_digi = 0; + + for (n = AX25_REPEATER_1; n < E->num_addr; n++) { + if ( ! ax25_get_h(E->pp, n)) { + any_unused_digi = 1; + } + } + + if (any_unused_digi) { + if (s_debug_radio) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("lm_data_indication (%d, %s>%s) - ignore due to unused digi address.\n", E->chan, E->addrs[AX25_SOURCE], E->addrs[AX25_DESTINATION]); + } + return; + } + +// Copy addresses from frame into event structure. + + for (n = 0; n < E->num_addr; n++) { + ax25_get_addr_with_ssid (E->pp, n, E->addrs[n]); + } + + if (s_debug_radio) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("lm_data_indication (%d, %s>%s)\n", E->chan, E->addrs[AX25_SOURCE], E->addrs[AX25_DESTINATION]); + } + +// Look for existing, or possibly create new, link state matching addresses and channel. + +// In most cases, we can ignore the frame if we don't have a corresponding +// data link state machine. However, we might want to create a new one for SABM or SABME. +// get_link_handle will check to see if the destination matches my address. + +// TODO: This won't work right because we don't know the modulo yet. +// Maybe we should have a shorter form that only returns the frame type. +// That is all we need at this point. + + ftype = ax25_frame_type (E->pp, &cr, desc, &pf, &nr, &ns); + + S = get_link_handle (E->addrs, E->num_addr, E->chan, client_not_applicable, + (ftype == frame_type_U_SABM) | (ftype == frame_type_U_SABME)); + + if (S == NULL) { + return; + } + +/* + * There is not a reliable way to tell if a frame, out of context, has modulo 8 or 128 + * sequence numbers. This needs to be supplied from the data link state machine. + * + * We can't do this until we get the link handle. + */ + + ax25_set_modulo (E->pp, S->modulo); + +/* + * Now we need to use ax25_frame_type again because the previous results, for nr and ns, might be wrong. + */ + + ftype = ax25_frame_type (E->pp, &cr, desc, &pf, &nr, &ns); + +// Gather statistics useful for testing. + + if (ftype <= frame_not_AX25) { + S->count_recv_frame_type[ftype]++; + } + + switch (ftype) { + + case frame_type_I: + if (cr != cr_cmd) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Stream %d: AX.25 Protocol Error S: %s must be COMMAND.\n", S->stream_id, desc); + } + break; + + case frame_type_S_RR: + case frame_type_S_RNR: + case frame_type_S_REJ: + if (cr != cr_cmd && cr != cr_res) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Stream %d: AX.25 Protocol Error: %s must be COMMAND or RESPONSE.\n", S->stream_id, desc); + } + break; + + case frame_type_U_SABME: + case frame_type_U_SABM: + case frame_type_U_DISC: + if (cr != cr_cmd) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Stream %d: AX.25 Protocol Error: %s must be COMMAND.\n", S->stream_id, desc); + } + break; + +// Erratum: The AX.25 spec is not clear about whether SREJ should be command, response, or both. +// The underlying X.25 spec clearly says it is response only. Let's go with that. + + case frame_type_S_SREJ: + case frame_type_U_DM: + case frame_type_U_UA: + case frame_type_U_FRMR: + if (cr != cr_res) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Stream %d: AX.25 Protocol Error: %s must be RESPONSE.\n", S->stream_id, desc); + } + break; + + case frame_type_U_XID: + case frame_type_U_TEST: + if (cr != cr_cmd && cr != cr_res) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Stream %d: AX.25 Protocol Error: %s must be COMMAND or RESPONSE.\n", S->stream_id, desc); + } + break; + + case frame_type_U_UI: + // Don't test at this point in case an APRS frame gets thru. + // APRS doesn't specify what to put in the Source and Dest C bits. + // In practice we see all 4 possible combinations. + // I have an opinion about what would be "correct" (discussed elsewhere) + // but in practice no one seems to care. + break; + + case frame_type_U: + case frame_not_AX25: + // not expected. + break; + } + + + switch (ftype) { + + case frame_type_I: // Information + { + int pid; + unsigned char *info_ptr; + int info_len; + + pid = ax25_get_pid (E->pp); + info_len = ax25_get_info (E->pp, &info_ptr); + + i_frame (S, cr, pf, nr, ns, pid, (char *)info_ptr, info_len); + } + break; + + case frame_type_S_RR: // Receive Ready - System Ready To Receive + rr_rnr_frame (S, 1, cr, pf, nr); + break; + + case frame_type_S_RNR: // Receive Not Ready - TNC Buffer Full + rr_rnr_frame (S, 0, cr, pf, nr); + break; + + case frame_type_S_REJ: // Reject Frame - Out of Sequence or Duplicate + rej_frame (S, cr, pf, nr); + break; + + case frame_type_S_SREJ: // Selective Reject - Ask for selective frame(s) repeat + { + unsigned char *info_ptr; + int info_len; + + info_len = ax25_get_info (E->pp, &info_ptr); + srej_frame (S, cr, pf, nr, info_ptr, info_len); + } + break; + + case frame_type_U_SABME: // Set Async Balanced Mode, Extended + sabm_e_frame (S, 1, pf); + break; + + case frame_type_U_SABM: // Set Async Balanced Mode + sabm_e_frame (S, 0, pf); + break; + + case frame_type_U_DISC: // Disconnect + disc_frame (S, pf); + break; + + case frame_type_U_DM: // Disconnect Mode + dm_frame (S, pf); + break; + + case frame_type_U_UA: // Unnumbered Acknowledge + ua_frame (S, pf); + break; + + case frame_type_U_FRMR: // Frame Reject + frmr_frame (S); + break; + + case frame_type_U_UI: // Unnumbered Information + ui_frame (S, cr, pf); + break; + + case frame_type_U_XID: // Exchange Identification + { + unsigned char *info_ptr; + int info_len; + + info_len = ax25_get_info (E->pp, &info_ptr); + + xid_frame (S, cr, pf, info_ptr, info_len); + } + break; + + case frame_type_U_TEST: // Test + { + unsigned char *info_ptr; + int info_len; + + info_len = ax25_get_info (E->pp, &info_ptr); + + test_frame (S, cr, pf, info_ptr, info_len); + } + break; + + case frame_type_U: // other Unnumbered, not used by AX.25. + break; + + case frame_not_AX25: // Could not get control byte from frame. + break; + } + +// An incoming frame might have ack'ed frames we sent or indicated peer is no longer busy. +// Rather than putting this test in many places, where those conditions, may have changed, +// we will try to catch them all on this single path. +// Start transmission if we now have some outgoing data ready to go. +// (Added in 1.5 beta 3 for issue 132.) + + if ( S->i_frame_queue != NULL && + (S->state == state_3_connected || S->state == state_4_timer_recovery) && + ( ! S->peer_receiver_busy ) && + WITHIN_WINDOW_SIZE(S) ) { + + //S->acknowledge_pending = 1; + lm_seize_request (S->chan); + } + +} /* end lm_data_indication */ + + + +/*------------------------------------------------------------------------------ + * + * Name: i_frame + * + * Purpose: Process I Frame. + * + * Inputs: S - Data Link State Machine. + * cr - Command or Response. We have already issued an error if not command. + * p - Poll bit. Assuming we checked earlier that it was a command. + * The meaning is described below. + * nr - N(R) from the frame. Next expected seq. for other end. + * ns - N(S) from the frame. Seq. number of this incoming frame. + * pid - protocol id. + * info_ptr - pointer to information part of frame. + * info_len - Number of bytes in information part of frame. + * Should be in range of 0 thru n1_paclen. + * + * Description: + * 6.4.2. Receiving I Frames + * + * The reception of I frames that contain zero-length information fields is reported to the next layer; no information + * field will be transferred. + * + * 6.4.2.1. Not Busy + * + * If a TNC receives a valid I frame (one with a correct FCS and whose send sequence number equals the + * receiver's receive state variable) and is not in the busy condition, it accepts the received I frame, increments its + * receive state variable, and acts in one of the following manners: + * + * a) If it has an I frame to send, that I frame may be sent with the transmitted N(R) equal to its receive state + * variable V(R) (thus acknowledging the received frame). Alternately, the TNC may send an RR frame with N(R) + * equal to V(R), and then send the I frame. + * + * or b) If there are no outstanding I frames, the receiving TNC sends an RR frame with N(R) equal to V(R). The + * receiving TNC may wait a small period of time before sending the RR frame to be sure additional I frames are + * not being transmitted. + * + * 6.4.2.2. Busy + * + * If the TNC is in a busy condition, it ignores any received I frames without reporting this condition, other than + * repeating the indication of the busy condition. + * If a busy condition exists, the TNC receiving the busy condition indication polls the sending TNC periodically + * until the busy condition disappears. + * A TNC may poll the busy TNC periodically with RR or RNR frames with the P bit set to "1". + * + * 6.4.6. Receiving Acknowledgement + * + * Whenever an I or S frame is correctly received, even in a busy condition, the N(R) of the received frame is + * checked to see if it includes an acknowledgement of outstanding sent I frames. The T1 timer is canceled if the + * received frame actually acknowledges previously unacknowledged frames. If the T1 timer is canceled and there + * are still some frames that have been sent that are not acknowledged, T1 is started again. If the T1 timer expires + * before an acknowledgement is received, the TNC proceeds with the retransmission procedure outlined in Section + * 6.4.11. + * + * + * 6.2. Poll/Final (P/F) Bit Procedures + * + * The next response frame returned to an I frame with the P bit set to "1", received during the information + * transfer state, is an RR, RNR or REJ response with the F bit set to "1". + * + * The next response frame returned to a S or I command frame with the P bit set to "1", received in the + * disconnected state, is a DM response frame with the F bit set to "1". + * + *------------------------------------------------------------------------------*/ + +static void i_frame (ax25_dlsm_t *S, cmdres_t cr, int p, int nr, int ns, int pid, char *info_ptr, int info_len) +{ + switch (S->state) { + + case state_0_disconnected: + + // Logic from flow chart for "all other commands." + + if (cr == cr_cmd) { + cmdres_t r = cr_res; // DM response with F taken from P. + int f = p; + int nopid = 0; // PID applies only for I and UI frames. + + packet_t pp = ax25_u_frame (S->addrs, S->num_addr, r, frame_type_U_DM, f, nopid, NULL, 0); + lm_data_request (S->chan, TQ_PRIO_1_LO, pp); + } + break; + + case state_1_awaiting_connection: + case state_5_awaiting_v22_connection: + + // Ignore it. Keep same state. + break; + + case state_2_awaiting_release: + + // Logic from flow chart for "I, RR, RNR, REJ, SREJ commands." + + if (cr == cr_cmd && p == 1) { + cmdres_t r = cr_res; // DM response with F = 1. + int f = 1; + int nopid = 0; // PID applies only for I and UI frames. + + packet_t pp = ax25_u_frame (S->addrs, S->num_addr, r, frame_type_U_DM, f, nopid, NULL, 0); + lm_data_request (S->chan, TQ_PRIO_1_LO, pp); + } + break; + + case state_3_connected: + case state_4_timer_recovery: + + // Look carefully. The original had two tiny differences between the two states. + // In the 2006 version, these differences no longer exist. + + // Erratum: SDL asks: Is information field length <= N1 (paclen). + // (github issue 102 - Thanks to KK6WHJ for pointing this out.) + // Just because we are limiting the size of our transmitted data, it doesn't mean + // that the other end will be doing the same. With v2.2, the XID frame can be + // used to negotiate a maximum info length but with v2.0, there is no way for the + // other end to know our paclen value. + + if (info_len >= 0 && info_len <= AX25_MAX_INFO_LEN) { + + if (is_good_nr(S,nr)) { + + // Erratum? + // I wonder if this difference is intentional or if only one place was + // was modified after a cut-n-paste of the flow chart segment. + + // Erratum: Discrepancy between original and 2006 version. + + // Pattern noticed: Anytime we have "is_good_nr" which tests for V(A) <= N(R) <= V(S), + // we should always call "check_i_frame_ackd" or at least set V(A) from N(R). + +#if 0 // Erratum: original - states 3 & 4 differ here. + + if (S->state == state_3_connected) { + // This sets "S->va = nr" and also does some timer stuff. + check_i_frame_ackd (S,nr); + } + else { + SET_VA(nr); + } + +#else // 2006 version - states 3 & 4 same here. + + // This sets "S->va = nr" and also does some timer stuff. + + check_i_frame_ackd (S,nr); +#endif + +// Erratum: v1.5 - My addition. +// I noticed that we sometimes got stuck in state 4 and rc crept up slowly even though +// we received 'I' frames with N(R) values indicating that the other side received everything +// that we sent. Eventually rc could reach the limit and we would get an error. +// If we are in state 4, and other guy ack'ed last I frame we sent, transition to state 3. +// We had a similar situation for RR/RNR for cases other than response, F=1. + + if (S->state == state_4_timer_recovery && S->va == S->vs) { + + STOP_T1; + select_t1_value (S); + START_T3; + SET_RC(0); + enter_new_state (S, state_3_connected, __func__, __LINE__); + } + + if (S->own_receiver_busy) { + // This should be unreachable because we currently don't have a way to set own_receiver_busy. + // But we might the capability someday so implement this while we are here. + + if (p == 1) { + cmdres_t cr = cr_res; // Erratum: The use of "F" in the flow chart implies that RNR is a response + // in this case, but I'm not confident about that. The text says frame. + int f = 1; + int nr = S->vr; + packet_t pp; + + pp = ax25_s_frame (S->addrs, S->num_addr, cr, frame_type_S_RNR, S->modulo, nr, f, NULL, 0); + + // I wonder if this difference is intentional or if only one place was + // was modified after a cut-n-paste of the flow chart segment. + +#if 0 // Erratum: Original - state 4 has expedited. + + if (S->state == state_4_timer_recovery) { + lm_data_request (S->chan, TQ_PRIO_0_HI, pp); // "expedited" + } + else { + lm_data_request (S->chan, TQ_PRIO_1_LO, pp); + } +#else // 2006 version - states 3 & 4 the same. + + lm_data_request (S->chan, TQ_PRIO_1_LO, pp); + +#endif + S->acknowledge_pending = 0; + } + + } + else { // Own receiver not busy. + + i_frame_continued (S, p, ns, pid, info_ptr, info_len); + } + + + } + else { // N(R) not in expected range. + + nr_error_recovery (S); + // my enhancement. See below. + enter_new_state (S, S->modulo == 128 ? state_5_awaiting_v22_connection : state_1_awaiting_connection, __func__, __LINE__); + } + } + else { // Bad information length. + // Wouldn't even get to CRC check if not octet aligned. + + text_color_set(DW_COLOR_ERROR); + dw_printf ("Stream %d: AX.25 Protocol Error O: Information part length, %d, not in range of 0 thru %d.\n", S->stream_id, info_len, AX25_MAX_INFO_LEN); + + establish_data_link (S); + S->layer_3_initiated = 0; + + // The original spec always sent SABM and went to state 1. + // I was thinking, why not use v2.2 instead of we were already connected with v2.2? + // My version of establish_data_link combined the two original functions and + // already uses SABME or SABM based on S->modulo. + + enter_new_state (S, S->modulo == 128 ? state_5_awaiting_v22_connection : state_1_awaiting_connection, __func__, __LINE__); + } + break; + } + +} /* end i_frame */ + + + +/*------------------------------------------------------------------------------ + * + * Name: i_frame_continued + * + * Purpose: The I frame processing logic gets pretty complicated. + * Some of it has been split out into a separate function to make + * things more readable. + * We have already done some error checking and processed N(R). + * This is used for both states 3 & 4. + * + * Inputs: S - Data Link State Machine. We are in state 3. + * p - Poll bit. + * ns - N(S) from the frame. Seq. number of this incoming frame. + * pid - protocol id. + * info_ptr - pointer to information part of frame. + * info_len - Number of bytes in information part of frame. Already verified. + * + * Description: + * + * 4.3.2.3. Reject (REJ) Command and Response + * + * The reject frame requests retransmission of I frames starting with N(R). Any frames sent with a sequence + * number of N(R)-1 or less are acknowledged. Additional I frames which may exist may be appended to the + * retransmission of the N(R) frame. + * Only one reject frame condition is allowed in each direction at a time. The reject condition is cleared by the + * proper reception of I frames up to the I frame that caused the reject condition to be initiated. + * The status of the TNC at the other end of the link is requested by sending a REJ command frame with the P bit + * set to one. + * + * 4.3.2.4. Selective Reject (SREJ) Command and Response + * + * (Erratum: SREJ is only response with F bit.) + * + * The selective reject, SREJ, frame is used by the receiving TNC to request retransmission of the single I frame + * numbered N(R). If the P/F bit in the SREJ frame is set to "1", then I frames numbered up to N(R)-1 inclusive are + * considered as acknowledged. However, if the P/F bit in the SREJ frame is set to "0", then the N(R) of the SREJ + * frame does not indicate acknowledgement of I frames. + * + * Each SREJ exception condition is cleared (reset) upon receipt of the I frame with an N(S) equal to the N(R) + * of the SREJ frame. + * + * A receiving TNC may transmit one or more SREJ frames, each containing a different N(R) with the P bit set + * to "0", before one or more earlier SREJ exception conditions have been cleared. However, a SREJ is not + * transmitted if an earlier REJ exception condition has not been cleared as indicated in Section 4.5.4. (To do so + * would request retransmission of an I frame that would be retransmitted by the REJ operation.) Likewise, a REJ + * frame is not transmitted if one or more earlier SREJ exception conditions have not been cleared as indicated in + * + * Section 4.5.4. + * + * I frames transmitted following the I frame indicated by the SREJ frame are not retransmitted as the result of + * receiving a SREJ frame. Additional I frames awaiting initial transmission may be transmitted following the + * retransmission of the specific I frame requested by the SREJ frame. + * + * + * 6.4.4. Reception of Out-of-Sequence Frames + * + * 6.4.4.1. Implicit Reject (REJ) + * + * When an I frame is received with a correct FCS but its send sequence number N(S) does not match the current + * receiver's receive state variable, the frame is discarded. A REJ frame is sent with a receive sequence number + * equal to one higher than the last correctly received I frame if an uncleared N(S) sequence error condition has not + * been previously established. The received state variable and poll bit of the discarded frame is checked and acted + * upon, if necessary. + * This mode requires no frame queueing and frame resequencing at the receiver. However, because the mode + * requires transmission of frames that may not be in error, its throughput is not as high as selective reject. This + * mode is ineffective on systems with long round-trip delays and high data rates. + * + * 6.4.4.2. Selective Reject (SREJ) + * + * When an I frame is received with a correct FCS but its send sequence number N(S) does not match the current + * receiver's receive state variable, the frame is retained. SREJ frames are sent with a receive sequence number + * equal to the value N(R) of the missing frame, and P=1 if an uncleared SREJ condition has not been previously + * established. If an SREJ condition is already pending, an SREJ will be sent with P=0. The received state variable + * and poll bit of the received frame are checked and acted upon, if necessary. + * This mode requires frame queueing and frame resequencing at the receiver. The holding of frames can + * consume precious buffer space, especially if the user device has limited memory available and several active + * links are operational. + * + * 6.4.4.3. Selective Reject-Reject (SREJ/REJ) + * + * (Erratum: REJ/SREJ should not be mixed. Basic (mod 8) allows only REJ. + * Extended (mod 128) gives you a choice of one or the other for a link.) + * + * When an I frame is received with a correct FCS but its send sequence number N(S) does not match the current + * receiver's receive state variable, and if N(S) indicates 2 or more frames are missing, a REJ frame is transmitted. + * All subsequently received frames are discarded until the lost frame is correctly received. If only one frame is + * missing, a SREJ frame is sent with a receive sequence number equal to the value N(R) of the missing frame. The + * received state variable and poll bit of the received frame are checked and acted upon. If another frame error + * occurs prior to recovery of the SREJ condition, the receiver saves all frames received after the first errored frame + * and discards frames received after the second errored frame until the first errored frame is recovered. Then, a + * REJ is issued to recover the second errored frame and all subsequent discarded frames. + * + *------------------------------------------------------------------------------*/ + +static void i_frame_continued (ax25_dlsm_t *S, int p, int ns, int pid, char *info_ptr, int info_len) +{ + + if (ns == S->vr) { + +// The receive sequence number, N(S), is the same as what we were expecting, V(R). +// Send it to the application and increment the next expected. +// It is possible that this was resent and we tucked away others with the following +// sequence numbers. If so, process them too. + + + SET_VR(AX25MODULO(S->vr + 1, S->modulo, __FILE__, __func__, __LINE__)); + S->reject_exception = 0; + + + if (s_debug_client_app) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("call dl_data_indication() at %s %d, N(S)=%d, V(R)=%d, \"", __func__, __LINE__, ns, S->vr); + ax25_safe_print (info_ptr, info_len, 1); + dw_printf ("\"\n"); + } + + dl_data_indication (S, pid, info_ptr, info_len); + + if (S->rxdata_by_ns[ns] != NULL) { + // There is a possibility that we might have another received frame stashed + // away from 8 or 128 (modulo) frames back. Remove it so it doesn't accidentally + // show up at some future inopportune time. + + cdata_delete (S->rxdata_by_ns[ns]); + S->rxdata_by_ns[ns] = NULL; + + } + + + while (S->rxdata_by_ns[S->vr] != NULL) { + + // dl_data_indication - send connected data to client application. + + if (s_debug_client_app) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("call dl_data_indication() at %s %d, N(S)=%d, V(R)=%d, data=\"", __func__, __LINE__, ns, S->vr); + ax25_safe_print (S->rxdata_by_ns[S->vr]->data, S->rxdata_by_ns[S->vr]->len, 1); + dw_printf ("\"\n"); + } + + dl_data_indication (S, S->rxdata_by_ns[S->vr]->pid, S->rxdata_by_ns[S->vr]->data, S->rxdata_by_ns[S->vr]->len); + + // Don't keep around anymore after sending it to client app. + + cdata_delete (S->rxdata_by_ns[S->vr]); + S->rxdata_by_ns[S->vr] = NULL; + + SET_VR(AX25MODULO(S->vr + 1, S->modulo, __FILE__, __func__, __LINE__)); + } + + if (p) { + +// Mentioned in section 6.2. +// The next response frame returned to an I frame with the P bit set to "1", received during the information +// transfer state, is an RR, RNR or REJ response with the F bit set to "1". + + int f = 1; + int nr = S->vr; // Next expected sequence number. + cmdres_t cr = cr_res; // response with F set to 1. + packet_t pp; + + pp = ax25_s_frame (S->addrs, S->num_addr, cr, frame_type_S_RR, S->modulo, nr, f, NULL, 0); + lm_data_request (S->chan, TQ_PRIO_1_LO, pp); + S->acknowledge_pending = 0; + } + else if ( ! S->acknowledge_pending) { + + S->acknowledge_pending = 1; // Probably want to set this before the LM-SEIZE Request + // in case the LM-SEIZE Confirm gets processed before we + // return from it. + + // Force start of transmission even if the transmit frame queue is empty. + // Notify me, with lm_seize_confirm, when transmission has started. + // When that event arrives, we check acknowledge_pending and send something + // to be determined later. + + lm_seize_request (S->chan); + } + } + else if (S->reject_exception) { + +// This is not the sequence we were expecting. +// We previously sent REJ, asking for a resend so don't send another. +// In this case, send RR only if the Poll bit is set. +// Again, reference section 6.2. + + if (p) { + int f = 1; + int nr = S->vr; // Next expected sequence number. + cmdres_t cr = cr_res; // response with F set to 1. + packet_t pp; + + pp = ax25_s_frame (S->addrs, S->num_addr, cr, frame_type_S_RR, S->modulo, nr, f, NULL, 0); + lm_data_request (S->chan, TQ_PRIO_1_LO, pp); + S->acknowledge_pending = 0; + } + } + else if (S->srej_enable == srej_none) { + +// The received sequence number is not the expected one and we can't use SREJ. +// The old v2.0 approach is to send and REJ with the number we are expecting. +// This can be very inefficient. For example if we received 1,3,4,5,6 in one transmission, +// we discard 3,4,5,6, and tell the other end to resend everything starting with 2. + +// At one time, I had some doubts about when to use command or response for REJ. +// I now believe that response, as implied by setting F in the flow chart, is correct. + + int f = p; + int nr = S->vr; // Next expected sequence number. + cmdres_t cr = cr_res; // response with F copied from P in I frame. + packet_t pp; + + S->reject_exception = 1; + + if (s_debug_retry) { + text_color_set(DW_COLOR_ERROR); // make it more noticeable. + dw_printf ("sending REJ, at %s %d, SREJ not enabled case, V(R)=%d", __func__, __LINE__, S->vr); + } + + pp = ax25_s_frame (S->addrs, S->num_addr, cr, frame_type_S_REJ, S->modulo, nr, f, NULL, 0); + lm_data_request (S->chan, TQ_PRIO_1_LO, pp); + + S->acknowledge_pending = 0; + } + else { + +// Selective reject is enabled so we can use the more efficient method. +// This is normally enabled for v2.2 but XID can be used to change that. +// First we save the current frame so we can retrieve it later after getting the fill in. + + if (S->modulo != 128) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("INTERNAL ERROR: Should not be sending SREJ in basic (modulo 8) mode.\n"); + } + +#if 1 + +// Erratum: AX.25 protocol spec did not handle SREJ very well. +// Based on X.25 section 2.4.6.4. + + + if (is_ns_in_window(S, ns)) { + +// X.25 2.4.6.4 (b) +// v(R) < N(S) < V(R)+k so it is in the expected range. +// Save it in the receive buffer. + + if (S->rxdata_by_ns[ns] != NULL) { + cdata_delete (S->rxdata_by_ns[ns]); + S->rxdata_by_ns[ns] = NULL; + } + S->rxdata_by_ns[ns] = cdata_new(pid, info_ptr, info_len); + + if (s_debug_misc) { + dw_printf ("%s %d, save to rxdata_by_ns N(S)=%d, V(R)=%d, \"", __func__, __LINE__, ns, S->vr); + ax25_safe_print (info_ptr, info_len, 1); + dw_printf ("\"\n"); + } + + if (p == 1) { + int f = 1; + enquiry_response (S, frame_type_I, f); + } + else if (S->own_receiver_busy) { + cmdres_t cr = cr_res; // send RNR response + int f = 0; // we know p=0 here. + int nr = S->vr; + packet_t pp; + + pp = ax25_s_frame (S->addrs, S->num_addr, cr, frame_type_S_RNR, S->modulo, nr, f, NULL, 0); + lm_data_request (S->chan, TQ_PRIO_1_LO, pp); + } + else if (S->rxdata_by_ns[ AX25MODULO(ns - 1, S->modulo, __FILE__, __func__, __LINE__)] == NULL) { + +// Ask for missing frames when we don't have N(S)-1 in the receive buffer. + +// In version 1.4: +// We end up sending more SREJ than necessary and and get back redundant information. Example: +// When we see 113 missing, we ask for a resend. +// When we see 115 & 116 missing, a cumulative SREJ asks for everything. +// The other end dutifully sends 113 twice. +// +// [0.4] DW1>DW0:(SREJ res, n(r)=113, f=0) +// [0.4] DW1>DW0:(SREJ res, n(r)=113, f=1)<0xe6><0xe8> +// +// [0L] DW0>DW1:(I cmd, n(s)=113, n(r)=11, p=0, pid=0xf0)0114 send data<0x0d> +// [0L] DW0>DW1:(I cmd, n(s)=113, n(r)=11, p=0, pid=0xf0)0114 send data<0x0d> +// [0L] DW0>DW1:(I cmd, n(s)=115, n(r)=11, p=0, pid=0xf0)0116 send data<0x0d> +// [0L] DW0>DW1:(I cmd, n(s)=116, n(r)=11, p=0, pid=0xf0)0117 send data<0x0d> + + +// Version 1.5: +// Don't generate duplicate requests for gaps in the same transmission. + +// Ideally, we might wait until carrier drops and then use one Multi-SREJ for entire transmission but +// we will keep that for another day. +// Probably need a flag similar to acknowledge_pending (or ask_resend_count, here) and the ask_for_resend array. +// It could then be processed first in lm_seize_confirm. + + int ask_for_resend[128]; + int ask_resend_count = 0; + int x; + +// Version 1.5 +// Erratum: AX.25 says use F=0 here. Doesn't make sense. +// We would want to set F when sending N(R) = V(R). +// int allow_f1 = 0; // F=1 from X.25 2.4.6.4 b) 3) + int allow_f1 = 1; // F=1 from X.25 2.4.6.4 b) 3) + +// send only for this gap, not cumulative from V(R). + + int last = AX25MODULO(ns - 1, S->modulo, __FILE__, __func__, __LINE__); + int first = last; + while (first != S->vr && S->rxdata_by_ns[AX25MODULO(first - 1, S->modulo, __FILE__, __func__, __LINE__)] == NULL) { + first = AX25MODULO(first - 1, S->modulo, __FILE__, __func__, __LINE__); + } + x = first; + do { + ask_for_resend[ask_resend_count++] = AX25MODULO(x, S->modulo, __FILE__, __func__, __LINE__); + x = AX25MODULO(x + 1, S->modulo, __FILE__, __func__, __LINE__); + } while (x != AX25MODULO(last + 1, S->modulo, __FILE__, __func__, __LINE__)); + + send_srej_frames (S, ask_for_resend, ask_resend_count, allow_f1); + } + } + else { + +// X.25 2.4.6.4 a) +// N(S) is not in expected range. Discard it. Send response if P=1. + + if (p == 1) { + int f = 1; + enquiry_response (S, frame_type_I, f); + } + + } + +#else // my earlier attempt before taking a close look at X.25 spec. + // Keeping it around for a little while because I might want to + // use earlier technique of sending only needed SREJ for any second + // and later gaps in a single multiframe transmission. + + + if (S->rxdata_by_ns[ns] != NULL) { + cdata_delete (S->rxdata_by_ns[ns]); + S->rxdata_by_ns[ns] = NULL; + } + S->rxdata_by_ns[ns] = cdata_new(pid, info_ptr, info_len); + + S->outstanding_srej[ns] = 0; // Don't care if it was previously set or not. + // We have this one so there is no outstanding SREJ for it. + + if (s_debug_misc) { + dw_printf ("%s %d, save to rxdata_by_ns N(S)=%d, V(R)=%d, \"", __func__, __LINE__, ns, S->vr); + ax25_safe_print (info_ptr, info_len, 1); + dw_printf ("\"\n"); + } + + + + + if (selective_reject_exception(S) == 0) { + +// Erratum: This is vastly different than the SDL in the AX.25 protocol spec. +// That would use SREJ if only one was missing and REJ instead. +// Here we do not mix the them. +// This agrees with the X.25 protocol spec that says use one or the other. Not both. + +// Suppose we had incoming I frames 0, 3, 7. +// 0 was already processed and V(R)=1 meaning that is the next expected. +// At this point we area processing N(S)=3. +// In this case, we need to ask for a resend of 1 & 2. +// More generally, the range of V(R) thru N(S)-1. + + int ask_for_resend[128]; + int ask_resend_count = 0; + int i; + int allow_f1 = 1; + +text_color_set(DW_COLOR_ERROR); +dw_printf ("%s:%d, zero exceptions, V(R)=%d, N(S)=%d\n", __func__, __LINE__, S->vr, ns); + + for (i = S->vr; i != ns; i = AX25MODULO(i+1, S->modulo, __FILE__, __func__, __LINE__)) { + ask_for_resend[ask_resend_count++] = i; + } + + send_srej_frames (S, ask_for_resend, ask_resend_count, allow_f1); + } + else { + +// Erratum: The SDL says ask for N(S) which is clearly wrong because that's what we just received. +// Instead we want to ask for any missing frames up to but not including N(S). + +// Let's continue with the example above. I frames with N(S) of 0, 3, 7. +// selective_reject_exception is non zero meaning there are outstanding requests to resend specified I frames. +// V(R) is still 1 because 0 is the last one received with contiguous N(S) values. +// 3 has been saved into S->rxdata_by_ns. +// We now have N(S)=7. We want to ask for a resend of 4, 5, 6. +// This can be achieved by searching S->rxdata_by_ns, starting with N(S)-1, and counting +// how many empty slots we have before finding a saved frame. + + int ask_resend_count = 0; + int first; + +text_color_set(DW_COLOR_ERROR); +dw_printf ("%s:%d, %d srej exceptions, V(R)=%d, N(S)=%d\n", __func__, __LINE__, selective_reject_exception(S), S->vr, ns); + + first = AX25MODULO(ns - 1, S->modulo, __FILE__, __func__, __LINE__); + while (S->rxdata_by_ns[first] == NULL) { + if (first == AX25MODULO(S->vr - 1, S->modulo, __FILE__, __func__, __LINE__)) { + // Oops! Went too far. This I frame was already processed. + text_color_set(DW_COLOR_ERROR); + dw_printf ("INTERNAL ERROR calculating what to put in SREJ, %s line %d\n", __func__, __LINE__); + dw_printf ("V(R)=%d, N(S)=%d, SREJ exception=%d, first=%d, ask_resend_count=%d\n", S->vr, ns, selective_reject_exception(S), first, ask_resend_count); + int k; + for (k=0; k<128; k++) { + if (S->rxdata_by_ns[k] != NULL) { + dw_printf ("rxdata_by_ns[%d] has data\n", k); + } + } + break; + } + ask_resend_count++; + first = AX25MODULO(first - 1, S->modulo, __FILE__, __func__, __LINE__); + } + + // Go beyond the slot where we already have an I frame. + first = AX25MODULO(first + 1, S->modulo, __FILE__, __func__, __LINE__); + + // The ask_resend_count could be 0. e.g. We got 4 rather than 7 in this example. + + if (ask_resend_count > 0) { + int ask_for_resend[128]; + int n; + int allow_f1 = 1; + + for (n = 0; n < ask_resend_count; n++) { + ask_for_resend[n] = AX25MODULO(first + n, S->modulo, __FILE__, __func__, __LINE__);; + } + + send_srej_frames (S, ask_for_resend, ask_resend_count, allow_f1); + } + + } /* end SREJ exception */ + +#endif // my earlier attempt. + + + + +// Erratum: original has following but 2006 rev does not. +// I think the 2006 version is correct. +// SREJ does not always satisfy the need for ack. +// There is a special case where F=1. We take care of that inside of send_srej_frames. + +#if 0 + S->acknowledge_pending = 0; +#endif + + } /* end srej enabled */ + + +} /* end i_frame_continued */ + + + +/*------------------------------------------------------------------------------ + * + * Name: is_ns_in_window + * + * Purpose: Is the N(S) value of the incoming I frame in the expected range? + * + * Inputs: ns - Sequence from I frame. + * + * Description: With selective reject, it is possible that we could receive a repeat of + * an I frame with N(S) less than V(R). In this case, we just want to + * discard it rather than getting upset and reestablishing the connection. + * + * The X.25 spec,section 2.4.6.4 (b) asks whether V(R) < N(S) < V(R)+k. + * + * The problem here is that it depends on the value of k for the other end. + * X.25 says that both sides need to agree on a common value of k ahead of time. + * We might have k=8 for our sending but the other side could have k=32 so + * this test could fail. + * + * As a hack, we could use the value 63 here. If too small we would discard + * I frames that are in the acceptable range because they would be >= V(R)+k. + * On the other hand, if this value is too big, the range < V(R) would not be + * large enough and we would accept frame we shouldn't. + * As a practical matter, using a window size that large is pretty unlikely. + * Maybe I could put a limit of 63, rather than 127 in the configuration. + * + *------------------------------------------------------------------------------*/ + +#define GENEROUS_K 63 + +static int is_ns_in_window (ax25_dlsm_t *S, int ns) +{ + int adjusted_vr, adjusted_ns, adjusted_vrpk; + int result; + +/* Shift all values relative to V(R) before comparing so we won't have wrap around. */ + +#define adjust_by_vr(x) (AX25MODULO((x) - S->vr, S->modulo, __FILE__, __func__, __LINE__)) + + adjusted_vr = adjust_by_vr(S->vr); // A clever compiler would know it is zero. + adjusted_ns = adjust_by_vr(ns); + adjusted_vrpk = adjust_by_vr(S->vr + GENEROUS_K); + + result = adjusted_vr < adjusted_ns && adjusted_ns < adjusted_vrpk; + + if (s_debug_retry) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("is_ns_in_window, V(R) %d < N(S) %d < V(R)+k %d, returns %d\n", S->vr, ns, S->vr + GENEROUS_K, result); + } + + return (result); +} + + +/*------------------------------------------------------------------------------ + * + * Name: send_srej_frames + * + * Purpose: Ask for a resend of I frames with specified sequence numbers. + * + * Inputs: resend - Array of N(S) values for missing I frames. + * + * count - Number of items in array. + * + * allow_f1 - When true, set F=1 when asking for V(R). + * + * X.25 section 2.4.6.4 b) 3) says F should be set to 0 + * when receiving I frame out of sequence. + * + * X.25 sections 2.4.6.11 & 2.3.5.2.2 say set F to 1 when + * responding to command with P=1. (our enquiry_response function). + * + * Version 1.5: The X.25 protocol spec allows additional sequence numbers in one frame + * by using the INFO part. + * By default that feature is off but can be negotiated with XID. + * We should be able to use this between two direwolf stations while + * maintaining compatibility with the original AX.25 v2.2. + * + *------------------------------------------------------------------------------*/ + + +static void send_srej_frames (ax25_dlsm_t *S, int *resend, int count, int allow_f1) +{ + int f; // Set if we are ack-ing one before. + int nr; + cmdres_t cr = cr_res; // SREJ is always response. + int i; + + packet_t pp; + + if (count <= 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("INTERNAL ERROR, count=%d, %s line %d\n", count, __func__, __LINE__); + return; + } + + if (s_debug_retry) { + text_color_set(DW_COLOR_INFO); + dw_printf ("%s line %d\n", __func__, __LINE__); + //dw_printf ("state=%d, count=%d, k=%d, V(R)=%d, SREJ exception=%d\n", S->state, count, S->k_maxframe, S->vr, selective_reject_exception(S)); + dw_printf ("state=%d, count=%d, k=%d, V(R)=%d\n", S->state, count, S->k_maxframe, S->vr); + + dw_printf ("resend[]="); + for (i = 0; i < count; i++) { + dw_printf (" %d", resend[i]); + } + dw_printf ("\n"); + + dw_printf ("rxdata_by_ns[]="); + for (i = 0; i < 128; i++) { + if (S->rxdata_by_ns[i] != NULL) { + dw_printf (" %d", i); + } + } + dw_printf ("\n"); + } + + +// Something is wrong! We ask for more than the window size. + + if (count > S->k_maxframe) { + + text_color_set(DW_COLOR_ERROR); + dw_printf ("INTERNAL ERROR - Extreme number of SREJ, %s line %d\n", __func__, __LINE__); + dw_printf ("state=%d, count=%d, k=%d, V(R)=%d\n", S->state, count, S->k_maxframe, S->vr); + + dw_printf ("resend[]="); + for (i = 0; i < count; i++) { + dw_printf (" %d", resend[i]); + } + dw_printf ("\n"); + + dw_printf ("rxdata_by_ns[]="); + for (i = 0; i < 128; i++) { + if (S->rxdata_by_ns[i] != NULL) { + dw_printf (" %d", i); + } + } + dw_printf ("\n"); + } + +// Multi-SREJ - Use info part for additional sequence number(s) instead of sending separate SREJ for each. + + if (S->srej_enable == srej_multi && count > 1) { + + unsigned char info[128]; + int info_len = 0; + + for (i = 1; i < count; i++) { // skip first one + + if (resend[i] < 0 || resend[i] >= S->modulo) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("INTERNAL ERROR, additional nr=%d, modulo=%d, %s line %d\n", resend[i], S->modulo, __func__, __LINE__); + } + + // There is also a form to specify a range but I don't + // think it is worth the effort to generate it. Maybe later. + + if (S->modulo == 8) { + info[info_len++] = resend[i] << 5; + } + else { + info[info_len++] = resend[i] << 1; + } + } + + f = 0; + nr = resend[0]; + f = allow_f1 && (nr == S->vr); + // Possibly set if we are asking for the next after + // the last one received in contiguous order. + + // This could only apply to the first in + // the list so this would not go in the loop. + + if (f) { // In this case the other end is being + // informed of my V(R) so no additional + // RR etc. is needed. + // TODO: Need to think about this. + S->acknowledge_pending = 0; + } + + if (nr < 0 || nr >= S->modulo) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("INTERNAL ERROR, nr=%d, modulo=%d, %s line %d\n", nr, S->modulo, __func__, __LINE__); + nr = AX25MODULO(nr, S->modulo, __FILE__, __func__, __LINE__); + } + + pp = ax25_s_frame (S->addrs, S->num_addr, cr, frame_type_S_SREJ, S->modulo, nr, f, info, info_len); + lm_data_request (S->chan, TQ_PRIO_1_LO, pp); + return; + } + +// Multi-SREJ not enabled. Send separate SREJ for each desired sequence number. + + for (i = 0; i < count; i++) { + + nr = resend[i]; + f = allow_f1 && (nr == S->vr); + // Possibly set if we are asking for the next after + // the last one received in contiguous order. + + if (f) { + // In this case the other end is being + // informed of my V(R) so no additional + // RR etc. is needed. + S->acknowledge_pending = 0; + } + + if (nr < 0 || nr >= S->modulo) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("INTERNAL ERROR, nr=%d, modulo=%d, %s line %d\n", nr, S->modulo, __func__, __LINE__); + nr = AX25MODULO(nr, S->modulo, __FILE__, __func__, __LINE__); + } + + pp = ax25_s_frame (S->addrs, S->num_addr, cr, frame_type_S_SREJ, S->modulo, nr, f, NULL, 0); + lm_data_request (S->chan, TQ_PRIO_1_LO, pp); + } + +} /* end send_srej_frames */ + + + +/*------------------------------------------------------------------------------ + * + * Name: rr_rnr_frame + * + * Purpose: Process RR or RNR Frame. + * Processing is the essentially the same so they are handled by a single function. + * + * Inputs: S - Data Link State Machine. + * ready - True for RR, false for RNR + * cr - Is this command or response? + * pf - Poll/Final bit. + * nr - N(R) from the frame. + * + * Description: 4.3.2.1. Receive Ready (RR) Command and Response + * + * Receive Ready accomplishes the following: + * a) indicates that the sender of the RR is now able to receive more I frames; + * b) acknowledges properly received I frames up to, and including N(R)-1;and + * c) clears a previously-set busy condition created by an RNR command having been sent. + * The status of the TNC at the other end of the link can be requested by sending an RR command frame with the + * P-bit set to one. + * + * 4.3.2.2. Receive Not Ready (RNR) Command and Response + * + * Receive Not Ready indicates to the sender of I frames that the receiving TNC is temporarily busy and cannot + * accept any more I frames. Frames up to N(R)-1 are acknowledged. Frames N(R) and above that may have been + * transmitted are discarded and must be retransmitted when the busy condition clears. + * The RNR condition is cleared by the sending of a UA, RR, REJ or SABM(E) frame. + * The status of the TNC at the other end of the link is requested by sending an RNR command frame with the + * P bit set to one. + * + *------------------------------------------------------------------------------*/ + + +static void rr_rnr_frame (ax25_dlsm_t *S, int ready, cmdres_t cr, int pf, int nr) +{ + + // dw_printf ("rr_rnr_frame (ready=%d, cr=%d, pf=%d, nr=%d) state=%d\n", ready, cr, pf, nr, S->state); + + switch (S->state) { + + case state_0_disconnected: + + if (cr == cr_cmd) { + cmdres_t r = cr_res; // DM response with F taken from P. + int f = pf; + int nopid = 0; // PID only for I and UI frames. + packet_t pp = ax25_u_frame (S->addrs, S->num_addr, r, frame_type_U_DM, f, nopid, NULL, 0); + lm_data_request (S->chan, TQ_PRIO_1_LO, pp); + } + break; + + case state_1_awaiting_connection: + case state_5_awaiting_v22_connection: + + // do nothing. + break; + + case state_2_awaiting_release: + + // Logic from flow chart for "I, RR, RNR, REJ, SREJ commands." + + if (cr == cr_cmd && pf == 1) { + cmdres_t r = cr_res; // DM response with F = 1. + int f = 1; + int nopid = 0; // PID applies only for I and UI frames. + + packet_t pp = ax25_u_frame (S->addrs, S->num_addr, r, frame_type_U_DM, f, nopid, NULL, 0); + lm_data_request (S->chan, TQ_PRIO_1_LO, pp); + } + +// Erratum: We have a disagreement here between original and 2006 version. +// RR, RNR, REJ, SREJ responses would fall under "all other primitives." +// In the original, we simply ignore it and stay in state 2. +// The 2006 version, page 94, says go into "1 awaiting connection" state. +// That makes no sense to me. + + break; + + case state_3_connected: + + S->peer_receiver_busy = ! ready; + +// Erratum: the flow charts have unconditional check_need_for_response here. +// I don't recall exactly why I added the extra test for command and P=1. +// It might have been because we were reporting error A for response with F=1. +// Other than avoiding that error message, this is functionally equivalent. + + if (cr == cr_cmd && pf) { + check_need_for_response (S, ready ? frame_type_S_RR : frame_type_S_RNR, cr, pf); + } + + if (is_good_nr(S,nr)) { + // dw_printf ("rr_rnr_frame (), line %d, state=%d, good nr=%d, calling check_i_frame_ackd\n", __LINE__, S->state, nr); + + check_i_frame_ackd (S, nr); + } + else { + if (s_debug_retry) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("rr_rnr_frame (), line %d, state=%d, bad nr, calling nr_error_recovery\n", __LINE__, S->state); + } + + nr_error_recovery (S); + // My enhancement. Original always sent SABM and went to state 1. + enter_new_state (S, S->modulo == 128 ? state_5_awaiting_v22_connection : state_1_awaiting_connection, __func__, __LINE__); + } + + break; + + case state_4_timer_recovery: + + S->peer_receiver_busy = ! ready; + + if (cr == cr_res && pf == 1) { + +// RR/RNR Response with F==1. + + if (s_debug_retry) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("rr_rnr_frame (), Response, f=%d, line %d, state=%d, good nr, calling check_i_frame_ackd\n", pf, __LINE__, S->state); + } + + STOP_T1; + select_t1_value(S); + + if (is_good_nr(S,nr)) { + + SET_VA(nr); + if (S->vs == S->va) { // all caught up with ack from other guy. + START_T3; + SET_RC(0); // My enhancement. See Erratum note in select_t1_value. + enter_new_state (S, state_3_connected, __func__, __LINE__); + } + else { + invoke_retransmission (S, nr); +// my addition + +// Erratum: We sent I frame(s) and want to timeout if no ack comes back. +// We also sent N(R) so no need for extra RR at the end only for that. + + STOP_T3; + START_T1; + S->acknowledge_pending = 0; + +// end of my addition + } + } + else { + nr_error_recovery (S); + +// Erratum: Another case of my enhancement. +// The flow charts go into state 1 after nr_error_recovery. +// I use state 5 instead if we were oprating in extended (modulo 128) mode. + + enter_new_state (S, S->modulo == 128 ? state_5_awaiting_v22_connection : state_1_awaiting_connection, __func__, __LINE__); + } + } + else { + +// RR/RNR command, either P value. +// RR/RNR response, F==0 + + if (cr == cr_cmd && pf == 1) { + int f = 1; + enquiry_response (S, ready ? frame_type_S_RR : frame_type_S_RNR, f); + } + + if (is_good_nr(S,nr)) { + + SET_VA(nr); + +// Erratum: v1.5 - my addition. +// I noticed that we sometimes got stuck in state 4 and rc crept up slowly even though +// we received RR frames with N(R) values indicating that the other side received everything +// that we sent. Eventually rc could reach the limit and we would get an error. +// If we are in state 4, and other guy ack'ed last I frame we sent, transition to state 3. +// The same thing was done for receiving I frames after check_i_frame_ackd. + +// Thought: Could we simply call check_i_frame_ackd, for consistency, rather than only setting V(A)? + + if (cr == cr_res && pf == 0) { + + if (S->vs == S->va) { // all caught up with ack from other guy. + STOP_T1; + select_t1_value (S); + START_T3; + SET_RC(0); + enter_new_state (S, state_3_connected, __func__, __LINE__); + } + } + } + else { + nr_error_recovery (S); + enter_new_state (S, S->modulo == 128 ? state_5_awaiting_v22_connection : state_1_awaiting_connection, __func__, __LINE__); + } + } + break; + } + +} /* end rr_rnr_frame */ + + + +/*------------------------------------------------------------------------------ + * + * Name: rej_frame + * + * Purpose: Process REJ Frame. + * + * Inputs: S - Data Link State Machine. + * cr - Is this command or response? + * pf - Poll/Final bit. + * nr - N(R) from the frame. + * + * Description: 4.3.2.2. Receive Not Ready (RNR) Command and Response + * + * ... The RNR condition is cleared by the sending of a UA, RR, REJ or SABM(E) frame. ... + * + * + * 4.3.2.3. Reject (REJ) Command and Response + * + * The reject frame requests retransmission of I frames starting with N(R). Any frames sent with a sequence + * number of N(R)-1 or less are acknowledged. Additional I frames which may exist may be appended to the + * retransmission of the N(R) frame. + * Only one reject frame condition is allowed in each direction at a time. The reject condition is cleared by the + * proper reception of I frames up to the I frame that caused the reject condition to be initiated. + * The status of the TNC at the other end of the link is requested by sending a REJ command frame with the P bit + * set to one. + * + * 4.4.3. Reject (REJ) Recovery + * + * The REJ frame requests a retransmission of I frames following the detection of a N(S) sequence error. Only + * one outstanding "sent REJ" condition is allowed at a time. This condition is cleared when the requested I frame + * has been received. + * A TNC receiving the REJ command clears the condition by resending all outstanding I frames (up to the + * window size), starting with the frame indicated in N(R) of the REJ frame. + * + * + * 4.4.5.1. T1 Timer Recovery + * + * If a transmission error causes a TNC to fail to receive (or to receive and discard) a single I frame, or the last I + * frame in a sequence of I frames, then the TNC does not detect a send-sequence-number error and consequently + * does not transmit a REJ/SREJ. The TNC that transmitted the unacknowledged I frame(s) following the completion + * of timeout period T1, takes appropriate recovery action to determine when I frame retransmission as described + * in Section 6.4.10 should begin. This condition is cleared by the reception of an acknowledgement for the sent + * frame(s), or by the link being reset. + * + * 6.2. Poll/Final (P/F) Bit Procedures + * + * The response frame returned by a TNC depends on the previous command received, as described in the + * following paragraphs. + * ... + * + * The next response frame returned to an I frame with the P bit set to "1", received during the information5 + * transfer state, is an RR, RNR or REJ response with the F bit set to "1". + * + * The next response frame returned to a supervisory command frame with the P bit set to "1", received during + * the information transfer state, is an RR, RNR or REJ response frame with the F bit set to "1". + * ... + * + * The P bit is used in conjunction with the timeout recovery condition discussed in Section 4.5.5. + * When not used, the P/F bit is set to "0". + * + * 6.4.4.1. Implicit Reject (REJ) + * + * When an I frame is received with a correct FCS but its send sequence number N(S) does not match the current + * receiver's receive state variable, the frame is discarded. A REJ frame is sent with a receive sequence number + * equal to one higher than the last correctly received I frame if an uncleared N(S) sequence error condition has not + * been previously established. The received state variable and poll bit of the discarded frame is checked and acted + * upon, if necessary. + * This mode requires no frame queueing and frame resequencing at the receiver. However, because the mode + * requires transmission of frames that may not be in error, its throughput is not as high as selective reject. This + * mode is ineffective on systems with long round-trip delays and high data rates. + * + * 6.4.7. Receiving REJ + * + * After receiving a REJ frame, the transmitting TNC sets its send state variable to the same value as the REJ + * frame's received sequence number in the control field. The TNC then retransmits any I frame(s) outstanding at + * the next available opportunity in accordance with the following: + * + * a) If the TNC is not transmitting at the time and the channel is open, the TNC may begin retransmission of the + * I frame(s) immediately. + * b) If the TNC is operating on a full-duplex channel transmitting a UI or S frame when it receives a REJ frame, + * it may finish sending the UI or S frame and then retransmit the I frame(s). + * c) If the TNC is operating in a full-duplex channel transmitting another I frame when it receives a REJ frame, + * it may abort the I frame it was sending and start retransmission of the requested I frames immediately. + * d) The TNC may send just the one I frame outstanding, or it may send more than the one indicated if more I + * frames followed the first unacknowledged frame, provided that the total to be sent does not exceed the flowcontrol + * window (k frames). + * If the TNC receives a REJ frame with the poll bit set, it responds with either an RR or RNR frame with the + * final bit set before retransmitting the outstanding I frame(s). + * + *------------------------------------------------------------------------------*/ + +static void rej_frame (ax25_dlsm_t *S, cmdres_t cr, int pf, int nr) +{ + + switch (S->state) { + + case state_0_disconnected: + + // states 0 and 2 are very similar with one tiny little difference. + + if (cr == cr_cmd) { + cmdres_t r = cr_res; // DM response with F taken from P. + int f = pf; + int nopid = 0; // PID is only for I and UI. + + packet_t pp = ax25_u_frame (S->addrs, S->num_addr, r, frame_type_U_DM, f, nopid, NULL, 0); + lm_data_request (S->chan, TQ_PRIO_1_LO, pp); + } + break; + + case state_1_awaiting_connection: + case state_5_awaiting_v22_connection: + // Do nothing. + break; + + case state_2_awaiting_release: + + if (cr == cr_cmd && pf == 1) { + cmdres_t r = cr_res; // DM response with F = 1. + int f = 1; + int nopid = 0; + + packet_t pp = ax25_u_frame (S->addrs, S->num_addr, r, frame_type_U_DM, f, nopid, NULL, 0); + lm_data_request (S->chan, TQ_PRIO_1_LO, pp); + } + +// Erratum: We have a disagreement here between original and 2006 version. +// RR, RNR, REJ, SREJ responses would fall under "all other primitives." +// In the original, we simply ignore it and stay in state 2. +// The 2006 version, page 94, says go into "1 awaiting connection" state. +// That makes no sense to me. + + break; + + case state_3_connected: + + S->peer_receiver_busy = 0; + +// Receipt of the REJ "frame" (either command or response) causes us to +// start resending I frames at the specified number. + +// I think there are 3 possibilities here: +// Response is used when incoming I frame processing detects one is missing. +// In this case, F is copied from the I frame P bit. I don't think we care here. +// Command with P=1 is used during timeout recovery. +// The rule is that we are supposed to send a response with F=1 for I, RR, RNR, or REJ with P=1. + + check_need_for_response (S, frame_type_S_REJ, cr, pf); + + if (is_good_nr(S,nr)) { + SET_VA(nr); + STOP_T1; + STOP_T3; + select_t1_value(S); + + invoke_retransmission (S, nr); + +// my addition +// Erratum: We sent I frame(s) and want to timeout if no ack comes back. +// We also sent N(R) so no need for extra RR at the end only for that. + +// We ran into cases where I frame(s) would be resent but lost. +// T1 was stopped so we just waited and waited and waited instead of trying again. +// I added the following after each invoke_retransmission. +// This seems clearer than hiding the timer stuff inside of it. + + // T3 is already stopped. + START_T1; + S->acknowledge_pending = 0; + } + else { + nr_error_recovery (S); + enter_new_state (S, S->modulo == 128 ? state_5_awaiting_v22_connection : state_1_awaiting_connection, __func__, __LINE__); + } + break; + + case state_4_timer_recovery: + + S->peer_receiver_busy = 0; + + if (cr == cr_res && pf == 1) { + + STOP_T1; + select_t1_value(S); + + if (is_good_nr(S,nr)) { + + SET_VA(nr); + if (S->vs == S->va) { + START_T3; + SET_RC(0); // My enhancement. See Erratum note in select_t1_value. + enter_new_state (S, state_3_connected, __func__, __LINE__); + } + else { + invoke_retransmission (S, nr); +// my addition. +// Erratum: We sent I frame(s) and want to timeout if no ack comes back. +// We also sent N(R) so no need for extra RR at the end only for that. + + STOP_T3; + START_T1; + S->acknowledge_pending = 0; + } + } + else { + nr_error_recovery (S); + enter_new_state (S, S->modulo == 128 ? state_5_awaiting_v22_connection : state_1_awaiting_connection, __func__, __LINE__); + } + } + else { + if (cr == cr_cmd && pf == 1) { + int f = 1; + enquiry_response (S, frame_type_S_REJ, f); + } + + if (is_good_nr(S,nr)) { + + SET_VA(nr); + + if (S->vs != S->va) { + // Observation: RR/RNR state 4 is identical but it doesn't have invoke_retransmission here. + invoke_retransmission (S, nr); +// my addition. +// Erratum: We sent I frame(s) and want to timeout if no ack comes back. +// We also sent N(R) so no need for extra RR at the end only for that. + + STOP_T3; + START_T1; + S->acknowledge_pending = 0; + } + + } + else { + nr_error_recovery (S); + enter_new_state (S, S->modulo == 128 ? state_5_awaiting_v22_connection : state_1_awaiting_connection, __func__, __LINE__); + } + } + break; + } + +} /* end rej_frame */ + + +/*------------------------------------------------------------------------------ + * + * Name: srej_frame + * + * Purpose: Process SREJ Response. + * + * Inputs: S - Data Link State Machine. + * cr - Is this command or response? + * f - Final bit. When set, it is ack-ing up thru N(R)-1 + * nr - N(R) from the frame. Peer has asked for a resend of I frame with this N(S). + * info - Information field, used only for Multi-SREJ + * info_len - Information field length, bytes. + * + * Description: 4.3.2.4. Selective Reject (SREJ) Command and Response + * + * The selective reject, SREJ, frame is used by the receiving TNC to request retransmission of the single I frame + * numbered N(R). If the P/F bit in the SREJ frame is set to "1", then I frames numbered up to N(R)-1 inclusive are + * considered as acknowledged. However, if the P/F bit in the SREJ frame is set to "0", then the N(R) of the SREJ + * frame does not indicate acknowledgement of I frames. + * + * Each SREJ exception condition is cleared (reset) upon receipt of the I frame with an N(S) equal to the N(R) + * of the SREJ frame. + * + * A receiving TNC may transmit one or more SREJ frames, each containing a different N(R) with the P bit set + * to "0", before one or more earlier SREJ exception conditions have been cleared. However, a SREJ is not + * transmitted if an earlier REJ exception condition has not been cleared as indicated in Section 4.5.4. (To do so + * would request retransmission of an I frame that would be retransmitted by the REJ operation.) Likewise, a REJ + * frame is not transmitted if one or more earlier SREJ exception conditions have not been cleared as indicated in + * Section 4.5.4. + * + * I frames transmitted following the I frame indicated by the SREJ frame are not retransmitted as the result of + * receiving a SREJ frame. Additional I frames awaiting initial transmission may be transmitted following the + * retransmission of the specific I frame requested by the SREJ frame. + * + * Erratum: The section above always refers to SREJ "frames." There doesn't seem to be any clue about when + * command vs. response would be used. When we look in the flow charts, we see that we generate only + * responses but the code is there to process command and response slightly differently. + * + * Description: 4.4.4. Selective Reject (SREJ) Recovery + * + * The SREJ command/response initiates more-efficient error recovery by requesting the retransmission of a + * single I frame following the detection of a sequence error. This is an advancement over the earlier versions in + * which the requested I frame was retransmitted together with all additional I frames subsequently transmitted and + * successfully received. + * + * When a TNC sends one or more SREJ commands, each with the P bit set to "0" or "1", or one or more SREJ + * responses, each with the F bit set to "0", and the "sent SREJ" conditions are not cleared when the TNC is ready + * to issue the next response frame with the F bit set to "1", the TNC sends a SREJ response with the F bit set to "1", + * with the same N(R) as the oldest unresolved SREJ frame. + * + * Because an I or S format frame with the F bit set to "1" can cause checkpoint retransmission, a TNC does not + * send SREJ frames until it receives at least one in-sequence I frame, or it perceives by timeout that the checkpoint + * retransmission will not be initiated at the remote TNC. + * + * With respect to each direction of transmission on the data link, one or more "sent SREJ" exception conditions + * from a TNC to another TNC may be established at a time. A "sent SREJ" exception condition is cleared when + * the requested I frame is received. + * + * The SREJ frame may be repeated when a TNC perceives by timeout that a requested I frame will not be + * received, because either the requested I frame or the SREJ frame was in error or lost. + * + * When appropriate, a TNC receiving one or more SREJ frames initiates retransmission of the individual I + * frames indicated by the N(R) contained in each SREJ frame. After having retransmitted the above frames, new + * I frames are transmitted later if they become available. + * + * When a TNC receives and acts on one or more SREJ commands, each with the P bit set to "0", or an SREJ + * command with the P bit set to "1", or one or more SREJ responses each with the F bit set to "0", it disables any + * action on the next SREJ response frame if that SREJ frame has the F bit set to "1" and has the same N(R) (i.e., + * the same value and the same numbering cycle) as a previously actioned SREJ frame, and if the resultant + * retransmission was made following the transmission of the P bit set to a "1". + * When the SREJ mechanism is used, the receiving station retains correctly-received I frames and delivers + * them to the higher layer in sequence number order. + * + * + * 6.4.4.2. Selective Reject (SREJ) + * + * When an I frame is received with a correct FCS but its send sequence number N(S) does not match the current + * receiver's receive state variable, the frame is retained. SREJ frames are sent with a receive sequence number + * equal to the value N(R) of the missing frame, and P=1 if an uncleared SREJ condition has not been previously + * established. If an SREJ condition is already pending, an SREJ will be sent with P=0. The received state variable + * and poll bit of the received frame are checked and acted upon, if necessary. + * + * This mode requires frame queueing and frame resequencing at the receiver. The holding of frames can + * consume precious buffer space, especially if the user device has limited memory available and several active + * links are operational. + * + * + * 6.4.4.3. Selective Reject-Reject (SREJ/REJ) + * + * When an I frame is received with a correct FCS but its send sequence number N(S) does not match the current + * receiver's receive state variable, and if N(S) indicates 2 or more frames are missing, a REJ frame is transmitted. + * All subsequently received frames are discarded until the lost frame is correctly received. If only one frame is + * missing, a SREJ frame is sent with a receive sequence number equal to the value N(R) of the missing frame. The + * received state variable and poll bit of the received frame are checked and acted upon. If another frame error + * occurs prior to recovery of the SREJ condition, the receiver saves all frames received after the first errored frame + * and discards frames received after the second errored frame until the first errored frame is recovered. Then, a + * REJ is issued to recover the second errored frame and all subsequent discarded frames. + * + * X.25: States that SREJ is only response. I'm following that and it simplifies matters. + * + * X.25 2.4.6.6.1 & 2.4.6.6.2 make a distinction between F being 0 or 1 besides copying N(R) into V(A). + * They talk about sending a poll under some conditions. + * We don't do that here. It seems to work reliably so leave well enough alone. + * + *------------------------------------------------------------------------------*/ + +static int resend_for_srej (ax25_dlsm_t *S, int nr, unsigned char *info, int info_len); + +static void srej_frame (ax25_dlsm_t *S, cmdres_t cr, int f, int nr, unsigned char *info, int info_len) +{ + + switch (S->state) { + + case state_0_disconnected: + + break; + + case state_1_awaiting_connection: + case state_5_awaiting_v22_connection: + // Do nothing. + + // Erratum: The original spec said stay in same state. (Seems correct.) + // 2006 revision shows state 5 transitioning into 1. I think that is wrong. + // probably a cut-n-paste from state 1 to 5 and that part not updated. + break; + + case state_2_awaiting_release: + + // Erratum: Flow chart says send DM(F=1) for "I, RR, RNR, REJ, SREJ commands" and P=1. + // It is wrong for two reasons. + // If SREJ was a command, the P flag has a different meaning than the other Supervisory commands. + // It means ack reception of frames up thru N(R)-1; it is not a poll to get a response. + + // Based on X.25, I don't think SREJ can be a command. + // It should say, "I, RR, RNR, REJ commands" + + // Erratum: We have a disagreement here between original and 2006 version. + // RR, RNR, REJ, SREJ responses would fall under "all other primitives." + // In the original, we simply ignore it and stay in state 2. + // The 2006 version, page 94, says go into "1 awaiting connection" state. + // That makes no sense to me. + + break; + + case state_3_connected: + + S->peer_receiver_busy = 0; + + // Erratum: Flow chart has "check need for response here." + + // check_need_for_response() does the following: + // - for command & P=1, send RR or RNR. + // - for response & F=1, error A. + + // SREJ can only be a response. We don't want to produce an error when F=1. + + if (is_good_nr(S,nr)) { + + if (f) { + SET_VA(nr); + } + STOP_T1; + START_T3; + select_t1_value(S); + + + int num_resent = resend_for_srej (S, nr, info, info_len); + if (num_resent) { + +// my addition +// Erratum: We sent I frame(s) and want to timeout if no ack comes back. +// We also sent N(R), from V(R), so no need for extra RR at the end only for that. + +// We would sometimes end up in a situation where T1 was stopped on +// both ends and everyone would wait for the other guy to timeout and do something. +// My solution was to Start T1 after every place we send an I frame if not already there. + + STOP_T3; + START_T1; + S->acknowledge_pending = 0; + } + // keep same state. + } + else { + nr_error_recovery (S); + // Erratum? Flow chart shows state 1 but that would not be appropriate if modulo is 128. + enter_new_state (S, S->modulo == 128 ? state_5_awaiting_v22_connection : state_1_awaiting_connection, __func__, __LINE__); + } + break; + + case state_4_timer_recovery: + + if (s_debug_timers) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("state 4 timer recovery, %s %d nr=%d, f=%d\n", __func__, __LINE__, nr, f); + } + + S->peer_receiver_busy = 0; + + // Erratum: Original Flow chart has "check need for response here." + // The 2006 version correctly removed it. + + // check_need_for_response() does the following: + // - for command & P=1, send RR or RNR. + // - for response & F=1, error A. + + // SREJ can only be a response. We don't want to produce an error when F=1. + + + // The flow chart splits into two paths for command/response with a lot of duplication. + // Command path has been omitted because SREJ can only be response. + + STOP_T1; + select_t1_value(S); + + if (is_good_nr(S,nr)) { + + if (f) { // f=1 means ack up thru previous sequence. + // Erratum: 2006 version tests "P". Original has "F." + SET_VA(nr); + + if (s_debug_timers) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("state 4 timer recovery, %s %d set v(a)= %d\n", __func__, __LINE__, S->va); + } + } + + if (S->vs == S->va) { // ACKs all caught up. Back to state 3. + + // Erratum: I think this is unreachable. + // If the other side is asking for I frame with sequence X, it must have + // received X+1 or later. That means my V(S) must be X+2 or greater. + // So, I don't think we can ever have V(S) == V(A) here. + // If we were to remove the 'if' test and true part, case 4 would then + // be exactly the same as state 4. We need to rely on RR to get us + // back to state 3. + + START_T3; + SET_RC(0); // My enhancement. See Erratum note in select_t1_value. + enter_new_state (S, state_3_connected, __func__, __LINE__); + + // text_color_set(DW_COLOR_ERROR); + // dw_printf ("state 4 timer recovery, go to state 3 \n"); + } + else { + +// Erratum: Difference between two AX.25 revisions. + +#if 1 // This is from the original protocol spec. + // Resend I frame with N(S) equal to the N(R) in the SREJ. + + //text_color_set(DW_COLOR_ERROR); + //dw_printf ("state 4 timer recovery, send requested frame(s) \n"); + + int num_resent = resend_for_srej (S, nr, info, info_len); + if (num_resent) { +// my addition +// Erratum: We sent I frame(s) and want to timeout if no ack comes back. +// We also sent N(R), from V(R), so no need for extra RR at the end only for that. + +// We would sometimes end up in a situation where T1 was stopped on +// both ends and everyone would wait for the other guy to timeout and do something. +// My solution was to Start T1 after every place we send an I frame if not already there. + + STOP_T3; + START_T1; + S->acknowledge_pending = 0; + } +#else // Erratum! This is from the 2006 revision. + // We should resend only the single requested I frame. + // I think there was a cut-n-paste from the REJ flow chart and this particular place did not get changed. + + invoke_retransmission(S); +#endif + } + } + else { + nr_error_recovery (S); + enter_new_state (S, S->modulo == 128 ? state_5_awaiting_v22_connection : state_1_awaiting_connection, __func__, __LINE__); + } + break; + } + +} /* end srej_frame */ + +/*------------------------------------------------------------------------------ + * + * Name: resend_for_srej + * + * Purpose: Resend the I frame(s) specified in SREJ response. + * + * Inputs: S - Data Link State Machine. + * nr - N(R) from the frame. Peer has asked for a resend of I frame with this N(S). + * info - Information field, might contain additional sequence numbers for Multi-SREJ. + * info_len - Information field length, bytes. + * + * Returns: Number of frames sent. Should be at least one. + * + * Description: Simply resend requested frame(s). + * The calling context will worry about the F bit and other state stuff. + * + *------------------------------------------------------------------------------*/ + +static int resend_for_srej (ax25_dlsm_t *S, int nr, unsigned char *info, int info_len) +{ + cmdres_t cr = cr_cmd; + int i_frame_nr = S->vr; + int i_frame_ns = nr; + int p = 0; + int num_resent = 0; + + // Resend I frame with N(S) equal to the N(R) in the SREJ. + // Additional sequence numbers can be in optional information part. + + cdata_t *txdata = S->txdata_by_ns[i_frame_ns]; + + if (txdata != NULL) { + packet_t pp = ax25_i_frame (S->addrs, S->num_addr, cr, S->modulo, i_frame_nr, i_frame_ns, p, txdata->pid, (unsigned char *)(txdata->data), txdata->len); + // dw_printf ("calling lm_data_request for I frame, %s line %d\n", __func__, __LINE__); + lm_data_request (S->chan, TQ_PRIO_1_LO, pp); + num_resent++; + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Stream %d: INTERNAL ERROR for SREJ. I frame for N(S)=%d is not available.\n", S->stream_id, i_frame_ns); + } + +// Multi-SREJ if there is an information part. + + int j; + for (j = 0; j < info_len; j++) { + + // We can have a single sequence number like this: + // xxx00000 (mod 8) + // xxxxxxx0 (mod 128) + // or we can have span (mod 128 only) like this, with the first and last: + // xxxxxxx1 + // xxxxxxx1 + // + // Note that the sequence number is shifted left by one + // and if the LSB is set, there should be two adjacent bytes + // with it set. + + if (S->modulo == 8) { + i_frame_ns = (info[j] >> 5) & 0x07; // no provision for span. + } + else { + i_frame_ns = (info[j] >> 1) & 0x7f; // TODO: test LSB and possible loop here. + } + + txdata = S->txdata_by_ns[i_frame_ns]; + if (txdata != NULL) { + packet_t pp = ax25_i_frame (S->addrs, S->num_addr, cr, S->modulo, i_frame_nr, i_frame_ns, p, txdata->pid, (unsigned char *)(txdata->data), txdata->len); + lm_data_request (S->chan, TQ_PRIO_1_LO, pp); + num_resent++; + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Stream %d: INTERNAL ERROR for Multi-SREJ. I frame for N(S)=%d is not available.\n", S->stream_id, i_frame_ns); + } + } + return (num_resent); + +} /* end resend_for_srej */ + + + + +/*------------------------------------------------------------------------------ + * + * Name: sabm_e_frame + * + * Purpose: Process SABM or SABME Frame. + * + * Inputs: S - Data Link State Machine. + * + * extended - True for SABME. False for SABM. + * + * p - Poll bit. TODO: What does it mean in this case? + * + * Description: This is a request, from the other end, to establish a connection. + * + * 4.3.3.1. Set Asynchronous Balanced Mode (SABM) Command + * + * The SABM command places two Terminal Node Comtrollers (TNC) in the asynchronous balanced mode + * (modulo 8). This a balanced mode of operation in which both devices are treated as equals or peers. + * + * Information fields are not allowed in SABM commands. Any outstanding I frames left when the SABM + * command is issued remain unacknowledged. + * + * The TNC confirms reception and acceptance of a SABM command by sending a UA response frame at the + * earliest opportunity. If the TNC is not capable of accepting a SABM command, it responds with a DM frame if + * possible. + * + * 4.3.3.2. Set Asynchronous Balanced Mode Extended (SABME) Command + * + * The SABME command places two TNCs in the asynchronous balanced mode extended (modulo 128). This + * is a balanced mode of operation in which both devices are treated as equals or peers. + * Information fields are not allowed in SABME commands. Any outstanding I frames left when the SABME + * command is issued remains unacknowledged. + * + * The TNC confirms reception and acceptance of a SABME command by sending a UA response frame at the + * earliest opportunity. If the TNC is not capable of accepting a SABME command, it responds with a DM frame. + * + * A TNC that uses a version of AX.25 prior to v2.2 responds with a FRMR. ** (see note below) + * + * + * Note: The KPC-3+, which does not appear to support v2.2, responds with a DM. + * The 2.0 spec, section 2.3.4.3.5, states, "While a DXE is in the disconnected mode, it will respond + * to any command other than a SABM or UI frame with a DM response with the P/F bit set to 1." + * I think it is a bug in the KPC but I can see how someone might implement it that way. + * However, another place says FRMR is sent for any unrecognized frame type. That would seem to take priority. + * + *------------------------------------------------------------------------------*/ + +static void sabm_e_frame (ax25_dlsm_t *S, int extended, int p) +{ + + switch (S->state) { + + case state_0_disconnected: + + // Flow chart has decision: "Able to establish?" + // I think this means, are we willing to accept connection requests? + // We are always willing to accept connections. + // Of course, we wouldn't get this far if local callsigns were not "registered." + + if (extended) { + set_version_2_2 (S); + } + else { + set_version_2_0 (S); + } + + cmdres_t res = cr_res; + int f = p; // I don't understand the purpose of "P" in SABM/SABME + // but we dutifully copy it into "F" for the UA response. + int nopid = 0; // PID is only for I and UI. + + packet_t pp = ax25_u_frame (S->addrs, S->num_addr, res, frame_type_U_UA, f, nopid, NULL, 0); + lm_data_request (S->chan, TQ_PRIO_1_LO, pp); + + clear_exception_conditions (S); + + SET_VS(0); + SET_VA(0); + SET_VR(0); + + text_color_set(DW_COLOR_INFO); + dw_printf ("Stream %d: Connected to %s. (%s)\n", S->stream_id, S->addrs[PEERCALL], extended ? "v2.2" : "v2.0"); + + // dl connect indication - inform the client app. + int incoming = 1; + server_link_established (S->chan, S->client, S->addrs[PEERCALL], S->addrs[OWNCALL], incoming); + + INIT_T1V_SRT; + + START_T3; + SET_RC(0); // My enhancement. See Erratum note in select_t1_value. + enter_new_state (S, state_3_connected, __func__, __LINE__); + break; + + case state_1_awaiting_connection: + + // Don't combine with state 5. They are slightly different. + + if (extended) { // SABME - respond with DM, enter state 5. + cmdres_t res = cr_res; + int f = p; + int nopid = 0; + + packet_t pp = ax25_u_frame (S->addrs, S->num_addr, res, frame_type_U_DM, f, nopid, NULL, 0); + lm_data_request (S->chan, TQ_PRIO_1_LO, pp); + enter_new_state (S, state_5_awaiting_v22_connection, __func__, __LINE__); + } + else { // SABM - respond with UA. + + // Erratum! 2006 version shows SAMBE twice for state 1. + // First one should be SABM in last page of Figure C4.2 + // Original appears to be correct. + + cmdres_t res = cr_res; + int f = p; + int nopid = 0; + + packet_t pp = ax25_u_frame (S->addrs, S->num_addr, res, frame_type_U_UA, f, nopid, NULL, 0); + lm_data_request (S->chan, TQ_PRIO_1_LO, pp); + // stay in state 1. + } + break; + + case state_5_awaiting_v22_connection: + + if (extended) { // SABME - respond with UA + cmdres_t res = cr_res; + int f = p; + int nopid = 0; + + packet_t pp = ax25_u_frame (S->addrs, S->num_addr, res, frame_type_U_UA, f, nopid, NULL, 0); + lm_data_request (S->chan, TQ_PRIO_1_LO, pp); + // stay in state 5 + } + else { // SABM, respond with UA, enter state 1 + cmdres_t res = cr_res; + int f = p; + int nopid = 0; + + packet_t pp = ax25_u_frame (S->addrs, S->num_addr, res, frame_type_U_UA, f, nopid, NULL, 0); + lm_data_request (S->chan, TQ_PRIO_1_LO, pp); + enter_new_state (S, state_1_awaiting_connection, __func__, __LINE__); + } + break; + + case state_2_awaiting_release: + + // Erratum! Flow charts don't list SABME for state 2. + // Probably just want to treat it the same as SABM here. + + { + cmdres_t res = cr_res; + int f = p; + int nopid = 0; + + packet_t pp = ax25_u_frame (S->addrs, S->num_addr, res, frame_type_U_DM, f, nopid, NULL, 0); + lm_data_request (S->chan, TQ_PRIO_0_HI, pp); // expedited + // stay in state 2. + } + break; + + case state_3_connected: + case state_4_timer_recovery: + + { + cmdres_t res = cr_res; + int f = p; + int nopid = 0; + + packet_t pp = ax25_u_frame (S->addrs, S->num_addr, res, frame_type_U_UA, f, nopid, NULL, 0); + lm_data_request (S->chan, TQ_PRIO_1_LO, pp); + + // State 3 & 4 handling are the same except for this one difference. + if (S->state == state_4_timer_recovery) { + if (extended) { + set_version_2_2 (S); + } + else { + set_version_2_0 (S); + } + } + + clear_exception_conditions (S); + if (s_debug_protocol_errors) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Stream %d: AX.25 Protocol Error F: Data Link reset; i.e. SABM(e) received in state %d.\n", S->stream_id, S->state); + } + if (S->vs != S->va) { + discard_i_queue (S); + // dl connect indication + int incoming = 1; + server_link_established (S->chan, S->client, S->addrs[PEERCALL], S->addrs[OWNCALL], incoming); + } + STOP_T1; + START_T3; + SET_VS(0); + SET_VA(0); + SET_VR(0); + SET_RC(0); // My enhancement. See Erratum note in select_t1_value. + enter_new_state (S, state_3_connected, __func__, __LINE__); + } + break; + } + +} /* end sabm_e_frame */ + + + +/*------------------------------------------------------------------------------ + * + * Name: disc_frame + * + * Purpose: Process DISC command. + * + * Inputs: S - Data Link State Machine. + * p - Poll bit. + * + * Description: 4.3.3.3. Disconnect (DISC) Command + * + * The DISC command terminates a link session between two stations. An information field is not permitted in + * a DISC command frame. + * + * Prior to acting on the DISC frame, the receiving TNC confirms acceptance of the DISC by issuing a UA + * response frame at its earliest opportunity. The TNC sending the DISC enters the disconnected state when it + * receives the UA response. + * + * Any unacknowledged I frames left when this command is acted upon remain unacknowledged. + * + * + * 6.3.4. Link Disconnection + * + * While in the information-transfer state, either TNC may indicate a request to disconnect the link by transmitting + * a DISC command frame and starting timer T1. + * + * After receiving a valid DISC command, the TNC sends a UA response frame and enters the disconnected + * state. After receiving a UA or DM response to a sent DISC command, the TNC cancels timer T1 and enters the + * disconnected state. + * + * If a UA or DM response is not correctly received before T1 times out, the DISC frame is sent again and T1 is + * restarted. If this happens N2 times, the TNC enters the disconnected state. + * + *------------------------------------------------------------------------------*/ + +static void disc_frame (ax25_dlsm_t *S, int p) +{ + + switch (S->state) { + + case state_0_disconnected: + case state_1_awaiting_connection: + case state_5_awaiting_v22_connection: + + { + cmdres_t res = cr_res; + int f = p; + int nopid = 0; + + packet_t pp = ax25_u_frame (S->addrs, S->num_addr, res, frame_type_U_DM, f, nopid, NULL, 0); + lm_data_request (S->chan, TQ_PRIO_1_LO, pp); + } + // keep current state, 0, 1, or 5. + break; + + case state_2_awaiting_release: + + { + cmdres_t res = cr_res; + int f = p; + int nopid = 0; + + packet_t pp = ax25_u_frame (S->addrs, S->num_addr, res, frame_type_U_UA, f, nopid, NULL, 0); + lm_data_request (S->chan, TQ_PRIO_0_HI, pp); // expedited + } + // keep current state, 2. + break; + + case state_3_connected: + case state_4_timer_recovery: + + { + discard_i_queue (S); + + cmdres_t res = cr_res; + int f = p; + int nopid = 0; + + packet_t pp = ax25_u_frame (S->addrs, S->num_addr, res, frame_type_U_UA, f, nopid, NULL, 0); + lm_data_request (S->chan, TQ_PRIO_1_LO, pp); + + // dl disconnect *indication* + text_color_set(DW_COLOR_INFO); + dw_printf ("Stream %d: Disconnected from %s.\n", S->stream_id, S->addrs[PEERCALL]); + server_link_terminated (S->chan, S->client, S->addrs[PEERCALL], S->addrs[OWNCALL], 0); + + STOP_T1; + STOP_T3; + enter_new_state (S, state_0_disconnected, __func__, __LINE__); + } + break; + } + +} /* end disc_frame */ + + + +/*------------------------------------------------------------------------------ + * + * Name: dm_frame + * + * Purpose: Process DM Response Frame. + * + * Inputs: S - Data Link State Machine. + * f - Final bit. + * + * Description: 4.3.3.1. Set Asynchronous Balanced Mode (SABM) Command + * + * The TNC confirms reception and acceptance of a SABM command by sending a UA response frame at the + * earliest opportunity. If the TNC is not capable of accepting a SABM command, it responds with a DM frame if + * possible. + * + * The TNC confirms reception and acceptance of a SABME command by sending a UA response frame at the + * earliest opportunity. If the TNC is not capable of accepting a SABME command, it responds with a DM frame. + * + * A TNC that uses a version of AX.25 prior to v2.2 responds with a FRMR. + * ( I think the KPC-3+ has a bug - it replies with DM - WB2OSZ ) + * + * 4.3.3.5. Disconnected Mode (DM) Response + * + * The disconnected mode response is sent whenever a TNC receives a frame other than a SABM(E) or UI + * frame while in a disconnected mode. The disconnected mode response also indicates that the TNC cannot + * accept a connection at the moment. The DM response does not have an information field. + * Whenever a SABM(E) frame is received and it is determined that a connection is not possible, a DM frame is + * sent. This indicates that the called station cannot accept a connection at that time. + * While a TNC is in the disconnected mode, it responds to any command other than a SABM(E) or UI frame + * with a DM response with the P/F bit set to "1". + * + * 4.3.3.6. Unnumbered Information (UI) Frame + * + * A received UI frame with the P bit set causes a response to be transmitted. This response is a DM frame when + * in the disconnected state, or an RR (or RNR, if appropriate) frame in the information transfer state. + * + * 6.3.1. AX.25 Link Connection Establishment + * + * If the distant TNC receives a SABM command and cannot enter the indicated state, it sends a DM frame. + * When the originating TNC receives a DM response to its SABM(E) frame, it cancels its T1 timer and does + * not enter the information-transfer state. + * + * 6.3.4. Link Disconnection + * + * After receiving a valid DISC command, the TNC sends a UA response frame and enters the disconnected + * state. After receiving a UA or DM response to a sent DISC command, the TNC cancels timer T1 and enters the + * disconnected state. + * + * 6.5. Resetting Procedure + * + * If a DM response is received, the TNC enters the disconnected state and stops timer T1. If timer T1 expires + * before a UA or DM response frame is received, the SABM(E) is retransmitted and timer T1 restarted. If timer T1 + * expires N2 times, the TNC enters the disconnected state. Any previously existing link conditions are cleared. + * Other commands or responses received by the TNC before completion of the reset procedure are discarded. + * + * Erratum: The flow chart shows the same behavior for states 1 and 5. + * For state 5, I think we should treat DM the same as FRMR. + * + *------------------------------------------------------------------------------*/ + + +static void dm_frame (ax25_dlsm_t *S, int f) +{ + switch (S->state) { + + case state_0_disconnected: + // Do nothing. + break; + + case state_1_awaiting_connection: + + if (f == 1) { + discard_i_queue (S); + // dl disconnect *indication* + text_color_set(DW_COLOR_INFO); + dw_printf ("Stream %d: Disconnected from %s.\n", S->stream_id, S->addrs[PEERCALL]); + server_link_terminated (S->chan, S->client, S->addrs[PEERCALL], S->addrs[OWNCALL], 0); + STOP_T1; + enter_new_state (S, state_0_disconnected, __func__, __LINE__); + } + else { + // keep current state. + } + break; + + case state_2_awaiting_release: + + if (f == 1) { + + // Erratum! Original flow chart, page 91, shows DL-CONNECT confirm. + // It should clearly be DISconnect rather than Connect. + + // 2006 has DISCONNECT *Indication*. + // Should it be indication or confirm? Not sure. + + // dl disconnect *confirm* + text_color_set(DW_COLOR_INFO); + dw_printf ("Stream %d: Disconnected from %s.\n", S->stream_id, S->addrs[PEERCALL]); + server_link_terminated (S->chan, S->client, S->addrs[PEERCALL], S->addrs[OWNCALL], 0); + STOP_T1; + enter_new_state (S, state_0_disconnected, __func__, __LINE__); + } + else { + // keep current state. + } + break; + + case state_3_connected: + case state_4_timer_recovery: + + if (s_debug_protocol_errors) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Stream %d: AX.25 Protocol Error E: DM received in state %d.\n", S->stream_id, S->state); + } + // dl disconnect *indication* + text_color_set(DW_COLOR_INFO); + dw_printf ("Stream %d: Disconnected from %s.\n", S->stream_id, S->addrs[PEERCALL]); + server_link_terminated (S->chan, S->client, S->addrs[PEERCALL], S->addrs[OWNCALL], 0); + discard_i_queue (S); + STOP_T1; + STOP_T3; + enter_new_state (S, state_0_disconnected, __func__, __LINE__); + break; + + case state_5_awaiting_v22_connection: + +#if 0 + // Erratum: The flow chart says we should do this. + // I'm not saying it is wrong. I just found it necessary to change this + // to work around an apparent bug in a popular hardware TNC. + + if (f == 1) { + discard_i_queue (S); + // dl disconnect *indication* + text_color_set(DW_COLOR_INFO); + dw_printf ("Stream %d: Disconnected from %s.\n", S->stream_id, S->addrs[PEERCALL]); + server_link_terminated (S->chan, S->client, S->addrs[PEERCALL], S->addrs[OWNCALL], 0); + STOP_T1; + enter_new_state (S, state_0_disconnected, __func__, __LINE__); + } + else { + // keep current state. + } +#else + // Erratum: This is not in original spec. It's copied from the FRMR case. + + // I was expecting FRMR to mean the other end did not understand v2.2. + // Experimentation, with KPC-3+, revealed that we get DM instead. + // One part of the the 2.0 spec sort of indicates this might be intentional. + // But another part more clearly states it should be FRMR. + + // At first I thought it was an error in the protocol spec. + // Later, I tend to believe it was just implemented wrong in the KPC-3+. + + if (f == 1) { + text_color_set(DW_COLOR_INFO); + dw_printf ("%s doesn't understand AX.25 v2.2. Trying v2.0 ...\n", S->addrs[PEERCALL]); + + INIT_T1V_SRT; + + // Erratum: page 105. We are in state 5 so I think that means modulo is 128, + // k is probably something > 7, and selective reject is enabled. + // At the end of this we go to state 1. + // It seems to me, that we really want to set version 2.0 in here so we have + // compatible settings. + + set_version_2_0 (S); + + establish_data_link (S); + S->layer_3_initiated = 1; + enter_new_state (S, state_1_awaiting_connection, __func__, __LINE__); + } +#endif + break; + } + +} /* end dm_frame */ + + + + +/*------------------------------------------------------------------------------ + * + * Name: UA_frame + * + * Purpose: Process UA Response Frame. + * + * Inputs: S - Data Link State Machine. + * f - Final bit. + * + * Description: 4.3.3.4. Unnumbered Acknowledge (UA) Response + * + * The UA response frame acknowledges the reception and acceptance of a SABM(E) or DISC command + * frame. A received command is not actually processed until the UA response frame is sent. Information fields are + * not permitted in a UA frame. + * + * 4.4.1. TNC Busy Condition + * + * When a TNC is temporarily unable to receive I frames (e.g., when receive buffers are full), it sends a Receive + * Not Ready (RNR) frame. This informs the sending TNC that the receiving TNC cannot handle any more I + * frames at the moment. This receiving TNC clears this condition by the sending a UA, RR, REJ or SABM(E) + * command frame. + * + * 6.2. Poll/Final (P/F) Bit Procedures + * + * The response frame returned by a TNC depends on the previous command received, as described in the + * following paragraphs. + * The next response frame returned by the TNC to a SABM(E) or DISC command with the P bit set to "1" is a + * UA or DM response with the F bit set to "1". + * + * 6.3.1. AX.25 Link Connection Establishment + * + * To connect to a distant TNC, the originating TNC sends a SABM command frame to the distant TNC and + * starts its T1 timer. If the distant TNC exists and accepts the connect request, it responds with a UA response + * frame and resets all of its internal state variables (V(S), V(A) and V(R)). Reception of the UA response frame by + * the originating TNC causes it to cancel the T1 timer and set its internal state variables to "0". + * + * 6.5. Resetting Procedure + * + * A TNC initiates a reset procedure whenever it receives an unexpected UA response frame, or after receipt of + * a FRMR frame from a TNC using an older version of the protocol. + * + *------------------------------------------------------------------------------*/ + +static void ua_frame (ax25_dlsm_t *S, int f) +{ + switch (S->state) { + + case state_0_disconnected: + + // Erratum: flow chart says errors C and D. Neither one really makes sense. + // "Unexpected UA in states 3, 4, or 5." We are in state 0 here. + // "UA received without F=1 when SABM or DISC was sent P=1." + + if (s_debug_protocol_errors) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Stream %d: AX.25 Protocol Error C: Unexpected UA in state %d.\n", S->stream_id, S->state); + } + break; + + case state_1_awaiting_connection: + case state_5_awaiting_v22_connection: + + if (f == 1) { + if (S->layer_3_initiated) { + text_color_set(DW_COLOR_INFO); + // TODO: add via if appropriate. + dw_printf ("Stream %d: Connected to %s. (%s)\n", S->stream_id, S->addrs[PEERCALL], S->state == state_5_awaiting_v22_connection ? "v2.2" : "v2.0"); + // There is a subtle difference here between connect confirm and indication. + // connect *confirm* means "has been made" + // The AGW API distinguishes between incoming (initiated by other station) and + // outgoing (initiated by me) connections. + int incoming = 0; + server_link_established (S->chan, S->client, S->addrs[PEERCALL], S->addrs[OWNCALL], incoming); + } + else if (S->vs != S->va) { +#if 1 + // Erratum: 2006 version has this. + + INIT_T1V_SRT; + + START_T3; // Erratum: Rather pointless because we immediately stop it below. + // In the original flow chart, that is. + // I think there is an error as explained below. + // In my version this is still pointless because we start T3 later. + +#else + // Erratum: Original version has this. + // I think this could be harmful. + // The client app might have been impatient and started sending + // information already. I don't see why we would want to discard it. + + discard_i_queue (S); +#endif + text_color_set(DW_COLOR_INFO); + dw_printf ("Stream %d: Connected to %s. (%s)\n", S->stream_id, S->addrs[PEERCALL], S->state == state_5_awaiting_v22_connection ? "v2.2" : "v2.0"); + + // Erratum: 2006 version says DL-CONNECT *confirm* but original has *indication*. + + // connect *indication* means "has been requested". + // *confirm* seems right because we got a reply from the other side. + + int incoming = 0; + server_link_established (S->chan, S->client, S->addrs[PEERCALL], S->addrs[OWNCALL], incoming); + } + + STOP_T1; +#if 1 // My version. + START_T3; +#else // As shown in flow chart. + STOP_T3; // Erratum? I think this is wrong. + // We are about to enter state 3. When in state 3 either T1 or T3 should be + // running. In state 3, we always see start one / stop the other pairs except where + // we are about to enter a different state. + // Since there is nothing outstanding where we expect a response, T1 would + // not be started. +#endif + SET_VS(0); + SET_VA(0); + SET_VR(0); + select_t1_value (S); + +// Erratum: mdl_negotiate_request does not appear in the SDL flow chart. +// It is mentioned here: +// +// C5.3 Internal Operation of the Machine +// +// The Management Data link State Machine handles the negotiation/notification of +// operational parameters. It uses a single command/response exchange to negotiate the +// final values of negotiable parameters. +// +// The station initiating the AX.25 connection will send an XID command after it receives +// the UA frame. If the other station is using a version of AX.25 earlier than 2.2, it will +// respond with an FRMR of the XID command and the default version 2.0 parameters will +// be used. If the other station is using version 2.2 or better, it will respond with an XID +// response. + + if (S->state == state_5_awaiting_v22_connection) { + mdl_negotiate_request (S); + } + + SET_RC(0); // My enhancement. See Erratum note in select_t1_value. + enter_new_state (S, state_3_connected, __func__, __LINE__); + } + else { + if (s_debug_protocol_errors) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Stream %d: AX.25 Protocol Error D: UA received without F=1 when SABM or DISC was sent P=1.\n", S->stream_id); + } + // stay in current state, either 1 or 5. + } + break; + + case state_2_awaiting_release: + + // Erratum: 2006 version is missing yes/no labels on this test. + // DL-ERROR Indication does not mention error D. + + if (f == 1) { + text_color_set(DW_COLOR_INFO); + dw_printf ("Stream %d: Disconnected from %s.\n", S->stream_id, S->addrs[PEERCALL]); + server_link_terminated (S->chan, S->client, S->addrs[PEERCALL], S->addrs[OWNCALL], 0); + STOP_T1; + enter_new_state (S, state_0_disconnected, __func__, __LINE__); + } + else { + if (s_debug_protocol_errors) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Stream %d: AX.25 Protocol Error D: UA received without F=1 when SABM or DISC was sent P=1.\n", S->stream_id); + } + // stay in same state. + } + break; + + case state_3_connected: + case state_4_timer_recovery: + + if (s_debug_protocol_errors) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Stream %d: AX.25 Protocol Error C: Unexpected UA in state %d.\n", S->stream_id, S->state); + } + establish_data_link (S); + S->layer_3_initiated = 0; + + // Erratum? Flow chart goes to state 1. Wouldn't we want this to be state 5 if modulo is 128? + enter_new_state (S, S->modulo == 128 ? state_5_awaiting_v22_connection : state_1_awaiting_connection, __func__, __LINE__); + break; + } + +} /* end ua_frame */ + + + +/*------------------------------------------------------------------------------ + * + * Name: frmr_frame + * + * Purpose: Process FRMR Response Frame. + * + * Inputs: S - Data Link State Machine. + * + * Description: 4.3.3.2. Set Asynchronous Balanced Mode Extended (SABME) Command + * ... + * The TNC confirms reception and acceptance of a SABME command by sending a UA response frame at the + * earliest opportunity. If the TNC is not capable of accepting a SABME command, it responds with a DM frame. + * A TNC that uses a version of AX.25 prior to v2.2 responds with a FRMR. + * + * 4.3.3.9. FRMR Response Frame + * + * The FRMR response is removed from the standard for the following reasons: + * a) UI frame transmission was not allowed during FRMR recovery; + * b) During FRMR recovery, the link could not be reestablished by the station that sent the FRMR; + * c) The above functions are better handled by simply resetting the link with a SABM(E) + UA exchange; + * d) An implementation that receives and process FRMRs but does not transmit them is compatible with older + * versions of the standard; and + * e) SDL is simplified and removes the need for one state. + * This version of AX.25 operates with previous versions of AX.25. It does not generate a FRMR Response + * frame, but handles error conditions by resetting the link. + * + * 6.3.2. Parameter Negotiation Phase + * + * Parameter negotiation occurs at any time. It is accomplished by sending the XID command frame and + * receiving the XID response frame. Implementations of AX.25 prior to version 2.2 respond to an XID command + * frame with a FRMR response frame. The TNC receiving the FRMR uses a default set of parameters compatible + * with previous versions of AX.25. + * + * 6.5. Resetting Procedure + * + * The link resetting procedure initializes both directions of data flow after a unrecoverable error has occurred. + * This resetting procedure is used only in the information-transfer state of an AX.25 link. + * A TNC initiates a reset procedure whenever it receives an unexpected UA response frame, or after receipt of + * a FRMR frame from a TNC using an older version of the protocol. + * + *------------------------------------------------------------------------------*/ + + +static void frmr_frame (ax25_dlsm_t *S) +{ + switch (S->state) { + + case state_0_disconnected: + case state_1_awaiting_connection: + case state_2_awaiting_release: + // Ignore it. Keep current state. + break; + + case state_3_connected: + case state_4_timer_recovery: + + if (s_debug_protocol_errors) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Stream %d: AX.25 Protocol Error K: FRMR not expected in state %d.\n", S->stream_id, S->state); + } + + set_version_2_0 (S); // Erratum: FRMR can only be sent by v2.0. + // Need to force v2.0. Should be added to flow chart. + establish_data_link (S); + S->layer_3_initiated = 0; + enter_new_state (S, state_1_awaiting_connection, __func__, __LINE__); + break; + + case state_5_awaiting_v22_connection: + + text_color_set(DW_COLOR_INFO); + dw_printf ("%s doesn't understand AX.25 v2.2. Trying v2.0 ...\n", S->addrs[PEERCALL]); + + INIT_T1V_SRT; + + set_version_2_0 (S); // Erratum: Need to force v2.0. This is not in flow chart. + + establish_data_link (S); + S->layer_3_initiated = 1; // Erratum? I don't understand the difference here. + // State 1 clears it. State 5 sets it. Why not the same? + + enter_new_state (S, state_1_awaiting_connection, __func__, __LINE__); + break; + } + +// part of state machine for the XID negotiation. + +// I would not expect this to happen. +// To get here: +// We sent SABME. (not SABM) +// Other side responded with UA so it understands v2.2. +// We sent XID command which puts us int the negotiating state. +// Presumably this is in response to the XID and not something else. + +// Anyhow, we will fall back to v2.0 parameters. + + switch (S->mdl_state) { + + case mdl_state_0_ready: + break; + + case mdl_state_1_negotiating: + + set_version_2_0 (S); + S->mdl_state = mdl_state_0_ready; + break; + } + +} /* end frmr_frame */ + + +/*------------------------------------------------------------------------------ + * + * Name: ui_frame + * + * Purpose: Process XID frame for negotiating protocol parameters. + * + * Inputs: S - Data Link State Machine. + * + * cr - Is it command or response? + * + * pf - Poll/Final bit. + * + * Description: 4.3.3.6. Unnumbered Information (UI) Frame + * + * The Unnumbered Information frame contains PID and information fields and passes information along the + * link outside the normal information controls. This allows information fields to be exchanged on the link, bypassing + * flow control. + * + * Because these frames cannot be acknowledged, if one such frame is obliterated, it cannot be recovered. + * A received UI frame with the P bit set causes a response to be transmitted. This response is a DM frame when + * in the disconnected state, or an RR (or RNR, if appropriate) frame in the information transfer state. + * + * Reality: The data link state machine was an add-on after APRS and client APIs were already done. + * UI frames don't go thru here for normal operation. + * The only reason we have this function is so that we can send a response to a UI command with P=1. + * + *------------------------------------------------------------------------------*/ + +static void ui_frame (ax25_dlsm_t *S, cmdres_t cr, int pf) +{ + if (cr == cr_cmd && pf == 1) { + + switch (S->state) { + + case state_0_disconnected: + case state_1_awaiting_connection: + case state_2_awaiting_release: + case state_5_awaiting_v22_connection: + { + cmdres_t r = cr_res; // DM response with F taken from P. + int nopid = 0; // PID applies only for I and UI frames. + + packet_t pp = ax25_u_frame (S->addrs, S->num_addr, r, frame_type_U_DM, pf, nopid, NULL, 0); + lm_data_request (S->chan, TQ_PRIO_1_LO, pp); + } + break; + + case state_3_connected: + case state_4_timer_recovery: + + enquiry_response (S, frame_type_U_UI, pf); + break; + } + } + +} /* end ui_frame */ + + + +/*------------------------------------------------------------------------------ + * + * Name: xid_frame + * + * Purpose: Process XID frame for negotiating protocol parameters. + * + * Inputs: S - Data Link State Machine. + * + * cr - Is it command or response? + * + * pf - Poll/Final bit. + * + * Description: 4.3.3.7 Exchange Identification (XID) Frame + * + * The Exchange Identification frame causes the addressed station to identify itself, and + * to provide its characteristics to the sending station. An information field is optional within + * the XID frame. A station receiving an XID command returns an XID response unless a UA + * response to a mode setting command is awaiting transmission, or a FRMR condition + * exists. + * + * The XID frame complies with ISO 8885. Only those fields applicable to AX.25 are + * described. All other fields are set to an appropriate value. This implementation is + * compatible with any implementation which follows ISO 8885. Only the general-purpose + * XID information field identifier is required in this version of AX.25. + * + * The information field consists of zero or more information elements. The information + * elements start with a Format Identifier (FI) octet. The second octet is the Group Identifier + * (GI). The third and forth octets form the Group Length (GL). The rest of the information + * field contains parameter fields. + * + * The FI takes the value 82 hex for the general-purpose XID information. The GI takes + * the value 80 hex for the parameter-negotiation identifier. The GL indicates the length of + * the associated parameter field. This length is expressed as a two-octet binary number + * representing the length of the associated parameter field in octets. The high-order bits of + * length value are in the first of the two octets. A group length of zero indicates the lack of + * an associated parameter field and that all parameters assume their default values. The GL + * does not include its own length or the length of the GI. + * + * The parameter field contains a series of Parameter Identifier (PI), Parameter Length + * (PL), and Parameter Value (PV) set structures, in that order. Each PI identifies a + * parameter and is one octet in length. Each PL indicates the length of the associated PV in + * octets, and is one octet in length. Each PV contains the parameter value and is PL octets + * in length. The PL does not include its own length or the length of its associated PI. A PL + * value of zero indicates that the associated PV is absent; the parameter assumes the + * default value. A PI/PL/PV set may be omitted if it is not required to convey information, or + * if present values for the parameter are to be used. The PI/PL/PV fields are placed into the + * information field of the XID frame in ascending order. There is only one entry for each + * PI/PL/PV field used. A parameter field containing an unrecognized PI is ignored. An + * omitted parameter field assumes the currently negotiated value. + * + *------------------------------------------------------------------------------*/ + + +static void xid_frame (ax25_dlsm_t *S, cmdres_t cr, int pf, unsigned char *info_ptr, int info_len) +{ + struct xid_param_s param; + char desc[150]; + int ok; + unsigned char xinfo[40]; + int xlen; + cmdres_t res = cr_res; + int f = 1; + int nopid = 0; + packet_t pp; + + + switch (S->mdl_state) { + + case mdl_state_0_ready: + + if (cr == cr_cmd) { + + if (pf == 1) { + +// Take parameters sent by other station. +// Generally we take minimum of what he wants and what I can do. +// Adjust my working configuration and send it back. + + ok = xid_parse (info_ptr, info_len, ¶m, desc, sizeof(desc)); + + if (ok) { + negotiation_response (S, ¶m); + + xlen = xid_encode (¶m, xinfo, res); + + pp = ax25_u_frame (S->addrs, S->num_addr, res, frame_type_U_XID, f, nopid, xinfo, xlen); + lm_data_request (S->chan, TQ_PRIO_1_LO, pp); + } + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Stream %d: AX.25 Protocol Error MDL-A: XID command without P=1.\n", S->stream_id); + } + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Stream %d: AX.25 Protocol Error MDL-B: Unexpected XID response.\n", S->stream_id); + } + break; + + case mdl_state_1_negotiating: + + if (cr == cr_res) { + + if (pf == 1) { + +// Got expected response. Copy into my working parameters. + + ok = xid_parse (info_ptr, info_len, ¶m, desc, sizeof(desc)); + + if (ok) { + complete_negotiation (S, ¶m); + } + + S->mdl_state = mdl_state_0_ready; + STOP_TM201; + +//#define TEST_TEST 1 + +#if TEST_TEST // Send TEST command to see how it responds. + // We currently have no Client API for sending this or reporting result. + { + char info[80] = "The quick brown fox jumps over the lazy dog."; + cmdres_t cmd = cr_cmd; + int p = 0; + int nopid = 0; + packet_t pp; + + pp = ax25_u_frame (S->addrs, S->num_addr, cmd, frame_type_U_TEST, p, nopid, (unsigned char *)info, (int)strlen(info)); + lm_data_request (S->chan, TQ_PRIO_1_LO, pp); + } +#endif + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Stream %d: AX.25 Protocol Error MDL-D: XID response without F=1.\n", S->stream_id); + } + } + else { + // Not expecting to receive a command when I sent one. + // Flow chart says requeue but I just drop it. + // The other end can retry and maybe I will be back to ready state by then. + } + break; + } + +} /* end xid_frame */ + + +/*------------------------------------------------------------------------------ + * + * Name: test_frame + * + * Purpose: Process TEST command for checking link. + * + * Inputs: S - Data Link State Machine. + * + * cr - Is it command or response? + * + * pf - Poll/Final bit. + * + * Description: 4.3.3.8. Test (TEST) Frame + * + * The Test command causes the addressed station to respond with the TEST response at the first respond + * opportunity; this performs a basic test of the data-link control. An information field is optional with the TEST + * command. If present, the received information field is returned, if possible, by the addressed station, with the + * TEST response. The TEST command has no effect on the mode or sequence variables maintained by the station. + * + * A FRMR condition may be established if the received TEST command information field exceeds the maximum + * defined storage capability of the station. If a FRMR response is not returned for this condition, a TEST response + * without an information field is returned. + * + * The station considers the data-link layer test terminated on receipt of the TEST response, or when a time-out + * period has expired. The results of the TEST command/response exchange are made available for interrogation + * by a higher layer. + * + * Erratum: TEST frame is not mentioned in the SDL flow charts. + * Don't know how P/F is supposed to be used. + * Here, the response sends back what was received in the command. + * + *------------------------------------------------------------------------------*/ + + +static void test_frame (ax25_dlsm_t *S, cmdres_t cr, int pf, unsigned char *info_ptr, int info_len) +{ + cmdres_t res = cr_res; + int f = pf; + int nopid = 0; + packet_t pp; + + if (cr == cr_cmd) { + pp = ax25_u_frame (S->addrs, S->num_addr, res, frame_type_U_TEST, f, nopid, info_ptr, info_len); + lm_data_request (S->chan, TQ_PRIO_1_LO, pp); + } + +} /* end test_frame */ + + + +/*------------------------------------------------------------------------------ + * + * Name: dl_timer_expiry + * + * Purpose: Some timer expired. Figure out which one and act accordingly. + * + * Inputs: none. + * + *------------------------------------------------------------------------------*/ + +void dl_timer_expiry (void) +{ + ax25_dlsm_t *p; + double now = dtime_now(); + +// Examine all of the data link state machines. +// Process only those where timer: +// - is running. +// - is not paused. +// - expiration time has arrived or passed. + + for (p = list_head; p != NULL; p = p->next) { + if (p->t1_exp != 0 && p->t1_paused_at == 0 && p->t1_exp <= now) { + p->t1_exp = 0; + p->t1_paused_at = 0; + p->t1_had_expired = 1; + t1_expiry (p); + } + } + + for (p = list_head; p != NULL; p = p->next) { + if (p->t3_exp != 0 && p->t3_exp <= now) { + p->t3_exp = 0; + t3_expiry (p); + } + } + + for (p = list_head; p != NULL; p = p->next) { + if (p->tm201_exp != 0 && p->tm201_paused_at == 0 && p->tm201_exp <= now) { + p->tm201_exp = 0; + p->tm201_paused_at = 0; + tm201_expiry (p); + } + } + +} /* end dl_timer_expiry */ + + +/*------------------------------------------------------------------------------ + * + * Name: t1_expiry + * + * Purpose: Handle T1 timer expiration for outstanding I frame or P-bit. + * + * Inputs: S - Data Link State Machine. + * + * Description: 4.4.5.1. T1 Timer Recovery + * + * If a transmission error causes a TNC to fail to receive (or to receive and discard) a single I frame, or the last I + * frame in a sequence of I frames, then the TNC does not detect a send-sequence-number error and consequently + * does not transmit a REJ/SREJ. The TNC that transmitted the unacknowledged I frame(s) following the completion + * of timeout period T1, takes appropriate recovery action to determine when I frame retransmission as described + * in Section 6.4.10 should begin. This condition is cleared by the reception of an acknowledgement for the sent + * frame(s), or by the link being reset. + * + * 6.7.1.1. Acknowledgment Timer T1 + * + * T1, the Acknowledgement Timer, ensures that a TNC does not wait indefinitely for a response to a frame it + * sends. This timer cannot be expressed in absolute time; the time required to send frames varies greatly with the + * signaling rate used at Layer 1. T1 should take at least twice the amount of time it would take to send maximum + * length frame to the distant TNC and get the proper response frame back from the distant TNC. This allows time + * for the distant TNC to do some processing before responding. + * If Layer 2 repeaters are used, the value of T1 should be adjusted according to the number of repeaters through + * which the frame is being transferred. + * + *------------------------------------------------------------------------------*/ + +// Make timer start, stop, expiry a different color to stand out. + +#define DW_COLOR_DEBUG_TIMER DW_COLOR_ERROR + + +static void t1_expiry (ax25_dlsm_t *S) +{ + + if (s_debug_timers) { + double now = dtime_now(); + + text_color_set(DW_COLOR_DEBUG_TIMER); + dw_printf ("t1_expiry (), [now=%.3f], state=%d, rc=%d\n", now - S->start_time, S->state, S->rc); + } + + switch (S->state) { + + case state_0_disconnected: + + // Ignore it. + break; + + case state_1_awaiting_connection: + case state_5_awaiting_v22_connection: + + // MAXV22 hack. + // If we already sent the maximum number of SABME, fall back to v2.0 SABM. + + if (S->state == state_5_awaiting_v22_connection && S->rc == g_misc_config_p->maxv22) { + set_version_2_0 (S); + enter_new_state (S, state_1_awaiting_connection, __func__, __LINE__); + } + + if (S->rc == S->n2_retry) { + discard_i_queue(S); + text_color_set(DW_COLOR_INFO); + dw_printf ("Failed to connect to %s after %d tries.\n", S->addrs[PEERCALL], S->n2_retry); + server_link_terminated (S->chan, S->client, S->addrs[PEERCALL], S->addrs[OWNCALL], 1); + enter_new_state (S, state_0_disconnected, __func__, __LINE__); + } + else { + cmdres_t cmd = cr_cmd; + int p = 1; + int nopid = 0; + + packet_t pp; + + SET_RC(S->rc+1); + if (S->rc > S->peak_rc_value) S->peak_rc_value = S->rc; // Keep statistics. + + pp = ax25_u_frame (S->addrs, S->num_addr, cmd, (S->state == state_5_awaiting_v22_connection) ? frame_type_U_SABME : frame_type_U_SABM, p, nopid, NULL, 0); + lm_data_request (S->chan, TQ_PRIO_1_LO, pp); + select_t1_value(S); + START_T1; + // Keep same state. + } + break; + + case state_2_awaiting_release: + + if (S->rc == S->n2_retry) { + text_color_set(DW_COLOR_INFO); + dw_printf ("Stream %d: Disconnected from %s.\n", S->stream_id, S->addrs[PEERCALL]); + server_link_terminated (S->chan, S->client, S->addrs[PEERCALL], S->addrs[OWNCALL], 0); + enter_new_state (S, state_0_disconnected, __func__, __LINE__); + } + else { + cmdres_t cmd = cr_cmd; + int p = 1; + int nopid = 0; + + packet_t pp; + + SET_RC(S->rc+1); + if (S->rc > S->peak_rc_value) S->peak_rc_value = S->rc; + + pp = ax25_u_frame (S->addrs, S->num_addr, cmd, frame_type_U_DISC, p, nopid, NULL, 0); + lm_data_request (S->chan, TQ_PRIO_1_LO, pp); + select_t1_value(S); + START_T1; + // stay in same state + } + break; + + case state_3_connected: + + SET_RC(1); + transmit_enquiry (S); + enter_new_state (S, state_4_timer_recovery, __func__, __LINE__); + break; + + case state_4_timer_recovery: + + if (S->rc == S->n2_retry) { + +// Erratum: 2006 version, page 103, is missing yes/no labels on decision blocks. + + if (S->va != S->vs) { + + if (s_debug_protocol_errors) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Stream %d: AX.25 Protocol Error I: %d timeouts: unacknowledged sent data.\n", S->stream_id, S->n2_retry); + } + } + else if (S->peer_receiver_busy) { + + if (s_debug_protocol_errors) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Stream %d: AX.25 Protocol Error U: %d timeouts: extended peer busy condition.\n", S->stream_id, S->n2_retry); + } + } + else { + + if (s_debug_protocol_errors) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Stream %d: AX.25 Protocol Error T: %d timeouts: no response to enquiry.\n", S->stream_id, S->n2_retry); + } + } + + // Erratum: Flow chart says DL-DISCONNECT "request" in both original and 2006 revision. + // That is clearly wrong because a "request" would come FROM the higher level protocol/client app. + // I think it should be "indication" rather than "confirm" because the peer condition is unknown. + + // dl disconnect *indication* + text_color_set(DW_COLOR_INFO); + dw_printf ("Stream %d: Disconnected from %s due to timeouts.\n", S->stream_id, S->addrs[PEERCALL]); + server_link_terminated (S->chan, S->client, S->addrs[PEERCALL], S->addrs[OWNCALL], 1); + + discard_i_queue (S); + + cmdres_t cr = cr_res; // DM can only be response. + int f = 0; // Erratum: Assuming F=0 because it is not response to P=1 + int nopid = 0; + + packet_t pp = ax25_u_frame (S->addrs, S->num_addr, cr, frame_type_U_DM, f, nopid, NULL, 0); + lm_data_request (S->chan, TQ_PRIO_1_LO, pp); + + enter_new_state (S, state_0_disconnected, __func__, __LINE__); + } + else { + SET_RC(S->rc+1); + if (S->rc > S->peak_rc_value) S->peak_rc_value = S->rc; // gather statistics. + + transmit_enquiry (S); + // Keep same state. + } + break; + } + +} /* end t1_expiry */ + + +/*------------------------------------------------------------------------------ + * + * Name: t3_expiry + * + * Purpose: Handle T3 timer expiration. + * + * Inputs: S - Data Link State Machine. + * + * Description: TODO: still don't understand this. + * + * 4.4.5.2. Timer T3 Recovery + * + * Timer T3 ensures that the link is still functional during periods of low information transfer. When T1 is not + * running (no outstanding I frames), T3 periodically causes the TNC to poll the other TNC of a link. When T3 + * times out, an RR or RNR frame is transmitted as a command with the P bit set, and then T1 is started. When a + * response to this command is received, T1 is stopped and T3 is started. If T1 expires before a response is + * received, then the waiting acknowledgement procedure (Section 6.4.11) is executed. + * + * 6.7.1.3. Inactive Link Timer T3 + * + * T3, the Inactive Link Timer, maintains link integrity whenever T1 is not running. It is recommended that + * whenever there are no outstanding unacknowledged I frames or P-bit frames (during the information-transfer + * state), an RR or RNR frame with the P bit set to "1" be sent every T3 time units to query the status of the other + * TNC. The period of T3 is locally defined, and depends greatly on Layer 1 operation. T3 should be greater than + * T1; it may be very large on channels of high integrity. + * + *------------------------------------------------------------------------------*/ + +static void t3_expiry (ax25_dlsm_t *S) +{ + + if (s_debug_timers) { + double now = dtime_now(); + + text_color_set(DW_COLOR_DEBUG_TIMER); + dw_printf ("t3_expiry (), [now=%.3f]\n", now - S->start_time); + } + + switch (S->state) { + + case state_0_disconnected: + case state_1_awaiting_connection: + case state_5_awaiting_v22_connection: + case state_2_awaiting_release: + case state_4_timer_recovery: + + break; + + case state_3_connected: + +// Erratum: Original sets RC to 0, 2006 revision sets RC to 1 which makes more sense. + + SET_RC(1); + transmit_enquiry (S); + enter_new_state (S, state_4_timer_recovery, __func__, __LINE__); + break; + } + +} /* end t3_expiry */ + + + +/*------------------------------------------------------------------------------ + * + * Name: tm201_expiry + * + * Purpose: Handle TM201 timer expiration. + * + * Inputs: S - Data Link State Machine. + * + * Description: This is used when waiting for a response to an XID command. + * + *------------------------------------------------------------------------------*/ + + +static void tm201_expiry (ax25_dlsm_t *S) +{ + + struct xid_param_s param; + unsigned char xinfo[40]; + int xlen; + cmdres_t cmd = cr_cmd; + int p = 1; + int nopid = 0; + packet_t pp; + + + if (s_debug_timers) { + double now = dtime_now(); + + text_color_set(DW_COLOR_DEBUG_TIMER); + dw_printf ("tm201_expiry (), [now=%.3f], state=%d, rc=%d\n", now - S->start_time, S->state, S->rc); + } + + switch (S->mdl_state) { + + case mdl_state_0_ready: + +// Timer shouldn't be running when in this state. + + break; + + case mdl_state_1_negotiating: + + S->mdl_rc++; + if (S->mdl_rc > S->n2_retry) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Stream %d: AX.25 Protocol Error MDL-C: Management retry limit exceeded.\n", S->stream_id); + S->mdl_state = mdl_state_0_ready; + } + else { + // No response. Ask again. + + initiate_negotiation (S, ¶m); + + xlen = xid_encode (¶m, xinfo, cmd); + + pp = ax25_u_frame (S->addrs, S->num_addr, cmd, frame_type_U_XID, p, nopid, xinfo, xlen); + lm_data_request (S->chan, TQ_PRIO_1_LO, pp); + + START_TM201; + } + break; + } + +} /* end tm201_expiry */ + + +//################################################################################### +//################################################################################### +// +// Subroutines from protocol spec, pages 106 - 109 +// +//################################################################################### +//################################################################################### + +// FIXME: continue review here. + + +/*------------------------------------------------------------------------------ + * + * Name: nr_error_recovery + * + * Purpose: Try to recover after receiving an expected N(r) value. + * + *------------------------------------------------------------------------------*/ + +static void nr_error_recovery (ax25_dlsm_t *S) +{ + if (s_debug_protocol_errors) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Stream %d: AX.25 Protocol Error J: N(r) sequence error.\n", S->stream_id); + } + establish_data_link (S); + S->layer_3_initiated = 0; + +} /* end nr_error_recovery */ + + +/*------------------------------------------------------------------------------ + * + * Name: establish_data_link + * (Combined with "establish extended data link") + * + * Purpose: Send SABM or SABME to other station. + * + * Inputs: S-> + * addrs destination, source, and optional digi addresses. + * num_addr Number of addresses. Should be 2 .. 10. + * modulo Determines if we send SABME or SABM. + * + * Description: Original spec had two different functions that differed + * only by sending SABM or SABME. Here they are combined into one. + * + *------------------------------------------------------------------------------*/ + +static void establish_data_link (ax25_dlsm_t *S) +{ + cmdres_t cmd = cr_cmd; + int p = 1; + packet_t pp; + int nopid = 0; + + clear_exception_conditions (S); + +// Erratum: We have an off-by-one error here. +// Flow chart shows setting RC to 0 and we end up sending SAMB(e) 11 times when N2 (RETRY) is 10. +// It should be 1 rather than 0. + + SET_RC(1); + pp = ax25_u_frame (S->addrs, S->num_addr, cmd, (S->modulo == 128) ? frame_type_U_SABME : frame_type_U_SABM, p, nopid, NULL, 0); + lm_data_request (S->chan, TQ_PRIO_1_LO, pp); + STOP_T3; + START_T1; + +} /* end establish_data_link */ + + + +/*------------------------------------------------------------------------------ + * + * Name: clear_exception_conditions + * + *------------------------------------------------------------------------------*/ + +static void clear_exception_conditions (ax25_dlsm_t *S) +{ + S->peer_receiver_busy = 0; + S->reject_exception = 0; + S->own_receiver_busy = 0; + S->acknowledge_pending = 0; + +// My enhancement. If we are establishing a new connection, we should discard any saved out of sequence incoming I frames. + + int n; + + for (n = 0; n < 128; n++) { + if (S->rxdata_by_ns[n] != NULL) { + cdata_delete (S->rxdata_by_ns[n]); + S->rxdata_by_ns[n] = NULL; + } + } + +// We retain the transmit I frame queue so we can continue after establishing a new connection. + +} /* end clear_exception_conditions */ + + +/*------------------------------------------------------------------------------ + * + * Name: transmit_enquiry, page 106 + * + * Purpose: This is called only when a timer expires. + * + * T1: We sent I frames and timed out waiting for the ack. + * Poke the other end to determine how much it got so far + * so we know where to continue. + * + * T3: Not activity for substantial amount of time. + * Poke the other end to see if it is still there. + * + * + * Observation: This is the only place where we send RR command with P=1. + * + * Sequence of events: + * + * We send some I frames to the other guy. + * There are outstanding sent I frames for which we did not receive ACK. + * + * Timer 1 expires when we are in state 3: send RR/RNR command P=1 (here). Enter state 4. + * Timer 1 expires when we are in state 4: same until max retry count is exceeded. + * + * Other guy gets RR/RNR command P=1. + * Same action for either state 3 or 4. + * Whether he has outstanding un-ack'ed sent I frames is irrelevant. + * He calls "enquiry response" which sends RR/RNR response F=1. + * (Read about detour 1 below and in enquiry_response.) + * + * I get back RR/RNR response F=1. Still in state 4. + * Of course, N(R) gets copied into V(A). + * Now here is the interesting part. + * If the ACKs are caught up, i.e. V(A) == V(S), stop T1 and enter state 3. + * Otherwise, "invoke retransmission" to resend everything after N(R). + * + * + * Detour 1: You were probably thinking, "Suppose SREJ is enabled and the other guy + * had a record of the SREJ frames sent which were not answered by filled in + * I frames. Why not send the SREJ again instead of backing up and resending + * stuff which already got there OK?" + * + * The code to handle incoming SREJ in state 4 is there but stop T1 is in the + * wrong place as mentioned above. + * + *------------------------------------------------------------------------------*/ + +static void transmit_enquiry (ax25_dlsm_t *S) +{ + int p = 1; + int nr = S->vr; + cmdres_t cmd = cr_cmd; + packet_t pp; + + if (s_debug_retry) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("\n****** TRANSMIT ENQUIRY RR/RNR cmd P=1 ****** state=%d, rc=%d\n\n", S->state, S->rc); + } + +// This is the ONLY place that we send RR/RNR *command* with P=1. +// Everywhere else should be response. +// I don't think we ever use RR/RNR command P=0 but need to check on that. + + pp = ax25_s_frame (S->addrs, S->num_addr, cmd, S->own_receiver_busy ? frame_type_S_RNR : frame_type_S_RR, S->modulo, nr, p, NULL, 0); + + lm_data_request (S->chan, TQ_PRIO_1_LO, pp); + + S->acknowledge_pending = 0; + START_T1; + +} /* end transmit_enquiry */ + + + +/*------------------------------------------------------------------------------ + * + * Name: enquiry_response + * + * Inputs: frame_type - Type of frame received or frame_not_AX25 for LM seize confirm. + * I think that this function is being called from too many + * different contexts where it really needs to react differently. + * So pass in more information about where we are coming from. + * + * F - Always specified as parameter in the references. + * + * Description: This is called for: + * - UI command with P=1 then F=1. + * - LM seize confirm with ack pending then F=0. (TODO: not clear on this yet.) + * TODO: I think we want to ensure that this function is called ONLY + * for RR/RNR/I command with P=1. LM Seize confirm can do its own thing and + * not get involved in this complication. + * - check_need_for_response(), command & P=1, then F=1 + * - RR/RNR/REJ command & P=1, then F=1 + * + * In all cases, we see that F has been specified, usually 1 because it is + * a response to a command with P=1. + * Specifying F would imply response when the flow chart says RR/RNR command. + * The documentation says: + * + * 6.2. Poll/Final (P/F) Bit Procedures + * + * The next response frame returned to an I frame with the P bit set to "1", received during the information + * transfer state, is an RR, RNR or REJ response with the F bit set to "1". + * + * The next response frame returned to a supervisory command frame with the P bit set to "1", received during + * the information transfer state, is an RR, RNR or REJ response frame with the F bit set to "1". + * + * Erattum! The flow chart says RR/RNR *command* but I'm confident it should be response. + * + * Erratum: Ax.25 spec has nothing here for SREJ. See X.25 2.4.6.11 for explanation. + * + *------------------------------------------------------------------------------*/ + +static void enquiry_response (ax25_dlsm_t *S, ax25_frame_type_t frame_type, int f) +{ + cmdres_t cr = cr_res; // Response, not command as seen in flow chart. + int nr = S->vr; + packet_t pp; + + + if (s_debug_retry) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("\n****** ENQUIRY RESPONSE F=%d ******\n\n", f); + } + +#if 1 // Detour 1 + + // My addition, Based on X.25 2.4.6.11. + // Only for RR, RNR, I. + // See sequence of events in transmit_enquiry comments. + + if (f == 1 && (frame_type == frame_type_S_RR || frame_type == frame_type_S_RNR || frame_type == frame_type_I)) { + + if (S->own_receiver_busy) { + +// I'm busy. + + pp = ax25_s_frame (S->addrs, S->num_addr, cr, frame_type_S_RNR, S->modulo, nr, f, NULL, 0); + lm_data_request (S->chan, TQ_PRIO_1_LO, pp); + + S->acknowledge_pending = 0; // because we sent N(R) from V(R). + } + + else if (S->srej_enable == srej_single || S->srej_enable == srej_multi) { + + +// SREJ is enabled. This is based on X.25 2.4.6.11. + + if (S->modulo != 128) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("INTERNAL ERROR: enquiry response should not be sending SREJ for modulo 8.\n"); + } + +// Suppose we received I frames with N(S) of 0, 3, 7. +// V(R) is still 1 because 0 is the last one received with contiguous N(S) values. +// 3 and 7 have been saved into S->rxdata_by_ns. +// We have outstanding requests to resend 1, 2, 4, 5, 6. +// Either those requests or the replies got lost. +// The other end timed out and asked us what is happening by sending RR/RNR command P=1. + +// First see if we have any out of sequence frames in the receive buffer. + + int last; + last = AX25MODULO(S->vr - 1, S->modulo, __FILE__, __func__, __LINE__); + while (last != S->vr && S->rxdata_by_ns[last] == NULL) { + last = AX25MODULO(last - 1, S->modulo, __FILE__, __func__, __LINE__); + } + + if (last != S->vr) { + +// Ask for missing frames to be sent again. X.25 2.4.6.11 b) & 2.3.5.2.2 + + int resend[128]; + int count = 0; + int j; + int allow_f1 = 1; + + j = S->vr; + while (j != last) { + if (S->rxdata_by_ns[j] == NULL) { + resend[count++] = j; + } + j = AX25MODULO(j + 1, S->modulo, __FILE__, __func__, __LINE__); + } + + send_srej_frames (S, resend, count, allow_f1); + } + else { + +// Not waiting for fill in of missing frames. X.25 2.4.6.11 c) + + pp = ax25_s_frame (S->addrs, S->num_addr, cr, frame_type_S_RR, S->modulo, nr, f, NULL, 0); + lm_data_request (S->chan, TQ_PRIO_1_LO, pp); + + S->acknowledge_pending = 0; + } + + } else { + +// SREJ not enabled. +// One might get the idea that it would make sense send REJ here if the reject exception is set. +// However, I can't seem to find that buried in X.25 2.4.5.9. +// And when we look at what happens when RR response, F=1 is received in state 4, it is +// effectively REJ when N(R) is not the same as V(S). + + if (s_debug_retry) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("\n****** ENQUIRY RESPONSE srej not enbled, sending RR resp F=%d ******\n\n", f); + } + + pp = ax25_s_frame (S->addrs, S->num_addr, cr, frame_type_S_RR, S->modulo, nr, f, NULL, 0); + lm_data_request (S->chan, TQ_PRIO_1_LO, pp); + + S->acknowledge_pending = 0; + } + + } // end of RR,RNR,I cmd with P=1 + + else { + +// For cases other than (RR, RNR, I) command, P=1. + + pp = ax25_s_frame (S->addrs, S->num_addr, cr, S->own_receiver_busy ? frame_type_S_RNR : frame_type_S_RR, S->modulo, nr, f, NULL, 0); + lm_data_request (S->chan, TQ_PRIO_1_LO, pp); + + S->acknowledge_pending = 0; + } + +#else + +// As found in AX.25 spec. +// Erratum: This is woefully inadequate when SREJ is enabled. +// Erratum: Flow chart says RR/RNR command but I'm confident it should be response. + + pp = ax25_s_frame (S->addrs, S->num_addr, cr, S->own_receiver_busy ? frame_type_S_RNR : frame_type_S_RR, S->modulo, nr, f, NULL, 0); + lm_data_request (S->chan, TQ_PRIO_1_LO, pp); + + S->acknowledge_pending = 0; + +# endif + +} /* end enquiry_response */ + + + + +/*------------------------------------------------------------------------------ + * + * Name: invoke_retransmission + * + * Inputs: nr_input - Resend starting with this. + * Continue will all up to and including current V(S) value. + * + * Description: Resend one or more frames that have already been sent. + * Should always send at least one. + * + * This is probably the result of getting REJ asking for a resend. + * + * Context: I would expect the caller to clear 'acknowledge_pending' after calling this + * because we sent N(R), from V(R), to ack what was received from other guy. + * I would also expect Stop T3 & Start T1 at the same place. + * + *------------------------------------------------------------------------------*/ + +static void invoke_retransmission (ax25_dlsm_t *S, int nr_input) +{ + +// Original flow chart showed saving V(S) into temp variable x, +// using V(S) as loop control variable, and finally restoring it +// to original value before returning. +// Here we just a local variable instead of messing with it. +// This should be equivalent but safer. + + int local_vs; + int sent_count = 0; + + if (s_debug_misc) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("invoke_retransmission(): starting with %d, state=%d, rc=%d, \n", nr_input, S->state, S->rc); + } + +// I don't think we should be here if SREJ is enabled. +// TODO: Figure out why this happens occasionally. + +// if (S->srej_enable != srej_none) { +// text_color_set(DW_COLOR_ERROR); +// dw_printf ("Internal Error, Did not expect to be here when SREJ enabled. %s %s %d\n", __FILE__, __func__, __LINE__); +// } + + if (S->txdata_by_ns[nr_input] == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Internal Error, Can't resend starting with N(S) = %d. It is not available. %s %s %d\n", nr_input, __FILE__, __func__, __LINE__); + return; + } + + + local_vs = nr_input; + do { + + if (S->txdata_by_ns[local_vs] != NULL) { + + cmdres_t cr = cr_cmd; + int ns = local_vs; + int nr = S->vr; + int p = 0; + + if (s_debug_misc) { + text_color_set(DW_COLOR_INFO); + dw_printf ("invoke_retransmission(): Resending N(S) = %d\n", ns); + } + + packet_t pp = ax25_i_frame (S->addrs, S->num_addr, cr, S->modulo, nr, ns, p, + S->txdata_by_ns[ns]->pid, (unsigned char *)(S->txdata_by_ns[ns]->data), S->txdata_by_ns[ns]->len); + + lm_data_request (S->chan, TQ_PRIO_1_LO, pp); + // Keep it around in case we need to send again. + + sent_count++; + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Internal Error, state=%d, need to retransmit N(S) = %d for REJ but it is not available. %s %s %d\n", S->state, local_vs, __FILE__, __func__, __LINE__); + } + local_vs = AX25MODULO(local_vs + 1, S->modulo, __FILE__, __func__, __LINE__); + + } while (local_vs != S->vs); + + if (sent_count == 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Internal Error, Nothing to retransmit. N(R)=%d, %s %s %d\n", nr_input, __FILE__, __func__, __LINE__); + } + +} /* end invoke_retransmission */ + + + +/*------------------------------------------------------------------------------ + * + * Name: check_i_frame_ackd + * + * Purpose: + * + * Inputs: nr - N(R) from I or S frame, acknowledging receipt thru N(R)-1. + * i.e. The next one expected by the peer is N(R). + * + * Outputs: S->va - updated from nr. + * + * Description: This is called for: + * - 'I' frame received and N(R) is in expected range, states 3 & 4. + * - RR/RNR command with p=1 received and N(R) is in expected range, state 3 only. + * + *------------------------------------------------------------------------------*/ + +static void check_i_frame_ackd (ax25_dlsm_t *S, int nr) +{ + if (S->peer_receiver_busy) { + SET_VA(nr); + + // Erratum? This looks odd to me. + // It doesn't seem right that we would have T3 and T1 running at the same time. + // Normally we stop one when starting the other. + // Should this be Stop T3 instead? + + START_T3; + if ( ! IS_T1_RUNNING) { + START_T1; + } + } + else if (nr == S->vs) { + SET_VA(nr); + STOP_T1; + START_T3; + select_t1_value (S); + } + else if (nr != S->va) { + + if (s_debug_misc) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("check_i_frame_ackd n(r)=%d, v(a)=%d, Set v(a) to new value %d\n", nr, S->va, nr); + } + + SET_VA(nr); + START_T1; // Erratum? Flow chart says "restart" rather than "start." + // Is this intentional, what is the difference? + } + +} /* check_i_frame_ackd */ + + + +/*------------------------------------------------------------------------------ + * + * Name: check_need_for_response + * + * Inputs: frame_type - frame_type_S_RR, etc. + * + * cr - Is it a command or response? + * + * pf - P/F from the frame. + * + * Description: This is called for RR, RNR, and REJ frames. + * If it is a command with P=1, we reply with RR or RNR with F=1. + * + *------------------------------------------------------------------------------*/ + +static void check_need_for_response (ax25_dlsm_t *S, ax25_frame_type_t frame_type, cmdres_t cr, int pf) +{ + if (cr == cr_cmd && pf == 1) { + int f = 1; + enquiry_response (S, frame_type, f); + } + else if (cr == cr_res && pf == 1) { + if (s_debug_protocol_errors) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Stream %d: AX.25 Protocol Error A: F=1 received but P=1 not outstanding.\n", S->stream_id); + } + } + +} /* end check_need_for_response */ + + + +/*------------------------------------------------------------------------------ + * + * Name: ui_check + * + * Description: I don't think we need this because UI frames are processed + * without going thru the data link state machine. + * + *------------------------------------------------------------------------------*/ + +/*------------------------------------------------------------------------------ + * + * Name: select_t1_value + * + * Purpose: Dynamically adjust the T1 timeout value, commonly a fixed time known as FRACK. + * + * Inputs: S->rc Retry counter. + * + * S->srt Smoothed roundtrip time in seconds. + * + * S->t1_remaining_when_last_stopped + * Seconds left on T1 when it is stopped. + * + * Outputs: S->srt New smoothed roundtrip time. + * + * S->t1v How long to wait for an acknowledgement before resending. + * Value used when starting timer T1, in seconds. + * Here it is dynamically adjusted. + * + * Description: How long should we wait for an ACK before sending again or giving up? + * some implementations have a fixed length time. This is usually the FRACK parameter, + * typically 3 seconds (D710A) or 4 seconds (KPC-3+). + * + * This should be increased for each digipeater in the path. + * Here it is dynamically adjusted by taking the average time it takes to get a response + * and then we double it. + * + * Rambling: It seems like a good idea to adapt to channel conditions, such as digipeater delays, + * but it is fraught with peril if you are not careful. + * + * For example, if we accept an incoming connection and only receive some I frames and + * send no I frames, T1 never gets started. In my earlier attempt, 't1_remaining_when_last_stopped' + * had the initial value of 0 lacking any reason to set it differently. The calculation here + * then kept pushing t1v up up up. After receiving 20 I frames and sending none, + * t1v was over 300 seconds!!! + * + * We need some way to indicate that 't1_remaining_when_last_stopped' is not valid and + * not to use it. Rather than adding a new variable, it is set to a negative value + * initially to mean it has not been set yet. That solves one problem. + * + * T1 is paused whenever the channel is busy, either transmitting or receiving, + * so the measured time could turn out to be a tiny fraction of a second, much less than + * the frame transmission time. + * If this gets too low, an unusually long random delay, before the sender's transmission, + * could exceed this. I put in a lower limit for t1v, currently 1 second. + * + * What happens if we get multiple timeouts because we don't get a response? + * For example, when we try to connect to a station which is not there, a KPC-3+ will give + * up and report failure after 10 tries x 4 sec = 40 seconds. + * + * The algorithm in the AX.25 protocol spec shows increasing timeout values. + * It might seem like a good idea but either it was not thought out very well + * or I am not understanding it. If it is doubled each time, it gets awful large + * very quickly. If we try to connect to a station which is not there, + * we want to know within a minute, not an hour later. + * + * Keeping with the spirit of increasing the time but keeping it sane, + * I increase the time linearly by a fraction of a second. + * + *------------------------------------------------------------------------------*/ + + +static void select_t1_value (ax25_dlsm_t *S) +{ + float old_srt = S->srt; + + +// Erratum: I don't think this test for RC == 0 is valid. +// We would need to set RC to 0 whenever we enter state 3 and we don't do that. +// I think a more appropriate test would be to check if we are in state 3. +// When things are going smoothly, it makes sense to fine tune timeout based on smoothed round trip time. +// When in some other state, we might want to slowly increase the time to minimize collisions. +// Maybe the solution is to set RC=0 when we enter state 3. + +// TODO: come back and revisit this. + + if (S->rc == 0) { + + if (S->t1_remaining_when_last_stopped >= 0) { // Negative means invalid, don't use it. + + // This is an IIR low pass filter. + // Algebraically equivalent to version in AX.25 protocol spec but I think the + // original intent is clearer by having 1/8 appear only once. + + S->srt = 7./8. * S->srt + 1./8. * ( S->t1v - S->t1_remaining_when_last_stopped ); + } + + // We pause T1 when the channel is busy. + // This includes both receiving someone else and us transmitting. + // This can result in the round trip time going down to almost nothing. + // My enhancement is to prevent srt from going below one second so + // t1v should never be less than 2 seconds. + // When t1v was allowed to go down to 1, we got occastional timeouts + // even under ideal conditions, probably due to random CSMA delay time. + + if (S->srt < 1) { + + S->srt = 1; + + // Add another 2 seconds for each digipeater in path. + + if (S->num_addr > 2) { + S->srt += 2 * (S->num_addr - 2); + } + } + + S->t1v = S->srt * 2; + } + else { + + if (S->t1_had_expired) { + + // This goes up exponentially if implemented as documented! + // For example, if we were trying to connect to a station which is not there, we + // would retry after 3, then 8, 16, 32, ... and not time out for over an hour. + // That's ridiculous. Let's try increasing it by a quarter second each time. + // We now give up after about a minute. + + // NO! S->t1v = powf(2, S->rc+1) * S->srt; + + S->t1v = S->rc * 0.25 + S->srt * 2; + } + } + + if (s_debug_timers) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("Stream %d: select_t1_value, rc = %d, t1 remaining = %.3f, old srt = %.3f, new srt = %.3f, new t1v = %.3f\n", + S->stream_id, S->rc, S->t1_remaining_when_last_stopped, old_srt, S->srt, S->t1v); + } + + +// See https://groups.io/g/direwolf/topic/100782658#8542 +// Perhaps the demands of file transfer lead to this problem. + +// "Temporary" hack. +// Automatic fine tuning of t1v generally works well, but on very rare occasions, it gets wildly out of control. +// Until I have more time to properly diagnose this, add some guardrails so it does not go flying off a cliff. + +// The initial value of t1v is frack + frack * 2 (number of digipeateers in path) +// If anything, it should automatically be adjusted down. +// Let's say, something smells fishy if it exceeds twice that initial value. + +// TODO: Add some instrumentation to record where this was called from and all the values in the printf below. + +#if 1 + if (S->t1v < 0.25 || S->t1v > 2 * (g_misc_config_p->frack * (2 * (S->num_addr - 2) + 1)) ) { + INIT_T1V_SRT; + } +#else + if (S->t1v < 0.99 || S->t1v > 30) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("INTERNAL ERROR? Stream %d: select_t1_value, rc = %d, t1 remaining = %.3f, old srt = %.3f, new srt = %.3f, Extreme new t1v = %.3f\n", + S->stream_id, S->rc, S->t1_remaining_when_last_stopped, old_srt, S->srt, S->t1v); + } +#endif +} /* end select_t1_value */ + + +/*------------------------------------------------------------------------------ + * + * Name: set_version_2_0 + * + * Erratum: Flow chart refers to T2 which doesn't appear anywhere else. + * + *------------------------------------------------------------------------------*/ + +static void set_version_2_0 (ax25_dlsm_t *S) +{ + S->srej_enable = srej_none; + S->modulo = 8; + S->n1_paclen = g_misc_config_p->paclen; + S->k_maxframe = g_misc_config_p->maxframe_basic; + S->n2_retry = g_misc_config_p->retry; + +} /* end set_version_2_0 */ + + +/*------------------------------------------------------------------------------ + * + * Name: set_version_2_2 + * + *------------------------------------------------------------------------------*/ + +static void set_version_2_2 (ax25_dlsm_t *S) +{ + S->srej_enable = srej_single; // Start with single. + // Can be increased to multi with XID exchange. + S->modulo = 128; + S->n1_paclen = g_misc_config_p->paclen; + S->k_maxframe = g_misc_config_p->maxframe_extended; + S->n2_retry = g_misc_config_p->retry; + +} /* end set_version_2_2 */ + + + + +/*------------------------------------------------------------------------------ + * + * Name: is_good_nr + * + * Purpose: Evaluate condition "V(a) <= N(r) <= V(s)" which appears in flow charts + * for incoming I, RR, RNR, REJ, and SREJ frames. + * + * Inputs: S - state machine. Contains V(a) and V(s). + * + * nr - N(r) found in the incoming frame. + * + * Description: This determines whether the Received Sequence Number, N(R), is in + * the expected range for normal processing or if we have an error + * condition that needs recovery. + * + * This gets tricky due to the wrap around of sequence numbers. + * + * 4.2.4.4. Received Sequence Number N(R) + * + * The received sequence number exists in both I and S frames. + * Prior to sending an I or S frame, this variable is updated to equal that + * of the received state variable, thus implicitly acknowledging the proper + * reception of all frames up to and including N(R)-1. + * + * Pattern noticed: Anytime we have "is_good_nr" returning true, we should always + * - set V(A) from N(R) or + * - call "check_i_frame_ackd" which does the same and some timer stuff. + * + *------------------------------------------------------------------------------*/ + + +static int is_good_nr (ax25_dlsm_t *S, int nr) +{ + int adjusted_va, adjusted_nr, adjusted_vs; + int result; + +/* Adjust all values relative to V(a) before comparing so we won't have wrap around. */ + +#define adjust_by_va(x) (AX25MODULO((x) - S->va, S->modulo, __FILE__, __func__, __LINE__)) + + adjusted_va = adjust_by_va(S->va); // A clever compiler would know it is zero. + adjusted_nr = adjust_by_va(nr); + adjusted_vs = adjust_by_va(S->vs); + + result = adjusted_va <= adjusted_nr && adjusted_nr <= adjusted_vs; + + if (s_debug_misc) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("is_good_nr, V(a) %d <= nr %d <= V(s) %d, returns %d\n", S->va, nr, S->vs, result); + } + + return (result); + +} /* end is_good_nr */ + + + +/*------------------------------------------------------------------------------ + * + * Name: i_frame_pop_off_queue + * + * Purpose: Transmit an I frame if we have one in the queue and conditions are right. + * This appears two slightly different ways in the flow charts: + * "frame pop off queue" + * "I frame pops off queue" + * + * Inputs: i_frame_queue - Remove items from here. + * peer_receiver_busy - If other end not busy. + * V(s) - and we haven't reached window size. + * V(a) + * k + * + * Outputs: v(s) is incremented for each processed. + * acknowledge_pending = 0 + * + *------------------------------------------------------------------------------*/ + +static void i_frame_pop_off_queue (ax25_dlsm_t *S) +{ + + + if (s_debug_misc) { + //text_color_set(DW_COLOR_DEBUG); + //dw_printf ("i_frame_pop_off_queue () state=%d\n", S->state); + } + +// TODO: Were we expecting something in the queue? +// or is empty an expected situation? + + if (S->i_frame_queue == NULL) { + + if (s_debug_misc) { + // TODO: add different switch for I frame queue. + //text_color_set(DW_COLOR_DEBUG); + //dw_printf ("i_frame_pop_off_queue () queue is empty get out, line %d\n", __LINE__); + } + + // I Frame queue is empty. + // Nothing to see here, folks. Move along. + return; + } + + switch (S->state) { + + case state_1_awaiting_connection: + case state_5_awaiting_v22_connection: + + if (s_debug_misc) { + //text_color_set(DW_COLOR_DEBUG); + //dw_printf ("i_frame_pop_off_queue () line %d\n", __LINE__); + } + + // This seems to say remove the I Frame from the queue and discard it if "layer 3 initiated" is set. + + // For the case of removing it from the queue and putting it back in we just leave it there. + + // Erratum? The flow chart seems to be backwards. + // It would seem like we want to keep it if we are further along in the connection process. + // I don't understand the intention here, and can't make a compelling argument on why it + // is backwards, so it is implemented as documented. + + if (S->layer_3_initiated) { + cdata_t *txdata; + + if (s_debug_misc) { + //text_color_set(DW_COLOR_DEBUG); + //dw_printf ("i_frame_pop_off_queue () discarding due to L3 init. line %d\n", __LINE__); + } + txdata = S->i_frame_queue; // Remove from head of list. + S->i_frame_queue = txdata->next; + cdata_delete (txdata); + } + break; + + case state_3_connected: + case state_4_timer_recovery: + + if (s_debug_misc) { + //text_color_set(DW_COLOR_DEBUG); + //dw_printf ("i_frame_pop_off_queue () state %d, line %d\n", S->state, __LINE__); + } + + while ( ( ! S->peer_receiver_busy ) && + S->i_frame_queue != NULL && + WITHIN_WINDOW_SIZE(S) ) { + + cdata_t *txdata; + + txdata = S->i_frame_queue; // Remove from head of list. + S->i_frame_queue = txdata->next; + txdata->next = NULL; + + cmdres_t cr = cr_cmd; + int ns = S->vs; + int nr = S->vr; + int p = 0; + + if (s_debug_misc || s_debug_radio) { + //dw_printf ("i_frame_pop_off_queue () ns=%d, queue for transmit \"", ns); + //ax25_safe_print (txdata->data, txdata->len, 1); + //dw_printf ("\"\n"); + } + packet_t pp = ax25_i_frame (S->addrs, S->num_addr, cr, S->modulo, nr, ns, p, txdata->pid, (unsigned char *)(txdata->data), txdata->len); + + if (s_debug_misc) { + //text_color_set(DW_COLOR_DEBUG); + //dw_printf ("calling lm_data_request for I frame, %s line %d\n", __func__, __LINE__); + } + + lm_data_request (S->chan, TQ_PRIO_1_LO, pp); + + // Stash in sent array in case it gets lost and needs to be sent again. + + if (S->txdata_by_ns[ns] != NULL) { + cdata_delete (S->txdata_by_ns[ns]); + } + S->txdata_by_ns[ns] = txdata; + + SET_VS(AX25MODULO(S->vs + 1, S->modulo, __FILE__, __func__, __LINE__)); // increment sequence of last sent. + + S->acknowledge_pending = 0; + +// Erratum: I think we always want to restart T1 when an I frame is sent. +// Otherwise we could time out too soon. +#if 1 + STOP_T3; + START_T1; +#else + if ( ! IS_T1_RUNNING) { + STOP_T3; + START_T1; + } +#endif + } + break; + + case state_0_disconnected: + case state_2_awaiting_release: + + // Do nothing. + break; + } + +} /* end i_frame_pop_off_queue */ + + + + +/*------------------------------------------------------------------------------ + * + * Name: discard_i_queue + * + * Purpose: Discard any data chunks waiting to be sent. + * + *------------------------------------------------------------------------------*/ + + +static void discard_i_queue (ax25_dlsm_t *S) +{ + cdata_t *t; + + while (S->i_frame_queue != NULL) { + + t = S->i_frame_queue; + S->i_frame_queue = S->i_frame_queue->next; + cdata_delete (t); + } + +} /* end discard_i_queue */ + + + +/*------------------------------------------------------------------------------ + * + * Name: enter_new_state + * + * Purpose: Switch to new state. + * + * Description: Use a function, rather than setting variable directly, so we have + * one common point for debug output and possibly other things we + * might want to do at a state change. + * + *------------------------------------------------------------------------------*/ + +// TODO: requeuing??? + +static void enter_new_state (ax25_dlsm_t *S, enum dlsm_state_e new_state, const char *from_func, int from_line) +{ + + if (s_debug_variables) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("\n"); + dw_printf (">>> NEW STATE = %d, previously %d, called from %s %d <<<\n", new_state, S->state, from_func, from_line); + dw_printf ("\n"); + } + + assert (new_state >= 0 && new_state <= 5); + + + if (( new_state == state_3_connected || new_state == state_4_timer_recovery) && + S->state != state_3_connected && S->state != state_4_timer_recovery ) { + + ptt_set (OCTYPE_CON, S->chan, 1); // Turn on connected indicator if configured. + } + else if (( new_state != state_3_connected && new_state != state_4_timer_recovery) && + ( S->state == state_3_connected || S->state == state_4_timer_recovery ) ) { + + ptt_set (OCTYPE_CON, S->chan, 0); // Turn off connected indicator if configured. + // Ideally we should look at any other link state machines + // for this channel and leave the indicator on if any + // are connected. I'm not that worried about it. + } + + S->state = new_state; + +} /* end enter_new_state */ + + + +/*------------------------------------------------------------------------------ + * + * Name: mdl_negotiate_request + * + * Purpose: After receiving UA, in response to SABME, this starts up the XID exchange. + * + * Description: Send XID command. + * Start timer TM201 so we can retry if timeout waiting for response. + * Enter MDL negotiating state. + * + *------------------------------------------------------------------------------*/ + +static void mdl_negotiate_request (ax25_dlsm_t *S) +{ + struct xid_param_s param; + unsigned char xinfo[40]; + int xlen; + cmdres_t cmd = cr_cmd; + int p = 1; + int nopid = 0; + packet_t pp; + int n; + +// At least one known [partial] v2.2 implementation understands SABME but not XID. +// Rather than wasting time, sending XID repeatedly until giving up, we have a workaround. +// The configuration file can contain a list of stations known not to respond to XID. +// Obviously this applies only to v2.2 because XID was not part of v2.0. + + for (n = 0; n < g_misc_config_p->noxid_count; n++) { + if (strcmp(S->addrs[PEERCALL],g_misc_config_p->noxid_addrs[n]) == 0) { + return; + } + } + + switch (S->mdl_state) { + + case mdl_state_0_ready: + + initiate_negotiation (S, ¶m); + + xlen = xid_encode (¶m, xinfo, cmd); + + pp = ax25_u_frame (S->addrs, S->num_addr, cmd, frame_type_U_XID, p, nopid, xinfo, xlen); + lm_data_request (S->chan, TQ_PRIO_1_LO, pp); + + S->mdl_rc = 0; + START_TM201; + S->mdl_state = mdl_state_1_negotiating; + + break; + + case mdl_state_1_negotiating: + + // SDL says "requeue" but I don't understand how it would be useful or how to do it. + break; + } + +} /* end mdl_negotiate_request */ + + +/*------------------------------------------------------------------------------ + * + * Name: initiate_negotiation + * + * Purpose: Used when preparing the XID *command*. + * + * Description: Prepare set of parameters to request from the other station. + * + *------------------------------------------------------------------------------*/ + +static void initiate_negotiation (ax25_dlsm_t *S, struct xid_param_s *param) +{ + param->full_duplex = 0; + switch (S->srej_enable) { + case srej_single: + case srej_multi: + param->srej = srej_multi; // see if other end reconizes it. + break; + case srej_none: + default: + param->srej = srej_none; + break; + } + + param->modulo = S->modulo; + param->i_field_length_rx = S->n1_paclen; // Hmmmm. Should we ask for what the user + // specified for PACLEN or offer the maximum + // that we can handle, AX25_N1_PACLEN_MAX? + param->window_size_rx = S->k_maxframe; + param->ack_timer = (int)(g_misc_config_p->frack * 1000); + param->retries = S->n2_retry; +} + + +/*------------------------------------------------------------------------------ + * + * Name: negotiation_response + * + * Purpose: Used when receiving the XID command and preparing the XID response. + * + * Description: Take what other station has asked for and reduce if we have lesser capabilities. + * For example if other end wants 8k information part we reduce it to 2k. + * Ack time and retries are the opposite, we take the maximum. + * + * Question: If the other send leaves anything undefined should we leave it + * undefined or fill in what we would like before sending it back? + * + * The original version of the protocol spec left this open. + * The 2006 revision, in red, says we should fill in defaults for anything + * not specified. This makes sense. We send back a complete set of parameters + * so both ends should agree. + * + *------------------------------------------------------------------------------*/ + +static void negotiation_response (ax25_dlsm_t *S, struct xid_param_s *param) +{ + +// TODO: Integrate with new full duplex capability in v1.5. + + param->full_duplex = 0; + +// Other end might want 8. +// Seems unlikely. If it implements XID it should have modulo 128. + + if (param->modulo == modulo_unknown) { + param->modulo = 8; // Not specified. Set default. + } + else { + param->modulo = MIN(param->modulo, 128); + } + +// We can do REJ or SREJ but won't combine them. +// Erratum: 2006 version, section, 4.3.3.7 says default selective reject - reject. +// We can't do that. + + if (param->srej == srej_not_specified) { + param->srej = (param->modulo == 128) ? srej_single : srej_none; // not specified, set default + } + +// We can currently do up to 2k. +// Take minimum of that and what other guy asks for. + + if (param->i_field_length_rx == G_UNKNOWN) { + param->i_field_length_rx = 256; // Not specified, take default. + } + else { + param->i_field_length_rx = MIN(param->i_field_length_rx, AX25_N1_PACLEN_MAX); + } + +// In theory extended mode can have window size of 127 but +// I'm limiting it to 63 for the reason mentioned in the SREJ logic. + + if (param->window_size_rx == G_UNKNOWN) { + param->window_size_rx = (param->modulo == 128) ? 32 : 4; // not specified, set default. + } + else { + if (param->modulo == 128) + param->window_size_rx = MIN(param->window_size_rx, AX25_K_MAXFRAME_EXTENDED_MAX); + else + param->window_size_rx = MIN(param->window_size_rx, AX25_K_MAXFRAME_BASIC_MAX); + } + +// Erratum: Unclear. Is the Acknowledgement Timer before or after compensating for digipeaters +// in the path? e.g. Typically TNCs use the FRACK parameter for this and it often defaults to 3. +// However, the actual timeout value might be something like FRACK*(2*m+1) where m is the number of +// digipeaters in the path. I'm assuming this is the FRACK value and any additional time, for +// digipeaters will be added in locally at each end on top of this exchanged value. + + if (param->ack_timer == G_UNKNOWN) { + param->ack_timer = 3000; // not specified, set default. + } + else { + param->ack_timer = MAX(param->ack_timer, (int)(g_misc_config_p->frack * 1000)); + } + + if (param->retries == G_UNKNOWN) { + param->retries = 10; // not specified, set default. + } + else { + param->retries = MAX(param->retries, S->n2_retry); + } + +// IMPORTANT: Take values we have agreed upon and put into my running configuration. + + complete_negotiation(S, param); +} + + +/*------------------------------------------------------------------------------ + * + * Name: complete_negotiation + * + * Purpose: Used when preparing or receiving the XID *response*. + * + * Description: Take set of parameters which we have agreed upon and apply + * to the running configuration. + * + * TODO: Should do some checking here in case other station + * sends something crazy. + * + *------------------------------------------------------------------------------*/ + +static void complete_negotiation (ax25_dlsm_t *S, struct xid_param_s *param) +{ + if (param->srej != srej_not_specified) { + S->srej_enable = param->srej; + } + + if (param->modulo != modulo_unknown) { + // Disaster if aren't agreeing on this. + S->modulo = param->modulo; + } + + if (param->i_field_length_rx != G_UNKNOWN) { + S->n1_paclen = param->i_field_length_rx; + } + + if (param->window_size_rx != G_UNKNOWN) { + S->k_maxframe = param->window_size_rx; + } + + if (param->ack_timer != G_UNKNOWN) { + S->t1v = param->ack_timer * 0.001; + } + + if (param->retries != G_UNKNOWN) { + S->n2_retry = param->retries; + } +} + + + + + +//################################################################################### +//################################################################################### +// +// Timers. +// +// Start. +// Stop. +// Pause (when channel busy) & resume. +// Is it running? +// Did it expire before being stopped? +// When will next one expire? +// +//################################################################################### +//################################################################################### + + +static void start_t1 (ax25_dlsm_t *S, const char *from_func, int from_line) +{ + double now = dtime_now(); + + if (s_debug_timers) { + text_color_set(DW_COLOR_DEBUG_TIMER); + dw_printf ("Start T1 for t1v = %.3f sec, rc = %d, [now=%.3f] from %s %d\n", S->t1v, S->rc, now - S->start_time, from_func, from_line); + } + + S->t1_exp = now + S->t1v; + if (S->radio_channel_busy) { + S->t1_paused_at = now; + } + else { + S->t1_paused_at = 0; + } + S->t1_had_expired = 0; + +} /* end start_t1 */ + + +static void stop_t1 (ax25_dlsm_t *S, const char *from_func, int from_line) +{ + double now = dtime_now(); + + RESUME_T1; // adjust expire time if paused. + + if (S->t1_exp == 0.0) { + // Was already stopped. + } + else { + S->t1_remaining_when_last_stopped = S->t1_exp - now; + if (S->t1_remaining_when_last_stopped < 0) S->t1_remaining_when_last_stopped = 0; + } + +// Normally this would be at the top but we don't know time remaining at that point. + + if (s_debug_timers) { + text_color_set(DW_COLOR_DEBUG_TIMER); + if (S->t1_exp == 0.0) { + dw_printf ("Stop T1. Wasn't running, [now=%.3f] from %s %d\n", now - S->start_time, from_func, from_line); + } + else { + dw_printf ("Stop T1, %.3f remaining, [now=%.3f] from %s %d\n", S->t1_remaining_when_last_stopped, now - S->start_time, from_func, from_line); + } + } + + S->t1_exp = 0.0; // now stopped. + S->t1_had_expired = 0; // remember that it did not expire. + +} /* end stop_t1 */ + + +static int is_t1_running (ax25_dlsm_t *S, const char *from_func, int from_line) +{ + int result = S->t1_exp != 0.0; + + if (s_debug_timers) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("is_t1_running? returns %d\n", result); + } + + return (result); + +} /* end is_t1_running */ + + +static void pause_t1 (ax25_dlsm_t *S, const char *from_func, int from_line) +{ + + if (S->t1_exp == 0.0) { + // Stopped so there is nothing to do. + } + else if (S->t1_paused_at == 0.0) { + // Running and not paused. + + double now = dtime_now(); + + S->t1_paused_at = now; + + if (s_debug_timers) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("Paused T1 with %.3f still remaining, [now=%.3f] from %s %d\n", S->t1_exp - now, now - S->start_time, from_func, from_line); + } + } + else { + if (s_debug_timers) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("T1 error: Didn't expect pause when already paused.\n"); + } + } + +} /* end pause_t1 */ + + +static void resume_t1 (ax25_dlsm_t *S, const char *from_func, int from_line) +{ + if (S->t1_exp == 0.0) { + // Stopped so there is nothing to do. + } + else if (S->t1_paused_at == 0.0) { + // Running but not paused. + } + else { + double now = dtime_now(); + double paused_for_sec = now - S->t1_paused_at; + + S->t1_exp += paused_for_sec; + S->t1_paused_at = 0.0; + + if (s_debug_timers) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("Resumed T1 after pausing for %.3f sec, %.3f still remaining, [now=%.3f]\n", paused_for_sec, S->t1_exp - now, now - S->start_time); + } + } + +} /* end resume_t1 */ + + + + +// T3 is a lot simpler. +// Here we are talking about minutes of inactivity with the peer +// rather than expecting a response within seconds where timing is more critical. +// We don't need to capture remaining time when stopped. +// I don't think there is a need to pause it due to the large time frame. + + +static void start_t3 (ax25_dlsm_t *S, const char *from_func, int from_line) +{ + double now = dtime_now(); + + if (s_debug_timers) { + text_color_set(DW_COLOR_DEBUG_TIMER); + dw_printf ("Start T3 for %.3f sec, [now=%.3f] from %s %d\n", T3_DEFAULT, now - S->start_time, from_func, from_line); + } + + S->t3_exp = now + T3_DEFAULT; +} + +static void stop_t3 (ax25_dlsm_t *S, const char *from_func, int from_line) +{ + if (s_debug_timers) { + double now = dtime_now(); + + text_color_set(DW_COLOR_DEBUG_TIMER); + if (S->t3_exp == 0.0) { + dw_printf ("Stop T3. Wasn't running.\n"); + } + else { + dw_printf ("Stop T3, %.3f remaining, [now=%.3f] from %s %d\n", S->t3_exp - now, now - S->start_time, from_func, from_line); + } + } + S->t3_exp = 0.0; +} + + + +// TM201 is similar to T1. +// It needs to be paused whent the channel is busy. +// Simpler because we don't need to keep track of time remaining when stopped. + + + +static void start_tm201 (ax25_dlsm_t *S, const char *from_func, int from_line) +{ + double now = dtime_now(); + + if (s_debug_timers) { + text_color_set(DW_COLOR_DEBUG_TIMER); + dw_printf ("Start TM201 for t1v = %.3f sec, rc = %d, [now=%.3f] from %s %d\n", S->t1v, S->rc, now - S->start_time, from_func, from_line); + } + + S->tm201_exp = now + S->t1v; + if (S->radio_channel_busy) { + S->tm201_paused_at = now; + } + else { + S->tm201_paused_at = 0; + } + +} /* end start_tm201 */ + + +static void stop_tm201 (ax25_dlsm_t *S, const char *from_func, int from_line) +{ + double now = dtime_now(); + + if (s_debug_timers) { + text_color_set(DW_COLOR_DEBUG_TIMER); + dw_printf ("Stop TM201. [now=%.3f] from %s %d\n", now - S->start_time, from_func, from_line); + } + + S->tm201_exp = 0.0; // now stopped. + +} /* end stop_tm201 */ + + + +static void pause_tm201 (ax25_dlsm_t *S, const char *from_func, int from_line) +{ + + if (S->tm201_exp == 0.0) { + // Stopped so there is nothing to do. + } + else if (S->tm201_paused_at == 0.0) { + // Running and not paused. + + double now = dtime_now(); + + S->tm201_paused_at = now; + + if (s_debug_timers) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("Paused TM201 with %.3f still remaining, [now=%.3f] from %s %d\n", S->tm201_exp - now, now - S->start_time, from_func, from_line); + } + } + else { + if (s_debug_timers) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("TM201 error: Didn't expect pause when already paused.\n"); + } + } + +} /* end pause_tm201 */ + + +static void resume_tm201 (ax25_dlsm_t *S, const char *from_func, int from_line) +{ + if (S->tm201_exp == 0.0) { + // Stopped so there is nothing to do. + } + else if (S->tm201_paused_at == 0.0) { + // Running but not paused. + } + else { + double now = dtime_now(); + double paused_for_sec = now - S->tm201_paused_at; + + S->tm201_exp += paused_for_sec; + S->tm201_paused_at = 0.0; + + if (s_debug_timers) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("Resumed TM201 after pausing for %.3f sec, %.3f still remaining, [now=%.3f]\n", paused_for_sec, S->tm201_exp - now, now - S->start_time); + } + } + +} /* end resume_tm201 */ + + + + + +double ax25_link_get_next_timer_expiry (void) +{ + double tnext = 0; + ax25_dlsm_t *p; + + for (p = list_head; p != NULL; p = p->next) { + + // Consider if running and not paused. + + if (p->t1_exp != 0 && p->t1_paused_at == 0) { + if (tnext == 0) { + tnext = p->t1_exp; + } + else if (p->t1_exp < tnext) { + tnext = p->t1_exp; + } + } + + if (p->t3_exp != 0) { + if (tnext == 0) { + tnext = p->t3_exp; + } + else if (p->t3_exp < tnext) { + tnext = p->t3_exp; + } + } + + if (p->tm201_exp != 0 && p->tm201_paused_at == 0) { + if (tnext == 0) { + tnext = p->tm201_exp; + } + else if (p->tm201_exp < tnext) { + tnext = p->tm201_exp; + } + } + + } + + if (s_debug_timers > 1) { + text_color_set(DW_COLOR_DEBUG); + if (tnext == 0.0) { + dw_printf ("ax25_link_get_next_timer_expiry returns none.\n"); + } + else { + dw_printf ("ax25_link_get_next_timer_expiry returns %.3f sec from now.\n", + tnext - dtime_now()); + } + } + + return (tnext); + +} /* end ax25_link_get_next_timer_expiry */ + + +/* end ax25_link.c */ diff --git a/src/ax25_link.h b/src/ax25_link.h new file mode 100644 index 00000000..40fa401b --- /dev/null +++ b/src/ax25_link.h @@ -0,0 +1,88 @@ + +/* ax25_link.h */ + + +#ifndef AX25_LINK_H +#define AX25_LINK_H 1 + +#include "ax25_pad.h" // for AX25_MAX_INFO_LEN + +#include "dlq.h" // for dlq_item_t + +#include "config.h" // for struct misc_config_s + + + +// Limits and defaults for parameters. + + +#define AX25_N1_PACLEN_MIN 1 // Max bytes in Information part of frame. +#define AX25_N1_PACLEN_DEFAULT 256 // some v2.0 implementations have 128 +#define AX25_N1_PACLEN_MAX AX25_MAX_INFO_LEN // from ax25_pad.h + + +#define AX25_N2_RETRY_MIN 1 // Number of times to retry before giving up. +#define AX25_N2_RETRY_DEFAULT 10 +#define AX25_N2_RETRY_MAX 15 + + +#define AX25_T1V_FRACK_MIN 1 // Number of seconds to wait before retrying. +#define AX25_T1V_FRACK_DEFAULT 3 // KPC-3+ has 4. TM-D710A has 3. +#define AX25_T1V_FRACK_MAX 15 + + +#define AX25_K_MAXFRAME_BASIC_MIN 1 // Window size - number of I frames to send before waiting for ack. +#define AX25_K_MAXFRAME_BASIC_DEFAULT 4 +#define AX25_K_MAXFRAME_BASIC_MAX 7 + +#define AX25_K_MAXFRAME_EXTENDED_MIN 1 +#define AX25_K_MAXFRAME_EXTENDED_DEFAULT 32 +#define AX25_K_MAXFRAME_EXTENDED_MAX 63 // In theory 127 but I'm restricting as explained in SREJ handling. + + + +// Call once at startup time. + +void ax25_link_init (struct misc_config_s *pconfig); + + + +// IMPORTANT: + +// These functions must be called on a single thread, one at a time. +// The Data Link Queue (DLQ) is used to serialize events from multiple sources. + +// Maybe the dispatch switch should be moved to ax25_link.c so they can all +// be made static and they can't be called from the wrong place accidentally. + +void dl_connect_request (dlq_item_t *E); + +void dl_disconnect_request (dlq_item_t *E); + +void dl_data_request (dlq_item_t *E); + +void dl_register_callsign (dlq_item_t *E); + +void dl_unregister_callsign (dlq_item_t *E); + +void dl_outstanding_frames_request (dlq_item_t *E); + +void dl_client_cleanup (dlq_item_t *E); + + +void lm_data_indication (dlq_item_t *E); + +void lm_seize_confirm (dlq_item_t *E); + +void lm_channel_busy (dlq_item_t *E); + + +void dl_timer_expiry (void); + + +double ax25_link_get_next_timer_expiry (void); + + +#endif + +/* end ax25_link.h */ \ No newline at end of file diff --git a/src/ax25_pad.c b/src/ax25_pad.c new file mode 100644 index 00000000..0f075808 --- /dev/null +++ b/src/ax25_pad.c @@ -0,0 +1,2946 @@ +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// +// Copyright (C) 2011 , 2013, 2014, 2015, 2019 John Langner, WB2OSZ +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . +// + + +/*------------------------------------------------------------------ + * + * Name: ax25_pad + * + * Purpose: Packet assembler and disasembler. + * + * This was written when I was only concerned about APRS which + * uses only UI frames. ax25_pad2.c, added years later, has + * functions for dealing with other types of frames. + * + * We can obtain AX.25 packets from different sources: + * + * (a) from an HDLC frame. + * (b) from text representation. + * (c) built up piece by piece. + * + * We also want to use a packet in different ways: + * + * (a) transmit as an HDLC frame. + * (b) print in human-readable text. + * (c) take it apart piece by piece. + * + * Looking at the more general case, we also want to modify + * an existing packet. For instance an APRS repeater might + * want to change "WIDE2-2" to "WIDE2-1" and retransmit it. + * + * + * Description: + * + * + * APRS uses only UI frames. + * Each starts with 2-10 addresses (14-70 octets): + * + * * Destination Address (note: opposite order in printed format) + * + * * Source Address + * + * * 0-8 Digipeater Addresses (Could there ever be more as a result of + * digipeaters inserting their own call for + * the tracing feature? + * NO. The limit is 8 when transmitting AX.25 over the + * radio. + * Communication with an IGate server could + * have a longer VIA path but that is only in text form, + * not as an AX.25 frame.) + * + * Each address is composed of: + * + * * 6 upper case letters or digits, blank padded. + * These are shifted left one bit, leaving the LSB always 0. + * + * * a 7th octet containing the SSID and flags. + * The LSB is always 0 except for the last octet of the address field. + * + * The final octet of the Destination has the form: + * + * C R R SSID 0, where, + * + * C = command/response = 1 + * R R = Reserved = 1 1 + * SSID = substation ID + * 0 = zero + * + * The AX.25 spec states that the RR bits should be 11 if not used. + * There are a couple documents talking about possible uses for APRS. + * I'm ignoring them for now. + * http://www.aprs.org/aprs12/preemptive-digipeating.txt + * http://www.aprs.org/aprs12/RR-bits.txt + * + * I don't recall why I originally set the source & destination C bits both to 1. + * Reviewing this 5 years later, after spending more time delving into the + * AX.25 spec, I think it should be 1 for destination and 0 for source. + * In practice you see all four combinations being used by APRS stations + * and everyone apparently ignores them for APRS. They do make a big + * difference for connected mode. + * + * The final octet of the Source has the form: + * + * C R R SSID 0, where, + * + * C = command/response = 0 + * R R = Reserved = 1 1 + * SSID = substation ID + * 0 = zero (or 1 if no repeaters) + * + * The final octet of each repeater has the form: + * + * H R R SSID 0, where, + * + * H = has-been-repeated = 0 initially. + * Set to 1 after this address has been used. + * R R = Reserved = 1 1 + * SSID = substation ID + * 0 = zero (or 1 if last repeater in list) + * + * A digipeater would repeat this frame if it finds its address + * with the "H" bit set to 0 and all earlier repeater addresses + * have the "H" bit set to 1. + * The "H" bit would be set to 1 in the repeated frame. + * + * In standard monitoring format, an asterisk is displayed after the last + * digipeater with the "H" bit set. That indicates who you are hearing + * over the radio. + * (That is if digipeaters update the via path properly. Some don't so + * we don't know who we are hearing. This is discussed in the User Guide.) + * No asterisk means the source is being heard directly. + * + * Example, if we can hear all stations involved, + * + * SRC>DST,RPT1,RPT2,RPT3: -- we heard SRC + * SRC>DST,RPT1*,RPT2,RPT3: -- we heard RPT1 + * SRC>DST,RPT1,RPT2*,RPT3: -- we heard RPT2 + * SRC>DST,RPT1,RPT2,RPT3*: -- we heard RPT3 + * + * + * Next we have: + * + * * One byte Control Field - APRS uses 3 for UI frame + * The more general AX.25 frame can have two. + * + * * One byte Protocol ID - APRS uses 0xf0 for no layer 3 + * + * Finally the Information Field of 1-256 bytes. + * + * And, of course, the 2 byte CRC. + * + * The descriptions above, for the C, H, and RR bits, are for APRS usage. + * When operating as a KISS TNC we just pass everything along and don't + * interpret or change them. + * + * + * Constructors: ax25_init - Clear everything. + * ax25_from_text - Tear apart a text string + * ax25_from_frame - Tear apart an AX.25 frame. + * Must be called before any other function. + * + * Get methods: .... - Extract destination, source, or digipeater + * address from frame. + * + * Assumptions: CRC has already been verified to be correct. + * + *------------------------------------------------------------------*/ + +#define AX25_PAD_C /* this will affect behavior of ax25_pad.h */ + +#include "direwolf.h" + +#include +#include +#include +#include +#include + +#include "regex.h" + +#if __WIN32__ +char *strtok_r(char *str, const char *delim, char **saveptr); +#endif + + +#include "textcolor.h" +#include "ax25_pad.h" +#include "fcs_calc.h" + +/* + * Accumulate statistics. + * If new_count gets much larger than delete_count plus the size of + * the transmit queue we have a memory leak. + */ + +static volatile int new_count = 0; +static volatile int delete_count = 0; +static volatile int last_seq_num = 0; + +#if AX25MEMDEBUG + +int ax25memdebug = 0; + + +void ax25memdebug_set(void) +{ + ax25memdebug = 1; +} + +int ax25memdebug_get (void) +{ + return (ax25memdebug); +} + +int ax25memdebug_seq (packet_t this_p) +{ + return (this_p->seq); +} + + +#endif + + + +#define CLEAR_LAST_ADDR_FLAG this_p->frame_data[this_p->num_addr*7-1] &= ~ SSID_LAST_MASK +#define SET_LAST_ADDR_FLAG this_p->frame_data[this_p->num_addr*7-1] |= SSID_LAST_MASK + + +/*------------------------------------------------------------------------------ + * + * Name: ax25_new + * + * Purpose: Allocate memory for a new packet object. + * + * Returns: Identifier for a new packet object. + * In the current implementation this happens to be a pointer. + * + *------------------------------------------------------------------------------*/ + + +packet_t ax25_new (void) +{ + struct packet_s *this_p; + + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("ax25_new(): before alloc, new=%d, delete=%d\n", new_count, delete_count); +#endif + + last_seq_num++; + new_count++; + +/* + * check for memory leak. + */ + +// version 1.4 push up the threshold. We could have considerably more with connected mode. + + //if (new_count > delete_count + 100) { + if (new_count > delete_count + 256) { + + + text_color_set(DW_COLOR_ERROR); + dw_printf ("Report to WB2OSZ - Memory leak for packet objects. new=%d, delete=%d\n", new_count, delete_count); +#if AX25MEMDEBUG + // Force on debug option to gather evidence. + ax25memdebug_set(); +#endif + } + + this_p = calloc(sizeof (struct packet_s), (size_t)1); + + if (this_p == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("ERROR - can't allocate memory in ax25_new.\n"); + } + + assert (this_p != NULL); + + this_p->magic1 = MAGIC; + this_p->seq = last_seq_num; + this_p->magic2 = MAGIC; + this_p->num_addr = (-1); + + return (this_p); +} + +/*------------------------------------------------------------------------------ + * + * Name: ax25_delete + * + * Purpose: Destroy a packet object, freeing up memory it was using. + * + *------------------------------------------------------------------------------*/ + +#if AX25MEMDEBUG +void ax25_delete_debug (packet_t this_p, char *src_file, int src_line) +#else +void ax25_delete (packet_t this_p) +#endif +{ +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("ax25_delete(): before free, new=%d, delete=%d\n", new_count, delete_count); +#endif + + if (this_p == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("ERROR - NULL pointer passed to ax25_delete.\n"); + return; + } + + + delete_count++; + +#if AX25MEMDEBUG + if (ax25memdebug) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("ax25_delete, seq=%d, called from %s %d, new_count=%d, delete_count=%d\n", this_p->seq, src_file, src_line, new_count, delete_count); + } +#endif + + assert (this_p->magic1 == MAGIC); + assert (this_p->magic2 == MAGIC); + + this_p->magic1 = 0; + this_p->magic1 = 0; + + //memset (this_p, 0, sizeof (struct packet_s)); + free (this_p); +} + + + +/*------------------------------------------------------------------------------ + * + * Name: ax25_from_text + * + * Purpose: Parse a frame in human-readable monitoring format and change + * to internal representation. + * + * Input: monitor - "TNC-2" monitor format for packet. i.e. + * source>dest[,repeater1,repeater2,...]:information + * + * The information part can have non-printable characters + * in the form of <0xff>. This will be converted to single + * bytes. e.g. <0x0d> is carriage return. + * In version 1.4H we will allow nul characters which means + * we have to maintain a length rather than using strlen(). + * I maintain that it violates the spec but want to handle it + * because it does happen and we want to preserve it when + * acting as an IGate rather than corrupting it. + * + * strict - True to enforce rules for packets sent over the air. + * False to be more lenient for packets from IGate server. + * + * Packets from an IGate server can have longer + * addresses after qAC. Up to 9 observed so far. + * The SSID can be 2 alphanumeric characters, not just 1 to 15. + * + * We can just truncate the name because we will only + * end up discarding it. TODO: check on this. + * + * Returns: Pointer to new packet object in the current implementation. + * + * Outputs: Use the "get" functions to retrieve information in different ways. + * + *------------------------------------------------------------------------------*/ + +#if AX25MEMDEBUG +packet_t ax25_from_text_debug (char *monitor, int strict, char *src_file, int src_line) +#else +packet_t ax25_from_text (char *monitor, int strict) +#endif +{ + +/* + * Tearing it apart is destructive so make our own copy first. + */ + char stuff[AX25_MAX_PACKET_LEN+1]; + char *pinfo; + + int ssid_temp, heard_temp; + char atemp[AX25_MAX_ADDR_LEN]; + + char info_part[AX25_MAX_INFO_LEN+1]; + int info_len; + + // text_color_set(DW_COLOR_DEBUG); + // dw_printf ("DEBUG: ax25_from_text ('%s', %d)\n", monitor, strict); + // fflush(stdout); sleep(1); + + packet_t this_p = ax25_new (); + +#if AX25MEMDEBUG + if (ax25memdebug) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("ax25_from_text, seq=%d, called from %s %d\n", this_p->seq, src_file, src_line); + } +#endif + + /* Is it possible to have a nul character (zero byte) in the */ + /* information field of an AX.25 frame? */ + /* At this point, we have a normal C string. */ + /* It is possible that will convert <0x00> to a nul character later. */ + /* There we need to maintain a separate length and not use normal C string functions. */ + + strlcpy (stuff, monitor, sizeof(stuff)); + + +/* + * Initialize the packet structure with two addresses and control/pid + * for APRS. + */ + memset (this_p->frame_data + AX25_DESTINATION*7, ' ' << 1, 6); + this_p->frame_data[AX25_DESTINATION*7+6] = SSID_H_MASK | SSID_RR_MASK; + + memset (this_p->frame_data + AX25_SOURCE*7, ' ' << 1, 6); + this_p->frame_data[AX25_SOURCE*7+6] = SSID_RR_MASK | SSID_LAST_MASK; + + this_p->frame_data[14] = AX25_UI_FRAME; + this_p->frame_data[15] = AX25_PID_NO_LAYER_3; + + this_p->frame_len = 7 + 7 + 1 + 1; + this_p->num_addr = (-1); + (void) ax25_get_num_addr(this_p); // when num_addr is -1, this sets it properly. + assert (this_p->num_addr == 2); + + +/* + * Separate the addresses from the rest. + */ + pinfo = strchr (stuff, ':'); + + if (pinfo == NULL) { + ax25_delete (this_p); + return (NULL); + } + + *pinfo = '\0'; + pinfo++; + +/* + * Separate the addresses. + * Note that source and destination order is swappped. + */ + +/* + * Source address. + */ + + char *pnxt = stuff; + char *pa = strsep (&pnxt, ">"); + if (pa == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Failed to create packet from text. No source address\n"); + ax25_delete (this_p); + return (NULL); + } + + if ( ! ax25_parse_addr (AX25_SOURCE, pa, strict, atemp, &ssid_temp, &heard_temp)) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Failed to create packet from text. Bad source address\n"); + ax25_delete (this_p); + return (NULL); + } + + ax25_set_addr (this_p, AX25_SOURCE, atemp); + ax25_set_h (this_p, AX25_SOURCE); // c/r in this position + ax25_set_ssid (this_p, AX25_SOURCE, ssid_temp); + +/* + * Destination address. + */ + + pa = strsep (&pnxt, ","); + if (pa == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Failed to create packet from text. No destination address\n"); + ax25_delete (this_p); + return (NULL); + } + + if ( ! ax25_parse_addr (AX25_DESTINATION, pa, strict, atemp, &ssid_temp, &heard_temp)) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Failed to create packet from text. Bad destination address\n"); + ax25_delete (this_p); + return (NULL); + } + + ax25_set_addr (this_p, AX25_DESTINATION, atemp); + ax25_set_h (this_p, AX25_DESTINATION); // c/r in this position + ax25_set_ssid (this_p, AX25_DESTINATION, ssid_temp); + +/* + * VIA path. + */ + +// Originally this used strtok_r. +// strtok considers all adjacent delimiters to be a single delimiter. +// This is handy for varying amounts of whitespace. +// It will never return a zero length string. +// All was good until this bizarre case came along: + +// AISAT-1>CQ,,::CQ-0 :From AMSAT INDIA & Exseed Space |114304|48|45|42{962 + +// Apparently there are two digipeater fields but they are empty. +// When we parsed this text representation, the extra commas were ignored rather +// than pointed out as being invalid. + +// Use strsep instead. This does not collapse adjacent delimiters. + + while (( pa = strsep (&pnxt, ",")) != NULL && this_p->num_addr < AX25_MAX_ADDRS ) { + + int k = this_p->num_addr; + + // printf ("DEBUG: get digi loop, num addr = %d, address = '%s'\n", k, pa);// FIXME + + // Hack for q construct, from APRS-IS, so it does not cause panic later. + + if ( ! strict && pa[0] == 'q' && pa[1] == 'A') { + pa[0] = 'Q'; + pa[2] = toupper(pa[2]); + } + + if ( ! ax25_parse_addr (k, pa, strict, atemp, &ssid_temp, &heard_temp)) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Failed to create packet from text. Bad digipeater address\n"); + ax25_delete (this_p); + return (NULL); + } + + ax25_set_addr (this_p, k, atemp); + ax25_set_ssid (this_p, k, ssid_temp); + + // Does it have an "*" at the end? + // TODO: Complain if more than one "*". + // Could also check for all has been repeated bits are adjacent. + + if (heard_temp) { + for ( ; k >= AX25_REPEATER_1; k--) { + ax25_set_h (this_p, k); + } + } + } + + +/* + * Finally, process the information part. + * + * Translate hexadecimal values like <0xff> to single bytes. + * MIC-E format uses 5 different non-printing characters. + * We might want to manually generate UTF-8 characters such as degree. + */ + +//#define DEBUG14H 1 + +#if DEBUG14H + text_color_set(DW_COLOR_DEBUG); + dw_printf ("BEFORE: %s\nSAFE: ", pinfo); + ax25_safe_print (pinfo, -1, 0); + dw_printf ("\n"); +#endif + + info_len = 0; + while (*pinfo != '\0' && info_len < AX25_MAX_INFO_LEN) { + + if (strlen(pinfo) >= 6 && + pinfo[0] == '<' && + pinfo[1] == '0' && + pinfo[2] == 'x' && + isxdigit(pinfo[3]) && + isxdigit(pinfo[4]) && + pinfo[5] == '>') { + + char *p; + + info_part[info_len] = strtol (pinfo + 3, &p, 16); + info_len++; + pinfo += 6; + } + else { + info_part[info_len] = *pinfo; + info_len++; + pinfo++; + } + } + info_part[info_len] = '\0'; + +#if DEBUG14H + text_color_set(DW_COLOR_DEBUG); + dw_printf ("AFTER: %s\nSAFE: ", info_part); + ax25_safe_print (info_part, info_len, 0); + dw_printf ("\n"); +#endif + +/* + * Append the info part. + */ + memcpy ((char*)(this_p->frame_data+this_p->frame_len), info_part, info_len); + this_p->frame_len += info_len; + + return (this_p); +} + + +/*------------------------------------------------------------------------------ + * + * Name: ax25_from_frame + * + * Purpose: Split apart an HDLC frame to components. + * + * Inputs: fbuf - Pointer to beginning of frame. + * + * flen - Length excluding the two FCS bytes. + * + * alevel - Audio level of received signal. + * Maximum range 0 - 100. + * -1 might be used when not applicable. + * + * Returns: Pointer to new packet object or NULL if error. + * + * Outputs: Use the "get" functions to retrieve information in different ways. + * + *------------------------------------------------------------------------------*/ + +#if AX25MEMDEBUG +packet_t ax25_from_frame_debug (unsigned char *fbuf, int flen, alevel_t alevel, char *src_file, int src_line) +#else +packet_t ax25_from_frame (unsigned char *fbuf, int flen, alevel_t alevel) +#endif +{ + packet_t this_p; + + +/* + * First make sure we have an acceptable length: + * + * We are not concerned with the FCS (CRC) because someone else checked it. + * + * Is is possible to have zero length for info? + * + * In the original version, assuming APRS, the answer was no. + * We always had at least 3 octets after the address part: + * control, protocol, and first byte of info part for data type. + * + * In later versions, this restriction was relaxed so other + * variations of AX.25 could be used. Now the minimum length + * is 7+7 for addresses plus 1 for control. + * + */ + + + if (flen < AX25_MIN_PACKET_LEN || flen > AX25_MAX_PACKET_LEN) + { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Frame length %d not in allowable range of %d to %d.\n", flen, AX25_MIN_PACKET_LEN, AX25_MAX_PACKET_LEN); + return (NULL); + } + + this_p = ax25_new (); + +#if AX25MEMDEBUG + if (ax25memdebug) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("ax25_from_frame, seq=%d, called from %s %d\n", this_p->seq, src_file, src_line); + } +#endif + +/* Copy the whole thing intact. */ + + memcpy (this_p->frame_data, fbuf, flen); + this_p->frame_data[flen] = 0; + this_p->frame_len = flen; + +/* Find number of addresses. */ + + this_p->num_addr = (-1); + (void) ax25_get_num_addr (this_p); + + return (this_p); +} + + +/*------------------------------------------------------------------------------ + * + * Name: ax25_dup + * + * Purpose: Make a copy of given packet object. + * + * Inputs: copy_from - Existing packet object. + * + * Returns: Pointer to new packet object or NULL if error. + * + * + *------------------------------------------------------------------------------*/ + + +#if AX25MEMDEBUG +packet_t ax25_dup_debug (packet_t copy_from, char *src_file, int src_line) +#else +packet_t ax25_dup (packet_t copy_from) +#endif +{ + int save_seq; + packet_t this_p; + + + this_p = ax25_new (); + assert (this_p != NULL); + + save_seq = this_p->seq; + + memcpy (this_p, copy_from, sizeof (struct packet_s)); + this_p->seq = save_seq; + +#if AX25MEMDEBUG + if (ax25memdebug) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("ax25_dup, seq=%d, called from %s %d, clone of seq %d\n", this_p->seq, src_file, src_line, copy_from->seq); + } +#endif + + return (this_p); + +} + + +/*------------------------------------------------------------------------------ + * + * Name: ax25_parse_addr + * + * Purpose: Parse address with optional ssid. + * + * Inputs: position - AX25_DESTINATION, AX25_SOURCE, AX25_REPEATER_1... + * Used for more specific error message. -1 if not used. + * + * in_addr - Input such as "WB2OSZ-15*" + * + * strict - 1 (true) for strict checking (6 characters, no lower case, + * SSID must be in range of 0 to 15). + * Strict is appropriate for packets sent + * over the radio. Communication with IGate + * allows lower case (e.g. "qAR") and two + * alphanumeric characters for the SSID. + * We also get messages like this from a server. + * KB1POR>APU25N,TCPIP*,qAC,T2NUENGLD:... + * K1BOS-B>APOSB,TCPIP,WR2X-2*:... + * + * 2 (extra true) will complain if * is found at end. + * + * Outputs: out_addr - Address without any SSID. + * Must be at least AX25_MAX_ADDR_LEN bytes. + * + * out_ssid - Numeric value of SSID. + * + * out_heard - True if "*" found. + * + * Returns: True (1) if OK, false (0) if any error. + * When 0, out_addr, out_ssid, and out_heard are undefined. + * + * + *------------------------------------------------------------------------------*/ + +static const char *position_name[1 + AX25_MAX_ADDRS] = { + "", "Destination ", "Source ", + "Digi1 ", "Digi2 ", "Digi3 ", "Digi4 ", + "Digi5 ", "Digi6 ", "Digi7 ", "Digi8 " }; + +int ax25_parse_addr (int position, char *in_addr, int strict, char *out_addr, int *out_ssid, int *out_heard) +{ + char *p; + char sstr[8]; /* Should be 1 or 2 digits for SSID. */ + int i, j, k; + int maxlen; + + *out_addr = '\0'; + *out_ssid = 0; + *out_heard = 0; + + // dw_printf ("ax25_parse_addr in: position=%d, '%s', strict=%d\n", position, in_addr, strict); + + if (position < -1) position = -1; + if (position > AX25_REPEATER_8) position = AX25_REPEATER_8; + position++; /* Adjust for position_name above. */ + + if (strlen(in_addr) == 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("%sAddress \"%s\" is empty.\n", position_name[position], in_addr); + return 0; + } + + if (strict && strlen(in_addr) >= 2 && strncmp(in_addr, "qA", 2) == 0) { + + text_color_set(DW_COLOR_ERROR); + dw_printf ("%sAddress \"%s\" is a \"q-construct\" used for communicating with\n", position_name[position], in_addr); + dw_printf ("APRS Internet Servers. It should never appear when going over the radio.\n"); + } + + // dw_printf ("ax25_parse_addr in: %s\n", in_addr); + + maxlen = strict ? 6 : (AX25_MAX_ADDR_LEN-1); + p = in_addr; + i = 0; + for (p = in_addr; *p != '\0' && *p != '-' && *p != '*'; p++) { + if (i >= maxlen) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("%sAddress is too long. \"%s\" has more than %d characters.\n", position_name[position], in_addr, maxlen); + return 0; + } + if ( ! isalnum(*p)) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("%sAddress, \"%s\" contains character other than letter or digit in character position %d.\n", position_name[position], in_addr, (int)(long)(p-in_addr)+1); + return 0; + } + + out_addr[i++] = *p; + out_addr[i] = '\0'; + +#if DECAMAIN // Hack when running in decode_aprs utility. + // Exempt the "qA..." case because it was already mentioned. + + if (strict && islower(*p) && strncmp(in_addr, "qA", 2) != 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("%sAddress has lower case letters. \"%s\" must be all upper case.\n", position_name[position], in_addr); + } +#else + if (strict && islower(*p)) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("%sAddress has lower case letters. \"%s\" must be all upper case.\n", position_name[position], in_addr); + return 0; + } +#endif + } + + j = 0; + sstr[j] = '\0'; + if (*p == '-') { + for (p++; isalnum(*p); p++) { + if (j >= 2) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("%sSSID is too long. SSID part of \"%s\" has more than 2 characters.\n", position_name[position], in_addr); + return 0; + } + sstr[j++] = *p; + sstr[j] = '\0'; + if (strict && ! isdigit(*p)) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("%sSSID must be digits. \"%s\" has letters in SSID.\n", position_name[position], in_addr); + return 0; + } + } + k = atoi(sstr); + if (k < 0 || k > 15) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("%sSSID out of range. SSID of \"%s\" not in range of 0 to 15.\n", position_name[position], in_addr); + return 0; + } + *out_ssid = k; + } + + if (*p == '*') { + *out_heard = 1; + p++; + if (strict == 2) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("\"*\" is not allowed at end of address \"%s\" here.\n", in_addr); + return 0; + } + } + + if (*p != '\0') { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Invalid character \"%c\" found in %saddress \"%s\".\n", *p, position_name[position], in_addr); + return 0; + } + + // dw_printf ("ax25_parse_addr out: '%s' %d %d\n", out_addr, *out_ssid, *out_heard); + + return (1); + +} /* end ax25_parse_addr */ + + +/*------------------------------------------------------------------- + * + * Name: ax25_check_addresses + * + * Purpose: Check addresses of given packet and print message if any issues. + * We call this when receiving and transmitting. + * + * Inputs: pp - packet object pointer. + * + * Errors: Print error message. + * + * Returns: 1 for all valid. 0 if not. + * + * Examples: I was surprised to get this from an APRS-IS server with + * a lower case source address. + * + * n1otx>APRS,TCPIP*,qAC,THIRD:@141335z4227.48N/07111.73W_348/005g014t044r000p000h60b10075.wview_5_20_2 + * + * I haven't gotten to the bottom of this yet but it sounds + * like "q constructs" are somehow getting on to the air when + * they should only appear in conversations with IGate servers. + * + * https://groups.yahoo.com/neo/groups/direwolf_packet/conversations/topics/678 + * + * WB0VGI-7>APDW12,W0YC-5*,qAR,AE0RF-10:}N0DZQ-10>APWW10,TCPIP,WB0VGI-7*:;145.230MN*080306z4607.62N/09230.58WrKE0ACL/R 145.230- T146.2 (Pine County ARES) + * + * Typical result: + * + * Digipeater WIDE2 (probably N3LEE-4) audio level = 28(10/6) [NONE] __||||||| + * [0.5] VE2DJE-9>P_0_P?,VE2PCQ-3,K1DF-7,N3LEE-4,WIDE2*:'{S+l <0x1c>>/ + * Invalid character "_" in MIC-E destination/latitude. + * Invalid character "_" in MIC-E destination/latitude. + * Invalid character "?" in MIC-E destination/latitude. + * Invalid MIC-E N/S encoding in 4th character of destination. + * Invalid MIC-E E/W encoding in 6th character of destination. + * MIC-E, normal car (side view), Unknown manufacturer, Returning + * N 00 00.0000, E 005 55.1500, 0 MPH + * Invalid character "_" found in Destination address "P_0_P?". + * + * *** The origin and journey of this packet should receive some scrutiny. *** + * + *--------------------------------------------------------------------*/ + +int ax25_check_addresses (packet_t pp) +{ + int n; + char addr[AX25_MAX_ADDR_LEN]; + char ignore1[AX25_MAX_ADDR_LEN]; + int ignore2, ignore3; + int all_ok = 1; + + for (n = 0; n < ax25_get_num_addr(pp); n++) { + ax25_get_addr_with_ssid (pp, n, addr); + all_ok &= ax25_parse_addr (n, addr, 1, ignore1, &ignore2, &ignore3); + } + + if (! all_ok) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("\n"); + dw_printf ("*** The origin and journey of this packet should receive some scrutiny. ***\n"); + dw_printf ("\n"); + } + + return (all_ok); +} /* end ax25_check_addresses */ + + +/*------------------------------------------------------------------------------ + * + * Name: ax25_unwrap_third_party + * + * Purpose: Unwrap a third party message from the header. + * + * Inputs: copy_from - Existing packet object. + * + * Returns: Pointer to new packet object or NULL if error. + * + * Example: Input: A>B,C:}D>E,F:info + * Output: D>E,F:info + * + *------------------------------------------------------------------------------*/ + +packet_t ax25_unwrap_third_party (packet_t from_pp) +{ + unsigned char *info_p; + packet_t result_pp; + + if (ax25_get_dti(from_pp) != '}') { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Internal error: ax25_unwrap_third_party: wrong data type.\n"); + return (NULL); + } + + (void) ax25_get_info (from_pp, &info_p); + + // Want strict because addresses should conform to AX.25 here. + // That's not the case for something from an Internet Server. + + result_pp = ax25_from_text((char *)info_p + 1, 1); + + return (result_pp); +} + + + +/*------------------------------------------------------------------------------ + * + * Name: ax25_set_addr + * + * Purpose: Add or change an address. + * + * Inputs: n - Index of address. Use the symbols + * AX25_DESTINATION, AX25_SOURCE, AX25_REPEATER1, etc. + * + * Must be either an existing address or one greater + * than the final which causes a new one to be added. + * + * ad - Address with optional dash and substation id. + * + * Assumption: ax25_from_text or ax25_from_frame was called first. + * + * TODO: ax25_from_text could use this. + * + * Returns: None. + * + *------------------------------------------------------------------------------*/ + +void ax25_set_addr (packet_t this_p, int n, char *ad) +{ + int ssid_temp, heard_temp; + char atemp[AX25_MAX_ADDR_LEN]; + int i; + + assert (this_p->magic1 == MAGIC); + assert (this_p->magic2 == MAGIC); + assert (n >= 0 && n < AX25_MAX_ADDRS); + + //dw_printf ("ax25_set_addr (%d, %s) num_addr=%d\n", n, ad, this_p->num_addr); + + if (strlen(ad) == 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Set address error! Station address for position %d is empty!\n", n); + } + + if (n >= 0 && n < this_p->num_addr) { + + //dw_printf ("ax25_set_addr , existing case\n"); +/* + * Set existing address position. + */ + + // Why aren't we setting 'strict' here? + // Messages from IGate have q-constructs. + // We use this to parse it and later remove unwanted parts. + + ax25_parse_addr (n, ad, 0, atemp, &ssid_temp, &heard_temp); + + memset (this_p->frame_data + n*7, ' ' << 1, 6); + + for (i=0; i<6 && atemp[i] != '\0'; i++) { + this_p->frame_data[n*7+i] = atemp[i] << 1; + } + ax25_set_ssid (this_p, n, ssid_temp); + } + else if (n == this_p->num_addr) { + + //dw_printf ("ax25_set_addr , appending case\n"); +/* + * One beyond last position, process as insert. + */ + + ax25_insert_addr (this_p, n, ad); + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Internal error, ax25_set_addr, bad position %d for '%s'\n", n, ad); + } + + //dw_printf ("------\n"); + //dw_printf ("dump after ax25_set_addr (%d, %s)\n", n, ad); + //ax25_hex_dump (this_p); + //dw_printf ("------\n"); +} + + +/*------------------------------------------------------------------------------ + * + * Name: ax25_insert_addr + * + * Purpose: Insert address at specified position, shifting others up one + * position. + * This is used when a digipeater wants to insert its own call + * for tracing purposes. + * For example: + * W1ABC>TEST,WIDE3-3 + * Would become: + * W1ABC>TEST,WB2OSZ-1*,WIDE3-2 + * + * Inputs: n - Index of address. Use the symbols + * AX25_DESTINATION, AX25_SOURCE, AX25_REPEATER1, etc. + * + * ad - Address with optional dash and substation id. + * + * Bugs: Little validity or bounds checking is performed. Be careful. + * + * Assumption: ax25_from_text or ax25_from_frame was called first. + * + * Returns: None. + * + * + *------------------------------------------------------------------------------*/ + +void ax25_insert_addr (packet_t this_p, int n, char *ad) +{ + int ssid_temp, heard_temp; + char atemp[AX25_MAX_ADDR_LEN]; + int i; + int expect; + + assert (this_p->magic1 == MAGIC); + assert (this_p->magic2 == MAGIC); + assert (n >= AX25_REPEATER_1 && n < AX25_MAX_ADDRS); + + //dw_printf ("ax25_insert_addr (%d, %s)\n", n, ad); + + if (strlen(ad) == 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Set address error! Station address for position %d is empty!\n", n); + } + + /* Don't do it if we already have the maximum number. */ + /* Should probably return success/fail code but currently the caller doesn't care. */ + + if ( this_p->num_addr >= AX25_MAX_ADDRS) { + return; + } + + CLEAR_LAST_ADDR_FLAG; + + this_p->num_addr++; + + memmove (this_p->frame_data + (n+1)*7, this_p->frame_data + n*7, this_p->frame_len - (n*7)); + memset (this_p->frame_data + n*7, ' ' << 1, 6); + this_p->frame_len += 7; + this_p->frame_data[n*7+6] = SSID_RR_MASK; + + SET_LAST_ADDR_FLAG; + + // Why aren't we setting 'strict' here? + // Messages from IGate have q-constructs. + // We use this to parse it and later remove unwanted parts. + + ax25_parse_addr (n, ad, 0, atemp, &ssid_temp, &heard_temp); + memset (this_p->frame_data + n*7, ' ' << 1, 6); + for (i=0; i<6 && atemp[i] != '\0'; i++) { + this_p->frame_data[n*7+i] = atemp[i] << 1; + } + + ax25_set_ssid (this_p, n, ssid_temp); + + // Sanity check after messing with number of addresses. + + expect = this_p->num_addr; + this_p->num_addr = (-1); + if (expect != ax25_get_num_addr (this_p)) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Internal error ax25_remove_addr expect %d, actual %d\n", expect, this_p->num_addr); + } +} + + +/*------------------------------------------------------------------------------ + * + * Name: ax25_remove_addr + * + * Purpose: Remove address at specified position, shifting others down one position. + * This is used when we want to remove something from the digipeater list. + * + * Inputs: n - Index of address. Use the symbols + * AX25_REPEATER1, AX25_REPEATER2, etc. + * + * Bugs: Little validity or bounds checking is performed. Be careful. + * + * Assumption: ax25_from_text or ax25_from_frame was called first. + * + * Returns: None. + * + * + *------------------------------------------------------------------------------*/ + +void ax25_remove_addr (packet_t this_p, int n) +{ + int expect; + + assert (this_p->magic1 == MAGIC); + assert (this_p->magic2 == MAGIC); + assert (n >= AX25_REPEATER_1 && n < AX25_MAX_ADDRS); + + /* Shift those beyond to fill this position. */ + + CLEAR_LAST_ADDR_FLAG; + + this_p->num_addr--; + + memmove (this_p->frame_data + n*7, this_p->frame_data + (n+1)*7, this_p->frame_len - ((n+1)*7)); + this_p->frame_len -= 7; + SET_LAST_ADDR_FLAG; + + // Sanity check after messing with number of addresses. + + expect = this_p->num_addr; + this_p->num_addr = (-1); + if (expect != ax25_get_num_addr (this_p)) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Internal error ax25_remove_addr expect %d, actual %d\n", expect, this_p->num_addr); + } + +} + + +/*------------------------------------------------------------------------------ + * + * Name: ax25_get_num_addr + * + * Purpose: Return number of addresses in current packet. + * + * Assumption: ax25_from_text or ax25_from_frame was called first. + * + * Returns: Number of addresses in the current packet. + * Should be in the range of 2 .. AX25_MAX_ADDRS. + * + * Version 0.9: Could be zero for a non AX.25 frame in KISS mode. + * + *------------------------------------------------------------------------------*/ + +int ax25_get_num_addr (packet_t this_p) +{ + //unsigned char *pf; + int a; + int addr_bytes; + + + assert (this_p->magic1 == MAGIC); + assert (this_p->magic2 == MAGIC); + +/* Use cached value if already set. */ + + if (this_p->num_addr >= 0) { + return (this_p->num_addr); + } + +/* Otherwise, determine the number ofaddresses. */ + + this_p->num_addr = 0; /* Number of addresses extracted. */ + + addr_bytes = 0; + for (a = 0; a < this_p->frame_len && addr_bytes == 0; a++) { + if (this_p->frame_data[a] & SSID_LAST_MASK) { + addr_bytes = a + 1; + } + } + + if (addr_bytes % 7 == 0) { + int addrs = addr_bytes / 7; + if (addrs >= AX25_MIN_ADDRS && addrs <= AX25_MAX_ADDRS) { + this_p->num_addr = addrs; + } + } + + return (this_p->num_addr); +} + + +/*------------------------------------------------------------------------------ + * + * Name: ax25_get_num_repeaters + * + * Purpose: Return number of repeater addresses in current packet. + * + * Assumption: ax25_from_text or ax25_from_frame was called first. + * + * Returns: Number of addresses in the current packet - 2. + * Should be in the range of 0 .. AX25_MAX_ADDRS - 2. + * + *------------------------------------------------------------------------------*/ + +int ax25_get_num_repeaters (packet_t this_p) +{ + assert (this_p->magic1 == MAGIC); + assert (this_p->magic2 == MAGIC); + + if (this_p->num_addr >= 2) { + return (this_p->num_addr - 2); + } + + return (0); +} + + +/*------------------------------------------------------------------------------ + * + * Name: ax25_get_addr_with_ssid + * + * Purpose: Return specified address with any SSID in current packet. + * + * Inputs: n - Index of address. Use the symbols + * AX25_DESTINATION, AX25_SOURCE, AX25_REPEATER1, etc. + * + * Outputs: station - String representation of the station, including the SSID. + * e.g. "WB2OSZ-15" + * Usually variables will be AX25_MAX_ADDR_LEN bytes + * but 10 would be adequate. + * + * Bugs: No bounds checking is performed. Be careful. + * + * Assumption: ax25_from_text or ax25_from_frame was called first. + * + * Returns: Character string in usual human readable format, + * + * + *------------------------------------------------------------------------------*/ + +void ax25_get_addr_with_ssid (packet_t this_p, int n, char *station) +{ + int ssid; + char sstr[8]; /* Should be 1 or 2 digits for SSID. */ + int i; + + assert (this_p->magic1 == MAGIC); + assert (this_p->magic2 == MAGIC); + + + if (n < 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Internal error detected in ax25_get_addr_with_ssid, %s, line %d.\n", __FILE__, __LINE__); + dw_printf ("Address index, %d, is less than zero.\n", n); + strlcpy (station, "??????", 10); + return; + } + + if (n >= this_p->num_addr) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Internal error detected in ax25_get_addr_with_ssid, %s, line %d.\n", __FILE__, __LINE__); + dw_printf ("Address index, %d, is too large for number of addresses, %d.\n", n, this_p->num_addr); + strlcpy (station, "??????", 10); + return; + } + + // At one time this would stop at the first space, on the assumption we would have only trailing spaces. + // Then there was a forum discussion where someone encountered the address " WIDE2" with a leading space. + // In that case, we would have returned a zero length string here. + // Now we return exactly what is in the address field and trim trailing spaces. + // This will provide better information for troubleshooting. + + for (i=0; i<6; i++) { + station[i] = (this_p->frame_data[n*7+i] >> 1) & 0x7f; + } + station[6] = '\0'; + + for (i=5; i>=0; i--) { + if (station[i] == '\0') { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Station address \"%s\" contains nul character. AX.25 protocol requires trailing ASCII spaces when less than 6 characters.\n", station); + } + else if (station[i] == ' ') + station[i] = '\0'; + else + break; + } + + if (strlen(station) == 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Station address, in position %d, is empty! This is not a valid AX.25 frame.\n", n); + } + + ssid = ax25_get_ssid (this_p, n); + if (ssid != 0) { + snprintf (sstr, sizeof(sstr), "-%d", ssid); + strlcat (station, sstr, 10); + } + +} /* end ax25_get_addr_with_ssid */ + + +/*------------------------------------------------------------------------------ + * + * Name: ax25_get_addr_no_ssid + * + * Purpose: Return specified address WITHOUT any SSID. + * + * Inputs: n - Index of address. Use the symbols + * AX25_DESTINATION, AX25_SOURCE, AX25_REPEATER1, etc. + * + * Outputs: station - String representation of the station, WITHOUT the SSID. + * e.g. "WB2OSZ" + * Usually variables will be AX25_MAX_ADDR_LEN bytes + * but 7 would be adequate. + * + * Bugs: No bounds checking is performed. Be careful. + * + * Assumption: ax25_from_text or ax25_from_frame was called first. + * + * Returns: Character string in usual human readable format, + * + * + *------------------------------------------------------------------------------*/ + +void ax25_get_addr_no_ssid (packet_t this_p, int n, char *station) +{ + int i; + + assert (this_p->magic1 == MAGIC); + assert (this_p->magic2 == MAGIC); + + + if (n < 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Internal error detected in ax25_get_addr_no_ssid, %s, line %d.\n", __FILE__, __LINE__); + dw_printf ("Address index, %d, is less than zero.\n", n); + strlcpy (station, "??????", 7); + return; + } + + if (n >= this_p->num_addr) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Internal error detected in ax25_get_no_with_ssid, %s, line %d.\n", __FILE__, __LINE__); + dw_printf ("Address index, %d, is too large for number of addresses, %d.\n", n, this_p->num_addr); + strlcpy (station, "??????", 7); + return; + } + + // At one time this would stop at the first space, on the assumption we would have only trailing spaces. + // Then there was a forum discussion where someone encountered the address " WIDE2" with a leading space. + // In that case, we would have returned a zero length string here. + // Now we return exactly what is in the address field and trim trailing spaces. + // This will provide better information for troubleshooting. + + for (i=0; i<6; i++) { + station[i] = (this_p->frame_data[n*7+i] >> 1) & 0x7f; + } + station[6] = '\0'; + + for (i=5; i>=0; i--) { + if (station[i] == ' ') + station[i] = '\0'; + else + break; + } + + if (strlen(station) == 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Station address, in position %d, is empty! This is not a valid AX.25 frame.\n", n); + } + +} /* end ax25_get_addr_no_ssid */ + + +/*------------------------------------------------------------------------------ + * + * Name: ax25_get_ssid + * + * Purpose: Return SSID of specified address in current packet. + * + * Inputs: n - Index of address. Use the symbols + * AX25_DESTINATION, AX25_SOURCE, AX25_REPEATER1, etc. + * + * Assumption: ax25_from_text or ax25_from_frame was called first. + * + * Returns: Substation id, as integer 0 .. 15. + * + *------------------------------------------------------------------------------*/ + +int ax25_get_ssid (packet_t this_p, int n) +{ + + assert (this_p->magic1 == MAGIC); + assert (this_p->magic2 == MAGIC); + + if (n >= 0 && n < this_p->num_addr) { + return ((this_p->frame_data[n*7+6] & SSID_SSID_MASK) >> SSID_SSID_SHIFT); + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Internal error: ax25_get_ssid(%d), num_addr=%d\n", n, this_p->num_addr); + return (0); + } +} + + +/*------------------------------------------------------------------------------ + * + * Name: ax25_set_ssid + * + * Purpose: Set the SSID of specified address in current packet. + * + * Inputs: n - Index of address. Use the symbols + * AX25_DESTINATION, AX25_SOURCE, AX25_REPEATER1, etc. + * + * ssid - New SSID. Must be in range of 0 to 15. + * + * Assumption: ax25_from_text or ax25_from_frame was called first. + * + * Bugs: Rewrite to keep call and SSID separate internally. + * + *------------------------------------------------------------------------------*/ + +void ax25_set_ssid (packet_t this_p, int n, int ssid) +{ + + assert (this_p->magic1 == MAGIC); + assert (this_p->magic2 == MAGIC); + + + if (n >= 0 && n < this_p->num_addr) { + this_p->frame_data[n*7+6] = (this_p->frame_data[n*7+6] & ~ SSID_SSID_MASK) | + ((ssid << SSID_SSID_SHIFT) & SSID_SSID_MASK) ; + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Internal error: ax25_set_ssid(%d,%d), num_addr=%d\n", n, ssid, this_p->num_addr); + } +} + + +/*------------------------------------------------------------------------------ + * + * Name: ax25_get_h + * + * Purpose: Return "has been repeated" flag of specified address in current packet. + * + * Inputs: n - Index of address. Use the symbols + * AX25_DESTINATION, AX25_SOURCE, AX25_REPEATER1, etc. + * + * Bugs: No bounds checking is performed. Be careful. + * + * Assumption: ax25_from_text or ax25_from_frame was called first. + * + * Returns: True or false. + * + *------------------------------------------------------------------------------*/ + +int ax25_get_h (packet_t this_p, int n) +{ + + assert (this_p->magic1 == MAGIC); + assert (this_p->magic2 == MAGIC); + assert (n >= 0 && n < this_p->num_addr); + + if (n >= 0 && n < this_p->num_addr) { + return ((this_p->frame_data[n*7+6] & SSID_H_MASK) >> SSID_H_SHIFT); + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Internal error: ax25_get_h(%d), num_addr=%d\n", n, this_p->num_addr); + return (0); + } +} + + +/*------------------------------------------------------------------------------ + * + * Name: ax25_set_h + * + * Purpose: Set the "has been repeated" flag of specified address in current packet. + * + * Inputs: n - Index of address. Use the symbols + * Should be in range of AX25_REPEATER_1 .. AX25_REPEATER_8. + * + * Bugs: No bounds checking is performed. Be careful. + * + * Assumption: ax25_from_text or ax25_from_frame was called first. + * + * Returns: None + * + *------------------------------------------------------------------------------*/ + +void ax25_set_h (packet_t this_p, int n) +{ + + assert (this_p->magic1 == MAGIC); + assert (this_p->magic2 == MAGIC); + + if (n >= 0 && n < this_p->num_addr) { + this_p->frame_data[n*7+6] |= SSID_H_MASK; + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Internal error: ax25_set_hd(%d), num_addr=%d\n", n, this_p->num_addr); + } +} + + +/*------------------------------------------------------------------------------ + * + * Name: ax25_get_heard + * + * Purpose: Return index of the station that we heard. + * + * Inputs: none + * + * + * Assumption: ax25_from_text or ax25_from_frame was called first. + * + * Returns: If any of the digipeaters have the has-been-repeated bit set, + * return the index of the last one. Otherwise return index for source. + * + *------------------------------------------------------------------------------*/ + +int ax25_get_heard(packet_t this_p) +{ + int i; + int result; + + assert (this_p->magic1 == MAGIC); + assert (this_p->magic2 == MAGIC); + + result = AX25_SOURCE; + + for (i = AX25_REPEATER_1; i < ax25_get_num_addr(this_p); i++) { + + if (ax25_get_h(this_p,i)) { + result = i; + } + } + return (result); +} + + + +/*------------------------------------------------------------------------------ + * + * Name: ax25_get_first_not_repeated + * + * Purpose: Return index of the first repeater that does NOT have the + * "has been repeated" flag set or -1 if none. + * + * Inputs: none + * + * + * Assumption: ax25_from_text or ax25_from_frame was called first. + * + * Returns: In range of X25_REPEATER_1 .. X25_REPEATER_8 or -1 if none. + * + *------------------------------------------------------------------------------*/ + +int ax25_get_first_not_repeated(packet_t this_p) +{ + int i; + + assert (this_p->magic1 == MAGIC); + assert (this_p->magic2 == MAGIC); + + for (i = AX25_REPEATER_1; i < ax25_get_num_addr(this_p); i++) { + + if ( ! ax25_get_h(this_p,i)) { + return (i); + } + } + return (-1); +} + + +/*------------------------------------------------------------------------------ + * + * Name: ax25_get_rr + * + * Purpose: Return the two reserved "RR" bits in the specified address field. + * + * Inputs: pp - Packet object. + * + * n - Index of address. Use the symbols + * AX25_DESTINATION, AX25_SOURCE, AX25_REPEATER1, etc. + * + * Returns: 0, 1, 2, or 3. + * + *------------------------------------------------------------------------------*/ + +int ax25_get_rr (packet_t this_p, int n) +{ + + assert (this_p->magic1 == MAGIC); + assert (this_p->magic2 == MAGIC); + assert (n >= 0 && n < this_p->num_addr); + + if (n >= 0 && n < this_p->num_addr) { + return ((this_p->frame_data[n*7+6] & SSID_RR_MASK) >> SSID_RR_SHIFT); + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Internal error: ax25_get_rr(%d), num_addr=%d\n", n, this_p->num_addr); + return (0); + } +} + + +/*------------------------------------------------------------------------------ + * + * Name: ax25_get_info + * + * Purpose: Obtain Information part of current packet. + * + * Inputs: this_p - Packet object pointer. + * + * Outputs: paddr - Starting address of information part is returned here. + * + * Assumption: ax25_from_text or ax25_from_frame was called first. + * + * Returns: Number of octets in the Information part. + * Should be in the range of AX25_MIN_INFO_LEN .. AX25_MAX_INFO_LEN. + * + *------------------------------------------------------------------------------*/ + +int ax25_get_info (packet_t this_p, unsigned char **paddr) +{ + unsigned char *info_ptr; + int info_len; + + + assert (this_p->magic1 == MAGIC); + assert (this_p->magic2 == MAGIC); + + if (this_p->num_addr >= 2) { + + /* AX.25 */ + + info_ptr = this_p->frame_data + ax25_get_info_offset(this_p); + info_len = ax25_get_num_info(this_p); + } + else { + + /* Not AX.25. Treat Whole packet as info. */ + + info_ptr = this_p->frame_data; + info_len = this_p->frame_len; + } + + /* Add nul character in case caller treats as printable string. */ + + assert (info_len >= 0); + + info_ptr[info_len] = '\0'; + + *paddr = info_ptr; + return (info_len); + +} /* end ax25_get_info */ + + +void ax25_set_info (packet_t this_p, unsigned char *new_info_ptr, int new_info_len) +{ + unsigned char *old_info_ptr; + int old_info_len = ax25_get_info (this_p, &old_info_ptr); + this_p->frame_len -= old_info_len; + + if (new_info_len < 0) new_info_len = 0; + if (new_info_len > AX25_MAX_INFO_LEN) new_info_len = AX25_MAX_INFO_LEN; + memcpy (old_info_ptr, new_info_ptr, new_info_len); + this_p->frame_len += new_info_len; +} + + +/*------------------------------------------------------------------------------ + * + * Name: ax25_cut_at_crlf + * + * Purpose: Truncate the information part at the first CR or LF. + * This is used for the RF>IS IGate function. + * CR/LF is used as record separator so we must remove it + * before packaging up packet to sending to server. + * + * Inputs: this_p - Packet object pointer. + * + * Outputs: Packet is modified in place. + * + * Returns: Number of characters removed from the end. + * 0 if not changed. + * + * Assumption: ax25_from_text or ax25_from_frame was called first. + * + *------------------------------------------------------------------------------*/ + +int ax25_cut_at_crlf (packet_t this_p) +{ + unsigned char *info_ptr; + int info_len; + int j; + + + assert (this_p->magic1 == MAGIC); + assert (this_p->magic2 == MAGIC); + + info_len = ax25_get_info (this_p, &info_ptr); + + // Can't use strchr because there is potential of nul character. + + for (j = 0; j < info_len; j++) { + + if (info_ptr[j] == '\r' || info_ptr[j] == '\n') { + + int chop = info_len - j; + + this_p->frame_len -= chop; + return (chop); + } + } + + return (0); +} + + +/*------------------------------------------------------------------------------ + * + * Name: ax25_get_dti + * + * Purpose: Get Data Type Identifier from Information part. + * + * Inputs: None. + * + * Assumption: ax25_from_text or ax25_from_frame was called first. + * + * Returns: First byte from the information part. + * + *------------------------------------------------------------------------------*/ + +int ax25_get_dti (packet_t this_p) +{ + assert (this_p->magic1 == MAGIC); + assert (this_p->magic2 == MAGIC); + + if (this_p->num_addr >= 2) { + return (this_p->frame_data[ax25_get_info_offset(this_p)]); + } + return (' '); +} + +/*------------------------------------------------------------------------------ + * + * Name: ax25_set_nextp + * + * Purpose: Set next packet object in queue. + * + * Inputs: this_p - Current packet object. + * + * next_p - pointer to next one + * + * Description: This is used to build a linked list for a queue. + * + *------------------------------------------------------------------------------*/ + +void ax25_set_nextp (packet_t this_p, packet_t next_p) +{ + assert (this_p->magic1 == MAGIC); + assert (this_p->magic2 == MAGIC); + + this_p->nextp = next_p; +} + + + +/*------------------------------------------------------------------------------ + * + * Name: ax25_get_nextp + * + * Purpose: Obtain next packet object in queue. + * + * Inputs: Packet object. + * + * Returns: Following object in queue or NULL. + * + *------------------------------------------------------------------------------*/ + +packet_t ax25_get_nextp (packet_t this_p) +{ + assert (this_p->magic1 == MAGIC); + assert (this_p->magic2 == MAGIC); + + return (this_p->nextp); +} + + +/*------------------------------------------------------------------------------ + * + * Name: ax25_set_release_time + * + * Purpose: Set release time + * + * Inputs: this_p - Current packet object. + * + * release_time - Time as returned by dtime_monotonic(). + * + *------------------------------------------------------------------------------*/ + +void ax25_set_release_time (packet_t this_p, double release_time) +{ + assert (this_p->magic1 == MAGIC); + assert (this_p->magic2 == MAGIC); + + this_p->release_time = release_time; +} + + + +/*------------------------------------------------------------------------------ + * + * Name: ax25_get_release_time + * + * Purpose: Get release time. + * + *------------------------------------------------------------------------------*/ + +double ax25_get_release_time (packet_t this_p) +{ + assert (this_p->magic1 == MAGIC); + assert (this_p->magic2 == MAGIC); + + return (this_p->release_time); +} + + +/*------------------------------------------------------------------------------ + * + * Name: ax25_set_modulo + * + * Purpose: Set modulo value for I and S frame sequence numbers. + * + *------------------------------------------------------------------------------*/ + +void ax25_set_modulo (packet_t this_p, int modulo) +{ + assert (this_p->magic1 == MAGIC); + assert (this_p->magic2 == MAGIC); + + this_p->modulo = modulo; +} + + +/*------------------------------------------------------------------------------ + * + * Name: ax25_get_modulo + * + * Purpose: Get modulo value for I and S frame sequence numbers. + * + * Returns: 8 or 128 if known. + * 0 if unknown. + * + *------------------------------------------------------------------------------*/ + +int ax25_get_modulo (packet_t this_p) +{ + assert (this_p->magic1 == MAGIC); + assert (this_p->magic2 == MAGIC); + + return (this_p->modulo); +} + + + + +/*------------------------------------------------------------------ + * + * Function: ax25_format_addrs + * + * Purpose: Format all the addresses suitable for printing. + * + * The AX.25 spec refers to this as "Source Path Header" - "TNC-2" Format + * + * Inputs: Current packet. + * + * Outputs: result - All addresses combined into a single string of the form: + * + * "Source > Destination [ , repeater ... ] :" + * + * An asterisk is displayed after the last digipeater + * with the "H" bit set. e.g. If we hear RPT2, + * + * SRC>DST,RPT1,RPT2*,RPT3: + * + * No asterisk means the source is being heard directly. + * Needs to be 101 characters to avoid overflowing. + * (Up to 100 characters + \0) + * + * Errors: No error checking so caller needs to be careful. + * + * + *------------------------------------------------------------------*/ + +// TODO: max len for result. buffer overflow? + +void ax25_format_addrs (packet_t this_p, char *result) +{ + int i; + int heard; + char stemp[AX25_MAX_ADDR_LEN]; + + assert (this_p->magic1 == MAGIC); + assert (this_p->magic2 == MAGIC); + *result = '\0'; + + /* New in 0.9. */ + /* Don't get upset if no addresses. */ + /* This will allow packets that do not comply to AX.25 format. */ + + if (this_p->num_addr == 0) { + return; + } + + ax25_get_addr_with_ssid (this_p, AX25_SOURCE, stemp); + // FIXME: For ALL strcat: Pass in sizeof result and use strlcat. + strcat (result, stemp); + strcat (result, ">"); + + ax25_get_addr_with_ssid (this_p, AX25_DESTINATION, stemp); + strcat (result, stemp); + + heard = ax25_get_heard(this_p); + + for (i=(int)AX25_REPEATER_1; inum_addr; i++) { + ax25_get_addr_with_ssid (this_p, i, stemp); + strcat (result, ","); + strcat (result, stemp); + if (i == heard) { + strcat (result, "*"); + } + } + + strcat (result, ":"); + + // dw_printf ("DEBUG ax25_format_addrs, num_addr = %d, result = '%s'\n", this_p->num_addr, result); +} + + +/*------------------------------------------------------------------ + * + * Function: ax25_format_via_path + * + * Purpose: Format via path addresses suitable for printing. + * + * Inputs: Current packet. + * + * result_size - Number of bytes available for result. + * We can have up to 8 addresses x 9 characters + * plus 7 commas, possible *, and nul = 81 minimum. + * + * Outputs: result - Digipeater field addresses combined into a single string of the form: + * + * "repeater, repeater ..." + * + * An asterisk is displayed after the last digipeater + * with the "H" bit set. e.g. If we hear RPT2, + * + * RPT1,RPT2*,RPT3 + * + * No asterisk means the source is being heard directly. + * + *------------------------------------------------------------------*/ + +void ax25_format_via_path (packet_t this_p, char *result, size_t result_size) +{ + int i; + int heard; + char stemp[AX25_MAX_ADDR_LEN]; + + assert (this_p->magic1 == MAGIC); + assert (this_p->magic2 == MAGIC); + *result = '\0'; + + /* Don't get upset if no addresses. */ + /* This will allow packets that do not comply to AX.25 format. */ + + if (this_p->num_addr == 0) { + return; + } + + heard = ax25_get_heard(this_p); + + for (i=(int)AX25_REPEATER_1; inum_addr; i++) { + if (i > (int)AX25_REPEATER_1) { + strlcat (result, ",", result_size); + } + ax25_get_addr_with_ssid (this_p, i, stemp); + strlcat (result, stemp, result_size); + if (i == heard) { + strlcat (result, "*", result_size); + } + } + +} /* end ax25_format_via_path */ + + +/*------------------------------------------------------------------ + * + * Function: ax25_pack + * + * Purpose: Put all the pieces into format ready for transmission. + * + * Inputs: this_p - pointer to packet object. + * + * Outputs: result - Frame buffer, AX25_MAX_PACKET_LEN bytes. + * Should also have two extra for FCS to be + * added later. + * + * Returns: Number of octets in the frame buffer. + * Does NOT include the extra 2 for FCS. + * + * Errors: Returns -1. + * + *------------------------------------------------------------------*/ + +int ax25_pack (packet_t this_p, unsigned char result[AX25_MAX_PACKET_LEN]) +{ + + assert (this_p->magic1 == MAGIC); + assert (this_p->magic2 == MAGIC); + + assert (this_p->frame_len >= 0 && this_p->frame_len <= AX25_MAX_PACKET_LEN); + + memcpy (result, this_p->frame_data, this_p->frame_len); + + return (this_p->frame_len); +} + + + +/*------------------------------------------------------------------ + * + * Function: ax25_frame_type + * + * Purpose: Extract the type of frame. + * This is derived from the control byte(s) but + * is an enumerated type for easier handling. + * + * Inputs: this_p - pointer to packet object. + * + * Outputs: desc - Text description such as "I frame" or + * "U frame SABME". + * Supply 56 bytes to be safe. + * + * cr - Command or response? + * + * pf - P/F - Poll/Final or -1 if not applicable + * + * nr - N(R) - receive sequence or -1 if not applicable. + * + * ns - N(S) - send sequence or -1 if not applicable. + * + * Returns: Frame type from enum ax25_frame_type_e. + * + *------------------------------------------------------------------*/ + +// TODO: need someway to ensure caller allocated enough space. +// Should pass in as parameter. +#define DESC_SIZ 56 + + +ax25_frame_type_t ax25_frame_type (packet_t this_p, cmdres_t *cr, char *desc, int *pf, int *nr, int *ns) +{ + int c; // U frames are always one control byte. + int c2 = 0; // I & S frames can have second Control byte. + + assert (this_p->magic1 == MAGIC); + assert (this_p->magic2 == MAGIC); + + strlcpy (desc, "????", DESC_SIZ); + *cr = cr_11; + *pf = -1; + *nr = -1; + *ns = -1; + + c = ax25_get_control(this_p); + if (c < 0) { + strlcpy (desc, "Not AX.25", DESC_SIZ); + return (frame_not_AX25); + } + +/* + * TERRIBLE HACK :-( for display purposes. + * + * I and S frames can have 1 or 2 control bytes but there is + * no good way to determine this without dipping into the data + * link state machine. Can we guess? + * + * S frames have no protocol id or information so if there is one + * more byte beyond the control field, we could assume there are + * two control bytes. + * + * For I frames, the protocol id will usually be 0xf0. If we find + * that as the first byte of the information field, it is probably + * the pid and not part of the information. Ditto for segments 0x08. + * Not fool proof but good enough for troubleshooting text out. + * + * If we have a link to the peer station, this will be set properly + * before it needs to be used for other reasons. + * + * Setting one of the RR bits (find reference!) is sounding better and better. + * It's in common usage so I should lobby to get that in the official protocol spec. + */ + + if (this_p->modulo == 0 && (c & 3) == 1 && ax25_get_c2(this_p) != -1) { + this_p->modulo = modulo_128; + } + else if (this_p->modulo == 0 && (c & 1) == 0 && this_p->frame_data[ax25_get_info_offset(this_p)] == 0xF0) { + this_p->modulo = modulo_128; + } + else if (this_p->modulo == 0 && (c & 1) == 0 && this_p->frame_data[ax25_get_info_offset(this_p)] == 0x08) { // same for segments + this_p->modulo = modulo_128; + } + + + if (this_p->modulo == modulo_128) { + c2 = ax25_get_c2 (this_p); + } + + int dst_c = this_p->frame_data[AX25_DESTINATION * 7 + 6] & SSID_H_MASK; + int src_c = this_p->frame_data[AX25_SOURCE * 7 + 6] & SSID_H_MASK; + + char cr_text[8]; + char pf_text[8]; + + if (dst_c) { + if (src_c) { *cr = cr_11; strcpy(cr_text,"cc=11"); strcpy(pf_text,"p/f"); } + else { *cr = cr_cmd; strcpy(cr_text,"cmd"); strcpy(pf_text,"p"); } + } + else { + if (src_c) { *cr = cr_res; strcpy(cr_text,"res"); strcpy(pf_text,"f"); } + else { *cr = cr_00; strcpy(cr_text,"cc=00"); strcpy(pf_text,"p/f"); } + } + + if ((c & 1) == 0) { + +// Information rrr p sss 0 or sssssss 0 rrrrrrr p + + if (this_p->modulo == modulo_128) { + *ns = (c >> 1) & 0x7f; + *pf = c2 & 1; + *nr = (c2 >> 1) & 0x7f; + } + else { + *ns = (c >> 1) & 7; + *pf = (c >> 4) & 1; + *nr = (c >> 5) & 7; + } + + //snprintf (desc, DESC_SIZ, "I %s, n(s)=%d, n(r)=%d, %s=%d", cr_text, *ns, *nr, pf_text, *pf); + snprintf (desc, DESC_SIZ, "I %s, n(s)=%d, n(r)=%d, %s=%d, pid=0x%02x", cr_text, *ns, *nr, pf_text, *pf, ax25_get_pid(this_p)); + return (frame_type_I); + } + else if ((c & 2) == 0) { + +// Supervisory rrr p/f ss 0 1 or 0000 ss 0 1 rrrrrrr p/f + + if (this_p->modulo == modulo_128) { + *pf = c2 & 1; + *nr = (c2 >> 1) & 0x7f; + } + else { + *pf = (c >> 4) & 1; + *nr = (c >> 5) & 7; + } + + + switch ((c >> 2) & 3) { + case 0: snprintf (desc, DESC_SIZ, "RR %s, n(r)=%d, %s=%d", cr_text, *nr, pf_text, *pf); return (frame_type_S_RR); break; + case 1: snprintf (desc, DESC_SIZ, "RNR %s, n(r)=%d, %s=%d", cr_text, *nr, pf_text, *pf); return (frame_type_S_RNR); break; + case 2: snprintf (desc, DESC_SIZ, "REJ %s, n(r)=%d, %s=%d", cr_text, *nr, pf_text, *pf); return (frame_type_S_REJ); break; + case 3: snprintf (desc, DESC_SIZ, "SREJ %s, n(r)=%d, %s=%d", cr_text, *nr, pf_text, *pf); return (frame_type_S_SREJ); break; + } + } + else { + +// Unnumbered mmm p/f mm 1 1 + + *pf = (c >> 4) & 1; + + switch (c & 0xef) { + + case 0x6f: snprintf (desc, DESC_SIZ, "SABME %s, %s=%d", cr_text, pf_text, *pf); return (frame_type_U_SABME); break; + case 0x2f: snprintf (desc, DESC_SIZ, "SABM %s, %s=%d", cr_text, pf_text, *pf); return (frame_type_U_SABM); break; + case 0x43: snprintf (desc, DESC_SIZ, "DISC %s, %s=%d", cr_text, pf_text, *pf); return (frame_type_U_DISC); break; + case 0x0f: snprintf (desc, DESC_SIZ, "DM %s, %s=%d", cr_text, pf_text, *pf); return (frame_type_U_DM); break; + case 0x63: snprintf (desc, DESC_SIZ, "UA %s, %s=%d", cr_text, pf_text, *pf); return (frame_type_U_UA); break; + case 0x87: snprintf (desc, DESC_SIZ, "FRMR %s, %s=%d", cr_text, pf_text, *pf); return (frame_type_U_FRMR); break; + case 0x03: snprintf (desc, DESC_SIZ, "UI %s, %s=%d", cr_text, pf_text, *pf); return (frame_type_U_UI); break; + case 0xaf: snprintf (desc, DESC_SIZ, "XID %s, %s=%d", cr_text, pf_text, *pf); return (frame_type_U_XID); break; + case 0xe3: snprintf (desc, DESC_SIZ, "TEST %s, %s=%d", cr_text, pf_text, *pf); return (frame_type_U_TEST); break; + default: snprintf (desc, DESC_SIZ, "U other???"); return (frame_type_U); break; + } + } + + // Should be unreachable but compiler doesn't realize that. + // Here only to suppress "warning: control reaches end of non-void function" + + return (frame_not_AX25); + +} /* end ax25_frame_type */ + + + +/*------------------------------------------------------------------ + * + * Function: ax25_hex_dump + * + * Purpose: Print out packet in hexadecimal for debugging. + * + * Inputs: fptr - Pointer to frame data. + * + * flen - Frame length, bytes. Does not include CRC. + * + *------------------------------------------------------------------*/ + +static void hex_dump (unsigned char *p, int len) +{ + int n, i, offset; + + offset = 0; + while (len > 0) { + n = len < 16 ? len : 16; + dw_printf (" %03x: ", offset); + for (i=0; i>5)&7, (c>>4)&1, (c>>1)&7); } + else if ((c & 0xf) == 0x01) { snprintf (out, outsiz, "S frame RR: n(r)=%d, p/f=%d", (c>>5)&7, (c>>4)&1); } + else if ((c & 0xf) == 0x05) { snprintf (out, outsiz, "S frame RNR: n(r)=%d, p/f=%d", (c>>5)&7, (c>>4)&1); } + else if ((c & 0xf) == 0x09) { snprintf (out, outsiz, "S frame REJ: n(r)=%d, p/f=%d", (c>>5)&7, (c>>4)&1); } + else if ((c & 0xf) == 0x0D) { snprintf (out, outsiz, "S frame sREJ: n(r)=%d, p/f=%d", (c>>5)&7, (c>>4)&1); } + else if ((c & 0xef) == 0x6f) { snprintf (out, outsiz, "U frame SABME: p=%d", (c>>4)&1); } + else if ((c & 0xef) == 0x2f) { snprintf (out, outsiz, "U frame SABM: p=%d", (c>>4)&1); } + else if ((c & 0xef) == 0x43) { snprintf (out, outsiz, "U frame DISC: p=%d", (c>>4)&1); } + else if ((c & 0xef) == 0x0f) { snprintf (out, outsiz, "U frame DM: f=%d", (c>>4)&1); } + else if ((c & 0xef) == 0x63) { snprintf (out, outsiz, "U frame UA: f=%d", (c>>4)&1); } + else if ((c & 0xef) == 0x87) { snprintf (out, outsiz, "U frame FRMR: f=%d", (c>>4)&1); } + else if ((c & 0xef) == 0x03) { snprintf (out, outsiz, "U frame UI: p/f=%d", (c>>4)&1); } + else if ((c & 0xef) == 0xAF) { snprintf (out, outsiz, "U frame XID: p/f=%d", (c>>4)&1); } + else if ((c & 0xef) == 0xe3) { snprintf (out, outsiz, "U frame TEST: p/f=%d", (c>>4)&1); } + else { snprintf (out, outsiz, "Unknown frame type for control = 0x%02x", c); } +} + +/* Text description of protocol id octet. */ + +#define PID_TEXT_SIZE 80 + +static void pid_to_text (int p, char out[PID_TEXT_SIZE]) +{ + + if ((p & 0x30) == 0x10) { snprintf (out, PID_TEXT_SIZE, "AX.25 layer 3 implemented."); } + else if ((p & 0x30) == 0x20) { snprintf (out, PID_TEXT_SIZE, "AX.25 layer 3 implemented."); } + else if (p == 0x01) { snprintf (out, PID_TEXT_SIZE, "ISO 8208/CCITT X.25 PLP"); } + else if (p == 0x06) { snprintf (out, PID_TEXT_SIZE, "Compressed TCP/IP packet. Van Jacobson (RFC 1144)"); } + else if (p == 0x07) { snprintf (out, PID_TEXT_SIZE, "Uncompressed TCP/IP packet. Van Jacobson (RFC 1144)"); } + else if (p == 0x08) { snprintf (out, PID_TEXT_SIZE, "Segmentation fragment"); } + else if (p == 0xC3) { snprintf (out, PID_TEXT_SIZE, "TEXNET datagram protocol"); } + else if (p == 0xC4) { snprintf (out, PID_TEXT_SIZE, "Link Quality Protocol"); } + else if (p == 0xCA) { snprintf (out, PID_TEXT_SIZE, "Appletalk"); } + else if (p == 0xCB) { snprintf (out, PID_TEXT_SIZE, "Appletalk ARP"); } + else if (p == 0xCC) { snprintf (out, PID_TEXT_SIZE, "ARPA Internet Protocol"); } + else if (p == 0xCD) { snprintf (out, PID_TEXT_SIZE, "ARPA Address resolution"); } + else if (p == 0xCE) { snprintf (out, PID_TEXT_SIZE, "FlexNet"); } + else if (p == 0xCF) { snprintf (out, PID_TEXT_SIZE, "NET/ROM"); } + else if (p == 0xF0) { snprintf (out, PID_TEXT_SIZE, "No layer 3 protocol implemented."); } + else if (p == 0xFF) { snprintf (out, PID_TEXT_SIZE, "Escape character. Next octet contains more Level 3 protocol information."); } + else { snprintf (out, PID_TEXT_SIZE, "Unknown protocol id = 0x%02x", p); } +} + + + +void ax25_hex_dump (packet_t this_p) +{ + int n; + unsigned char *fptr = this_p->frame_data; + int flen = this_p->frame_len; + + + + if (this_p->num_addr >= AX25_MIN_ADDRS && this_p->num_addr <= AX25_MAX_ADDRS) { + int c, p; + char cp_text[120]; + char l_text[20]; + + c = fptr[this_p->num_addr*7]; + p = fptr[this_p->num_addr*7+1]; + + ctrl_to_text (c, cp_text, sizeof(cp_text)); // TODO: use ax25_frame_type() instead. + + if ( (c & 0x01) == 0 || /* I xxxx xxx0 */ + c == 0x03 || c == 0x13) { /* UI 000x 0011 */ + + char pid_text[PID_TEXT_SIZE]; + + pid_to_text (p, pid_text); + + strlcat (cp_text, ", ", sizeof(cp_text)); + strlcat (cp_text, pid_text, sizeof(cp_text)); + + } + + snprintf (l_text, sizeof(l_text), ", length = %d", flen); + strlcat (cp_text, l_text, sizeof(cp_text)); + + dw_printf ("%s\n", cp_text); + } + + // Address fields must be only upper case letters and digits. + // If less than 6 characters, trailing positions are filled with ASCII space. + // Using all zero bits in one of these 6 positions is wrong. + // Any non printable characters will be printed as "." here. + + dw_printf (" dest %c%c%c%c%c%c %2d c/r=%d res=%d last=%d\n", + isprint(fptr[0]>>1) ? fptr[0]>>1 : '.', + isprint(fptr[1]>>1) ? fptr[1]>>1 : '.', + isprint(fptr[2]>>1) ? fptr[2]>>1 : '.', + isprint(fptr[3]>>1) ? fptr[3]>>1 : '.', + isprint(fptr[4]>>1) ? fptr[4]>>1 : '.', + isprint(fptr[5]>>1) ? fptr[5]>>1 : '.', + (fptr[6]&SSID_SSID_MASK)>>SSID_SSID_SHIFT, + (fptr[6]&SSID_H_MASK)>>SSID_H_SHIFT, + (fptr[6]&SSID_RR_MASK)>>SSID_RR_SHIFT, + fptr[6]&SSID_LAST_MASK); + + dw_printf (" source %c%c%c%c%c%c %2d c/r=%d res=%d last=%d\n", + isprint(fptr[7]>>1) ? fptr[7]>>1 : '.', + isprint(fptr[8]>>1) ? fptr[8]>>1 : '.', + isprint(fptr[9]>>1) ? fptr[9]>>1 : '.', + isprint(fptr[10]>>1) ? fptr[10]>>1 : '.', + isprint(fptr[11]>>1) ? fptr[11]>>1 : '.', + isprint(fptr[12]>>1) ? fptr[12]>>1 : '.', + (fptr[13]&SSID_SSID_MASK)>>SSID_SSID_SHIFT, + (fptr[13]&SSID_H_MASK)>>SSID_H_SHIFT, + (fptr[13]&SSID_RR_MASK)>>SSID_RR_SHIFT, + fptr[13]&SSID_LAST_MASK); + + for (n=2; nnum_addr; n++) { + + dw_printf (" digi %d %c%c%c%c%c%c %2d h=%d res=%d last=%d\n", + n - 1, + isprint(fptr[n*7+0]>>1) ? fptr[n*7+0]>>1 : '.', + isprint(fptr[n*7+1]>>1) ? fptr[n*7+1]>>1 : '.', + isprint(fptr[n*7+2]>>1) ? fptr[n*7+2]>>1 : '.', + isprint(fptr[n*7+3]>>1) ? fptr[n*7+3]>>1 : '.', + isprint(fptr[n*7+4]>>1) ? fptr[n*7+4]>>1 : '.', + isprint(fptr[n*7+5]>>1) ? fptr[n*7+5]>>1 : '.', + (fptr[n*7+6]&SSID_SSID_MASK)>>SSID_SSID_SHIFT, + (fptr[n*7+6]&SSID_H_MASK)>>SSID_H_SHIFT, + (fptr[n*7+6]&SSID_RR_MASK)>>SSID_RR_SHIFT, + fptr[n*7+6]&SSID_LAST_MASK); + + } + + hex_dump (fptr, flen); + +} /* end ax25_hex_dump */ + + + +/*------------------------------------------------------------------ + * + * Function: ax25_is_aprs + * + * Purpose: Is this packet APRS format? + * + * Inputs: this_p - pointer to packet object. + * + * Returns: True if this frame has the proper control + * octets for an APRS packet. + * control 3 for UI frame + * protocol id 0xf0 for no layer 3 + * + * + * Description: Dire Wolf should be able to act as a KISS TNC for + * any type of AX.25 activity. However, there are other + * places where we want to process only APRS. + * (e.g. digipeating and IGate.) + * + *------------------------------------------------------------------*/ + + +int ax25_is_aprs (packet_t this_p) +{ + int ctrl, pid, is_aprs; + + assert (this_p->magic1 == MAGIC); + assert (this_p->magic2 == MAGIC); + + if (this_p->frame_len == 0) return(0); + + ctrl = ax25_get_control(this_p); + pid = ax25_get_pid(this_p); + + is_aprs = this_p->num_addr >= 2 && ctrl == AX25_UI_FRAME && pid == AX25_PID_NO_LAYER_3; + +#if 0 + text_color_set(DW_COLOR_ERROR); + dw_printf ("ax25_is_aprs(): ctrl=%02x, pid=%02x, is_aprs=%d\n", ctrl, pid, is_aprs); +#endif + return (is_aprs); +} + + +/*------------------------------------------------------------------ + * + * Function: ax25_is_null_frame + * + * Purpose: Is this packet structure empty? + * + * Inputs: this_p - pointer to packet object. + * + * Returns: True if frame data length is 0. + * + * Description: This is used when we want to wake up the + * transmit queue processing thread but don't + * want to transmit a frame. + * + *------------------------------------------------------------------*/ + + +int ax25_is_null_frame (packet_t this_p) +{ + int is_null; + + assert (this_p->magic1 == MAGIC); + assert (this_p->magic2 == MAGIC); + + is_null = this_p->frame_len == 0; + +#if 0 + text_color_set(DW_COLOR_ERROR); + dw_printf ("ax25_is_null_frame(): is_null=%d\n", is_null); +#endif + return (is_null); +} + + +/*------------------------------------------------------------------ + * + * Function: ax25_get_control + ax25_get_c2 + * + * Purpose: Get Control field from packet. + * + * Inputs: this_p - pointer to packet object. + * + * Returns: APRS uses AX25_UI_FRAME. + * This could also be used in other situations. + * + *------------------------------------------------------------------*/ + + +int ax25_get_control (packet_t this_p) +{ + assert (this_p->magic1 == MAGIC); + assert (this_p->magic2 == MAGIC); + + if (this_p->frame_len == 0) return(-1); + + if (this_p->num_addr >= 2) { + return (this_p->frame_data[ax25_get_control_offset(this_p)]); + } + return (-1); +} + +int ax25_get_c2 (packet_t this_p) +{ + assert (this_p->magic1 == MAGIC); + assert (this_p->magic2 == MAGIC); + + if (this_p->frame_len == 0) return(-1); + + if (this_p->num_addr >= 2) { + int offset2 = ax25_get_control_offset(this_p)+1; + + if (offset2 < this_p->frame_len) { + return (this_p->frame_data[offset2]); + } + else { + return (-1); /* attempt to go beyond the end of frame. */ + } + } + return (-1); /* not AX.25 */ +} + + +/*------------------------------------------------------------------ + * + * Function: ax25_get_pid + * + * Purpose: Get protocol ID from packet. + * + * Inputs: this_p - pointer to packet object. + * + * Returns: APRS uses 0xf0 for no layer 3. + * This could also be used in other situations. + * + * AX.25: "The Protocol Identifier (PID) field appears in information + * frames (I and UI) only. It identifies which kind of + * Layer 3 protocol, if any, is in use." + * + *------------------------------------------------------------------*/ + + +int ax25_get_pid (packet_t this_p) +{ + assert (this_p->magic1 == MAGIC); + assert (this_p->magic2 == MAGIC); + + // TODO: handle 2 control byte case. + // TODO: sanity check: is it I or UI frame? + + if (this_p->frame_len == 0) return(-1); + + if (this_p->num_addr >= 2) { + return (this_p->frame_data[ax25_get_pid_offset(this_p)]); + } + return (-1); +} + + + +/*------------------------------------------------------------------ + * + * Function: ax25_get_frame_len + * + * Purpose: Get length of frame. + * + * Inputs: this_p - pointer to packet object. + * + * Returns: Number of octets in the frame buffer. + * Does NOT include the extra 2 for FCS. + * + *------------------------------------------------------------------*/ + +int ax25_get_frame_len (packet_t this_p) +{ + assert (this_p->magic1 == MAGIC); + assert (this_p->magic2 == MAGIC); + + assert (this_p->frame_len >= 0 && this_p->frame_len <= AX25_MAX_PACKET_LEN); + + return (this_p->frame_len); + +} /* end ax25_get_frame_len */ + + +unsigned char *ax25_get_frame_data_ptr (packet_t this_p) +{ + assert (this_p->magic1 == MAGIC); + assert (this_p->magic2 == MAGIC); + + return (this_p->frame_data); + +} /* end ax25_get_frame_data_ptr */ + + +/*------------------------------------------------------------------------------ + * + * Name: ax25_dedupe_crc + * + * Purpose: Calculate a checksum for the packet source, destination, and + * information but NOT the digipeaters. + * This is used for duplicate detection in the digipeater + * and IGate algorithms. + * + * Input: pp - Pointer to packet object. + * + * Returns: Value which will be the same for a duplicate but very unlikely + * to match a non-duplicate packet. + * + * Description: For detecting duplicates, we need to look + * + source station + * + destination + * + information field + * but NOT the changing list of digipeaters. + * + * Typically, only a checksum is kept to reduce memory + * requirements and amount of compution for comparisons. + * There is a very very small probability that two unrelated + * packets will result in the same checksum, and the + * undesired dropping of the packet. + * + * There is a 1 / 65536 chance of getting a false positive match + * which is good enough for this application. + * We could reduce that with a 32 bit CRC instead of reusing + * code from the AX.25 frame CRC calculation. + * + * Version 1.3: We exclude any trailing CR/LF at the end of the info part + * so we can detect duplicates that are received only over the + * air and those which have gone thru an IGate where the process + * removes any trailing CR/LF. Example: + * + * Original via RF only: + * W1TG-1>APU25N,N3LEE-10*,WIDE2-1: + * + * When we get the same thing via APRS-IS: + * W1TG-1>APU25N,K1FFK,WIDE2*,qAR,WB2ZII-15:= 1 && (pinfo[info_len-1] == '\r' || + pinfo[info_len-1] == '\n' || + pinfo[info_len-1] == ' ')) { + + // Temporary for debugging! + + // if (pinfo[info_len-1] == ' ') { + // text_color_set(DW_COLOR_ERROR); + // dw_printf ("DEBUG: ax25_dedupe_crc ignoring trailing space.\n"); + // } + + info_len--; + } + + crc = 0xffff; + crc = crc16((unsigned char *)src, strlen(src), crc); + crc = crc16((unsigned char *)dest, strlen(dest), crc); + crc = crc16(pinfo, info_len, crc); + + return (crc); +} + +/*------------------------------------------------------------------------------ + * + * Name: ax25_m_m_crc + * + * Purpose: Calculate a checksum for the packet. + * This is used for the multimodem duplicate detection. + * + * Input: pp - Pointer to packet object. + * + * Returns: Value which will be the same for a duplicate but very unlikely + * to match a non-duplicate packet. + * + * Description: For detecting duplicates, we need to look the entire packet. + * + * Typically, only a checksum is kept to reduce memory + * requirements and amount of compution for comparisons. + * There is a very very small probability that two unrelated + * packets will result in the same checksum, and the + * undesired dropping of the packet. + + *------------------------------------------------------------------------------*/ + +unsigned short ax25_m_m_crc (packet_t pp) +{ + unsigned short crc; + unsigned char fbuf[AX25_MAX_PACKET_LEN]; + int flen; + + // TODO: I think this can be more efficient by getting the packet content pointer instead of copying. + flen = ax25_pack (pp, fbuf); + + crc = 0xffff; + crc = crc16(fbuf, flen, crc); + + return (crc); +} + + +/*------------------------------------------------------------------ + * + * Function: ax25_safe_print + * + * Purpose: Print given string, changing non printable characters to + * hexadecimal notation. Note that character values + * , 28, 29, 30, and 31 can appear in MIC-E message. + * + * Inputs: pstr - Pointer to string. + * + * len - Number of bytes. If < 0 we use strlen(). + * + * ascii_only - Restrict output to only ASCII. + * Normally we allow UTF-8. + * + * Stops after non-zero len characters or at nul. + * + * Returns: none + * + * Description: Print a string in a "safe" manner. + * Anything that is not a printable character + * will be converted to a hexadecimal representation. + * For example, a Line Feed character will appear as <0x0a> + * rather than dropping down to the next line on the screen. + * + * ax25_from_text can accept this format. + * + * + * Example: W1MED-1>T2QP0S,N1OHZ,N8VIM*,WIDE1-1:'cQBl <0x1c>-/]<0x0d> + * ------ ------ + * + * Questions: What should we do about UTF-8? Should that be displayed + * as hexadecimal for troubleshooting? Maybe an option so the + * packet raw data is in hexadecimal but an extracted + * comment displays UTF-8? Or a command line option for only ASCII? + * + * Trailing space: + * I recently noticed a case where a packet has space character + * at the end. If the last character of the line is a space, + * this will be displayed in hexadecimal to make it obvious. + * + *------------------------------------------------------------------*/ + +//#define MAXSAFE 500 +#define MAXSAFE AX25_MAX_INFO_LEN + +void ax25_safe_print (char *pstr, int len, int ascii_only) +{ + int ch; + char safe_str[MAXSAFE*6+1]; + int safe_len; + + safe_len = 0; + safe_str[safe_len] = '\0'; + + + if (len < 0) + len = strlen(pstr); + + if (len > MAXSAFE) + len = MAXSAFE; + + while (len > 0) + { + ch = *((unsigned char *)pstr); + + if (ch == ' ' && (len == 1 || pstr[1] == '\0')) { + + snprintf (safe_str + safe_len, sizeof(safe_str)-safe_len, "<0x%02x>", ch); + safe_len += 6; + } + else if (ch < ' ' || ch == 0x7f || ch == 0xfe || ch == 0xff || + (ascii_only && ch >= 0x80) ) { + + /* Control codes and delete. */ + /* UTF-8 does not use fe and ff except in a possible */ + /* "Byte Order Mark" (BOM) at the beginning. */ + + snprintf (safe_str + safe_len, sizeof(safe_str)-safe_len, "<0x%02x>", ch); + safe_len += 6; + } + else { + /* Let everything else thru so we can handle UTF-8 */ + /* Maybe we should have an option to display 0x80 */ + /* and above as hexadecimal. */ + + safe_str[safe_len++] = ch; + safe_str[safe_len] = '\0'; + } + + pstr++; + len--; + } + +// TODO1.2: should return string rather printing to remove a race condition. + + dw_printf ("%s", safe_str); + +} /* end ax25_safe_print */ + + + +/*------------------------------------------------------------------ + * + * Function: ax25_alevel_to_text + * + * Purpose: Convert audio level to text representation. + * + * Inputs: alevel - Audio levels collected from demodulator. + * + * Outputs: text - Text representation for presentation to user. + * Currently it will look something like this: + * + * r(m/s) + * + * With n,m,s corresponding to received, mark, and space. + * Comma is to be avoided because one place this + * ends up is in a CSV format file. + * + * size should be AX25_ALEVEL_TO_TEXT_SIZE. + * + * Returns: True if something to print. (currently if alevel.original >= 0) + * False if not. + * + * Description: Audio level used to be simple; it was a single number. + * In version 1.2, we start collecting more details. + * At the moment, it includes: + * + * - Received level from new method. + * - Levels from mark & space filters to examine the ratio. + * + * We print this in multiple places so put it into a function. + * + *------------------------------------------------------------------*/ + + +int ax25_alevel_to_text (alevel_t alevel, char text[AX25_ALEVEL_TO_TEXT_SIZE]) +{ + if (alevel.rec < 0) { + strlcpy (text, "", AX25_ALEVEL_TO_TEXT_SIZE); + return (0); + } + +// TODO1.2: haven't thought much about non-AFSK cases yet. +// What should we do for 9600 baud? + +// For DTMF omit the two extra numbers. + + if (alevel.mark >= 0 && alevel.space < 0) { /* baseband */ + + snprintf (text, AX25_ALEVEL_TO_TEXT_SIZE, "%d(%+d/%+d)", alevel.rec, alevel.mark, alevel.space); + } + else if ((alevel.mark == -1 && alevel.space == -1) || /* PSK */ + (alevel.mark == -99 && alevel.space == -99)) { /* v. 1.7 "B" FM demodulator. */ + // ?? Where does -99 come from? + + snprintf (text, AX25_ALEVEL_TO_TEXT_SIZE, "%d", alevel.rec); + } + else if (alevel.mark == -2 && alevel.space == -2) { /* DTMF - single number. */ + + snprintf (text, AX25_ALEVEL_TO_TEXT_SIZE, "%d", alevel.rec); + } + else { /* AFSK */ + + //snprintf (text, AX25_ALEVEL_TO_TEXT_SIZE, "%d:%d(%d/%d=%05.3f=)", alevel.original, alevel.rec, alevel.mark, alevel.space, alevel.ms_ratio); + snprintf (text, AX25_ALEVEL_TO_TEXT_SIZE, "%d(%d/%d)", alevel.rec, alevel.mark, alevel.space); + } + return (1); + +} /* end ax25_alevel_to_text */ + + +/* end ax25_pad.c */ diff --git a/ax25_pad.h b/src/ax25_pad.h similarity index 50% rename from ax25_pad.h rename to src/ax25_pad.h index 12db4812..cdb84c65 100644 --- a/ax25_pad.h +++ b/src/ax25_pad.h @@ -11,7 +11,7 @@ #define AX25_MAX_REPEATERS 8 -#define AX25_MIN_ADDRS 2 /* Destinatin & Source. */ +#define AX25_MIN_ADDRS 2 /* Destination & Source. */ #define AX25_MAX_ADDRS 10 /* Destination, Source, 8 digipeaters. */ #define AX25_DESTINATION 0 /* Address positions in frame. */ @@ -64,8 +64,10 @@ */ #define AX25_UI_FRAME 3 /* Control field value. */ -#define AX25_NO_LAYER_3 0xf0 /* protocol ID */ +#define AX25_PID_NO_LAYER_3 0xf0 /* protocol ID used for APRS */ +#define AX25_PID_SEGMENTATION_FRAGMENT 0x08 +#define AX25_PID_ESCAPE_CHARACTER 0xff #ifdef AX25_PAD_C /* Keep this hidden - implementation could change. */ @@ -74,6 +76,11 @@ struct packet_s { int magic1; /* for error checking. */ + int seq; /* unique sequence number for debugging. */ + + double release_time; /* Time stamp in format returned by dtime_now(). */ + /* When to release from the SATgate mode delay queue. */ + #define MAGIC 0x41583235 struct packet_s *nextp; /* Pointer to next in queue. */ @@ -91,11 +98,12 @@ struct packet_s { * * Bits: H R R SSID 0 * - * H for digipeaters set to 0 intially. + * H for digipeaters set to 0 initially. * Changed to 1 when position has been used. * * for source & destination it is called - * command/response and is normally 1. + * command/response. Normally both 1 for APRS. + * They should be opposites for connected mode. * * R R Reserved. Normally set to 1 1. * @@ -104,6 +112,7 @@ struct packet_s { * 0 Usually 0 but 1 for last address. */ + #define SSID_H_MASK 0x80 #define SSID_H_SHIFT 7 @@ -118,6 +127,15 @@ struct packet_s { int frame_len; /* Frame length without CRC. */ + int modulo; /* I & S frames have sequence numbers of either 3 bits (modulo 8) */ + /* or 7 bits (modulo 128). This is conveyed by either 1 or 2 */ + /* control bytes. Unfortunately, we can't determine this by looking */ + /* at an isolated frame. We need to know about the context. If we */ + /* are part of the conversation, we would know. But if we are */ + /* just listening to others, this would be more difficult to determine. */ + + /* For U frames: set to 0 - not applicable */ + /* For I & S frames: 8 or 128 if known. 0 if unknown. */ unsigned char frame_data[AX25_MAX_PACKET_LEN+1]; /* Raw frame contents, without the CRC. */ @@ -140,31 +158,57 @@ struct packet_s { typedef struct packet_s *packet_t; +typedef enum cmdres_e { cr_00 = 2, cr_cmd = 1, cr_res = 0, cr_11 = 3 } cmdres_t; + + +extern packet_t ax25_new (void); #ifdef AX25_PAD_C /* Keep this hidden - implementation could change. */ + /* * APRS always has one control octet of 0x03 but the more * general AX.25 case is one or two control bytes depending on - * "modulo 128 operation" is in effect. Unfortunately, it seems - * this can be determined only by examining the XID frames and - * keeping this information for each connection. - * We can assume 1 for our purposes. + * whether "modulo 128 operation" is in effect. */ +//#define DEBUGX 1 + static inline int ax25_get_control_offset (packet_t this_p) { - //return (0); return (this_p->num_addr*7); } static inline int ax25_get_num_control (packet_t this_p) { - return (1); + int c; + + c = this_p->frame_data[ax25_get_control_offset(this_p)]; + + if ( (c & 0x01) == 0 ) { /* I xxxx xxx0 */ +#if DEBUGX + dw_printf ("ax25_get_num_control, %02x is I frame, returns %d\n", c, (this_p->modulo == 128) ? 2 : 1); +#endif + return ((this_p->modulo == 128) ? 2 : 1); + } + + if ( (c & 0x03) == 1 ) { /* S xxxx xx01 */ +#if DEBUGX + dw_printf ("ax25_get_num_control, %02x is S frame, returns %d\n", c, (this_p->modulo == 128) ? 2 : 1); +#endif + return ((this_p->modulo == 128) ? 2 : 1); + } + +#if DEBUGX + dw_printf ("ax25_get_num_control, %02x is U frame, always returns 1.\n", c); +#endif + + return (1); /* U xxxx xx11 */ } + /* * APRS always has one protocol octet of 0xF0 meaning no level 3 * protocol but the more general case is 0, 1 or 2 protocol ID octets. @@ -186,32 +230,43 @@ static int ax25_get_num_pid (packet_t this_p) c == 0x03 || c == 0x13) { /* UI 000x 0011 */ pid = this_p->frame_data[ax25_get_pid_offset(this_p)]; - if (pid == 0xff) { +#if DEBUGX + dw_printf ("ax25_get_num_pid, %02x is I or UI frame, pid = %02x, returns %d\n", c, pid, (pid==AX25_PID_ESCAPE_CHARACTER) ? 2 : 1); +#endif + if (pid == AX25_PID_ESCAPE_CHARACTER) { return (2); /* pid 1111 1111 means another follows. */ } return (1); } +#if DEBUGX + dw_printf ("ax25_get_num_pid, %02x is neither I nor UI frame, returns 0\n", c); +#endif return (0); } /* - * APRS always has an Information field with at least one octet for the - * Data Type Indicator. AX.25 has this for only 5 frame types depending - * on the control field. + * AX.25 has info field for 5 frame types depending on the control field. + * * xxxx xxx0 I - * 000x 0011 UI + * 000x 0011 UI (which includes APRS) * 101x 1111 XID * 111x 0011 TEST * 100x 0111 FRMR + * + * APRS always has an Information field with at least one octet for the Data Type Indicator. */ static inline int ax25_get_info_offset (packet_t this_p) { - return (ax25_get_control_offset (this_p) + ax25_get_num_control(this_p) + ax25_get_num_pid(this_p)); + int offset = ax25_get_control_offset (this_p) + ax25_get_num_control(this_p) + ax25_get_num_pid(this_p); +#if DEBUGX + dw_printf ("ax25_get_info_offset, returns %d\n", offset); +#endif + return (offset); } -static int ax25_get_num_info (packet_t this_p) +static inline int ax25_get_num_info (packet_t this_p) { int len; @@ -228,22 +283,93 @@ static int ax25_get_num_info (packet_t this_p) #endif +typedef enum ax25_modulo_e { modulo_unknown = 0, modulo_8 = 8, modulo_128 = 128 } ax25_modulo_t; +typedef enum ax25_frame_type_e { + frame_type_I = 0, // Information -//static packet_t ax25_new (void); + frame_type_S_RR, // Receive Ready - System Ready To Receive + frame_type_S_RNR, // Receive Not Ready - TNC Buffer Full + frame_type_S_REJ, // Reject Frame - Out of Sequence or Duplicate + frame_type_S_SREJ, // Selective Reject - Request single frame repeat -extern void ax25_delete (packet_t pp); + frame_type_U_SABME, // Set Async Balanced Mode, Extended + frame_type_U_SABM, // Set Async Balanced Mode + frame_type_U_DISC, // Disconnect + frame_type_U_DM, // Disconnect Mode + frame_type_U_UA, // Unnumbered Acknowledge + frame_type_U_FRMR, // Frame Reject + frame_type_U_UI, // Unnumbered Information + frame_type_U_XID, // Exchange Identification + frame_type_U_TEST, // Test + frame_type_U, // other Unnumbered, not used by AX.25. + + frame_not_AX25 // Could not get control byte from frame. + // This must be last because value plus 1 is + // for the size of an array. + +} ax25_frame_type_t; + -extern void ax25_clear (packet_t pp); +/* + * Originally this was a single number. + * Let's try something new in version 1.2. + * Also collect AGC values from the mark and space filters. + */ + +typedef struct alevel_s { + + int rec; + int mark; + int space; + //float ms_ratio; // TODO: take out after temporary investigation. +} alevel_t; + + +#ifndef AXTEST +// TODO: remove this? +#define AX25MEMDEBUG 1 +#endif + + +#if AX25MEMDEBUG // to investigate a memory leak problem + + +extern void ax25memdebug_set(void); +extern int ax25memdebug_get (void); +extern int ax25memdebug_seq (packet_t this_p); + + +extern packet_t ax25_from_text_debug (char *monitor, int strict, char *src_file, int src_line); +#define ax25_from_text(m,s) ax25_from_text_debug(m,s,__FILE__,__LINE__) + +extern packet_t ax25_from_frame_debug (unsigned char *data, int len, alevel_t alevel, char *src_file, int src_line); +#define ax25_from_frame(d,l,a) ax25_from_frame_debug(d,l,a,__FILE__,__LINE__); + +extern packet_t ax25_dup_debug (packet_t copy_from, char *src_file, int src_line); +#define ax25_dup(p) ax25_dup_debug(p,__FILE__,__LINE__); -extern packet_t ax25_from_text (char *, int strict); +extern void ax25_delete_debug (packet_t pp, char *src_file, int src_line); +#define ax25_delete(p) ax25_delete_debug(p,__FILE__,__LINE__); -extern packet_t ax25_from_frame (unsigned char *data, int len, int alevel); +#else + +extern packet_t ax25_from_text (char *monitor, int strict); + +extern packet_t ax25_from_frame (unsigned char *data, int len, alevel_t alevel); extern packet_t ax25_dup (packet_t copy_from); -extern int ax25_parse_addr (char *in_addr, int strict, char *out_addr, int *out_ssid, int *out_heard); +extern void ax25_delete (packet_t pp); + +#endif + + + + +extern int ax25_parse_addr (int position, char *in_addr, int strict, char *out_addr, int *out_ssid, int *out_heard); +extern int ax25_check_addresses (packet_t pp); extern packet_t ax25_unwrap_third_party (packet_t from_pp); @@ -254,7 +380,8 @@ extern void ax25_remove_addr (packet_t this_p, int n); extern int ax25_get_num_addr (packet_t pp); extern int ax25_get_num_repeaters (packet_t this_p); -extern void ax25_get_addr_with_ssid (packet_t pp, int n, char *); +extern void ax25_get_addr_with_ssid (packet_t pp, int n, char *station); +extern void ax25_get_addr_no_ssid (packet_t pp, int n, char *station); extern int ax25_get_ssid (packet_t pp, int n); extern void ax25_set_ssid (packet_t this_p, int n, int ssid); @@ -267,7 +394,11 @@ extern int ax25_get_heard(packet_t this_p); extern int ax25_get_first_not_repeated(packet_t pp); +extern int ax25_get_rr (packet_t this_p, int n); + extern int ax25_get_info (packet_t pp, unsigned char **paddr); +extern void ax25_set_info (packet_t pp, unsigned char *info_ptr, int info_len); +extern int ax25_cut_at_crlf (packet_t this_p); extern void ax25_set_nextp (packet_t this_p, packet_t next_p); @@ -275,24 +406,41 @@ extern int ax25_get_dti (packet_t this_p); extern packet_t ax25_get_nextp (packet_t this_p); +extern void ax25_set_release_time (packet_t this_p, double release_time); +extern double ax25_get_release_time (packet_t this_p); + +extern void ax25_set_modulo (packet_t this_p, int modulo); +extern int ax25_get_modulo (packet_t this_p); + extern void ax25_format_addrs (packet_t pp, char *); +extern void ax25_format_via_path (packet_t this_p, char *result, size_t result_size); extern int ax25_pack (packet_t pp, unsigned char result[AX25_MAX_PACKET_LEN]); +extern ax25_frame_type_t ax25_frame_type (packet_t this_p, cmdres_t *cr, char *desc, int *pf, int *nr, int *ns); + extern void ax25_hex_dump (packet_t this_p); extern int ax25_is_aprs (packet_t pp); +extern int ax25_is_null_frame (packet_t this_p); extern int ax25_get_control (packet_t this_p); +extern int ax25_get_c2 (packet_t this_p); extern int ax25_get_pid (packet_t this_p); +extern int ax25_get_frame_len (packet_t this_p); +extern unsigned char *ax25_get_frame_data_ptr (packet_t this_p); + extern unsigned short ax25_dedupe_crc (packet_t pp); extern unsigned short ax25_m_m_crc (packet_t pp); extern void ax25_safe_print (char *, int, int ascii_only); +#define AX25_ALEVEL_TO_TEXT_SIZE 40 // overkill but safe. +extern int ax25_alevel_to_text (alevel_t alevel, char text[AX25_ALEVEL_TO_TEXT_SIZE]); + #endif /* AX25_PAD_H */ diff --git a/src/ax25_pad2.c b/src/ax25_pad2.c new file mode 100644 index 00000000..347df4b1 --- /dev/null +++ b/src/ax25_pad2.c @@ -0,0 +1,941 @@ +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// +// Copyright (C) 2016 John Langner, WB2OSZ +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . +// + + + +/*------------------------------------------------------------------ + * + * Name: ax25_pad2.c + * + * Purpose: Packet assembler and disasembler, part 2. + * + * Description: + * + * The original ax25_pad.c was written with APRS in mind. + * It handles UI frames and transparency for a KISS TNC. + * Here we add new functions that can handle the + * more general cases of AX.25 frames. + * + * + * * Destination Address (note: opposite order in printed format) + * + * * Source Address + * + * * 0-8 Digipeater Addresses + * (The AX.25 v2.2 spec reduced this number to + * a maximum of 2 but I allow the original 8.) + * + * Each address is composed of: + * + * * 6 upper case letters or digits, blank padded. + * These are shifted left one bit, leaving the LSB always 0. + * + * * a 7th octet containing the SSID and flags. + * The LSB is always 0 except for the last octet of the address field. + * + * The final octet of the Destination has the form: + * + * C R R SSID 0, where, + * + * C = command/response. Set to 1 for command. + * R R = Reserved = 1 1 (See RR note, below) + * SSID = substation ID + * 0 = zero + * + * The final octet of the Source has the form: + * + * C R R SSID 0, where, + * + * C = command/response. Must be inverse of destination C bit. + * R R = Reserved = 1 1 (See RR note, below) + * SSID = substation ID + * 0 = zero (or 1 if no repeaters) + * + * The final octet of each repeater has the form: + * + * H R R SSID 0, where, + * + * H = has-been-repeated = 0 initially. + * Set to 1 after this address has been used. + * R R = Reserved = 1 1 + * SSID = substation ID + * 0 = zero (or 1 if last repeater in list) + * + * A digipeater would repeat this frame if it finds its address + * with the "H" bit set to 0 and all earlier repeater addresses + * have the "H" bit set to 1. + * The "H" bit would be set to 1 in the repeated frame. + * + * In standard monitoring format, an asterisk is displayed after the last + * digipeater with the "H" bit set. That indicates who you are hearing + * over the radio. + * + * + * Next we have: + * + * * One or two byte Control Field - A U frame always has one control byte. + * When using modulo 128 sequence numbers, the + * I and S frames can have a second byte allowing + * 7 bit fields instead of 3 bit fields. + * Unfortunately, we can't tell which we have by looking + * at a frame out of context. :-( + * If we are one end of the link, we would know this + * from SABM/SABME and possible later negotiation + * with XID. But if we start monitoring two other + * stations that are already conversing, we don't know. + * + * RR note: It seems that some implementations put a hint + * in the "RR" reserved bits. + * http://www.tapr.org/pipermail/ax25-layer2/2005-October/000297.html (now broken) + * https://elixir.bootlin.com/linux/latest/source/net/ax25/ax25_addr.c#L237 + * + * The RR bits can also be used for "DAMA" which is + * some sort of channel access coordination scheme. + * http://internet.freepage.de/cgi-bin/feets/freepage_ext/41030x030A/rewrite/hennig/afu/afudoc/afudama.html + * Neither is part of the official protocol spec. + * + * * One byte Protocol ID - Only for I and UI frames. + * Normally we would use 0xf0 for no layer 3. + * + * Finally the Information Field. The initial max size is 256 but it + * can be negotiated higher if both ends agree. + * + * Only these types of frames can have an information part: + * - I + * - UI + * - XID + * - TEST + * - FRMR + * + * The 2 byte CRC is not stored here. + * + * + * Constructors: + * ax25_u_frame - Construct a U frame. + * ax25_s_frame - Construct a S frame. + * ax25_i_frame - Construct a I frame. + * + * Get methods: .... ??? + * + *------------------------------------------------------------------*/ + +#define AX25_PAD_C /* this will affect behavior of ax25_pad.h */ + + +#include "direwolf.h" + +#include +#include +#include +#include +#include + + +#include "textcolor.h" +#include "ax25_pad.h" +#include "ax25_pad2.h" + + + +extern int ax25memdebug; + +static int set_addrs (packet_t pp, char addrs[AX25_MAX_ADDRS][AX25_MAX_ADDR_LEN], int num_addr, cmdres_t cr); + +//#if AX25MEMDEBUG +//#undef AX25MEMDEBUG +//#endif + + +/*------------------------------------------------------------------------------ + * + * Name: ax25_u_frame + * + * Purpose: Construct a U frame. + * + * Input: addrs - Array of addresses. + * + * num_addr - Number of addresses, range 2 .. 10. + * + * cr - cr_cmd command frame, cr_res for a response frame. + * + * ftype - One of: + * frame_type_U_SABME // Set Async Balanced Mode, Extended + * frame_type_U_SABM // Set Async Balanced Mode + * frame_type_U_DISC // Disconnect + * frame_type_U_DM // Disconnect Mode + * frame_type_U_UA // Unnumbered Acknowledge + * frame_type_U_FRMR // Frame Reject + * frame_type_U_UI // Unnumbered Information + * frame_type_U_XID // Exchange Identification + * frame_type_U_TEST // Test + * + * pf - Poll/Final flag. + * + * pid - Protocol ID. >>> Used ONLY for the UI type. <<< + * Normally 0xf0 meaning no level 3. + * Could be other values for NET/ROM, etc. + * + * pinfo - Pointer to data for Info field. Allowed only for UI, XID, TEST, FRMR. + * + * info_len - Length for Info field. + * + * + * Returns: Pointer to new packet object. + * + *------------------------------------------------------------------------------*/ + +#if AX25MEMDEBUG +packet_t ax25_u_frame_debug (char addrs[AX25_MAX_ADDRS][AX25_MAX_ADDR_LEN], int num_addr, cmdres_t cr, ax25_frame_type_t ftype, int pf, int pid, unsigned char *pinfo, int info_len, char *src_file, int src_line) +#else +packet_t ax25_u_frame (char addrs[AX25_MAX_ADDRS][AX25_MAX_ADDR_LEN], int num_addr, cmdres_t cr, ax25_frame_type_t ftype, int pf, int pid, unsigned char *pinfo, int info_len) +#endif +{ + packet_t this_p; + unsigned char *p; + int ctrl = 0; + unsigned int t = 999; // 1 = must be cmd, 0 = must be response, 2 = can be either. + int i = 0; // Is Info part allowed? + + this_p = ax25_new (); + +#if AX25MEMDEBUG + if (ax25memdebug) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("ax25_u_frame, seq=%d, called from %s %d\n", this_p->seq, src_file, src_line); + } +#endif + + if (this_p == NULL) return (NULL); + + this_p->modulo = 0; + + if ( ! set_addrs (this_p, addrs, num_addr, cr)) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Internal error in %s: Could not set addresses for U frame.\n", __func__); + ax25_delete (this_p); + return (NULL); + } + + switch (ftype) { + // 1 = cmd only, 0 = res only, 2 = either + case frame_type_U_SABME: ctrl = 0x6f; t = 1; break; + case frame_type_U_SABM: ctrl = 0x2f; t = 1; break; + case frame_type_U_DISC: ctrl = 0x43; t = 1; break; + case frame_type_U_DM: ctrl = 0x0f; t = 0; break; + case frame_type_U_UA: ctrl = 0x63; t = 0; break; + case frame_type_U_FRMR: ctrl = 0x87; t = 0; i = 1; break; + case frame_type_U_UI: ctrl = 0x03; t = 2; i = 1; break; + case frame_type_U_XID: ctrl = 0xaf; t = 2; i = 1; break; + case frame_type_U_TEST: ctrl = 0xe3; t = 2; i = 1; break; + + default: + text_color_set(DW_COLOR_ERROR); + dw_printf ("Internal error in %s: Invalid ftype %d for U frame.\n", __func__, ftype); + ax25_delete (this_p); + return (NULL); + break; + } + if (pf) ctrl |= 0x10; + + if (t != 2) { + if (cr != t) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Internal error in %s: U frame, cr is %d but must be %d. ftype=%d\n", __func__, cr, t, ftype); + } + } + + p = this_p->frame_data + this_p->frame_len; + *p++ = ctrl; + this_p->frame_len++; + + if (ftype == frame_type_U_UI) { + + // Definitely don't want pid value of 0 (not in valid list) + // or 0xff (which means more bytes follow). + + if (pid < 0 || pid == 0 || pid == 0xff) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Internal error in %s: U frame, Invalid pid value 0x%02x.\n", __func__, pid); + pid = AX25_PID_NO_LAYER_3; + } + *p++ = pid; + this_p->frame_len++; + } + + if (i) { + if (pinfo != NULL && info_len > 0) { + if (info_len > AX25_MAX_INFO_LEN) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Internal error in %s: U frame, Invalid information field length %d.\n", __func__, info_len); + info_len = AX25_MAX_INFO_LEN; + } + memcpy (p, pinfo, info_len); + p += info_len; + this_p->frame_len += info_len; + } + } + else { + if (pinfo != NULL && info_len > 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Internal error in %s: Info part not allowed for U frame type.\n", __func__); + } + } + *p = '\0'; + + assert (p == this_p->frame_data + this_p->frame_len); + assert (this_p->magic1 == MAGIC); + assert (this_p->magic2 == MAGIC); + +#if PAD2TEST + ax25_frame_type_t check_ftype; + cmdres_t check_cr; + char check_desc[80]; + int check_pf; + int check_nr; + int check_ns; + + check_ftype = ax25_frame_type (this_p, &check_cr, check_desc, &check_pf, &check_nr, &check_ns); + + text_color_set(DW_COLOR_DEBUG); + dw_printf ("check: ftype=%d, desc=\"%s\", pf=%d\n", check_ftype, check_desc, check_pf); + + assert (check_cr == cr); + assert (check_ftype == ftype); + assert (check_pf == pf); + assert (check_nr == -1); + assert (check_ns == -1); + +#endif + + return (this_p); + +} /* end ax25_u_frame */ + + + + + + + +/*------------------------------------------------------------------------------ + * + * Name: ax25_s_frame + * + * Purpose: Construct an S frame. + * + * Input: addrs - Array of addresses. + * + * num_addr - Number of addresses, range 2 .. 10. + * + * cr - cr_cmd command frame, cr_res for a response frame. + * + * ftype - One of: + * frame_type_S_RR, // Receive Ready - System Ready To Receive + * frame_type_S_RNR, // Receive Not Ready - TNC Buffer Full + * frame_type_S_REJ, // Reject Frame - Out of Sequence or Duplicate + * frame_type_S_SREJ, // Selective Reject - Request single frame repeat + * + * modulo - 8 or 128. Determines if we have 1 or 2 control bytes. + * + * nr - N(R) field --- describe. + * + * pf - Poll/Final flag. + * + * pinfo - Pointer to data for Info field. Allowed only for SREJ. + * + * info_len - Length for Info field. + * + * + * Returns: Pointer to new packet object. + * + *------------------------------------------------------------------------------*/ + +#if AX25MEMDEBUG +packet_t ax25_s_frame_debug (char addrs[AX25_MAX_ADDRS][AX25_MAX_ADDR_LEN], int num_addr, cmdres_t cr, ax25_frame_type_t ftype, int modulo, int nr, int pf, unsigned char *pinfo, int info_len, char *src_file, int src_line) +#else +packet_t ax25_s_frame (char addrs[AX25_MAX_ADDRS][AX25_MAX_ADDR_LEN], int num_addr, cmdres_t cr, ax25_frame_type_t ftype, int modulo, int nr, int pf, unsigned char *pinfo, int info_len) +#endif +{ + packet_t this_p; + unsigned char *p; + int ctrl = 0; + + this_p = ax25_new (); + +#if AX25MEMDEBUG + if (ax25memdebug) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("ax25_s_frame, seq=%d, called from %s %d\n", this_p->seq, src_file, src_line); + } +#endif + + if (this_p == NULL) return (NULL); + + if ( ! set_addrs (this_p, addrs, num_addr, cr)) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Internal error in %s: Could not set addresses for S frame.\n", __func__); + ax25_delete (this_p); + return (NULL); + } + + if (modulo != 8 && modulo != 128) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Internal error in %s: Invalid modulo %d for S frame.\n", __func__, modulo); + modulo = 8; + } + this_p->modulo = modulo; + + if (nr < 0 || nr >= modulo) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Internal error in %s: Invalid N(R) %d for S frame.\n", __func__, nr); + nr &= (modulo - 1); + } + + // Erratum: The AX.25 spec is not clear about whether SREJ should be command, response, or both. + // The underlying X.25 spec clearly says it is response only. Let's go with that. + + if (ftype == frame_type_S_SREJ && cr != cr_res) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Internal error in %s: SREJ must be response.\n", __func__); + } + + switch (ftype) { + + case frame_type_S_RR: ctrl = 0x01; break; + case frame_type_S_RNR: ctrl = 0x05; break; + case frame_type_S_REJ: ctrl = 0x09; break; + case frame_type_S_SREJ: ctrl = 0x0d; break; + + default: + text_color_set(DW_COLOR_ERROR); + dw_printf ("Internal error in %s: Invalid ftype %d for S frame.\n", __func__, ftype); + ax25_delete (this_p); + return (NULL); + break; + } + + p = this_p->frame_data + this_p->frame_len; + + if (modulo == 8) { + if (pf) ctrl |= 0x10; + ctrl |= nr << 5; + *p++ = ctrl; + this_p->frame_len++; + } + else { + *p++ = ctrl; + this_p->frame_len++; + + ctrl = pf & 1; + ctrl |= nr << 1; + *p++ = ctrl; + this_p->frame_len++; + } + + if (ftype == frame_type_S_SREJ) { + if (pinfo != NULL && info_len > 0) { + if (info_len > AX25_MAX_INFO_LEN) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Internal error in %s: SREJ frame, Invalid information field length %d.\n", __func__, info_len); + info_len = AX25_MAX_INFO_LEN; + } + memcpy (p, pinfo, info_len); + p += info_len; + this_p->frame_len += info_len; + } + } + else { + if (pinfo != NULL || info_len != 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Internal error in %s: Info part not allowed for RR, RNR, REJ frame.\n", __func__); + } + } + *p = '\0'; + + assert (p == this_p->frame_data + this_p->frame_len); + assert (this_p->magic1 == MAGIC); + assert (this_p->magic2 == MAGIC); + +#if PAD2TEST + + ax25_frame_type_t check_ftype; + cmdres_t check_cr; + char check_desc[80]; + int check_pf; + int check_nr; + int check_ns; + + // todo modulo must be input. + check_ftype = ax25_frame_type (this_p, &check_cr, check_desc, &check_pf, &check_nr, &check_ns); + + text_color_set(DW_COLOR_DEBUG); + dw_printf ("check: ftype=%d, desc=\"%s\", pf=%d, nr=%d\n", check_ftype, check_desc, check_pf, check_nr); + + assert (check_cr == cr); + assert (check_ftype == ftype); + assert (check_pf == pf); + assert (check_nr == nr); + assert (check_ns == -1); + +#endif + return (this_p); + +} /* end ax25_s_frame */ + + + + + +/*------------------------------------------------------------------------------ + * + * Name: ax25_i_frame + * + * Purpose: Construct an I frame. + * + * Input: addrs - Array of addresses. + * + * num_addr - Number of addresses, range 2 .. 10. + * + * cr - cr_cmd command frame, cr_res for a response frame. + * + * modulo - 8 or 128. + * + * nr - N(R) field --- describe. + * + * ns - N(S) field --- describe. + * + * pf - Poll/Final flag. + * + * pid - Protocol ID. + * Normally 0xf0 meaning no level 3. + * Could be other values for NET/ROM, etc. + * + * pinfo - Pointer to data for Info field. + * + * info_len - Length for Info field. + * + * + * Returns: Pointer to new packet object. + * + *------------------------------------------------------------------------------*/ + +#if AX25MEMDEBUG +packet_t ax25_i_frame_debug (char addrs[AX25_MAX_ADDRS][AX25_MAX_ADDR_LEN], int num_addr, cmdres_t cr, int modulo, int nr, int ns, int pf, int pid, unsigned char *pinfo, int info_len, char *src_file, int src_line) +#else +packet_t ax25_i_frame (char addrs[AX25_MAX_ADDRS][AX25_MAX_ADDR_LEN], int num_addr, cmdres_t cr, int modulo, int nr, int ns, int pf, int pid, unsigned char *pinfo, int info_len) +#endif +{ + packet_t this_p; + unsigned char *p; + int ctrl = 0; + + this_p = ax25_new (); + +#if AX25MEMDEBUG + if (ax25memdebug) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("ax25_i_frame, seq=%d, called from %s %d\n", this_p->seq, src_file, src_line); + } +#endif + + if (this_p == NULL) return (NULL); + + if ( ! set_addrs (this_p, addrs, num_addr, cr)) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Internal error in %s: Could not set addresses for I frame.\n", __func__); + ax25_delete (this_p); + return (NULL); + } + + if (modulo != 8 && modulo != 128) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Internal error in %s: Invalid modulo %d for I frame.\n", __func__, modulo); + modulo = 8; + } + this_p->modulo = modulo; + + if (nr < 0 || nr >= modulo) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Internal error in %s: Invalid N(R) %d for I frame.\n", __func__, nr); + nr &= (modulo - 1); + } + + if (ns < 0 || ns >= modulo) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Internal error in %s: Invalid N(S) %d for I frame.\n", __func__, ns); + ns &= (modulo - 1); + } + + p = this_p->frame_data + this_p->frame_len; + + if (modulo == 8) { + ctrl = (nr << 5) | (ns << 1); + if (pf) ctrl |= 0x10; + *p++ = ctrl; + this_p->frame_len++; + } + else { + ctrl = ns << 1; + *p++ = ctrl; + this_p->frame_len++; + + ctrl = nr << 1; + if (pf) ctrl |= 0x01; + *p++ = ctrl; + this_p->frame_len++; + } + + // Definitely don't want pid value of 0 (not in valid list) + // or 0xff (which means more bytes follow). + + if (pid < 0 || pid == 0 || pid == 0xff) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("Warning: Client application provided invalid PID value, 0x%02x, for I frame.\n", pid); + pid = AX25_PID_NO_LAYER_3; + } + *p++ = pid; + this_p->frame_len++; + + if (pinfo != NULL && info_len > 0) { + if (info_len > AX25_MAX_INFO_LEN) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Internal error in %s: I frame, Invalid information field length %d.\n", __func__, info_len); + info_len = AX25_MAX_INFO_LEN; + } + memcpy (p, pinfo, info_len); + p += info_len; + this_p->frame_len += info_len; + } + + *p = '\0'; + + assert (p == this_p->frame_data + this_p->frame_len); + assert (this_p->magic1 == MAGIC); + assert (this_p->magic2 == MAGIC); + +#if PAD2TEST + + ax25_frame_type_t check_ftype; + cmdres_t check_cr; + char check_desc[80]; + int check_pf; + int check_nr; + int check_ns; + unsigned char *check_pinfo; + int check_info_len; + + check_ftype = ax25_frame_type (this_p, &check_cr, check_desc, &check_pf, &check_nr, &check_ns); + + text_color_set(DW_COLOR_DEBUG); + dw_printf ("check: ftype=%d, desc=\"%s\", pf=%d, nr=%d, ns=%d\n", check_ftype, check_desc, check_pf, check_nr, check_ns); + + check_info_len = ax25_get_info (this_p, &check_pinfo); + + assert (check_cr == cr); + assert (check_ftype == frame_type_I); + assert (check_pf == pf); + assert (check_nr == nr); + assert (check_ns == ns); + + assert (check_info_len == info_len); + assert (strcmp((char*)check_pinfo,(char*)pinfo) == 0); +#endif + + return (this_p); + +} /* end ax25_i_frame */ + + + + + +/*------------------------------------------------------------------------------ + * + * Name: set_addrs + * + * Purpose: Set address fields + * + * Input: pp - Packet object. + * + * addrs - Array of addresses. Same order as in frame. + * + * num_addr - Number of addresses, range 2 .. 10. + * + * cr - cr_cmd command frame, cr_res for a response frame. + * + * Output: pp->frame_data - 7 bytes for each address. + * + * pp->frame_len - num_addr * 7 + * + * p->num_addr - num_addr + * + * Returns: 1 for success. 0 for failure. + * + *------------------------------------------------------------------------------*/ + + +static int set_addrs (packet_t pp, char addrs[AX25_MAX_ADDRS][AX25_MAX_ADDR_LEN], int num_addr, cmdres_t cr) +{ + int n; + + assert (pp->frame_len == 0); + assert (cr == cr_cmd || cr == cr_res); + + if (num_addr < AX25_MIN_ADDRS || num_addr > AX25_MAX_ADDRS) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("INTERNAL ERROR: %s %s %d, num_addr = %d\n", __FILE__, __func__, __LINE__, num_addr); + return (0); + } + + for (n = 0; n < num_addr; n++) { + + unsigned char *pa = pp->frame_data + n * 7; + int ok; + int strict = 1; + char oaddr[AX25_MAX_ADDR_LEN]; + int ssid; + int heard; + int j; + + ok = ax25_parse_addr (n, addrs[n], strict, oaddr, &ssid, &heard); + + if (! ok) return (0); + + // Fill in address. + + memset (pa, ' ' << 1, 6); + for (j = 0; oaddr[j]; j++) { + pa[j] = oaddr[j] << 1; + } + pa += 6; + + // Fill in SSID. + + *pa = 0x60 | ((ssid & 0xf) << 1); + + // Command / response flag. + + switch (n) { + case AX25_DESTINATION: + if (cr == cr_cmd) *pa |= 0x80; + break; + case AX25_SOURCE: + if (cr == cr_res) *pa |= 0x80; + break; + default: + break; + } + + // Is this the end of address field? + + if (n == num_addr - 1) { + *pa |= 1; + } + + pp->frame_len += 7; + } + + pp->num_addr = num_addr; + return (1); + +} /* end set_addrs */ + + + + +/*------------------------------------------------------------------------------ + * + * Name: main + * + * Purpose: Quick unit test for this file. + * + * Description: Generate a variety of frames. + * Each function calls ax25_frame_type to verify results. + * + * $ gcc -DPAD2TEST -DUSE_REGEX_STATIC -Iregex ax25_pad.c ax25_pad2.c fcs_calc.o textcolor.o regex.a misc.a + * + *------------------------------------------------------------------------------*/ + +#if PAD2TEST + +int main () +{ + char addrs[AX25_MAX_ADDRS][AX25_MAX_ADDR_LEN]; + int num_addr = 2; + cmdres_t cr; + ax25_frame_type_t ftype; + int pf = 0; + int pid = 0xf0; + int modulo; + int nr, ns; + unsigned char *pinfo = NULL; + int info_len = 0; + packet_t pp; + + strcpy (addrs[0], "W2UB"); + strcpy (addrs[1], "WB2OSZ-15"); + num_addr = 2; + +/* U frame */ + + for (ftype = frame_type_U_SABME; ftype <= frame_type_U_TEST; ftype++) { + + for (pf = 0; pf <= 1; pf++) { + + int cmin = 0, cmax = 1; + + switch (ftype) { + // 0 = response, 1 = command + case frame_type_U_SABME: cmin = 1; cmax = 1; break; + case frame_type_U_SABM: cmin = 1; cmax = 1; break; + case frame_type_U_DISC: cmin = 1; cmax = 1; break; + case frame_type_U_DM: cmin = 0; cmax = 0; break; + case frame_type_U_UA: cmin = 0; cmax = 0; break; + case frame_type_U_FRMR: cmin = 0; cmax = 0; break; + case frame_type_U_UI: cmin = 0; cmax = 1; break; + case frame_type_U_XID: cmin = 0; cmax = 1; break; + case frame_type_U_TEST: cmin = 0; cmax = 1; break; + default: break; // avoid compiler warning. + } + + for (cr = cmin; cr <= cmax; cr++) { + + text_color_set(DW_COLOR_INFO); + dw_printf ("\nConstruct U frame, cr=%d, ftype=%d, pid=0x%02x\n", cr, ftype, pid); + + pp = ax25_u_frame (addrs, num_addr, cr, ftype, pf, pid, pinfo, info_len); + ax25_hex_dump (pp); + ax25_delete (pp); + } + } + } + + dw_printf ("\n----------\n\n"); + +/* S frame */ + + strcpy (addrs[2], "DIGI1-1"); + num_addr = 3; + + for (ftype = frame_type_S_RR; ftype <= frame_type_S_SREJ; ftype++) { + + for (pf = 0; pf <= 1; pf++) { + + modulo = 8; + nr = modulo / 2 + 1; + + for (cr = 0; cr <= 1; cr++) { + + text_color_set(DW_COLOR_INFO); + dw_printf ("\nConstruct S frame, cmd=%d, ftype=%d, pid=0x%02x\n", cr, ftype, pid); + + pp = ax25_s_frame (addrs, num_addr, cr, ftype, modulo, nr, pf, NULL, 0); + + ax25_hex_dump (pp); + ax25_delete (pp); + } + + modulo = 128; + nr = modulo / 2 + 1; + + for (cr = 0; cr <= 1; cr++) { + + text_color_set(DW_COLOR_INFO); + dw_printf ("\nConstruct S frame, cmd=%d, ftype=%d, pid=0x%02x\n", cr, ftype, pid); + + pp = ax25_s_frame (addrs, num_addr, cr, ftype, modulo, nr, pf, NULL, 0); + + ax25_hex_dump (pp); + ax25_delete (pp); + } + } + } + +/* SREJ is only S frame which can have information part. */ + + static unsigned char srej_info[] = { 1<<1, 2<<1, 3<<1, 4<<1 }; + + ftype = frame_type_S_SREJ; + for (pf = 0; pf <= 1; pf++) { + + modulo = 128; + nr = 127; + cr = cr_res; + + text_color_set(DW_COLOR_INFO); + dw_printf ("\nConstruct Multi-SREJ S frame, cmd=%d, ftype=%d, pid=0x%02x\n", cr, ftype, pid); + + pp = ax25_s_frame (addrs, num_addr, cr, ftype, modulo, nr, pf, srej_info, (int)(sizeof(srej_info))); + + ax25_hex_dump (pp); + ax25_delete (pp); + } + + dw_printf ("\n----------\n\n"); + +/* I frame */ + + pinfo = (unsigned char*)"The rain in Spain stays mainly on the plain."; + info_len = strlen((char*)pinfo); + + for (pf = 0; pf <= 1; pf++) { + + modulo = 8; + nr = 0x55 & (modulo - 1); + ns = 0xaa & (modulo - 1); + + for (cr = 0; cr <= 1; cr++) { + + text_color_set(DW_COLOR_INFO); + dw_printf ("\nConstruct I frame, cmd=%d, ftype=%d, pid=0x%02x\n", cr, ftype, pid); + + pp = ax25_i_frame (addrs, num_addr, cr, modulo, nr, ns, pf, pid, pinfo, info_len); + + ax25_hex_dump (pp); + ax25_delete (pp); + } + + modulo = 128; + nr = 0x55 & (modulo - 1); + ns = 0xaa & (modulo - 1); + + for (cr = 0; cr <= 1; cr++) { + + text_color_set(DW_COLOR_INFO); + dw_printf ("\nConstruct I frame, cmd=%d, ftype=%d, pid=0x%02x\n", cr, ftype, pid); + + pp = ax25_i_frame (addrs, num_addr, cr, modulo, nr, ns, pf, pid, pinfo, info_len); + + ax25_hex_dump (pp); + ax25_delete (pp); + } + } + + text_color_set(DW_COLOR_REC); + dw_printf ("\n----------\n\n"); + dw_printf ("\nSUCCESS!\n"); + + exit (EXIT_SUCCESS); + +} /* end main */ + +#endif + + +/* end ax25_pad2.c */ diff --git a/src/ax25_pad2.h b/src/ax25_pad2.h new file mode 100644 index 00000000..c6dc17a2 --- /dev/null +++ b/src/ax25_pad2.h @@ -0,0 +1,55 @@ +/*------------------------------------------------------------------- + * + * Name: ax25_pad2.h + * + * Purpose: Header file for using ax25_pad2.c + * ax25_pad dealt only with UI frames. + * This adds a facility for the other types: U, s, I. + * + *------------------------------------------------------------------*/ + +#ifndef AX25_PAD2_H +#define AX25_PAD2_H 1 + +#include "ax25_pad.h" + + + + +#if AX25MEMDEBUG // to investigate a memory leak problem + + + +packet_t ax25_u_frame_debug (char addrs[AX25_MAX_ADDRS][AX25_MAX_ADDR_LEN], int num_addr, cmdres_t cr, ax25_frame_type_t ftype, int pf, int pid, unsigned char *pinfo, int info_len, char *src_file, int src_line); + +packet_t ax25_s_frame_debug (char addrs[AX25_MAX_ADDRS][AX25_MAX_ADDR_LEN], int num_addr, cmdres_t cr, ax25_frame_type_t ftype, int modulo, int nr, int pf, unsigned char *pinfo, int info_len, char *src_file, int src_line); + +packet_t ax25_i_frame_debug (char addrs[AX25_MAX_ADDRS][AX25_MAX_ADDR_LEN], int num_addr, cmdres_t cr, int modulo, int nr, int ns, int pf, int pid, unsigned char *pinfo, int info_len, char *src_file, int src_line); + + +#define ax25_u_frame(a,n,c,f,p,q,i,l) ax25_u_frame_debug(a,n,c,f,p,q,i,l,__FILE__,__LINE__) + +#define ax25_s_frame(a,n,c,f,m,r,p,i,l) ax25_s_frame_debug(a,n,c,f,m,r,p,i,l,__FILE__,__LINE__) + +#define ax25_i_frame(a,n,c,m,r,s,p,q,i,l) ax25_i_frame_debug(a,n,c,m,r,s,p,q,i,l,__FILE__,__LINE__) + + +#else + +packet_t ax25_u_frame (char addrs[AX25_MAX_ADDRS][AX25_MAX_ADDR_LEN], int num_addr, cmdres_t cr, ax25_frame_type_t ftype, int pf, int pid, unsigned char *pinfo, int info_len); + +packet_t ax25_s_frame (char addrs[AX25_MAX_ADDRS][AX25_MAX_ADDR_LEN], int num_addr, cmdres_t cr, ax25_frame_type_t ftype, int modulo, int nr, int pf, unsigned char *pinfo, int info_len); + +packet_t ax25_i_frame (char addrs[AX25_MAX_ADDRS][AX25_MAX_ADDR_LEN], int num_addr, cmdres_t cr, int modulo, int nr, int ns, int pf, int pid, unsigned char *pinfo, int info_len); + + +#endif + + + + +#endif /* AX25_PAD2_H */ + +/* end ax25_pad2.h */ + + diff --git a/src/beacon.c b/src/beacon.c new file mode 100644 index 00000000..69a72701 --- /dev/null +++ b/src/beacon.c @@ -0,0 +1,1085 @@ +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// +// Copyright (C) 2011, 2013, 2014, 2015, 2016, 2017 John Langner, WB2OSZ +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . +// + + +/*------------------------------------------------------------------ + * + * Module: beacon.c + * + * Purpose: Transmit messages on a fixed schedule. + * + * Description: Transmit periodic messages as specified in the config file. + * + *---------------------------------------------------------------*/ + +//#define DEBUG 1 + +#include "direwolf.h" + + +#include +#include +#include +#include +#include +#include +#include + + +#include "ax25_pad.h" +#include "textcolor.h" +#include "audio.h" +#include "tq.h" +#include "xmit.h" +#include "config.h" +#include "version.h" +#include "encode_aprs.h" +#include "beacon.h" +#include "latlong.h" +#include "dwgps.h" +#include "log.h" +#include "dlq.h" +#include "aprs_tt.h" // for dw_run_cmd - should relocate someday. +#include "mheard.h" + + +/* + * Save pointers to configuration settings. + */ + +static struct audio_s *g_modem_config_p; +static struct misc_config_s *g_misc_config_p; +static struct igate_config_s *g_igate_config_p; + + +#if __WIN32__ +static unsigned __stdcall beacon_thread (void *arg); +#else +static void * beacon_thread (void *arg); +#endif + +static int g_tracker_debug_level = 0; // 1 for data from gps. + // 2 + Smart Beaconing logic. + // 3 + Send transmissions to log file. + + +void beacon_tracker_set_debug (int level) +{ + g_tracker_debug_level = level; +} + +static time_t sb_calculate_next_time (time_t now, + float current_speed_mph, float current_course, + time_t last_xmit_time, float last_xmit_course); + +static void beacon_send (int j, dwgps_info_t *gpsinfo); + + +/*------------------------------------------------------------------- + * + * Name: beacon_init + * + * Purpose: Initialize the beacon process. + * + * Inputs: pmodem - Audio device and modem configuration. + * Used only to find valid channels. + * + * pconfig - misc. configuration from config file. + * Beacon stuff ended up here. + * + * pigate - IGate configuration. + * Need this for calculating IGate statistics. + * + * + * Outputs: Remember required information for future use. + * + * Description: Do some validity checking on the beacon configuration. + * + * Start up beacon_thread to actually send the packets + * at the appropriate time. + * + *--------------------------------------------------------------------*/ + + + +void beacon_init (struct audio_s *pmodem, struct misc_config_s *pconfig, struct igate_config_s *pigate) +{ + time_t now; + struct tm tm; + int j; + int count; +#if __WIN32__ + HANDLE beacon_th; +#else + pthread_t beacon_tid; +#endif + + + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("beacon_init ( ... )\n"); +#endif + + + +/* + * Save parameters for later use. + */ + g_modem_config_p = pmodem; + g_misc_config_p = pconfig; + g_igate_config_p = pigate; + +/* + * Precompute the packet contents so any errors are + * Reported once at start up time rather than for each transmission. + * If a serious error is found, set type to BEACON_IGNORE and that + * table entry should be ignored later on. + */ + +// TODO: Better checking. +// We should really have a table for which keywords are are required, +// optional, or not allowed for each beacon type. Options which +// are not applicable are often silently ignored, causing confusion. + + for (j=0; jnum_beacons; j++) { + int chan = g_misc_config_p->beacon[j].sendto_chan; + + if (chan < 0) chan = 0; /* For IGate, use channel 0 call. */ + if (chan >= MAX_CHANS) chan = 0; // For ICHANNEL, use channel 0 call. + + if (g_modem_config_p->chan_medium[chan] == MEDIUM_RADIO || + g_modem_config_p->chan_medium[chan] == MEDIUM_NETTNC) { + + if (strlen(g_modem_config_p->achan[chan].mycall) > 0 && + strcasecmp(g_modem_config_p->achan[chan].mycall, "N0CALL") != 0 && + strcasecmp(g_modem_config_p->achan[chan].mycall, "NOCALL") != 0) { + + switch (g_misc_config_p->beacon[j].btype) { + + case BEACON_OBJECT: + + /* Object name is required. */ + + if (strlen(g_misc_config_p->beacon[j].objname) == 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file, line %d: OBJNAME is required for OBEACON.\n", g_misc_config_p->beacon[j].lineno); + g_misc_config_p->beacon[j].btype = BEACON_IGNORE; + continue; + } + /* Fall thru. Ignore any warning about missing break. */ + + case BEACON_POSITION: + + /* Location is required. */ + + if (g_misc_config_p->beacon[j].lat == G_UNKNOWN || g_misc_config_p->beacon[j].lon == G_UNKNOWN) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file, line %d: Latitude and longitude are required.\n", g_misc_config_p->beacon[j].lineno); + g_misc_config_p->beacon[j].btype = BEACON_IGNORE; + continue; + } + + /* INFO and INFOCMD are only for Custom Beacon. */ + + if (g_misc_config_p->beacon[j].custom_info != NULL || g_misc_config_p->beacon[j].custom_infocmd != NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file, line %d: INFO or INFOCMD are allowed only for custom beacon.\n", g_misc_config_p->beacon[j].lineno); + dw_printf ("INFO and INFOCMD allow you to specify contents of the Information field so it\n"); + dw_printf ("so it would not make sense to use these with other beacon types which construct\n"); + dw_printf ("the Information field. Perhaps you want to use COMMENT or COMMENTCMD option.\n"); + //g_misc_config_p->beacon[j].btype = BEACON_IGNORE; + continue; + } + break; + + case BEACON_TRACKER: + + { + dwgps_info_t gpsinfo; + dwfix_t fix; + + fix = dwgps_read (&gpsinfo); + if (fix == DWFIX_NOT_INIT) { + + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file, line %d: GPS must be configured to use TBEACON.\n", g_misc_config_p->beacon[j].lineno); + g_misc_config_p->beacon[j].btype = BEACON_IGNORE; +#if __WIN32__ + dw_printf ("You must specify the GPSNMEA command in your configuration file.\n"); + dw_printf ("This contains the name of the serial port where the receiver is connected.\n"); +#else + dw_printf ("You must specify the source of the GPS data in your configuration file.\n"); + dw_printf ("It can be either GPSD, meaning the gpsd daemon, or GPSNMEA for\n"); + dw_printf ("for a serial port connection with exclusive use.\n"); +#endif + + } + } + + /* INFO and INFOCMD are only for Custom Beacon. */ + + if (g_misc_config_p->beacon[j].custom_info != NULL || g_misc_config_p->beacon[j].custom_infocmd != NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file, line %d: INFO or INFOCMD are allowed only for custom beacon.\n", g_misc_config_p->beacon[j].lineno); + dw_printf ("INFO and INFOCMD allow you to specify contents of the Information field so it\n"); + dw_printf ("so it would not make sense to use these with other beacon types which construct\n"); + dw_printf ("the Information field. Perhaps you want to use COMMENT or COMMENTCMD option.\n"); + //g_misc_config_p->beacon[j].btype = BEACON_IGNORE; + continue; + } + break; + + case BEACON_CUSTOM: + + /* INFO or INFOCMD is required. */ + + if (g_misc_config_p->beacon[j].custom_info == NULL && g_misc_config_p->beacon[j].custom_infocmd == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file, line %d: INFO or INFOCMD is required for custom beacon.\n", g_misc_config_p->beacon[j].lineno); + g_misc_config_p->beacon[j].btype = BEACON_IGNORE; + continue; + } + break; + + case BEACON_IGATE: + + /* Doesn't make sense if IGate is not configured. */ + + if (strlen(g_igate_config_p->t2_server_name) == 0 || + strlen(g_igate_config_p->t2_login) == 0 || + strlen(g_igate_config_p->t2_passcode) == 0) { + + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file, line %d: Doesn't make sense to use IBEACON without IGate Configured.\n", g_misc_config_p->beacon[j].lineno); + dw_printf ("IBEACON has been disabled.\n"); + g_misc_config_p->beacon[j].btype = BEACON_IGNORE; + continue; + } + break; + + case BEACON_IGNORE: + break; + } + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file, line %d: MYCALL must be set for beacon on channel %d. \n", g_misc_config_p->beacon[j].lineno, chan); + g_misc_config_p->beacon[j].btype = BEACON_IGNORE; + } + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file, line %d: Invalid channel number %d for beacon. \n", g_misc_config_p->beacon[j].lineno, chan); + g_misc_config_p->beacon[j].btype = BEACON_IGNORE; + } + } + +/* + * Calculate first time for each beacon from the 'slot' or 'delay' value. + */ + + now = time(NULL); + localtime_r (&now, &tm); + + for (j=0; jnum_beacons; j++) { + struct beacon_s *bp = & (g_misc_config_p->beacon[j]); +#if DEBUG + + text_color_set(DW_COLOR_DEBUG); + dw_printf ("beacon[%d] chan=%d, delay=%d, slot=%d, every=%d\n", + j, + bp->sendto_chan, + bp->delay, + bp->slot, + bp->every); +#endif + +/* + * If timeslots, there must be a full number of beacon intervals per hour. + */ +#define IS_GOOD(x) ((3600/(x))*(x) == 3600) + + if (bp->slot != G_UNKNOWN) { + + if ( ! IS_GOOD(bp->every)) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file, line %d: When using timeslots, there must be a whole number of beacon intervals per hour.\n", bp->lineno); + + // Try to make it valid by adjusting up or down. + + int n; + for (n=1; ; n++) { + int e; + e = bp->every + n; + if (e > 3600) { + bp->every = 3600; + break; + } + if (IS_GOOD(e)) { + bp->every = e; + break; + } + e = bp->every - n; + if (e < 1) { + bp->every = 1; // Impose a larger minimum? + break; + } + if (IS_GOOD(e)) { + bp->every = e; + break; + } + } + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file, line %d: Time between slotted beacons has been adjusted to %d seconds.\n", bp->lineno, bp->every); + } +/* + * Determine when next slot time will arrive. + */ + bp->delay = bp->slot - (tm.tm_min * 60 + tm.tm_sec); + while (bp->delay > bp->every) bp->delay -= bp->every; + while (bp->delay < 5) bp->delay += bp->every; + } + + g_misc_config_p->beacon[j].next = now + g_misc_config_p->beacon[j].delay; + } + + +/* + * Start up thread for processing only if at least one is valid. + */ + + count = 0; + for (j=0; jnum_beacons; j++) { + if (g_misc_config_p->beacon[j].btype != BEACON_IGNORE) { + count++; + } + } + + if (count >= 1) { + +#if __WIN32__ + beacon_th = (HANDLE)_beginthreadex (NULL, 0, &beacon_thread, NULL, 0, NULL); + if (beacon_th == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Could not create beacon thread\n"); + return; + } +#else + int e; + + e = pthread_create (&beacon_tid, NULL, beacon_thread, NULL); + if (e != 0) { + text_color_set(DW_COLOR_ERROR); + perror("Could not create beacon thread"); + return; + } +#endif + } + + +} /* end beacon_init */ + + + + + +/*------------------------------------------------------------------- + * + * Name: beacon_thread + * + * Purpose: Transmit beacons when it is time. + * + * Inputs: g_misc_config_p->beacon + * + * Outputs: g_misc_config_p->beacon[].next_time + * + * Description: Go to sleep until it is time for the next beacon. + * Transmit any beacons scheduled for now. + * Repeat. + * + *--------------------------------------------------------------------*/ + +#define MIN(x,y) ((x) < (y) ? (x) : (y)) + + + + +#if __WIN32__ +static unsigned __stdcall beacon_thread (void *arg) +#else +static void * beacon_thread (void *arg) +#endif +{ + int j; /* Index into array of beacons. */ + time_t earliest; + time_t now; /* Current time. */ + int number_of_tbeacons; /* Number of tracker beacons. */ + + +/* + * SmartBeaconing state. + */ + time_t sb_prev_time = 0; /* Time of most recent transmission. */ + float sb_prev_course = 0; /* Most recent course reported. */ + + +#if DEBUG + struct tm tm; + char hms[20]; + + now = time(NULL); + + localtime_r (&now, &tm); + + strftime (hms, sizeof(hms), "%H:%M:%S", &tm); + text_color_set(DW_COLOR_DEBUG); + dw_printf ("beacon_thread: started %s\n", hms); +#endif + +/* + * See if any tracker beacons are configured. + * No need to obtain GPS data if none. + */ + + number_of_tbeacons = 0; + for (j=0; jnum_beacons; j++) { + if (g_misc_config_p->beacon[j].btype == BEACON_TRACKER) { + number_of_tbeacons++; + } + } + + now = time(NULL); + + while (1) { + + dwgps_info_t gpsinfo; + +/* + * Sleep until time for the earliest scheduled or + * the soonest we could transmit due to corner pegging. + */ + + earliest = now + 60 * 60; + for (j=0; jnum_beacons; j++) { + if (g_misc_config_p->beacon[j].btype != BEACON_IGNORE) { + earliest = MIN(g_misc_config_p->beacon[j].next, earliest); + } + } + + if (g_misc_config_p->sb_configured && number_of_tbeacons > 0) { + earliest = MIN(now + g_misc_config_p->sb_turn_time, earliest); + earliest = MIN(now + g_misc_config_p->sb_fast_rate, earliest); + } + + if (earliest > now) { + SLEEP_SEC (earliest - now); + } + +/* + * Woke up. See what needs to be done. + */ + now = time(NULL); + +#if DEBUG + localtime_r (&now, &tm); + strftime (hms, sizeof(hms), "%H:%M:%S", &tm); + text_color_set(DW_COLOR_DEBUG); + dw_printf ("beacon_thread: woke up %s\n", hms); +#endif + +/* + * Get information from GPS if being used. + * This needs to be done before the next scheduled tracker + * beacon because corner pegging make it sooner. + */ + + if (number_of_tbeacons > 0) { + + dwfix_t fix = dwgps_read (&gpsinfo); + float my_speed_mph = DW_KNOTS_TO_MPH(gpsinfo.speed_knots); + + if (g_tracker_debug_level >= 1) { + struct tm tm; + char hms[20]; + + + localtime_r (&now, &tm); + strftime (hms, sizeof(hms), "%H:%M:%S", &tm); + text_color_set(DW_COLOR_DEBUG); + if (fix == 3) { + dw_printf ("%s 3D, %.6f, %.6f, %.1f mph, %.0f\xc2\xb0, %.1f m\n", hms, gpsinfo.dlat, gpsinfo.dlon, my_speed_mph, gpsinfo.track, gpsinfo.altitude); + } + else if (fix == 2) { + dw_printf ("%s 2D, %.6f, %.6f, %.1f mph, %.0f\xc2\xb0\n", hms, gpsinfo.dlat, gpsinfo.dlon, my_speed_mph, gpsinfo.track); + } + else { + dw_printf ("%s No GPS fix\n", hms); + } + } + + /* Don't complain here for no fix. */ + /* Possibly at the point where about to transmit. */ + +/* + * Run SmartBeaconing calculation if configured and GPS data available. + */ + if (g_misc_config_p->sb_configured && fix >= DWFIX_2D) { + + time_t tnext = sb_calculate_next_time (now, + DW_KNOTS_TO_MPH(gpsinfo.speed_knots), gpsinfo.track, + sb_prev_time, sb_prev_course); + + for (j=0; jnum_beacons; j++) { + if (g_misc_config_p->beacon[j].btype == BEACON_TRACKER) { + /* Haven't thought about the consequences of SmartBeaconing */ + /* and having more than one tbeacon configured. */ + if (tnext < g_misc_config_p->beacon[j].next) { + g_misc_config_p->beacon[j].next = tnext; + } + } + } /* Update next time if sooner. */ + } /* apply SmartBeaconing */ + } /* tbeacon(s) configured. */ + +/* + * Send if the time has arrived. + */ + for (j=0; jnum_beacons; j++) { + + struct beacon_s *bp = & (g_misc_config_p->beacon[j]); + + if (bp->btype == BEACON_IGNORE) + continue; + + if (bp->next <= now) { + + /* Send the beacon. */ + + beacon_send (j, &gpsinfo); + + /* Calculate when the next one should be sent. */ + /* Easy for fixed interval. SmartBeaconing takes more effort. */ + + if (bp->btype == BEACON_TRACKER) { + + if (gpsinfo.fix < DWFIX_2D) { + /* Fix not available so beacon was not sent. */ + + if (g_misc_config_p->sb_configured) { + /* Try again in a couple seconds. */ + bp->next = now + 2; + } + else { + /* Stay with the schedule. */ + /* Important for slotted. Might reconsider otherwise. */ + bp->next += bp->every; + } + } + else if (g_misc_config_p->sb_configured) { + + /* Remember most recent tracker beacon. */ + /* Compute next time if not turning. */ + + sb_prev_time = now; + sb_prev_course = gpsinfo.track; + + bp->next = sb_calculate_next_time (now, + DW_KNOTS_TO_MPH(gpsinfo.speed_knots), gpsinfo.track, + sb_prev_time, sb_prev_course); + } + else { + /* Tracker beacon, fixed spacing. */ + bp->next += bp->every; + } + } + else { + /* Non-tracker beacon, fixed spacing. */ + /* Increment by 'every' so slotted times come out right. */ + /* i.e. Don't take relative to now in case there was some delay. */ + + bp->next += bp->every; + + // https://github.com/wb2osz/direwolf/pull/301 + // https://github.com/wb2osz/direwolf/pull/301 + // This happens with a portable system with no Internet connection. + // On reboot, the time is in the past. + // After time gets set from GPS, all beacons from that interval are sent. + // FIXME: This will surely break time slotted scheduling. + // TODO: The correct fix will be using monotonic, rather than clock, time. + + /* craigerl: if next beacon is scheduled in the past, then set next beacon relative to now (happens when NTP pushes clock AHEAD) */ + /* fixme: if NTP sets clock BACK an hour, this thread will sleep for that hour */ + if ( bp->next < now ) { + bp->next = now + bp->every; + text_color_set(DW_COLOR_INFO); + dw_printf("\nSystem clock appears to have jumped forward. Beacon schedule updated.\n\n"); + } + } + + } /* if time to send it */ + + } /* for each configured beacon */ + + } /* do forever */ + +#if __WIN32__ + return(0); /* unreachable but warning if not here. */ +#else + return(NULL); +#endif + +} /* end beacon_thread */ + + +/*------------------------------------------------------------------- + * + * Name: sb_calculate_next_time + * + * Purpose: Calculate next transmission time using the SmartBeaconing algorithm. + * + * Inputs: now - Current time. + * + * current_speed_mph - Current speed from GPS. + * Not expecting G_UNKNOWN but should check for it. + * + * current_course - Current direction of travel. + * Could be G_UNKNOWN if stationary. + * + * last_xmit_time - Time of most recent transmission. + * + * last_xmit_course - Direction included in most recent transmission. + * + * Global In: g_misc_config_p-> + * sb_configured TRUE if SmartBeaconing is configured. + * sb_fast_speed MPH + * sb_fast_rate seconds + * sb_slow_speed MPH + * sb_slow_rate seconds + * sb_turn_time seconds + * sb_turn_angle degrees + * sb_turn_slope degrees * MPH + * + * Returns: Time of next transmission. + * Could vary from now to sb_slow_rate in the future. + * + * Caution: The algorithm is defined in MPH units. GPS uses knots. + * The caller must be careful about using the proper conversions. + * + *--------------------------------------------------------------------*/ + +/* Difference between two angles. */ + +static float heading_change (float a, float b) +{ + float diff; + + diff = fabs(a - b); + if (diff <= 180.) + return (diff); + else + return (360. - diff); +} + +static time_t sb_calculate_next_time (time_t now, + float current_speed_mph, float current_course, + time_t last_xmit_time, float last_xmit_course) +{ + int beacon_rate; + time_t next_time; + +/* + * Compute time between beacons for travelling in a straight line. + */ + + if (current_speed_mph == G_UNKNOWN) { + beacon_rate = (int)roundf((g_misc_config_p->sb_fast_rate + g_misc_config_p->sb_slow_rate) / 2.); + } + else if (current_speed_mph > g_misc_config_p->sb_fast_speed) { + beacon_rate = g_misc_config_p->sb_fast_rate; + } + else if (current_speed_mph < g_misc_config_p->sb_slow_speed) { + beacon_rate = g_misc_config_p->sb_slow_rate; + } + else { + /* Can't divide by 0 assuming sb_slow_speed > 0. */ + beacon_rate = (int)roundf(( g_misc_config_p->sb_fast_rate * g_misc_config_p->sb_fast_speed ) / current_speed_mph); + } + + if (g_tracker_debug_level >= 2) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("SmartBeaconing: Beacon Rate = %d seconds for %.1f MPH\n", beacon_rate, current_speed_mph); + } + + next_time = last_xmit_time + beacon_rate; + +/* + * Test for "Corner Pegging" if moving. + */ + if (current_speed_mph != G_UNKNOWN && current_speed_mph >= 1.0 && + current_course != G_UNKNOWN && last_xmit_course != G_UNKNOWN) { + + float change = heading_change(current_course, last_xmit_course); + float turn_threshold = g_misc_config_p->sb_turn_angle + + g_misc_config_p->sb_turn_slope / current_speed_mph; + + if (change > turn_threshold && + now >= last_xmit_time + g_misc_config_p->sb_turn_time) { + + if (g_tracker_debug_level >= 2) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("SmartBeaconing: Send now for heading change of %.0f\n", change); + } + + next_time = now; + } + } + + return (next_time); + +} /* end sb_calculate_next_time */ + + +/*------------------------------------------------------------------- + * + * Name: beacon_send + * + * Purpose: Transmit one beacon after it was determined to be time. + * + * Inputs: j Index into beacon configuration array below. + * + * gpsinfo Information from GPS. Used only for TBEACON. + * + * Global In: g_misc_config_p->beacon Array of beacon configurations. + * + * Outputs: Destination(s) specified: + * - Transmit queue. + * - IGate. + * - Simulated reception. + * + * Description: Prepare text in monitor format. + * Convert to packet object. + * Send to desired destination(s). + * + *--------------------------------------------------------------------*/ + +static void beacon_send (int j, dwgps_info_t *gpsinfo) +{ + + struct beacon_s *bp = & (g_misc_config_p->beacon[j]); + + int strict = 1; /* Strict packet checking because they will go over air. */ + char stemp[20]; + char info[AX25_MAX_INFO_LEN]; + char beacon_text[AX25_MAX_PACKET_LEN]; + packet_t pp = NULL; + char mycall[AX25_MAX_ADDR_LEN]; + + char super_comment[AX25_MAX_INFO_LEN]; // Fixed part + any dynamic part. + +/* + * Obtain source call for the beacon. + * This could potentially be different on different channels. + * When sending to IGate server, use call from first radio channel. + * + * Check added in version 1.0a. Previously used index of -1. + * + * Version 1.1 - channel should now be 0 for IGate. + * Type of destination is encoded separately. + */ + strlcpy (mycall, "NOCALL", sizeof(mycall)); + + assert (bp->sendto_chan >= 0); + + if (g_modem_config_p->chan_medium[bp->sendto_chan] == MEDIUM_IGATE) { // ICHANNEL uses chan 0 mycall. + // TODO: Maybe it should be allowed to have own. + strlcpy (mycall, g_modem_config_p->achan[0].mycall, sizeof(mycall)); + } + else { + strlcpy (mycall, g_modem_config_p->achan[bp->sendto_chan].mycall, sizeof(mycall)); + } + + if (strlen(mycall) == 0 || strcmp(mycall, "NOCALL") == 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("MYCALL not set for beacon to chan %d in config file line %d.\n", bp->sendto_chan, bp->lineno); + return; + } + +/* + * Prepare the monitor format header. + * + * src > dest [ , via ] + */ + + if (bp->source != NULL) { + strlcpy (beacon_text, bp->source, sizeof(beacon_text)); + } + else { + strlcpy (beacon_text, mycall, sizeof(beacon_text)); + } + strlcat (beacon_text, ">", sizeof(beacon_text)); + + if (bp->dest != NULL) { + strlcat (beacon_text, bp->dest, sizeof(beacon_text)); + } + else { + snprintf (stemp, sizeof(stemp), "%s%1d%1d", APP_TOCALL, MAJOR_VERSION, MINOR_VERSION); + strlcat (beacon_text, stemp, sizeof(beacon_text)); + } + + if (bp->via != NULL) { + strlcat (beacon_text, ",", sizeof(beacon_text)); + strlcat (beacon_text, bp->via, sizeof(beacon_text)); + } + strlcat (beacon_text, ":", sizeof(beacon_text)); + + +/* + * If the COMMENTCMD option was specified, run specified command to get variable part. + * Result is any fixed part followed by any variable part. + */ + +// TODO: test & document. + + strlcpy (super_comment, "", sizeof(super_comment)); + if (bp->comment != NULL) { + strlcpy (super_comment, bp->comment, sizeof(super_comment)); + } + + if (bp->commentcmd != NULL) { + char var_comment[AX25_MAX_INFO_LEN]; + int k; + + /* Run given command to get variable part of comment. */ + + k = dw_run_cmd (bp->commentcmd, 2, var_comment, sizeof(var_comment)); + if (k > 0) { + strlcat (super_comment, var_comment, sizeof(super_comment)); + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("xBEACON, config file line %d, COMMENTCMD failure.\n", bp->lineno); + } + } + + +/* + * Add the info part depending on beacon type. + */ + switch (bp->btype) { + + case BEACON_POSITION: + + encode_position (bp->messaging, bp->compress, + bp->lat, bp->lon, bp->ambiguity, + (int)roundf(DW_METERS_TO_FEET(bp->alt_m)), + bp->symtab, bp->symbol, + bp->power, bp->height, bp->gain, bp->dir, + G_UNKNOWN, G_UNKNOWN, /* course, speed */ + bp->freq, bp->tone, bp->offset, + super_comment, + info, sizeof(info)); + strlcat (beacon_text, info, sizeof(beacon_text)); + break; + + case BEACON_OBJECT: + + encode_object (bp->objname, bp->compress, 0, bp->lat, bp->lon, bp->ambiguity, + bp->symtab, bp->symbol, + bp->power, bp->height, bp->gain, bp->dir, + G_UNKNOWN, G_UNKNOWN, /* course, speed */ + bp->freq, bp->tone, bp->offset, super_comment, + info, sizeof(info)); + strlcat (beacon_text, info, sizeof(beacon_text)); + break; + + case BEACON_TRACKER: + + if (gpsinfo->fix >= DWFIX_2D) { + + int coarse; /* Round to nearest integer. retaining unknown state. */ + int my_alt_ft; + + /* Transmit altitude only if user asked for it. */ + /* A positive altitude in the config file enables */ + /* transmission of altitude from GPS. */ + + my_alt_ft = G_UNKNOWN; + if (gpsinfo->fix >= 3 && gpsinfo->altitude != G_UNKNOWN && bp->alt_m > 0) { + my_alt_ft = (int)roundf(DW_METERS_TO_FEET(gpsinfo->altitude)); + } + + coarse = G_UNKNOWN; + if (gpsinfo->track != G_UNKNOWN) { + coarse = (int)roundf(gpsinfo->track); + } + + encode_position (bp->messaging, bp->compress, + gpsinfo->dlat, gpsinfo->dlon, bp->ambiguity, my_alt_ft, + bp->symtab, bp->symbol, + bp->power, bp->height, bp->gain, bp->dir, + coarse, (int)roundf(gpsinfo->speed_knots), + bp->freq, bp->tone, bp->offset, + super_comment, + info, sizeof(info)); + strlcat (beacon_text, info, sizeof(beacon_text)); + + /* Write to log file for testing. */ + /* The idea is to run log2gpx and map the result rather than */ + /* actually transmitting and relying on someone else to receive */ + /* the signals. */ + + if (g_tracker_debug_level >= 3) { + + decode_aprs_t A; + alevel_t alevel; + + memset (&A, 0, sizeof(A)); + A.g_freq = G_UNKNOWN; + A.g_offset = G_UNKNOWN; + A.g_tone = G_UNKNOWN; + A.g_dcs = G_UNKNOWN; + + strlcpy (A.g_src, mycall, sizeof(A.g_src)); + A.g_symbol_table = bp->symtab; + A.g_symbol_code = bp->symbol; + A.g_lat = gpsinfo->dlat; + A.g_lon = gpsinfo->dlon; + A.g_speed_mph = DW_KNOTS_TO_MPH(gpsinfo->speed_knots); + A.g_course = coarse; + A.g_altitude_ft = DW_METERS_TO_FEET(gpsinfo->altitude); + + /* Fake channel of 999 to distinguish from real data. */ + memset (&alevel, 0, sizeof(alevel)); + log_write (999, &A, NULL, alevel, 0); + } + } + else { + return; /* No fix. Skip this time. */ + } + break; + + case BEACON_CUSTOM: + + if (bp->custom_info != NULL) { + + /* Fixed handcrafted text. */ + + strlcat (beacon_text, bp->custom_info, sizeof(beacon_text)); + } + else if (bp->custom_infocmd != NULL) { + char info_part[AX25_MAX_INFO_LEN]; + int k; + + /* Run given command to obtain the info part for packet. */ + + k = dw_run_cmd (bp->custom_infocmd, 2, info_part, sizeof(info_part)); + if (k > 0) { + strlcat (beacon_text, info_part, sizeof(beacon_text)); + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("CBEACON, config file line %d, INFOCMD failure.\n", bp->lineno); + strlcpy (beacon_text, "", sizeof(beacon_text)); // abort! + } + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Internal error. custom_info is null. %s %d\n", __FILE__, __LINE__); + strlcpy (beacon_text, "", sizeof(beacon_text)); // abort! + } + break; + + case BEACON_IGATE: + + { + int last_minutes = 30; + char stuff[256]; + + snprintf (stuff, sizeof(stuff), "max_digi_hops,last_minutes), + mheard_count(8,last_minutes), + igate_get_upl_cnt(), + igate_get_dnl_cnt()); + + strlcat (beacon_text, stuff, sizeof(beacon_text)); + } + break; + + case BEACON_IGNORE: + default: + break; + + } /* switch beacon type. */ + +/* + * Parse monitor format into form for transmission. + */ + if (strlen(beacon_text) == 0) { + return; + } + + pp = ax25_from_text (beacon_text, strict); + + if (pp != NULL) { + + /* Send to desired destination. */ + + alevel_t alevel; + + + switch (bp->sendto_type) { + + case SENDTO_IGATE: + + text_color_set(DW_COLOR_XMIT); + dw_printf ("[ig] %s\n", beacon_text); + + igate_send_rec_packet (-1, pp); // Channel -1 to avoid RF>IS filtering. + ax25_delete (pp); + break; + + case SENDTO_XMIT: + default: + + tq_append (bp->sendto_chan, TQ_PRIO_1_LO, pp); + break; + + case SENDTO_RECV: + + /* Simulated reception from radio. */ + + memset (&alevel, 0xff, sizeof(alevel)); + dlq_rec_frame (bp->sendto_chan, 0, 0, pp, alevel, 0, 0, ""); + break; + } + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: Failed to parse packet constructed from line %d.\n", bp->lineno); + dw_printf ("%s\n", beacon_text); + } + +} /* end beacon_send */ + + +/* end beacon.c */ diff --git a/src/beacon.h b/src/beacon.h new file mode 100644 index 00000000..f7d2a561 --- /dev/null +++ b/src/beacon.h @@ -0,0 +1,6 @@ + +/* beacon.h */ + +void beacon_init (struct audio_s *pmodem, struct misc_config_s *pconfig, struct igate_config_s *pigate); + +void beacon_tracker_set_debug (int level); diff --git a/src/cdigipeater.c b/src/cdigipeater.c new file mode 100644 index 00000000..06128b20 --- /dev/null +++ b/src/cdigipeater.c @@ -0,0 +1,352 @@ +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// +// Copyright (C) 2016, 2017 John Langner, WB2OSZ +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . +// + + +/*------------------------------------------------------------------ + * + * Name: cdigipeater.c + * + * Purpose: Act as an digital repeater for connected AX.25 mode. + * Similar digipeater.c is for APRS. + * + * + * Description: Decide whether the specified packet should + * be digipeated. Put my callsign in the digipeater field used. + * + * APRS and connected mode were two split into two + * separate files. Yes, there is duplicate code but they + * are significantly different and I thought it would be + * too confusing to munge them together. + * + * References: The Ax.25 protocol barely mentions digipeaters and + * and doesn't describe how they should work. + * + *------------------------------------------------------------------*/ + +#define CDIGIPEATER_C + +#include "direwolf.h" + +#include +#include +#include +#include +#include /* for isdigit, isupper */ +#include "regex.h" +#include + +#include "ax25_pad.h" +#include "cdigipeater.h" +#include "textcolor.h" +#include "tq.h" +#include "pfilter.h" + + +static packet_t cdigipeat_match (int from_chan, packet_t pp, char *mycall_rec, char *mycall_xmit, + int has_alias, regex_t *alias, int to_chan, char *cfilter_str); + + +/* + * Keep pointer to configuration options. + * Set by cdigipeater_init and used later. + */ + + +static struct audio_s *save_audio_config_p; +static struct cdigi_config_s *save_cdigi_config_p; + + +/* + * Maintain count of packets digipeated for each combination of from/to channel. + */ + +static int cdigi_count[MAX_CHANS][MAX_CHANS]; + +int cdigipeater_get_count (int from_chan, int to_chan) { + return (cdigi_count[from_chan][to_chan]); +} + + + +/*------------------------------------------------------------------------------ + * + * Name: cdigipeater_init + * + * Purpose: Initialize with stuff from configuration file. + * + * Inputs: p_audio_config - Configuration for audio channels. + * + * p_cdigi_config - Connected Digipeater configuration details. + * + * Outputs: Save pointers to configuration for later use. + * + * Description: Called once at application startup time. + * + *------------------------------------------------------------------------------*/ + +void cdigipeater_init (struct audio_s *p_audio_config, struct cdigi_config_s *p_cdigi_config) +{ + save_audio_config_p = p_audio_config; + save_cdigi_config_p = p_cdigi_config; +} + + + + +/*------------------------------------------------------------------------------ + * + * Name: cdigipeater + * + * Purpose: Re-transmit packet if it matches the rules. + * + * Inputs: chan - Radio channel where it was received. + * + * pp - Packet object. + * + * Returns: None. + * + *------------------------------------------------------------------------------*/ + + + +void cdigipeater (int from_chan, packet_t pp) +{ + int to_chan; + + // Connected mode is allowed only for channels with internal modem. + // It probably wouldn't matter for digipeating but let's keep that rule simple and consistent. + + if ( from_chan < 0 || from_chan >= MAX_CHANS || save_audio_config_p->chan_medium[from_chan] != MEDIUM_RADIO) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("cdigipeater: Did not expect to receive on invalid channel %d.\n", from_chan); + return; + } + +/* + * First pass: Look at packets being digipeated to same channel. + * + * There was a reason for two passes for APRS. + * Might not have a benefit here. + */ + + for (to_chan=0; to_chanenabled[from_chan][to_chan]) { + if (to_chan == from_chan) { + packet_t result; + + result = cdigipeat_match (from_chan, pp, save_audio_config_p->achan[from_chan].mycall, + save_audio_config_p->achan[to_chan].mycall, + save_cdigi_config_p->has_alias[from_chan][to_chan], + &(save_cdigi_config_p->alias[from_chan][to_chan]), to_chan, + save_cdigi_config_p->cfilter_str[from_chan][to_chan]); + if (result != NULL) { + tq_append (to_chan, TQ_PRIO_0_HI, result); + cdigi_count[from_chan][to_chan]++; + } + } + } + } + + +/* + * Second pass: Look at packets being digipeated to different channel. + */ + + for (to_chan=0; to_chanenabled[from_chan][to_chan]) { + if (to_chan != from_chan) { + packet_t result; + + result = cdigipeat_match (from_chan, pp, save_audio_config_p->achan[from_chan].mycall, + save_audio_config_p->achan[to_chan].mycall, + save_cdigi_config_p->has_alias[from_chan][to_chan], + &(save_cdigi_config_p->alias[from_chan][to_chan]), to_chan, + save_cdigi_config_p->cfilter_str[from_chan][to_chan]); + if (result != NULL) { + tq_append (to_chan, TQ_PRIO_0_HI, result); + cdigi_count[from_chan][to_chan]++; + } + } + } + } + +} /* end cdigipeater */ + + + +/*------------------------------------------------------------------------------ + * + * Name: cdigipeat_match + * + * Purpose: A simple digipeater for connected mode AX.25. + * + * Input: pp - Pointer to a packet object. + * + * mycall_rec - Call of my station, with optional SSID, + * associated with the radio channel where the + * packet was received. + * + * mycall_xmit - Call of my station, with optional SSID, + * associated with the radio channel where the + * packet is to be transmitted. Could be the same as + * mycall_rec or different. + * + * has_alias - True if we have an alias. + * + * alias - Optional compiled pattern for my station aliases. + * Do NOT attempt to use this if 'has_alias' is false. + * + * to_chan - Channel number that we are transmitting to. + * + * cfilter_str - Filter expression string for the from/to channel pair or NULL. + * Note that only a subset of the APRS filters are applicable here. + * + * Returns: Packet object for transmission or NULL. + * The original packet is not modified. The caller is responsible for freeing it. + * We make a copy and return that modified copy! + * This is very important because we could digipeat from one channel to many. + * + * Description: The packet will be digipeated if the next unused digipeater + * field matches one of the following: + * + * - mycall_rec + * - alias list + * + * APRS digipeating drops duplicates within 30 seconds but we don't do that here. + * + *------------------------------------------------------------------------------*/ + + +static packet_t cdigipeat_match (int from_chan, packet_t pp, char *mycall_rec, char *mycall_xmit, + int has_alias, regex_t *alias, int to_chan, char *cfilter_str) +{ + int r; + char repeater[AX25_MAX_ADDR_LEN]; + int err; + char err_msg[100]; + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("cdigipeat_match (from_chan=%d, pp=%p, mycall_rec=%s, mycall_xmit=%s, has_alias=%d, alias=%p, to_chan=%d, cfilter_str=%s\n", + from_chan, pp, mycall_rec, mycall_xmit, has_alias, alias, to_chan, cfilter_str); +#endif + +/* + * First check if filtering has been configured. + * Note that we have three different config file filter commands: + * + * FILTER - APRS digipeating and IGate client side. + * Originally this was the only one. + * Should we change it to AFILTER to make it clearer? + * CFILTER - Similar for connected moded digipeater. + * IGFILTER - APRS-IS (IGate) server side - completely different. + * Confusing with similar name but much different idea. + * Maybe this should be renamed to SUBSCRIBE or something like that. + * + * Logically this should come later, after an address/alias match. + * But here we only have to do it once. + */ + + if (cfilter_str != NULL) { + + if (pfilter(from_chan, to_chan, cfilter_str, pp, 0) != 1) { + return(NULL); + } + } + + +/* + * Find the first repeater station which doesn't have "has been repeated" set. + * + * r = index of the address position in the frame. + */ + r = ax25_get_first_not_repeated(pp); + + if (r < AX25_REPEATER_1) { + return (NULL); // Nothing to do. + } + + ax25_get_addr_with_ssid(pp, r, repeater); + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("First unused digipeater is %s\n", repeater); +#endif + + +/* + * First check for explicit use of my call. + * Note that receive and transmit channels could have different callsigns. + */ + + if (strcmp(repeater, mycall_rec) == 0) { + packet_t result; + + result = ax25_dup (pp); + assert (result != NULL); + + /* If using multiple radio channels, they could have different calls. */ + + ax25_set_addr (result, r, mycall_xmit); + ax25_set_h (result, r); + return (result); + } + +/* + * If we have an alias match, substitute MYCALL. + */ + if (has_alias) { +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("Checking %s for alias match.\n", repeater); +#endif + err = regexec(alias,repeater,0,NULL,0); + if (err == 0) { + packet_t result; + + result = ax25_dup (pp); + assert (result != NULL); + + ax25_set_addr (result, r, mycall_xmit); + ax25_set_h (result, r); + return (result); + } + else if (err != REG_NOMATCH) { + regerror(err, alias, err_msg, sizeof(err_msg)); + text_color_set (DW_COLOR_ERROR); + dw_printf ("%s\n", err_msg); + } + } + else { +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("No alias was specified.\n"); +#endif + } + +/* + * Don't repeat it if we get here. + */ + return (NULL); + +} /* end cdigipeat_match */ + + + +/* end cdigipeater.c */ diff --git a/src/cdigipeater.h b/src/cdigipeater.h new file mode 100644 index 00000000..69a4b8c7 --- /dev/null +++ b/src/cdigipeater.h @@ -0,0 +1,62 @@ + + +#ifndef CDIGIPEATER_H +#define CDIGIPEATER_H 1 + +#include "regex.h" + +#include "direwolf.h" /* for MAX_CHANS */ +#include "ax25_pad.h" /* for packet_t */ +#include "audio.h" /* for radio channel properties */ + + +/* + * Information required for Connected mode digipeating. + * + * The configuration file reader fills in this information + * and it is passed to cdigipeater_init at application start up time. + */ + + +struct cdigi_config_s { + +/* + * Rules for each of the [from_chan][to_chan] combinations. + */ + int enabled[MAX_CHANS][MAX_CHANS]; // Is it enabled for from/to pair? + + int has_alias[MAX_CHANS][MAX_CHANS]; // If there was no alias in the config file, + // the structure below will not be set up + // properly and an attempt to use it could + // result in a crash. (fixed v1.5) + // Not needed for [APRS] DIGIPEAT because + // the alias is mandatory there. + regex_t alias[MAX_CHANS][MAX_CHANS]; + + char *cfilter_str[MAX_CHANS][MAX_CHANS]; + // NULL or optional Packet Filter strings such as "t/m". +}; + +/* + * Call once at application start up time. + */ + +extern void cdigipeater_init (struct audio_s *p_audio_config, struct cdigi_config_s *p_cdigi_config); + +/* + * Call this for each packet received. + * Suitable packets will be queued for transmission. + */ + +extern void cdigipeater (int from_chan, packet_t pp); + + +/* Make statistics available. */ + +int cdigipeater_get_count (int from_chan, int to_chan); + + +#endif + +/* end cdigipeater.h */ + diff --git a/src/cm108.c b/src/cm108.c new file mode 100644 index 00000000..ff3ff792 --- /dev/null +++ b/src/cm108.c @@ -0,0 +1,1080 @@ +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// +// Copyright (C) 2017,2019,2021 John Langner, WB2OSZ +// +// Parts of this were adapted from "hamlib" which contains the notice: +// +// * Copyright (c) 2000-2012 by Stephane Fillod +// * Copyright (c) 2011 by Andrew Errington +// * CM108 detection code Copyright (c) Thomas Sailer used with permission +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . + +/*------------------------------------------------------------------ + * + * Module: cm108.c + * + * Purpose: Use the CM108/CM119 (or compatible) GPIO pins for the Push To Talk (PTT) Control. + * + * Description: + * + * There is an increasing demand for using the GPIO pins of USB audio devices for PTT. + * We have a few commercial products: + * + * DINAH https://hamprojects.info/dinah/ + * PAUL https://hamprojects.info/paul/ + * DMK URI http://www.dmkeng.com/URI_Order_Page.htm + * RB-USB RIM http://www.repeater-builder.com/products/usb-rim-lite.html + * RA-35 http://www.masterscommunications.com/products/radio-adapter/ra35.html + * + * and homebrew projects which are all very similar. + * + * http://www.qsl.net/kb9mwr/projects/voip/usbfob-119.pdf + * http://rtpdir.weebly.com/uploads/1/6/8/7/1687703/usbfob.pdf + * http://www.repeater-builder.com/projects/fob/USB-Fob-Construction.pdf + * https://irongarment.wordpress.com/2011/03/29/cm108-compatible-chips-with-gpio/ + * + * Homebrew plans all use GPIO 3 because it is easier to tack solder a wire to a pin on the end. + * All of the products, that I have seen, also use the same pin so this is the default. + * + * Soundmodem and hamlib paved the way but didn't get too far. + * Dire Wolf 1.3 added HAMLIB support (Linux only) which theoretically allows this in a + * painful roundabout way. This is documented in the User Guide, section called, + * "Hamlib PTT Example 2: Use GPIO of USB audio adapter. (e.g. DMK URI)" + * + * It's rather involved and the explanation doesn't cover the case of multiple + * USB-Audio adapters. It is not as straightforward as you might expect. Here we have + * an example of 3 C-Media USB adapters, a SignaLink USB, a keyboard, and a mouse. + * + * + * VID PID Product Sound ADEVICE HID [ptt] + * --- --- ------- ----- ------- --------- + * ** 0d8c 000c C-Media USB Headphone Set /dev/snd/pcmC1D0c plughw:1,0 /dev/hidraw0 + * ** 0d8c 000c C-Media USB Headphone Set /dev/snd/pcmC1D0p plughw:1,0 /dev/hidraw0 + * ** 0d8c 000c C-Media USB Headphone Set /dev/snd/controlC1 /dev/hidraw0 + * 08bb 2904 USB Audio CODEC /dev/snd/pcmC2D0c plughw:2,0 /dev/hidraw2 + * 08bb 2904 USB Audio CODEC /dev/snd/pcmC2D0p plughw:2,0 /dev/hidraw2 + * 08bb 2904 USB Audio CODEC /dev/snd/controlC2 /dev/hidraw2 + * ** 0d8c 000c C-Media USB Headphone Set /dev/snd/pcmC0D0c plughw:0,0 /dev/hidraw1 + * ** 0d8c 000c C-Media USB Headphone Set /dev/snd/pcmC0D0p plughw:0,0 /dev/hidraw1 + * ** 0d8c 000c C-Media USB Headphone Set /dev/snd/controlC0 /dev/hidraw1 + * ** 0d8c 0008 C-Media USB Audio Device /dev/snd/pcmC4D0c plughw:4,0 /dev/hidraw6 + * ** 0d8c 0008 C-Media USB Audio Device /dev/snd/pcmC4D0p plughw:4,0 /dev/hidraw6 + * ** 0d8c 0008 C-Media USB Audio Device /dev/snd/controlC4 /dev/hidraw6 + * 413c 2010 Dell USB Keyboard /dev/hidraw4 + * 0461 4d15 USB Optical Mouse /dev/hidraw5 + * + * + * The USB soundcards (/dev/snd/pcm...) have an associated Human Interface Device (HID) + * corresponding to the GPIO pins which are sometimes connected to pushbuttons. + * The mapping has no obvious pattern. + * + * Sound Card 0 HID 1 + * Sound Card 1 HID 0 + * Sound Card 2 HID 2 + * Sound Card 4 HID 6 + * + * That would be a real challenge if you had to figure that all out and configure manually. + * Dire Wolf version 1.5 makes this much more flexible and easier to use by supporting multiple + * sound devices and automatically determining the corresponding HID for the PTT signal. + * + * In version 1.7, we add a half-backed solution for Windows. It's fine for situations + * with a single USB Audio Adapter, but does not automatically handle the multiple device case. + * Manual configuration needs to be used in this case. + * + * Here is something new and interesting. The All in One cable (AIOC). + * https://github.com/skuep/AIOC/tree/master + * + * A microcontroller is used to emulate a CM108-compatible soundcard + * and a serial port. It fits right on the side of a Bao Feng or similar. + * + *---------------------------------------------------------------*/ + +#include "direwolf.h" + +#ifndef USE_CM108 + +#ifdef CM108_MAIN + + +#include "textcolor.h" + +int main (void) +{ + text_color_init (0); // Turn off text color. +#if defined(__OpenBSD__) || defined(__FreeBSD__) + dw_printf ("CM108 PTT support is not available for this operating system.\n"); +#else + dw_printf ("CM108 PTT support was excluded because /usr/include/libudev.h was missing.\n"); + dw_printf ("Install it with \"sudo apt-get install libudev-dev\" or\n"); + dw_printf ("\"sudo yum install libudev-devel\" then rebuild.\n"); +#endif + return (0); +} + +#endif + +#else // USE_CM108 is defined + +#include +#include +#include +#include +#include +#include + +#if __WIN32__ +#include +#include "hidapi.h" +#else +#include +#include +#include +#include // ioctl, _IOR +#include +#include +#include // for HIDIOCGRAWINFO +#endif + +#include "textcolor.h" +#include "cm108.h" + +static int cm108_write (char *name, int iomask, int iodata); + + +// The CM108, CM109, and CM119 datasheets all say that idProduct can be in the range +// of 0008 to 000f programmable by MSEL and MODE pin. How can we tell the difference? + +// CM108B is 0012. +// CM119B is 0013. +// CM108AH is 0139 programmable by MSEL and MODE pin. +// CM119A is 013A programmable by MSEL and MODE pin. + +// To make matters even more confusing, these can be overridden +// with an external EEPROM. Some have 8, rather than 4 GPIO. + +#define CMEDIA_VID 0xd8c // Vendor ID +#define CMEDIA_PID1_MIN 0x0008 // range for CM108, CM109, CM119 (no following letters) +#define CMEDIA_PID1_MAX 0x000f + +#define CMEDIA_PID_CM108AH 0x0139 // CM108AH +#define CMEDIA_PID_CM108AH_alt 0x013c // CM108AH? - see issue 210 +#define CMEDIA_PID_CM108B 0x0012 // CM108B +#define CMEDIA_PID_CM119A 0x013a // CM119A +#define CMEDIA_PID_CM119B 0x0013 // CM119B +#define CMEDIA_PID_HS100 0x013c // HS100 + +// The SSS chips seem to be pretty much compatible but they have only two GPIO. +// https://irongarment.wordpress.com/2011/03/29/cm108-compatible-chips-with-gpio/ +// Data sheet says VID/PID is from an EEPROM but mentions no default. + +#define SSS_VID 0x0c76 // SSS1621, SSS1623 +#define SSS_PID1 0x1605 +#define SSS_PID2 0x1607 +#define SSS_PID3 0x160b + +// https://github.com/skuep/AIOC/blob/master/stm32/aioc-fw/Src/usb_descriptors.h + +#define AIOC_VID 0x1209 +#define AIOC_PID 0x7388 + + +// Device VID PID Number of GPIO +// ------ --- --- -------------- +// CM108 0d8c 0008-000f * 4 +// CM108AH 0d8c 0139 * 3 Has GPIO 1,3,4 but not 2 +// CM108B 0d8c 0012 3 Has GPIO 1,3,4 but not 2 +// CM109 0d8c 0008-000f * 8 +// CM119 0d8c 0008-000f * 8 +// CM119A 0d8c 013a * 8 +// CM119B 0d8c 0013 8 +// HS100 0d8c 013c 0 (issue 210 reported 013c +// being seen for CM108AH) +// +// SSS1621 0c76 1605 2 per ZL3AME, Can't find data sheet +// SSS1623 0c76 1607,160b 2 per ZL3AME, Not in data sheet. +// +// * idProduct programmable by MSEL and MODE pin. +// + +// CMedia pin GPIO Notes +// ---------- ---- ----- +// 43 1 +// 11 2 N.C. for CM108AH, CM108B +// 13 3 Most popular for PTT because it is on the end. +// 15 4 +// 16 5 CM109, CM119, CM119A, CM119B only +// 17 6 " +// 20 7 " +// 22 8 " + +// Test for supported devices. + +#define GOOD_DEVICE(v,p) ( (v == CMEDIA_VID && ((p >= CMEDIA_PID1_MIN && p <= CMEDIA_PID1_MAX) \ + || p == CMEDIA_PID_CM108AH \ + || p == CMEDIA_PID_CM108AH_alt \ + || p == CMEDIA_PID_CM108B \ + || p == CMEDIA_PID_CM119A \ + || p == CMEDIA_PID_CM119B )) \ + || \ + (v == SSS_VID && (p == SSS_PID1 || p == SSS_PID2 || p == SSS_PID3)) \ + || \ + (v == AIOC_VID && p == AIOC_PID) ) + +// Look out for null source pointer, and avoid buffer overflow on destination. + +#define SAFE_STRCPY(to,from) { if (from != NULL) { strncpy(to,from,sizeof(to)); to[sizeof(to)-1] = '\0'; } } + + +// Used to process regular expression matching results. + +#ifndef __WIN32__ + +static void substr_se (char *dest, const char *src, int start, int endp1) +{ + int len = endp1 - start; + + if (start < 0 || endp1 < 0 || len <= 0) { + dest[0] = '\0'; + return; + } + memcpy (dest, src + start, len); + dest[len] = '\0'; + +} /* end substr_se */ + +#endif + +// Maximum length of name for PTT HID. +// For Linux, this was originally 17 to handle names like /dev/hidraw3. +// Windows has more complicated names. The longest I saw was 95 but longer have been reported. + +#define MAXX_HIDRAW_NAME_LEN 128 + +/* + * Result of taking inventory of USB soundcards and USB HIDs. + */ + +struct thing_s { + int vid; // vendor id, displayed as four hexadecimal digits. + int pid; // product id, displayed as four hexadecimal digits. + char card_number[8]; // "Card" Number. e.g. 2 for plughw:2,0 + char card_name[32]; // Audio Card Name, assigned by system (e.g. Device_1) or by udev rule. + char product[32]; // product name (e.g. manufacturer, model) + char devnode_sound[22]; // e.g. /dev/snd/pcmC0D0p + char plughw[72]; // Above in more familiar format e.g. plughw:0,0 + // Oversized to silence a compiler warning. + char plughw2[72]; // With name rather than number. + char devpath[128]; // Kernel dev path. Does not include /sys mount point. + char devnode_hidraw[MAXX_HIDRAW_NAME_LEN]; + // e.g. /dev/hidraw3 - for Linux - was length 17 + // The Windows path for a HID looks like this, lengths up to 95 seen. + // \\?\hid#vid_0d8c&pid_000c&mi_03#8&164d11c9&0&0000#{4d1e55b2-f16f-11cf-88cb-001111000030} + char devnode_usb[25]; // e.g. /dev/bus/usb/001/012 + // This is what we use to match up audio and HID. +}; + +int cm108_inventory (struct thing_s *things, int max_things); + + +/*------------------------------------------------------------------- + * + * Name: main + * + * Purpose: Useful utility to list USB audio and HID devices. + * + * Optional command line arguments: + * + * HID path + * GPIO number (default 3) + * + * When specified the pin will be set high and low until interrupted. + * + *------------------------------------------------------------------*/ + +//#define EXTRA 1 + +#define MAXX_THINGS 60 + +#ifdef CM108_MAIN + +static void usage(void) +{ + text_color_set(DW_COLOR_ERROR); + dw_printf ("\n"); + dw_printf ("Usage: cm108 [ device-path [ gpio-num ] ]\n"); + dw_printf ("\n"); + dw_printf ("With no command line arguments, this will produce a list of\n"); +#if __WIN32__ + dw_printf ("Human Interface Devices (HID) and indicate which ones can be\n"); + dw_printf ("used for GPIO PTT.\n"); +#else + dw_printf ("Audio devices and Human Interface Devices (HID) and indicate\n"); + dw_printf ("which ones can be used for GPIO PTT.\n"); +#endif + dw_printf ("\n"); + dw_printf ("Specify the HID device path to test the PTT function.\n"); + dw_printf ("Its state should change once per second.\n"); +#if __WIN32__ + dw_printf ("You might need to quote the path depending on the command processor.\n"); +#endif + dw_printf ("GPIO 3 is the default. A different number can be optionally specified.\n"); + exit (EXIT_FAILURE); +} + +int main (int argc, char **argv) +{ + struct thing_s things[MAXX_THINGS]; + int num_things; + int i; + + text_color_init (0); // Turn off text color. + text_color_set(DW_COLOR_INFO); + + if (argc >=2) { + char path[128]; + strlcpy(path, argv[1], sizeof(path)); + int gpio = 3; + if (argc >= 3) { + gpio = atoi(argv[2]); + } + if (gpio < 1 || gpio > 8) { + dw_printf ("GPIO number must be in range of 1 - 8.\n"); + usage(); + exit (EXIT_FAILURE); + } + int state = 0; + while (1) { + dw_printf ("%d", state); + fflush (stdout); + int err = cm108_set_gpio_pin (path, gpio, state); + if (err != 0) { + dw_printf ("\nWRITE ERROR for USB Audio Adapter GPIO!\n"); + usage(); + exit (EXIT_FAILURE); + } + SLEEP_SEC(1); + state = ! state; + } + } + + +// Take inventory of USB Audio adapters and other HID devices. + + num_things = cm108_inventory (things, MAXX_THINGS); + +#if __WIN32__ + +///////////////////////////////////////////////////// +// Windows - Remove the sound related columns for now. +///////////////////////////////////////////////////// + + dw_printf (" VID PID %-*s %-*s" + "\n", (int)sizeof(things[0].product), "Product", + 17, "HID [ptt]" + ); + + dw_printf (" --- --- %-*s %-*s" + + "\n", (int)sizeof(things[0].product), "-------", + 17, "---------" + ); + for (i = 0; i < num_things; i++) { + + dw_printf ("%2s %04x %04x %-*s %s" + + "\n", + GOOD_DEVICE(things[i].vid,things[i].pid) ? "**" : " ", + things[i].vid, things[i].pid, + (int)sizeof(things[i].product), things[i].product, + things[i].devnode_hidraw + ); + } + dw_printf ("\n"); + dw_printf ("** = Can use Audio Adapter GPIO for PTT.\n"); + dw_printf ("\n"); + + // T.B.D. - additional text ??? + +#else + +///////////////////////////////////////////// +// Linux +///////////////////////////////////////////// + + + dw_printf (" VID PID %-*s %-*s %-*s %-*s %-*s" +#if EXTRA + " %-*s" +#endif + "\n", (int)sizeof(things[0].product), "Product", + (int)sizeof(things[0].devnode_sound), "Sound", + (int)sizeof(things[0].plughw)/5, "ADEVICE", + (int)sizeof(things[0].plughw2)/4, "ADEVICE", + 17, "HID [ptt]" +#if EXTRA + , (int)sizeof(things[0].devnode_usb), "USB" +#endif + ); + + dw_printf (" --- --- %-*s %-*s %-*s %-*s %-*s" +#if EXTRA + " %-*s" +#endif + "\n", (int)sizeof(things[0].product), "-------", + (int)sizeof(things[0].devnode_sound), "-----", + (int)sizeof(things[0].plughw)/5, "-------", + (int)sizeof(things[0].plughw2)/4, "-------", + 17, "---------" +#if EXTRA + , (int)sizeof(things[0].devnode_usb), "---" +#endif + ); + for (i = 0; i < num_things; i++) { + + dw_printf ("%2s %04x %04x %-*s %-*s %-*s %-*s %s" +#if EXTRA + " %-*s" +#endif + "\n", + GOOD_DEVICE(things[i].vid,things[i].pid) ? "**" : " ", + things[i].vid, things[i].pid, + (int)sizeof(things[i].product), things[i].product, + (int)sizeof(things[i].devnode_sound), things[i].devnode_sound, + (int)sizeof(things[0].plughw)/5, things[i].plughw, + (int)sizeof(things[0].plughw2)/4, things[i].plughw2, + things[i].devnode_hidraw +#if EXTRA + , (int)sizeof(things[i].devnode_usb), things[i].devnode_usb +#endif + ); + //dw_printf (" %-*s\n", (int)sizeof(things[i].devpath), things[i].devpath); + } + dw_printf ("\n"); + dw_printf ("** = Can use Audio Adapter GPIO for PTT.\n"); + dw_printf ("\n"); + + static const char *suggested_names[] = {"Fred", "Wilma", "Pebbles", "Dino", "Barney", "Betty", "Bamm_Bamm", "Chip", "Roxy" }; + int iname = 0; + + // From example in https://alsa.opensrc.org/Udev + + dw_printf ("Notice that each USB Audio adapter is assigned a number and a name. These are not predictable so you could\n"); + dw_printf ("end up using the wrong adapter after adding or removing other USB devices or after rebooting. You can assign a\n"); + dw_printf ("name to each USB adapter so you can refer to the same one each time. This can be based on any characteristics\n"); + dw_printf ("that makes them unique such as product id or serial number. Unfortunately these devices don't have unique serial\n"); + dw_printf ("numbers so how can we tell them apart? A name can also be assigned based on the physical USB socket.\n"); + dw_printf ("Create a file like \"/etc/udev/rules.d/85-my-usb-audio.rules\" with the following contents and then reboot.\n"); + dw_printf ("\n"); + dw_printf ("SUBSYSTEM!=\"sound\", GOTO=\"my_usb_audio_end\"\n"); + dw_printf ("ACTION!=\"add\", GOTO=\"my_usb_audio_end\"\n"); + +// Consider only the 'devnode' paths that end with "card" and a number. +// Replace the number with a question mark. + + regex_t devpath_re; + char emsg[100]; + // Drop any "/sys" at the beginning. + int e = regcomp (&devpath_re, "(/devices/.+/card)[0-9]$", REG_EXTENDED); + if (e) { + regerror (e, &devpath_re, emsg, sizeof(emsg)); + text_color_set(DW_COLOR_ERROR); + dw_printf("INTERNAL ERROR: %s:%d: %s\n", __FILE__, __LINE__, emsg); + return (-1); + } + + for (i = 0; i < num_things; i++) { + if (i == 0 || strcmp(things[i].devpath,things[i-1].devpath) != 0) { + regmatch_t devpath_match[2]; + if (regexec (&devpath_re, things[i].devpath, 2, devpath_match, 0) == 0) { + char without_number[256]; + substr_se (without_number, things[i].devpath, devpath_match[1].rm_so, devpath_match[1].rm_eo); + dw_printf ("DEVPATH==\"%s?\", ATTR{id}=\"%s\"\n", without_number, suggested_names[iname]); + if (iname < 6) iname++; + } + } + } + dw_printf ("LABEL=\"my_usb_audio_end\"\n"); + dw_printf ("\n"); +#endif + return (0); +} + +#endif // CM108_MAIN + + + +/*------------------------------------------------------------------- + * + * Name: cm108_inventory + * + * Purpose: Take inventory of USB audio and HID. + * + * Inputs: max_things - Maximum number of items to collect. + * + * Outputs: things - Array of items collected. + * Corresponding sound device and HID are merged into one item. + * + * Returns: Number of items placed in things array. + * Should be in the range of 0 thru max_things. + * -1 for a bad unexpected error. + * + *------------------------------------------------------------------*/ + + +int cm108_inventory (struct thing_s *things, int max_things) +{ + int num_things = 0; + memset (things, 0, sizeof(struct thing_s) * max_things); + +#if __WIN32__ + + struct hid_device_info *devs, *cur_dev; + + if (hid_init()) { + text_color_set(DW_COLOR_ERROR); + dw_printf("cm108_inventory: hid_init() failed.\n"); + return (-1); + } + + devs = hid_enumerate(0x0, 0x0); + cur_dev = devs; + while (cur_dev) { +#if 0 + printf("Device Found\n type: %04hx %04hx\n path: %s\n serial_number: %ls", cur_dev->vendor_id, cur_dev->product_id, cur_dev->path, cur_dev->serial_number); + printf("\n"); + printf(" Manufacturer: %ls\n", cur_dev->manufacturer_string); + printf(" Product: %ls\n", cur_dev->product_string); + printf(" Release: %hx\n", cur_dev->release_number); + printf(" Interface: %d\n", cur_dev->interface_number); + printf(" Usage (page): 0x%hx (0x%hx)\n", cur_dev->usage, cur_dev->usage_page); + printf("\n"); +#endif + if (num_things < max_things && cur_dev->vendor_id != 0x051d) { // FIXME - remove exception + things[num_things].vid = cur_dev->vendor_id; + things[num_things].pid = cur_dev->product_id; + wcstombs (things[num_things].product, cur_dev->product_string, sizeof(things[num_things].product)); + things[num_things].product[sizeof(things[num_things].product) - 1] = '\0'; + strlcpy (things[num_things].devnode_hidraw, cur_dev->path, sizeof(things[num_things].devnode_hidraw)); + + num_things++; + } + cur_dev = cur_dev->next; + } + hid_free_enumeration(devs); + +#else // Linux, with udev + + struct udev *udev; + struct udev_enumerate *enumerate; + struct udev_list_entry *devices, *dev_list_entry; + struct udev_device *dev; + struct udev_device *parentdev; + + char const *pattrs_id = NULL; + char const *pattrs_number = NULL; + char card_devpath[128] = ""; + + +/* + * First get a list of the USB audio devices. + * This is based on the example in http://www.signal11.us/oss/udev/ + */ + udev = udev_new(); + if (!udev) { + text_color_set(DW_COLOR_ERROR); + dw_printf("INTERNAL ERROR: Can't create udev.\n"); + return (-1); + } + + enumerate = udev_enumerate_new(udev); + udev_enumerate_add_match_subsystem(enumerate, "sound"); + udev_enumerate_scan_devices(enumerate); + devices = udev_enumerate_get_list_entry(enumerate); + udev_list_entry_foreach(dev_list_entry, devices) { + const char *path = udev_list_entry_get_name(dev_list_entry); + dev = udev_device_new_from_syspath(udev, path); + char const *devnode = udev_device_get_devnode(dev); + + if (devnode == NULL ) { + // I'm not happy with this but couldn't figure out how + // to get attributes from one level up from the pcmC?D?? node. + strlcpy (card_devpath, path, sizeof(card_devpath)); + pattrs_id = udev_device_get_sysattr_value(dev,"id"); + pattrs_number = udev_device_get_sysattr_value(dev,"number"); + //dw_printf (" >card_devpath = %s\n", card_devpath); + //dw_printf (" >>pattrs_id = %s\n", pattrs_id); + //dw_printf (" >>pattrs_number = %s\n", pattrs_number); + } + else { + parentdev = udev_device_get_parent_with_subsystem_devtype( dev, "usb", "usb_device"); + if (parentdev != NULL) { + char const *p; + int vid = 0; + int pid = 0; + + p = udev_device_get_sysattr_value(parentdev,"idVendor"); + if (p != NULL) vid = strtol(p, NULL, 16); + p = udev_device_get_sysattr_value(parentdev,"idProduct"); + if (p != NULL) pid = strtol(p, NULL, 16); + + if (num_things < max_things) { + things[num_things].vid = vid; + things[num_things].pid = pid; + SAFE_STRCPY (things[num_things].card_name, pattrs_id); + SAFE_STRCPY (things[num_things].card_number, pattrs_number); + SAFE_STRCPY (things[num_things].product, udev_device_get_sysattr_value(parentdev,"product")); + SAFE_STRCPY (things[num_things].devnode_sound, devnode); + SAFE_STRCPY (things[num_things].devnode_usb, udev_device_get_devnode(parentdev)); + strlcpy (things[num_things].devpath, card_devpath, sizeof(things[num_things].devpath)); + num_things++; + } + udev_device_unref(parentdev); + } + } + } + udev_enumerate_unref(enumerate); + udev_unref(udev); + +/* + * Now merge in all of the USB HID. + */ + udev = udev_new(); + if (!udev) { + text_color_set(DW_COLOR_ERROR); + dw_printf("INTERNAL ERROR: Can't create udev.\n"); + return (-1); + } + + enumerate = udev_enumerate_new(udev); + udev_enumerate_add_match_subsystem(enumerate, "hidraw"); + udev_enumerate_scan_devices(enumerate); + devices = udev_enumerate_get_list_entry(enumerate); + udev_list_entry_foreach(dev_list_entry, devices) { + const char *path = udev_list_entry_get_name(dev_list_entry); + dev = udev_device_new_from_syspath(udev, path); + char const *devnode = udev_device_get_devnode(dev); + if (devnode != NULL) { + parentdev = udev_device_get_parent_with_subsystem_devtype( dev, "usb", "usb_device"); + if (parentdev != NULL) { + char const *p; + int vid = 0; + int pid = 0; + + p = udev_device_get_sysattr_value(parentdev,"idVendor"); + if (p != NULL) vid = strtol(p, NULL, 16); + p = udev_device_get_sysattr_value(parentdev,"idProduct"); + if (p != NULL) pid = strtol(p, NULL, 16); + + int j, matched = 0; + char const *usb = udev_device_get_devnode(parentdev); + + // Add hidraw name to any matching existing. + for (j = 0; j < num_things; j++) { + if (things[j].vid == vid && things[j].pid == pid && usb != NULL && strcmp(things[j].devnode_usb,usb) == 0) { + matched = 1; + SAFE_STRCPY (things[j].devnode_hidraw, devnode); + } + } + + // If it did not match to existing, add new entry. + if (matched == 0 && num_things < max_things) { + things[num_things].vid = vid; + things[num_things].pid = pid; + SAFE_STRCPY (things[num_things].product, udev_device_get_sysattr_value(parentdev,"product")); + SAFE_STRCPY (things[num_things].devnode_hidraw, devnode); + SAFE_STRCPY (things[num_things].devnode_usb, usb); + SAFE_STRCPY (things[num_things].devpath, udev_device_get_devpath(dev)); + num_things++; + } + udev_device_unref(parentdev); + } + } + } + udev_enumerate_unref(enumerate); + udev_unref(udev); + +/* + * Seeing the form /dev/snd/pcmC4D0p will be confusing to many because we + * would generally something like plughw:4,0 for in the direwolf configuration file. + * Construct the more familiar form. + * Previously we only used the numeric form. In version 1.6, the name is listed as well + * and we describe how to assign names based on the physical USB socket for repeatability. + */ + int i; + regex_t pcm_re; + char emsg[100]; + int e = regcomp (&pcm_re, "pcmC([0-9]+)D([0-9]+)[cp]", REG_EXTENDED); + if (e) { + regerror (e, &pcm_re, emsg, sizeof(emsg)); + text_color_set(DW_COLOR_ERROR); + dw_printf("INTERNAL ERROR: %s:%d: %s\n", __FILE__, __LINE__, emsg); + return (-1); + } + + for (i = 0; i < num_things; i++) { + regmatch_t match[3]; + + if (regexec (&pcm_re, things[i].devnode_sound, 3, match, 0) == 0) { + char c[32], d[32]; + substr_se (c, things[i].devnode_sound, match[1].rm_so, match[1].rm_eo); + substr_se (d, things[i].devnode_sound, match[2].rm_so, match[2].rm_eo); + snprintf (things[i].plughw, sizeof(things[i].plughw), "plughw:%s,%s", c, d); + snprintf (things[i].plughw2, sizeof(things[i].plughw), "plughw:%s,%s", things[i].card_name, d); + } + } + +#endif // end Linux + + return (num_things); + +} /* end cm108_inventory */ + + +/*------------------------------------------------------------------- + * + * Name: cm108_find_ptt + * + * Purpose: Try to find /dev/hidraw corresponding to a USB audio "card." + * + * Inputs: output_audio_device + * - Used in the ADEVICE configuration. + * This can take many forms such as: + * surround41:CARD=Fred,DEV=0 + * surround41:Fred,0 + * surround41:Fred + * plughw:2,3 + * In our case we just need to extract the card number or name. + * + * ptt_device_size - Size of result area to avoid buffer overflow. + * + * Outputs: ptt_device - Device name, something like /dev/hidraw2. + * Will be empty string if no match found. + * + * Returns: none + * + *------------------------------------------------------------------*/ + +void cm108_find_ptt (char *output_audio_device, char *ptt_device, int ptt_device_size) +{ + struct thing_s things[MAXX_THINGS]; + int num_things; + + //dw_printf ("DEBUG: cm108_find_ptt('%s')\n", output_audio_device); + + strlcpy (ptt_device, "", ptt_device_size); + + // Possible improvement: Skip if inventory already taken. + num_things = cm108_inventory (things, MAXX_THINGS); + +#if __WIN32__ + // FIXME - This is just a half baked implementation. + // I have not been able to figure out how to find the connection + // between the audio device and HID in the same package. + // This is fine for a single USB Audio Adapter, good enough for most people. + // Those with multiple devices will need to manually configure PTT device path. + + // Count how many good devices we have. + + int good_devices = 0; + + for (int i = 0; i < num_things; i++) { + if (GOOD_DEVICE(things[i].vid,things[i].pid) ) { + good_devices++; + //dw_printf ("DEBUG: success! returning '%s'\n", things[i].devnode_hidraw); + strlcpy (ptt_device, things[i].devnode_hidraw, ptt_device_size); + } + } + + if (good_devices == 0) return; // None found - caller will print a message. + + if (good_devices == 1) return; // Success - Only one candidate device. + + text_color_set(DW_COLOR_ERROR); + dw_printf ("There are multiple USB Audio Devices with GPIO capability.\n"); + dw_printf ("Explicitly specify one of them for more predictable results:\n"); + for (int i = 0; i < num_things; i++) { + if (GOOD_DEVICE(things[i].vid,things[i].pid) ) { + dw_printf (" \"%s\"\n", things[i].devnode_hidraw); + } + } + dw_printf ("Run the \"cm108\" utility for more details.\n"); + text_color_set(DW_COLOR_INFO); +#else + regex_t sound_re; + char emsg[100]; + int e = regcomp (&sound_re, ".+:(CARD=)?([A-Za-z0-9_]+)(,.*)?", REG_EXTENDED); + if (e) { + regerror (e, &sound_re, emsg, sizeof(emsg)); + text_color_set(DW_COLOR_ERROR); + dw_printf("INTERNAL ERROR: %s:%d: %s\n", __FILE__, __LINE__, emsg); + return; + } + + char num_or_name[64]; + strcpy (num_or_name, ""); + regmatch_t sound_match[4]; + if (regexec (&sound_re, output_audio_device, 4, sound_match, 0) == 0) { + substr_se (num_or_name, output_audio_device, sound_match[2].rm_so, sound_match[2].rm_eo); + //dw_printf ("DEBUG: Got '%s' from '%s'\n", num_or_name, output_audio_device); + } + if (strlen(num_or_name) == 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Could not extract card number or name from %s\n", output_audio_device); + dw_printf ("Can't automatically find matching HID for PTT.\n"); + return; + } + + for (int i = 0; i < num_things; i++) { + //dw_printf ("DEBUG: i=%d, card_name='%s', card_number='%s'\n", i, things[i].card_name, things[i].card_number); + if (strcmp(num_or_name,things[i].card_name) == 0 || strcmp(num_or_name,things[i].card_number) == 0) { + //dw_printf ("DEBUG: success! returning '%s'\n", things[i].devnode_hidraw); + strlcpy (ptt_device, things[i].devnode_hidraw, ptt_device_size); + if ( ! GOOD_DEVICE(things[i].vid,things[i].pid) ) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Warning: USB audio card %s (%s) is not a device known to work with GPIO PTT.\n", + things[i].card_number, things[i].card_name); + } + return; + } + } +#endif + +} /* end cm108_find_ptt */ + + + +/*------------------------------------------------------------------- + * + * Name: cm108_set_gpio_pin + * + * Purpose: Set one GPIO pin of the CM108 or similar. + * + * Inputs: name - Name of device such as /dev/hidraw2 or + * \\?\hid#vid_0d8c&pid_0008&mi_03#8&39d3555&0&0000#{4d1e55b2-f16f-11cf-88cb-001111000030} + * + * num - GPIO number, range 1 thru 8. + * + * state - 1 for on, 0 for off. + * + * Returns: 0 for success. -1 for error. + * + * Errors: A descriptive error message will be printed for any problem. + * + * Shortcut: For our initial implementation we are making the simplifying + * restriction of using only one GPIO pin per device and limit + * configuration to PTT only. + * Longer term, we might want to have DCD, and maybe other + * controls thru the same chip. + * In this case, we would need to retain bit masks for each + * device so new data can be merged with old before sending it out. + * + *------------------------------------------------------------------*/ + + +int cm108_set_gpio_pin (char *name, int num, int state) +{ + int iomask; + int iodata; + + if (num < 1 || num > 8) { + text_color_set(DW_COLOR_ERROR); + dw_printf("%s CM108 GPIO number %d must be in range of 1 thru 8.\n", name, num); + return (-1); + } + + if (state != 0 && state != 1) { + text_color_set(DW_COLOR_ERROR); + dw_printf("%s CM108 GPIO state %d must be 0 or 1.\n", name, state); + return (-1); + } + + iomask = 1 << (num - 1); // 0=input, 1=output + iodata = state << (num - 1); // 0=low, 1=high + return (cm108_write (name, iomask, iodata)); + +} /* end cm108_set_gpio_pin */ + + +/*------------------------------------------------------------------- + * + * Name: cm108_write + * + * Purpose: Set the GPIO pins of the CM108 or similar. + * + * Inputs: name - Name of device such as /dev/hidraw2. + * + * iomask - Bit mask for I/O direction. + * LSB is GPIO1, bit 1 is GPIO2, etc. + * 1 for output, 0 for input. + * + * iodata - Output data, same bit order as iomask. + * + * Returns: 0 for success. -1 for error. + * + * Errors: A descriptive error message will be printed for any problem. + * + * Description: This is the lowest level function. + * An application probably wants to use cm108_set_gpio_pin. + * + *------------------------------------------------------------------*/ + +static int cm108_write (char *name, int iomask, int iodata) +{ + +#if __WIN32__ + + //text_color_set(DW_COLOR_DEBUG); + //dw_printf ("TEMP DEBUG cm108_write: %s %d %d\n", name, iomask, iodata); + + hid_device *handle = hid_open_path(name); + if (handle == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Could not open %s for write\n", name); + return (-1); + } + + unsigned char io[5]; + io[0] = 0; + io[1] = 0; + io[2] = iodata; + io[3] = iomask; + io[4] = 0; + + int res = hid_write(handle, io, sizeof(io)); + if (res < 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Write failed to %s\n", name); + return (-1); + } + + hid_close(handle); + +#else + int fd; + struct hidraw_devinfo info; + char io[5]; + int n; + + //text_color_set(DW_COLOR_DEBUG); + //dw_printf ("TEMP DEBUG cm108_write: %s %d %d\n", name, iomask, iodata); + +/* + * By default, the USB HID are accessible only by root: + * + * crw------- 1 root root 249, 1 ... /dev/hidraw1 + * + * How should we handle this? + * Manually changing it will revert back on the next reboot or + * when the device is removed and reinserted. + * + * According to various articles on the Internet, we should be able to + * add a file to /etc/udev/rules.d. "99-direwolf-cmedia.rules" would be a + * suitable name. The leading number is the order. We want this to be + * near the end. I think the file extension must be ".rules." + * + * We could completely open it up to everyone like this: + * + * # Allow ordinary user to access CMedia GPIO for PTT. + * SUBSYSTEM=="hidraw", ATTRS{idVendor}=="0d8c", MODE="0666" + * + * Whenever we have CMedia USB audio adapter, it should be accessible by everyone. + * This would not apply to other /dev/hidraw* corresponding to keyboard, mouse, etc. + * + * Notice the == (double =) for testing and := for setting a property. + * + * If you are concerned about security, you could restrict access to + * a particular group, something like this: + * + * SUBSYSTEM=="hidraw", ATTRS{idVendor}=="0d8c", GROUP="audio", MODE="0660" + * + * I figure "audio" makes more sense than "gpio" because we need to be part of + * audio group to use the USB Audio adapter for sound. + */ + + fd = open (name, O_WRONLY); + if (fd == -1) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Could not open %s for write, errno=%d\n", name, errno); + if (errno == EACCES) { // 13 + dw_printf ("Type \"ls -l %s\" and verify that it has audio group rw similar to this:\n", name); + dw_printf (" crw-rw---- 1 root audio 247, 0 Oct 6 19:24 %s\n", name); + dw_printf ("rather than root-only access like this:\n"); + dw_printf (" crw------- 1 root root 247, 0 Sep 24 09:40 %s\n", name); + } + return (-1); + } + + // Just for fun, let's get the device information. + +#if 1 + n = ioctl(fd, HIDIOCGRAWINFO, &info); + if (n == 0) { + if ( ! GOOD_DEVICE(info.vendor, info.product)) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("ioctl HIDIOCGRAWINFO failed for %s. errno = %d.\n", name, errno); + } + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("%s is not a supported device type. Proceed at your own risk. vid=%04x pid=%04x\n", name, info.vendor, info.product); + } +#endif + // To make a long story short, I think we need 0 for the first two bytes. + + io[0] = 0; + io[1] = 0; +// Issue 210 - These were reversed. Fixed in 1.6. + io[2] = iodata; + io[3] = iomask; + io[4] = 0; + + // Writing 4 bytes fails with errno 32, EPIPE, "broken pipe." + // Hamlib writes 5 bytes which I don't understand. + // Writing 5 bytes works. + // I have no idea why. From the CMedia datasheet it looks like we need 4. + + n = write (fd, io, sizeof(io)); + if (n != sizeof(io)) { + // Errors observed during development. + // as pi EACCES 13 /* Permission denied */ + // as root EPIPE 32 /* Broken pipe - Happens if we send 4 bytes */ + + text_color_set(DW_COLOR_ERROR); + dw_printf ("Write to %s failed, n=%d, errno=%d\n", name, n, errno); + + if (errno == EACCES) { + dw_printf ("Type \"ls -l %s\" and verify that it has audio group rw similar to this:\n", name); + dw_printf (" crw-rw---- 1 root audio 247, 0 Oct 6 19:24 %s\n", name); + dw_printf ("rather than root-only access like this:\n"); + dw_printf (" crw------- 1 root root 247, 0 Sep 24 09:40 %s\n", name); + } + + close (fd); + return (-1); + } + + close (fd); + +#endif + return (0); + +} /* end cm108_write */ + +#endif // ifdef USE_CM108 + +/* end cm108.c */ + + diff --git a/src/cm108.h b/src/cm108.h new file mode 100644 index 00000000..2def77a8 --- /dev/null +++ b/src/cm108.h @@ -0,0 +1,5 @@ +/* Dire Wolf cm108.h */ + +extern void cm108_find_ptt (char *output_audio_device, char *ptt_device, int ptt_device_size); + +extern int cm108_set_gpio_pin (char *name, int num, int state); \ No newline at end of file diff --git a/src/config.c b/src/config.c new file mode 100644 index 00000000..1ad6c081 --- /dev/null +++ b/src/config.c @@ -0,0 +1,5931 @@ +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// +// Copyright (C) 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2021 John Langner, WB2OSZ +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . +// + +#define CONFIG_C 1 // influences behavior of aprs_tt.h + + +// #define DEBUG 1 + +/*------------------------------------------------------------------ + * + * Module: config.c + * + * Purpose: Read configuration information from a file. + * + * Description: This started out as a simple little application with a few + * command line options. Due to creeping featurism, it's now + * time to add a configuration file to specify options. + * + *---------------------------------------------------------------*/ + +#include "direwolf.h" + +#include +#include +#include +#include +#include +#include +#include + +#if ENABLE_GPSD +#include /* for DEFAULT_GPSD_PORT (2947) */ +#endif + + +#include "ax25_pad.h" +#include "textcolor.h" +#include "audio.h" +#include "digipeater.h" +#include "cdigipeater.h" +#include "config.h" +#include "aprs_tt.h" +#include "igate.h" +#include "latlong.h" +#include "symbols.h" +#include "xmit.h" +#include "tt_text.h" +#include "ax25_link.h" + +#if USE_CM108 // Current Linux or Windows only +#include "cm108.h" +#endif + +// geotranz + +#include "utm.h" +#include "mgrs.h" +#include "usng.h" +#include "error_string.h" + +#define D2R(d) ((d) * M_PI / 180.) +#define R2D(r) ((r) * 180. / M_PI) + + + +/* + * Conversions from various units to meters. + * There is some disagreement about the exact values for some of these. + * Close enough for our purposes. + * Parsec, light year, and angstrom are probably not useful. + */ + +static const struct units_s { + char *name; + float meters; +} units[] = { + { "barleycorn", 0.008466667 }, + { "inch", 0.0254 }, + { "in", 0.0254 }, + { "hand", 0.1016 }, + { "shaku", 0.3030 }, + { "foot", 0.304801 }, + { "ft", 0.304801 }, + { "cubit", 0.4572 }, + { "megalithicyard", 0.8296 }, + { "my", 0.8296 }, + { "yard", 0.914402 }, + { "yd", 0.914402 }, + { "m", 1. }, + { "meter", 1. }, + { "metre", 1. }, + { "ell", 1.143 }, + { "ken", 1.818 }, + { "hiro", 1.818 }, + { "fathom", 1.8288 }, + { "fath", 1.8288 }, + { "toise", 1.949 }, + { "jo", 3.030 }, + { "twain", 3.6576074 }, + { "rod", 5.0292 }, + { "rd", 5.0292 }, + { "perch", 5.0292 }, + { "pole", 5.0292 }, + { "rope", 6.096 }, + { "dekameter", 10. }, + { "dekametre", 10. }, + { "dam", 10. }, + { "chain", 20.1168 }, + { "ch", 20.1168 }, + { "actus", 35.47872 }, + { "arpent", 58.471 }, + { "hectometer", 100. }, + { "hectometre", 100. }, + { "hm", 100. }, + { "cho", 109.1 }, + { "furlong", 201.168 }, + { "fur", 201.168 }, + { "kilometer", 1000. }, + { "kilometre", 1000. }, + { "km", 1000. }, + { "mile", 1609.344 }, + { "mi", 1609.344 }, + { "ri", 3927. }, + { "league", 4828.032 }, + { "lea", 4828.032 } }; + +#define NUM_UNITS ((int)((sizeof(units) / sizeof(struct units_s)))) + +static int beacon_options(char *cmd, struct beacon_s *b, int line, struct audio_s *p_audio_config); + +/* Do we have a string of all digits? */ + +static int alldigits(char *p) +{ + if (p == NULL) return (0); + if (strlen(p) == 0) return (0); + while (*p != '\0') { + if ( ! isdigit(*p)) return (0); + p++; + } + return (1); +} + +/* Do we have a string of all letters or + or - ? */ + +static int alllettersorpm(char *p) +{ + if (p == NULL) return (0); + if (strlen(p) == 0) return (0); + while (*p != '\0') { + if ( ! isalpha(*p) && *p != '+' && *p != '-') return (0); + p++; + } + return (1); +} + +/*------------------------------------------------------------------ + * + * Name: parse_ll + * + * Purpose: Parse latitude or longitude from configuration file. + * + * Inputs: str - String like [-]deg[^min][hemisphere] + * + * which - LAT or LON for error checking and message. + * + * line - Line number for use in error message. + * + * Returns: Coordinate in signed degrees. + * + *----------------------------------------------------------------*/ + +/* Acceptable symbols to separate degrees & minutes. */ +/* Degree symbol is not in ASCII so documentation says to use "^" instead. */ +/* Some wise guy will try to use degree symbol. */ +/* UTF-8 is more difficult because it is a two byte sequence, c2 b0. */ + +#define DEG1 '^' +#define DEG2 0xb0 /* ISO Latin1 */ +#define DEG3 0xf8 /* Microsoft code page 437 */ + + +enum parse_ll_which_e { LAT, LON }; + +static double parse_ll (char *str, enum parse_ll_which_e which, int line) +{ + char stemp[40]; + int sign; + double degrees, minutes; + char *endptr; + char hemi; + int limit; + unsigned char sep; + +/* + * Remove any negative sign. + */ + strlcpy (stemp, str, sizeof(stemp)); + sign = +1; + if (stemp[0] == '-') { + sign = -1; + stemp[0] = ' '; + } +/* + * Process any hemisphere on the end. + */ + if (strlen(stemp) >= 2) { + endptr = stemp + strlen(stemp) - 1; + if (isalpha(*endptr)) { + + hemi = *endptr; + *endptr = '\0'; + if (islower(hemi)) { + hemi = toupper(hemi); + } + + if (hemi == 'W' || hemi == 'S') { + sign = -sign; + } + + if (which == LAT) { + if (hemi != 'N' && hemi != 'S') { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Latitude hemisphere in \"%s\" is not N or S.\n", line, str); + } + } + else { + if (hemi != 'E' && hemi != 'W') { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Longitude hemisphere in \"%s\" is not E or W.\n", line, str); + } + } + } + } + +/* + * Parse the degrees part. + */ + degrees = strtod (stemp, &endptr); + +/* + * Is there a minutes part? + */ + sep = *endptr; + if (sep != '\0') { + + if (sep == DEG1 || sep == DEG2 || sep == DEG3) { + + minutes = strtod (endptr+1, &endptr); + if (*endptr != '\0') { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Unexpected character '%c' in location \"%s\"\n", line, sep, str); + } + if (minutes >= 60.0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Number of minutes in \"%s\" is >= 60.\n", line, str); + } + degrees += minutes / 60.0; + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Unexpected character '%c' in location \"%s\"\n", line, sep, str); + } + } + + degrees = degrees * sign; + + limit = which == LAT ? 90 : 180; + if (degrees < -limit || degrees > limit) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Number of degrees in \"%s\" is out of range for %s\n", line, str, + which == LAT ? "latitude" : "longitude"); + } + //dw_printf ("%s = %f\n", str, degrees); + return (degrees); +} + + + +/*------------------------------------------------------------------ + * + * Name: parse_utm_zone + * + * Purpose: Parse UTM zone from configuration file. + * + * Inputs: szone - String like [-]number[letter] + * + * Outputs: latband - Latitude band if specified, otherwise space or -. + * + * hemi - Hemisphere, always one of 'N' or 'S'. + * + * Returns: Zone as number. + * Type is long because Convert_UTM_To_Geodetic expects that. + * + * Errors: Prints message and return 0. + * + * Description: + * It seems there are multiple conventions for specifying the UTM hemisphere. + * + * - MGRS latitude band. North if missing or >= 'N'. + * - Negative zone for south. + * - Separate North or South. + * + * I'm using the first alternative. + * GEOTRANS uses the third. + * We will also recognize the second one but I'm not sure if I want to document it. + * + *----------------------------------------------------------------*/ + +long parse_utm_zone (char *szone, char *latband, char *hemi) +{ + long lzone; + char *zlet; + + + *latband = ' '; + *hemi = 'N'; /* default */ + + lzone = strtol(szone, &zlet, 10); + + if (*zlet == '\0') { + /* Number is not followed by letter something else. */ + /* Allow negative number to mean south. */ + + if (lzone < 0) { + *latband = '-'; + *hemi = 'S'; + lzone = (- lzone); + } + } + else { + if (islower (*zlet)) { + *zlet = toupper(*zlet); + } + *latband = *zlet; + if (strchr ("CDEFGHJKLMNPQRSTUVWX", *zlet) != NULL) { + if (*zlet < 'N') { + *hemi = 'S'; + } + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Latitudinal band in \"%s\" must be one of CDEFGHJKLMNPQRSTUVWX.\n", szone); + *hemi = '?'; + } + } + + if (lzone < 1 || lzone > 60) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("UTM Zone number %ld must be in range of 1 to 60.\n", lzone); + + } + + return (lzone); + +} /* end parse_utm_zone */ + + + + +#if 0 +main () +{ + + parse_ll ("12.5", LAT); + parse_ll ("12.5N", LAT); + parse_ll ("12.5E", LAT); // error + + parse_ll ("-12.5", LAT); + parse_ll ("12.5S", LAT); + parse_ll ("12.5W", LAT); // error + + parse_ll ("12.5", LON); + parse_ll ("12.5E", LON); + parse_ll ("12.5N", LON); // error + + parse_ll ("-12.5", LON); + parse_ll ("12.5W", LON); + parse_ll ("12.5S", LON); // error + + parse_ll ("12^30", LAT); + parse_ll ("12\xb030", LAT); // ISO Latin-1 degree symbol + + parse_ll ("91", LAT); // out of range + parse_ll ("91", LON); + parse_ll ("181", LON); // out of range + + parse_ll ("12&5", LAT); // bad character +} +#endif + + +/*------------------------------------------------------------------ + * + * Name: parse_interval + * + * Purpose: Parse time interval from configuration file. + * + * Inputs: str - String like 10 or 9:30 + * + * line - Line number for use in error message. + * + * Returns: Number of seconds. + * + * Description: This is used by the BEACON configuration items + * for initial delay or time between beacons. + * + * The format is either minutes or minutes:seconds. + * + *----------------------------------------------------------------*/ + + +static int parse_interval (char *str, int line) +{ + char *p; + int sec; + int nc = 0; + int bad = 0; + + for (p = str; *p != '\0'; p++) { + if (*p == ':') nc++; + else if ( ! isdigit(*p)) bad++; + } + if (bad > 0 || nc > 1) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file, line %d: Time interval must be of the form minutes or minutes:seconds.\n", line); + } + + p = strchr (str, ':'); + + if (p != NULL) { + sec = atoi(str) * 60 + atoi(p+1); + } + else { + sec = atoi(str) * 60; + } + + return (sec); + +} /* end parse_interval */ + + + +/*------------------------------------------------------------------ + * + * Name: check_via_path + * + * Purpose: Check for valid path in beacons, IGate, and APRStt configuration. + * + * Inputs: via_path - Zero or more comma separated stations. + * + * Returns: Maximum number of digipeater hops or -1 for error. + * + * Description: Beacons and IGate can use via paths such as: + * + * WIDE1-1,MA3-3 + * N2GH,RARA-7 + * + * Each part could be a specific station, an alias, or a path + * from the "New n-N Paradigm." + * In the first example above, the maximum number of digipeater + * hops would be 4. In the second example, 2. + * + *----------------------------------------------------------------*/ + +// Put something like this in the config file as a quick test. +// Not worth adding to "make check" regression tests. +// +// IBEACON via= +// IBEACON via=W2UB +// IBEACON via=W2UB-7 +// IBEACON via=WIDE1-1,WIDE2-2,WIDE3-3 +// IBEACON via=Lower +// IBEACON via=T00LONG +// IBEACON via=W2UB-16 +// IBEACON via=D1,D2,D3,D4,D5,D6,D7,D8 +// IBEACON via=D1,D2,D3,D4,D5,D6,D7,D8,D9 +// +// Define below and visually check results. + +//#define DEBUG8 1 + + +static int check_via_path (char *via_path) +{ + char stemp[AX25_MAX_REPEATERS * (AX25_MAX_ADDR_LEN + 1)]; + int num_digi = 0; + int max_digi_hops = 0; + char *r; + char *a; + +#if DEBUG8 + text_color_set(DW_COLOR_DEBUG); + dw_printf ("check_via_path %s\n", via_path); +#endif + if (strlen(via_path) == 0) { + return (0); + } + + strlcpy (stemp, via_path, sizeof(stemp)); + + r = stemp; + while (( a = strsep(&r,",")) != NULL) { + int strict = 2; + int ok; + char addr[AX25_MAX_ADDR_LEN]; + int ssid; + int heard; + + num_digi++; + ok = ax25_parse_addr (AX25_REPEATER_1 - 1 + num_digi, a, strict, addr, &ssid, &heard); + if ( ! ok) { +#if DEBUG8 + text_color_set(DW_COLOR_DEBUG); + dw_printf ("check_via_path bad address\n"); +#endif + return (-1); + } + + /* Based on assumption that a callsign can't end with a digit. */ + /* For something of the form xxx9-9, we take the ssid as max hop count. */ + + if (ssid > 0 && strlen(addr) >= 2 && isdigit(addr[strlen(addr)-1])) { + max_digi_hops += ssid; + } + else { + max_digi_hops++; + } + } + + if (num_digi > AX25_MAX_REPEATERS) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Maximum of 8 digipeaters has been exceeded.\n"); + return (-1); + } + +#if DEBUG8 + text_color_set(DW_COLOR_DEBUG); + dw_printf ("check_via_path %d addresses, %d max digi hops\n", num_digi, max_digi_hops); +#endif + + return (max_digi_hops); + +} /* end check_via_path */ + + + +/*------------------------------------------------------------------- + * + * Name: split + * + * Purpose: Separate a line into command and parameters. + * + * Inputs: string - Complete command line to start process. + * NULL for subsequent calls. + * + * rest_of_line - Caller wants remainder of line, not just + * the next parameter. + * + * Returns: Pointer to next part with any quoting removed. + * + * Description: the configuration file started out very simple and strtok + * was used to split up the lines. As more complicated options + * were added, there were several different situations where + * parameter values might contain spaces. These were handled + * inconsistently in different places. In version 1.3, we now + * treat them consistently in one place. + * + * + *--------------------------------------------------------------------*/ + +#define MAXCMDLEN 1200 + + +static char *split (char *string, int rest_of_line) +{ + static char cmd[MAXCMDLEN]; + static char token[MAXCMDLEN]; + static char shutup[] = " "; // Shut up static analysis which gets upset + // over the case where this could be called with + // string NULL and c was not yet initialized. + static char *c = shutup; // Current position in command line. + char *s, *t; + int in_quotes; + +/* + * If string is provided, make a copy. + * Drop any CRLF at the end. + * Change any tabs to spaces so we don't have to check for it later. + */ + if (string != NULL) { + + // dw_printf("split in: '%s'\n", string); + + c = cmd; + for (s = string; *s != '\0'; s++) { + if (*s == '\t') { + *c++ = ' '; + } + else if (*s == '\r' || *s == '\n') { + ; + } + else { + *c++ = *s; + } + } + *c = '\0'; + c = cmd; + } + +/* + * Get next part, separated by whitespace, keeping spaces within quotes. + * Quotation marks inside need to be doubled. + */ + + while (*c == ' ') { + c++; + }; + + t = token; + in_quotes = 0; + for ( ; *c != '\0'; c++) { + + if (*c == '"') { + if (in_quotes) { + if (c[1] == '"') { + *t++ = *c++; + } + else { + in_quotes = 0; + } + } + else { + in_quotes = 1; + } + } + else if (*c == ' ') { + if (in_quotes || rest_of_line) { + *t++ = *c; + } + else { + break; + } + } + else { + *t++ = *c; + } + } + *t = '\0'; + + // dw_printf("split out: '%s'\n", token); + + t = token; + if (*t == '\0') { + return (NULL); + } + + return (t); + +} /* end split */ + + + +/*------------------------------------------------------------------- + * + * Name: config_init + * + * Purpose: Read configuration file when application starts up. + * + * Inputs: fname - Name of configuration file. + * + * Outputs: p_audio_config - Radio channel parameters stored here. + * + * p_digi_config - APRS Digipeater configuration stored here. + * + * p_cdigi_config - Connected Digipeater configuration stored here. + * + * p_tt_config - APRStt stuff. + * + * p_igate_config - Internet Gateway. + * + * p_misc_config - Everything else. This wasn't thought out well. + * + * Description: Apply default values for various parameters then read the + * the configuration file which can override those values. + * + * Errors: For invalid input, display line number and message on stdout (not stderr). + * In many cases this will result in keeping the default rather than aborting. + * + * Bugs: Very simple-minded parsing. + * Not much error checking. (e.g. atoi() will return 0 for invalid string.) + * Not very forgiving about sloppy input. + * + *--------------------------------------------------------------------*/ + +static void rtfm() +{ + text_color_set(DW_COLOR_ERROR); + dw_printf ("See online documentation:\n"); + dw_printf (" stable release: https://github.com/wb2osz/direwolf/tree/master/doc\n"); + dw_printf (" development version: https://github.com/wb2osz/direwolf/tree/dev/doc\n"); + dw_printf (" additional topics: https://github.com/wb2osz/direwolf-doc\n"); +} + +void config_init (char *fname, struct audio_s *p_audio_config, + struct digi_config_s *p_digi_config, + struct cdigi_config_s *p_cdigi_config, + struct tt_config_s *p_tt_config, + struct igate_config_s *p_igate_config, + struct misc_config_s *p_misc_config) +{ + FILE *fp; + char filepath[128]; + char stuff[MAXCMDLEN]; + int line; + int channel; + int adevice; + int m; + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("config_init ( %s )\n", fname); +#endif + +/* + * First apply defaults. + */ + + memset (p_audio_config, 0, sizeof(struct audio_s)); + + p_audio_config->igate_vchannel = -1; // none. + + /* First audio device is always available with defaults. */ + /* Others must be explicitly defined before use. */ + + for (adevice=0; adeviceadev[adevice].adevice_in, DEFAULT_ADEVICE, sizeof(p_audio_config->adev[adevice].adevice_in)); + strlcpy (p_audio_config->adev[adevice].adevice_out, DEFAULT_ADEVICE, sizeof(p_audio_config->adev[adevice].adevice_out)); + + p_audio_config->adev[adevice].defined = 0; + p_audio_config->adev[adevice].num_channels = DEFAULT_NUM_CHANNELS; /* -2 stereo */ + p_audio_config->adev[adevice].samples_per_sec = DEFAULT_SAMPLES_PER_SEC; /* -r option */ + p_audio_config->adev[adevice].bits_per_sample = DEFAULT_BITS_PER_SAMPLE; /* -8 option for 8 instead of 16 bits */ + } + + p_audio_config->adev[0].defined = 1; + + for (channel=0; channelchan_medium[channel] = MEDIUM_NONE; /* One or both channels will be */ + /* set to radio when corresponding */ + /* audio device is defined. */ + p_audio_config->achan[channel].modem_type = MODEM_AFSK; + p_audio_config->achan[channel].v26_alternative = V26_UNSPECIFIED; + p_audio_config->achan[channel].mark_freq = DEFAULT_MARK_FREQ; /* -m option */ + p_audio_config->achan[channel].space_freq = DEFAULT_SPACE_FREQ; /* -s option */ + p_audio_config->achan[channel].baud = DEFAULT_BAUD; /* -b option */ + + /* None. Will set default later based on other factors. */ + strlcpy (p_audio_config->achan[channel].profiles, "", sizeof(p_audio_config->achan[channel].profiles)); + + p_audio_config->achan[channel].num_freq = 1; + p_audio_config->achan[channel].offset = 0; + + p_audio_config->achan[channel].layer2_xmit = LAYER2_AX25; + p_audio_config->achan[channel].il2p_max_fec = 1; + p_audio_config->achan[channel].il2p_invert_polarity = 0; + + p_audio_config->achan[channel].fix_bits = DEFAULT_FIX_BITS; + p_audio_config->achan[channel].sanity_test = SANITY_APRS; + p_audio_config->achan[channel].passall = 0; + + for (ot = 0; ot < NUM_OCTYPES; ot++) { + p_audio_config->achan[channel].octrl[ot].ptt_method = PTT_METHOD_NONE; + strlcpy (p_audio_config->achan[channel].octrl[ot].ptt_device, "", sizeof(p_audio_config->achan[channel].octrl[ot].ptt_device)); + p_audio_config->achan[channel].octrl[ot].ptt_line = PTT_LINE_NONE; + p_audio_config->achan[channel].octrl[ot].ptt_line2 = PTT_LINE_NONE; + p_audio_config->achan[channel].octrl[ot].out_gpio_num = 0; + p_audio_config->achan[channel].octrl[ot].ptt_lpt_bit = 0; + p_audio_config->achan[channel].octrl[ot].ptt_invert = 0; + p_audio_config->achan[channel].octrl[ot].ptt_invert2 = 0; + } + + for (it = 0; it < NUM_ICTYPES; it++) { + p_audio_config->achan[channel].ictrl[it].method = PTT_METHOD_NONE; + p_audio_config->achan[channel].ictrl[it].in_gpio_num = 0; + p_audio_config->achan[channel].ictrl[it].invert = 0; + } + + p_audio_config->achan[channel].dwait = DEFAULT_DWAIT; + p_audio_config->achan[channel].slottime = DEFAULT_SLOTTIME; + p_audio_config->achan[channel].persist = DEFAULT_PERSIST; + p_audio_config->achan[channel].txdelay = DEFAULT_TXDELAY; + p_audio_config->achan[channel].txtail = DEFAULT_TXTAIL; + p_audio_config->achan[channel].fulldup = DEFAULT_FULLDUP; + } + + p_audio_config->fx25_auto_enable = AX25_N2_RETRY_DEFAULT / 2; + + /* First channel should always be valid. */ + /* If there is no ADEVICE, it uses default device in mono. */ + + p_audio_config->chan_medium[0] = MEDIUM_RADIO; + + memset (p_digi_config, 0, sizeof(struct digi_config_s)); // APRS digipeater + p_digi_config->dedupe_time = DEFAULT_DEDUPE; + memset (p_cdigi_config, 0, sizeof(struct cdigi_config_s)); // Connected mode digipeater + + memset (p_tt_config, 0, sizeof(struct tt_config_s)); + p_tt_config->gateway_enabled = 0; + p_tt_config->ttloc_size = 2; /* Start with at least 2. */ + /* When full, it will be increased by 50 %. */ + p_tt_config->ttloc_ptr = malloc (sizeof(struct ttloc_s) * p_tt_config->ttloc_size); + p_tt_config->ttloc_len = 0; + + /* Retention time and decay algorithm from 13 Feb 13 version of */ + /* http://www.aprs.org/aprstt/aprstt-coding24.txt */ + /* Reduced by transmit count by one. An 8 minute delay in between transmissions seems awful long. */ + + p_tt_config->retain_time = 80 * 60; + p_tt_config->num_xmits = 6; + assert (p_tt_config->num_xmits <= TT_MAX_XMITS); + p_tt_config->xmit_delay[0] = 3; /* Before initial transmission. */ + p_tt_config->xmit_delay[1] = 16; + p_tt_config->xmit_delay[2] = 32; + p_tt_config->xmit_delay[3] = 64; + p_tt_config->xmit_delay[4] = 2 * 60; + p_tt_config->xmit_delay[5] = 4 * 60; + p_tt_config->xmit_delay[6] = 8 * 60; // not currently used. + + strlcpy (p_tt_config->status[0], "", sizeof(p_tt_config->status[0])); + strlcpy (p_tt_config->status[1], "/off duty", sizeof(p_tt_config->status[1])); + strlcpy (p_tt_config->status[2], "/enroute", sizeof(p_tt_config->status[2])); + strlcpy (p_tt_config->status[3], "/in service", sizeof(p_tt_config->status[3])); + strlcpy (p_tt_config->status[4], "/returning", sizeof(p_tt_config->status[4])); + strlcpy (p_tt_config->status[5], "/committed", sizeof(p_tt_config->status[5])); + strlcpy (p_tt_config->status[6], "/special", sizeof(p_tt_config->status[6])); + strlcpy (p_tt_config->status[7], "/priority", sizeof(p_tt_config->status[7])); + strlcpy (p_tt_config->status[8], "/emergency", sizeof(p_tt_config->status[8])); + strlcpy (p_tt_config->status[9], "/custom 1", sizeof(p_tt_config->status[9])); + + for (m = 0; m < TT_ERROR_MAXP1; m++) { + strlcpy (p_tt_config->response[m].method, "MORSE", sizeof(p_tt_config->response[m].method)); + strlcpy (p_tt_config->response[m].mtext, "?", sizeof(p_tt_config->response[m].mtext)); + } + strlcpy (p_tt_config->response[TT_ERROR_OK].mtext, "R", sizeof(p_tt_config->response[TT_ERROR_OK].mtext)); + + + memset (p_misc_config, 0, sizeof(struct misc_config_s)); + p_misc_config->agwpe_port = DEFAULT_AGWPE_PORT; + + for (int i=0; ikiss_port[i] = 0; // entry not used. + p_misc_config->kiss_chan[i] = -1; + } + p_misc_config->kiss_port[0] = DEFAULT_KISS_PORT; + p_misc_config->kiss_chan[0] = -1; // all channels. + + p_misc_config->enable_kiss_pt = 0; /* -p option */ + p_misc_config->kiss_copy = 0; + + p_misc_config->dns_sd_enabled = 1; + + /* Defaults from http://info.aprs.net/index.php?title=SmartBeaconing */ + + p_misc_config->sb_configured = 0; /* TRUE if SmartBeaconing is configured. */ + p_misc_config->sb_fast_speed = 60; /* MPH */ + p_misc_config->sb_fast_rate = 180; /* seconds */ + p_misc_config->sb_slow_speed = 5; /* MPH */ + p_misc_config->sb_slow_rate = 1800; /* seconds */ + p_misc_config->sb_turn_time = 15; /* seconds */ + p_misc_config->sb_turn_angle = 30; /* degrees */ + p_misc_config->sb_turn_slope = 255; /* degrees * MPH */ + + memset (p_igate_config, 0, sizeof(struct igate_config_s)); + p_igate_config->t2_server_port = DEFAULT_IGATE_PORT; + p_igate_config->tx_chan = -1; /* IS->RF not enabled */ + p_igate_config->tx_limit_1 = IGATE_TX_LIMIT_1_DEFAULT; + p_igate_config->tx_limit_5 = IGATE_TX_LIMIT_5_DEFAULT; + p_igate_config->igmsp = 1; + p_igate_config->rx2ig_dedupe_time = IGATE_RX2IG_DEDUPE_TIME; + + + /* People find this confusing. */ + /* Ideally we'd like to figure out if com0com is installed */ + /* and automatically enable this. */ + + strlcpy (p_misc_config->kiss_serial_port, "", sizeof(p_misc_config->kiss_serial_port)); + p_misc_config->kiss_serial_speed = 0; + p_misc_config->kiss_serial_poll = 0; + + strlcpy (p_misc_config->gpsnmea_port, "", sizeof(p_misc_config->gpsnmea_port)); + strlcpy (p_misc_config->waypoint_serial_port, "", sizeof(p_misc_config->waypoint_serial_port)); + + p_misc_config->log_daily_names = 0; + strlcpy (p_misc_config->log_path, "", sizeof(p_misc_config->log_path)); + + /* connected mode. */ + + p_misc_config->frack = AX25_T1V_FRACK_DEFAULT; /* Number of seconds to wait for ack to transmission. */ + + p_misc_config->retry = AX25_N2_RETRY_DEFAULT; /* Number of times to retry before giving up. */ + + p_misc_config->paclen = AX25_N1_PACLEN_DEFAULT; /* Max number of bytes in information part of frame. */ + + p_misc_config->maxframe_basic = AX25_K_MAXFRAME_BASIC_DEFAULT; /* Max frames to send before ACK. mod 8 "Window" size. */ + + p_misc_config->maxframe_extended = AX25_K_MAXFRAME_EXTENDED_DEFAULT; /* Max frames to send before ACK. mod 128 "Window" size. */ + + p_misc_config->maxv22 = AX25_N2_RETRY_DEFAULT / 3; /* Max SABME before falling back to SABM. */ + p_misc_config->v20_addrs = NULL; /* Go directly to v2.0 for stations listed. */ + p_misc_config->v20_count = 0; + p_misc_config->noxid_addrs = NULL; /* Don't send XID to these stations. */ + p_misc_config->noxid_count = 0; + +/* + * Try to extract options from a file. + * + * Windows: File must be in current working directory. + * + * Linux: Search current directory then home directory. + * + * Future possibility - Could also search home directory + * for Windows by combinting two variables: + * HOMEDRIVE=C: + * HOMEPATH=\Users\John + * + * It's not clear if this always points to same location: + * USERPROFILE=C:\Users\John + */ + + + channel = 0; + adevice = 0; + +// TODO: Would be better to have a search list and loop thru it. + + strlcpy(filepath, fname, sizeof(filepath)); + + fp = fopen (filepath, "r"); + +#ifndef __WIN32__ + if (fp == NULL && strcmp(fname, "direwolf.conf") == 0) { + /* Failed to open the default location. Try home dir. */ + char *p; + + + strlcpy (filepath, "", sizeof(filepath)); + + p = getenv("HOME"); + if (p != NULL) { + strlcpy (filepath, p, sizeof(filepath)); + strlcat (filepath, "/direwolf.conf", sizeof(filepath)); + fp = fopen (filepath, "r"); + } + } +#endif + if (fp == NULL) { + // TODO: not exactly right for all situations. + text_color_set(DW_COLOR_ERROR); + dw_printf ("ERROR - Could not open config file %s\n", filepath); + dw_printf ("Try using -c command line option for alternate location.\n"); + rtfm(); + exit(EXIT_FAILURE); + } + + dw_printf ("\nReading config file %s\n", filepath); + + line = 0; + while (fgets(stuff, sizeof(stuff), fp) != NULL) { + char *t; + + line++; + + t = split(stuff,0); + + if (t == NULL) { + continue; + } + + if (*t == '#' || *t == '*') { + continue; + } + + + +/* + * ==================== Audio device parameters ==================== + */ + +/* + * ADEVICE[n] - Name of input sound device, and optionally output, if different. + * + * ADEVICE plughw:1,0 -- same for in and out. + * ADEVICE plughw:2,0 plughw:3,0 -- different in/out for a channel or channel pair. + * ADEVICE1 udp:7355 default -- from Software defined radio (SDR) via UDP. + * + */ + + /* Note that ALSA name can contain comma such as hw:1,0 */ + + if (strncasecmp(t, "ADEVICE", 7) == 0) { + /* "ADEVICE" is equivalent to "ADEVICE0". */ + adevice = 0; + if (strlen(t) >= 8) { + adevice = atoi(t+7); + } + + if (adevice < 0 || adevice >= MAX_ADEVS) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: Device number %d out of range for ADEVICE command on line %d.\n", adevice, line); + dw_printf ("If you really need more than %d audio devices, increase MAX_ADEVS and recompile.\n", MAX_ADEVS); + adevice = 0; + continue; + } + + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: Missing name of audio device for ADEVICE command on line %d.\n", line); + rtfm(); + exit(EXIT_FAILURE); + } + + p_audio_config->adev[adevice].defined = 1; + + /* First channel of device is valid. */ + p_audio_config->chan_medium[ADEVFIRSTCHAN(adevice)] = MEDIUM_RADIO; + + strlcpy (p_audio_config->adev[adevice].adevice_in, t, sizeof(p_audio_config->adev[adevice].adevice_in)); + strlcpy (p_audio_config->adev[adevice].adevice_out, t, sizeof(p_audio_config->adev[adevice].adevice_out)); + + t = split(NULL,0); + if (t != NULL) { + strlcpy (p_audio_config->adev[adevice].adevice_out, t, sizeof(p_audio_config->adev[adevice].adevice_out)); + } + } + + +/* + * PAIDEVICE[n] input-device + * PAODEVICE[n] output-device + * + * This was submitted by KK5VD for the Mac OS X version. (__APPLE__) + * + * It looks like device names can contain spaces making it a little + * more difficult to put two names on the same line unless we come up with + * some other delimiter between them or a quoting scheme to handle + * embedded spaces in a name. + * + * It concerns me that we could have one defined without the other + * if we don't put in more error checking later. + * + * version 1.3 dev snapshot C: + * + * We now have a general quoting scheme so the original ADEVICE can handle this. + * These options will probably be removed before general 1.3 release. + */ + + else if (strcasecmp(t, "PAIDEVICE") == 0) { + adevice = 0; + if (isdigit(t[9])) { + adevice = t[9] - '0'; + } + + if (adevice < 0 || adevice >= MAX_ADEVS) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: Device number %d out of range for PADEVICE command on line %d.\n", adevice, line); + adevice = 0; + continue; + } + + t = split(NULL,1); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: Missing name of audio device for PADEVICE command on line %d.\n", line); + continue; + } + + p_audio_config->adev[adevice].defined = 1; + + /* First channel of device is valid. */ + p_audio_config->chan_medium[ADEVFIRSTCHAN(adevice)] = MEDIUM_RADIO; + + strlcpy (p_audio_config->adev[adevice].adevice_in, t, sizeof(p_audio_config->adev[adevice].adevice_in)); + } + else if (strcasecmp(t, "PAODEVICE") == 0) { + adevice = 0; + if (isdigit(t[9])) { + adevice = t[9] - '0'; + } + + if (adevice < 0 || adevice >= MAX_ADEVS) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: Device number %d out of range for PADEVICE command on line %d.\n", adevice, line); + adevice = 0; + continue; + } + + t = split(NULL,1); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: Missing name of audio device for PADEVICE command on line %d.\n", line); + continue; + } + + p_audio_config->adev[adevice].defined = 1; + + /* First channel of device is valid. */ + p_audio_config->chan_medium[ADEVFIRSTCHAN(adevice)] = MEDIUM_RADIO; + + strlcpy (p_audio_config->adev[adevice].adevice_out, t, sizeof(p_audio_config->adev[adevice].adevice_out)); + } + + +/* + * ARATE - Audio samples per second, 11025, 22050, 44100, etc. + */ + + else if (strcasecmp(t, "ARATE") == 0) { + int n; + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing audio sample rate for ARATE command.\n", line); + continue; + } + n = atoi(t); + if (n >= MIN_SAMPLES_PER_SEC && n <= MAX_SAMPLES_PER_SEC) { + p_audio_config->adev[adevice].samples_per_sec = n; + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Use a more reasonable audio sample rate in range of %d - %d.\n", + line, MIN_SAMPLES_PER_SEC, MAX_SAMPLES_PER_SEC); + } + } + +/* + * ACHANNELS - Number of audio channels for current device: 1 or 2 + */ + + else if (strcasecmp(t, "ACHANNELS") == 0) { + int n; + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing number of audio channels for ACHANNELS command.\n", line); + continue; + } + n = atoi(t); + if (n ==1 || n == 2) { + p_audio_config->adev[adevice].num_channels = n; + + /* Set valid channels depending on mono or stereo. */ + + p_audio_config->chan_medium[ADEVFIRSTCHAN(adevice)] = MEDIUM_RADIO; + if (n == 2) { + p_audio_config->chan_medium[ADEVFIRSTCHAN(adevice) + 1] = MEDIUM_RADIO; + } + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Number of audio channels must be 1 or 2.\n", line); + } + } + +/* + * ==================== Radio channel parameters ==================== + */ + +/* + * CHANNEL n - Set channel for channel-specific commands. + */ + + else if (strcasecmp(t, "CHANNEL") == 0) { + int n; + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing channel number for CHANNEL command.\n", line); + continue; + } + n = atoi(t); + if (n >= 0 && n < MAX_CHANS) { + + channel = n; + + if (p_audio_config->chan_medium[n] != MEDIUM_RADIO) { + + if ( ! p_audio_config->adev[ACHAN2ADEV(n)].defined) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Channel number %d is not valid because audio device %d is not defined.\n", + line, n, ACHAN2ADEV(n)); + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Channel number %d is not valid because audio device %d is not in stereo.\n", + line, n, ACHAN2ADEV(n)); + } + } + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Channel number must in range of 0 to %d.\n", line, MAX_CHANS-1); + } + } + +/* + * ICHANNEL n - Define IGate virtual channel. + * + * This allows a client application to talk to to APRS-IS + * by using a channel number outside the normal range for modems. + * In the future there might be other typs of virtual channels. + * This does not change the current channel number used by MODEM, PTT, etc. + */ + + else if (strcasecmp(t, "ICHANNEL") == 0) { + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing virtual channel number for ICHANNEL command.\n", line); + continue; + } + int ichan = atoi(t); + if (ichan >= MAX_CHANS && ichan < MAX_TOTAL_CHANS) { + + if (p_audio_config->chan_medium[ichan] == MEDIUM_NONE) { + + p_audio_config->chan_medium[ichan] = MEDIUM_IGATE; + + // This is redundant but saves the time of searching through all + // the channels for each packet. + p_audio_config->igate_vchannel = ichan; + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: ICHANNEL can't use %d because it is already in use.\n", line, ichan); + } + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: ICHANNEL number must in range of %d to %d.\n", line, MAX_CHANS, MAX_TOTAL_CHANS-1); + } + } + +/* + * MYCALL station + */ + else if (strcasecmp(t, "mycall") == 0) { + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: Missing value for MYCALL command on line %d.\n", line); + continue; + } + else { + + char *p; + int const strict = 2; + char call_no_ssid[AX25_MAX_ADDR_LEN]; + int ssid, heard; + + for (p = t; *p != '\0'; p++) { + if (islower(*p)) { + *p = toupper(*p); /* Silently force upper case. */ + /* Might change to warning someday. */ + } + } + + if ( ! ax25_parse_addr (-1, t, strict, call_no_ssid, &ssid, &heard)) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: Invalid value for MYCALL command on line %d.\n", line); + continue; + } + + // Definitely set for current channel. + // Set for other channels which have not been set yet. + + int c; + + for (c = 0; c < MAX_CHANS; c++) { + + if (c == channel || + strlen(p_audio_config->achan[c].mycall) == 0 || + strcasecmp(p_audio_config->achan[c].mycall, "NOCALL") == 0 || + strcasecmp(p_audio_config->achan[c].mycall, "N0CALL") == 0) { + + strlcpy (p_audio_config->achan[c].mycall, t, sizeof(p_audio_config->achan[c].mycall)); + } + } + } + } + + +/* + * MODEM - Set modem properties for current channel. + * + * + * Old style: + * MODEM baud [ mark space [A][B][C][+] [ num-decoders spacing ] ] + * + * New style, version 1.2: + * MODEM speed [ option ] ... + * + * Options: + * mark:space - AFSK tones. Defaults based on speed. + * num@offset - Multiple decoders on different frequencies. + * /9 - Divide sample rate by specified number. + * *9 - Upsample ratio for G3RUH. + * [A-Z+-]+ - Letters, plus, minus for the demodulator "profile." + * g3ruh - This modem type regardless of default for speed. + * v26a or v26b - V.26 alternative. a=original, b=MFJ compatible + */ + + else if (strcasecmp(t, "MODEM") == 0) { + int n; + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing data transmission speed for MODEM command.\n", line); + continue; + } + if (strcasecmp(t,"AIS") == 0) { + n = MAX_BAUD-1; // Hack - See special case later. + } + else if (strcasecmp(t,"EAS") == 0) { + n = MAX_BAUD-2; // Hack - See special case later. + } + else { + n = atoi(t); + } + if (n >= MIN_BAUD && n <= MAX_BAUD) { + p_audio_config->achan[channel].baud = n; + if (n != 300 && n != 1200 && n != 2400 && n != 4800 && n != 9600 && n != 19200 && n != MAX_BAUD-1 && n != MAX_BAUD-2) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Warning: Non-standard data rate of %d bits per second. Are you sure?\n", line, n); + } + } + else { + p_audio_config->achan[channel].baud = DEFAULT_BAUD; + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Unreasonable data rate. Using %d bits per second.\n", + line, p_audio_config->achan[channel].baud); + } + + + /* Set defaults based on speed. */ + /* Should be same as -B command line option in direwolf.c. */ + + /* We have similar logic in direwolf.c, config.c, gen_packets.c, and atest.c, */ + /* that need to be kept in sync. Maybe it could be a common function someday. */ + + if (p_audio_config->achan[channel].baud < 600) { + p_audio_config->achan[channel].modem_type = MODEM_AFSK; + p_audio_config->achan[channel].mark_freq = 1600; + p_audio_config->achan[channel].space_freq = 1800; + } + else if (p_audio_config->achan[channel].baud < 1800) { + p_audio_config->achan[channel].modem_type = MODEM_AFSK; + p_audio_config->achan[channel].mark_freq = DEFAULT_MARK_FREQ; + p_audio_config->achan[channel].space_freq = DEFAULT_SPACE_FREQ; + } + else if (p_audio_config->achan[channel].baud < 3600) { + p_audio_config->achan[channel].modem_type = MODEM_QPSK; + p_audio_config->achan[channel].mark_freq = 0; + p_audio_config->achan[channel].space_freq = 0; + } + else if (p_audio_config->achan[channel].baud < 7200) { + p_audio_config->achan[channel].modem_type = MODEM_8PSK; + p_audio_config->achan[channel].mark_freq = 0; + p_audio_config->achan[channel].space_freq = 0; + } + else if (p_audio_config->achan[channel].baud == MAX_BAUD-1) { + p_audio_config->achan[channel].modem_type = MODEM_AIS; + p_audio_config->achan[channel].mark_freq = 0; + p_audio_config->achan[channel].space_freq = 0; + } + else if (p_audio_config->achan[channel].baud == MAX_BAUD-2) { + p_audio_config->achan[channel].modem_type = MODEM_EAS; + p_audio_config->achan[channel].baud = 521; // Actually 520.83 but we have an integer field here. + // Will make more precise in afsk demod init. + p_audio_config->achan[channel].mark_freq = 2083; // Actually 2083.3 - logic 1. + p_audio_config->achan[channel].space_freq = 1563; // Actually 1562.5 - logic 0. + // ? strlcpy (p_audio_config->achan[channel].profiles, "A", sizeof(p_audio_config->achan[channel].profiles)); + } + else { + p_audio_config->achan[channel].modem_type = MODEM_SCRAMBLE; + p_audio_config->achan[channel].mark_freq = 0; + p_audio_config->achan[channel].space_freq = 0; + } + + /* Get any options. */ + + t = split(NULL,0); + if (t == NULL) { + /* all done. */ + continue; + } + + if (alldigits(t)) { + +/* old style */ + + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Old style (pre version 1.2) format will no longer be supported in next version.\n", line); + + n = atoi(t); + /* Originally the upper limit was 3000. */ + /* Version 1.0 increased to 5000 because someone */ + /* wanted to use 2400/4800 Hz AFSK. */ + /* Of course the MIC and SPKR connections won't */ + /* have enough bandwidth so radios must be modified. */ + if (n >= 300 && n <= 5000) { + p_audio_config->achan[channel].mark_freq = n; + } + else { + p_audio_config->achan[channel].mark_freq = DEFAULT_MARK_FREQ; + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Unreasonable mark tone frequency. Using %d.\n", + line, p_audio_config->achan[channel].mark_freq); + } + + /* Get space frequency */ + + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing tone frequency for space.\n", line); + continue; + } + n = atoi(t); + if (n >= 300 && n <= 5000) { + p_audio_config->achan[channel].space_freq = n; + } + else { + p_audio_config->achan[channel].space_freq = DEFAULT_SPACE_FREQ; + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Unreasonable space tone frequency. Using %d.\n", + line, p_audio_config->achan[channel].space_freq); + } + + /* Gently guide users toward new format. */ + + if (p_audio_config->achan[channel].baud == 1200 && + p_audio_config->achan[channel].mark_freq == 1200 && + p_audio_config->achan[channel].space_freq == 2200) { + + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: The AFSK frequencies can be omitted when using the 1200 baud default 1200:2200.\n", line); + } + if (p_audio_config->achan[channel].baud == 300 && + p_audio_config->achan[channel].mark_freq == 1600 && + p_audio_config->achan[channel].space_freq == 1800) { + + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: The AFSK frequencies can be omitted when using the 300 baud default 1600:1800.\n", line); + } + + /* New feature in 0.9 - Optional filter profile(s). */ + + t = split(NULL,0); + if (t != NULL) { + + /* Look for some combination of letter(s) and + */ + + if (isalpha(t[0]) || t[0] == '+') { + char *pc; + + /* Here we only catch something other than letters and + mixed in. */ + /* Later, we check for valid letters and no more than one letter if + specified. */ + + for (pc = t; *pc != '\0'; pc++) { + if ( ! isalpha(*pc) && ! (*pc == '+')) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Demodulator type can only contain letters and + character.\n", line); + } + } + + strlcpy (p_audio_config->achan[channel].profiles, t, sizeof(p_audio_config->achan[channel].profiles)); + t = split(NULL,0); + if (strlen(p_audio_config->achan[channel].profiles) > 1 && t != NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Can't combine multiple demodulator types and multiple frequencies.\n", line); + continue; + } + } + } + + /* New feature in 0.9 - optional number of decoders and frequency offset between. */ + + if (t != NULL) { + n = atoi(t); + if (n < 1 || n > MAX_SUBCHANS) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Number of demodulators is out of range. Using 3.\n", line); + n = 3; + } + p_audio_config->achan[channel].num_freq = n; + + t = split(NULL,0); + if (t != NULL) { + n = atoi(t); + if (n < 5 || n > abs(p_audio_config->achan[channel].mark_freq - p_audio_config->achan[channel].space_freq)/2) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Unreasonable value for offset between modems. Using 50 Hz.\n", line); + n = 50; + } + p_audio_config->achan[channel].offset = n; + + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: New style for multiple demodulators is %d@%d\n", line, + p_audio_config->achan[channel].num_freq, p_audio_config->achan[channel].offset); + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing frequency offset between modems. Using 50 Hz.\n", line); + p_audio_config->achan[channel].offset = 50; + } + } + } + else { + +/* New style in version 1.2. */ + + while (t != NULL) { + char *s; + + if ((s = strchr(t, ':')) != NULL) { /* mark:space */ + + p_audio_config->achan[channel].mark_freq = atoi(t); + p_audio_config->achan[channel].space_freq = atoi(s+1); + + if (p_audio_config->achan[channel].mark_freq == 0 && p_audio_config->achan[channel].space_freq == 0) { + p_audio_config->achan[channel].modem_type = MODEM_SCRAMBLE; + } + else { + p_audio_config->achan[channel].modem_type = MODEM_AFSK; + + if (p_audio_config->achan[channel].mark_freq < 300 || p_audio_config->achan[channel].mark_freq > 5000) { + p_audio_config->achan[channel].mark_freq = DEFAULT_MARK_FREQ; + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Unreasonable mark tone frequency. Using %d instead.\n", + line, p_audio_config->achan[channel].mark_freq); + } + if (p_audio_config->achan[channel].space_freq < 300 || p_audio_config->achan[channel].space_freq > 5000) { + p_audio_config->achan[channel].space_freq = DEFAULT_SPACE_FREQ; + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Unreasonable space tone frequency. Using %d instead.\n", + line, p_audio_config->achan[channel].space_freq); + } + } + } + + else if ((s = strchr(t, '@')) != NULL) { /* num@offset */ + + p_audio_config->achan[channel].num_freq = atoi(t); + p_audio_config->achan[channel].offset = atoi(s+1); + + if (p_audio_config->achan[channel].num_freq < 1 || p_audio_config->achan[channel].num_freq > MAX_SUBCHANS) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Number of demodulators is out of range. Using 3.\n", line); + p_audio_config->achan[channel].num_freq = 3; + } + + if (p_audio_config->achan[channel].offset < 5 || + p_audio_config->achan[channel].offset > abs(p_audio_config->achan[channel].mark_freq - p_audio_config->achan[channel].space_freq)/2) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Offset between demodulators is unreasonable. Using 50 Hz.\n", line); + p_audio_config->achan[channel].offset = 50; + } + } + + else if (alllettersorpm(t)) { /* profile of letter(s) + - */ + + // Will be validated later. + strlcpy (p_audio_config->achan[channel].profiles, t, sizeof(p_audio_config->achan[channel].profiles)); + } + + else if (*t == '/') { /* /div */ + int n = atoi(t+1); + + if (n >= 1 && n <= 8) { + p_audio_config->achan[channel].decimate = n; + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Ignoring unreasonable sample rate division factor of %d.\n", line, n); + } + } + + else if (*t == '*') { /* *upsample */ + int n = atoi(t+1); + + if (n >= 1 && n <= 4) { + p_audio_config->achan[channel].upsample = n; + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Ignoring unreasonable upsample ratio of %d.\n", line, n); + } + } + + else if (strcasecmp(t, "G3RUH") == 0) { /* Force G3RUH modem regardless of default for speed. New in 1.6. */ + + p_audio_config->achan[channel].modem_type = MODEM_SCRAMBLE; + p_audio_config->achan[channel].mark_freq = 0; + p_audio_config->achan[channel].space_freq = 0; + } + + else if (strcasecmp(t, "V26A") == 0 || /* Compatible with direwolf versions <= 1.5. New in 1.6. */ + strcasecmp(t, "V26B") == 0) { /* Compatible with MFJ-2400. New in 1.6. */ + + if (p_audio_config->achan[channel].modem_type != MODEM_QPSK || + p_audio_config->achan[channel].baud != 2400) { + + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: %s option can only be used with 2400 bps PSK.\n", line, t); + continue; + } + p_audio_config->achan[channel].v26_alternative = (strcasecmp(t, "V26A") == 0) ? V26_A : V26_B; + } + + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Unrecognized option for MODEM: %s\n", line, t); + } + + t = split(NULL,0); + } + + /* A later place catches disallowed combination of + and @. */ + /* A later place sets /n for 300 baud if not specified by user. */ + + //dw_printf ("debug: div = %d\n", p_audio_config->achan[channel].decimate); + + } + } + + + +/* + * DTMF - Enable DTMF decoder. + * + * Future possibilities: + * Option to determine if it goes to APRStt gateway and/or application. + * Disable normal demodulator to reduce CPU requirements. + */ + + + else if (strcasecmp(t, "DTMF") == 0) { + + p_audio_config->achan[channel].dtmf_decode = DTMF_DECODE_ON; + + } + + +/* + * FIX_BITS n [ APRS | AX25 | NONE ] [ PASSALL ] + * + * - Attempt to fix frames with bad FCS. + * - n is maximum number of bits to attempt fixing. + * - Optional sanity check & allow everything even with bad FCS. + */ + + else if (strcasecmp(t, "FIX_BITS") == 0) { + int n; + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing value for FIX_BITS command.\n", line); + continue; + } + n = atoi(t); + if (n >= RETRY_NONE && n < RETRY_MAX) { // MAX is actually last valid +1 + p_audio_config->achan[channel].fix_bits = (retry_t)n; + } + else { + p_audio_config->achan[channel].fix_bits = DEFAULT_FIX_BITS; + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Invalid value %d for FIX_BITS. Using default of %d.\n", + line, n, p_audio_config->achan[channel].fix_bits); + } + + if (p_audio_config->achan[channel].fix_bits > DEFAULT_FIX_BITS) { + text_color_set(DW_COLOR_INFO); + dw_printf ("Line %d: Using a FIX_BITS value greater than %d is not recommended for normal operation.\n", + line, DEFAULT_FIX_BITS); + dw_printf ("FIX_BITS > 1 was an interesting experiment but turned out to be a bad idea.\n"); + dw_printf ("Don't be surprised if it takes 100%% CPU, direwolf can't keep up with the audio stream,\n"); + dw_printf ("and you see messages like \"Audio input device 0 error code -32: Broken pipe\"\n"); + } + + t = split(NULL,0); + while (t != NULL) { + + // If more than one sanity test, we silently take the last one. + + if (strcasecmp(t, "APRS") == 0) { + p_audio_config->achan[channel].sanity_test = SANITY_APRS; + } + else if (strcasecmp(t, "AX25") == 0 || strcasecmp(t, "AX.25") == 0) { + p_audio_config->achan[channel].sanity_test = SANITY_AX25; + } + else if (strcasecmp(t, "NONE") == 0) { + p_audio_config->achan[channel].sanity_test = SANITY_NONE; + } + else if (strcasecmp(t, "PASSALL") == 0) { + p_audio_config->achan[channel].passall = 1; + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: There is an old saying, \"Be careful what you ask for because you might get it.\"\n", line); + dw_printf ("The PASSALL option means allow all frames even when they are invalid.\n"); + dw_printf ("You are asking to receive random trash and you WILL get your wish.\n"); + dw_printf ("Don't complain when you see all sorts of random garbage. That's what you asked for.\n"); + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Invalid option '%s' for FIX_BITS.\n", line, t); + } + t = split(NULL,0); + } + } + + +/* + * PTT - Push To Talk signal line. + * DCD - Data Carrier Detect indicator. + * CON - Connected to another station indicator. + * + * xxx serial-port [-]rts-or-dtr [ [-]rts-or-dtr ] + * xxx GPIO [-]gpio-num + * xxx LPT [-]bit-num + * PTT RIG model port [ rate ] + * PTT RIG AUTO port [ rate ] + * PTT CM108 [ [-]bit-num ] [ hid-device ] + * + * When model is 2, port would host:port like 127.0.0.1:4532 + * Otherwise, port would be a serial port like /dev/ttyS0 + * + * + * Applies to most recent CHANNEL command. + */ + + else if (strcasecmp(t, "PTT") == 0 || strcasecmp(t, "DCD") == 0 || strcasecmp(t, "CON") == 0) { + int ot; + char otname[8]; + + if (strcasecmp(t, "PTT") == 0) { + ot = OCTYPE_PTT; + strlcpy (otname, "PTT", sizeof(otname)); + } + else if (strcasecmp(t, "DCD") == 0) { + ot = OCTYPE_DCD; + strlcpy (otname, "DCD", sizeof(otname)); + } + else { + ot = OCTYPE_CON; + strlcpy (otname, "CON", sizeof(otname)); + } + + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file line %d: Missing output control device for %s command.\n", + line, otname); + continue; + } + + if (strcasecmp(t, "GPIO") == 0) { + +/* GPIO case, Linux only. */ + +#if __WIN32__ + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file line %d: %s with GPIO is only available on Linux.\n", line, otname); +#else + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file line %d: Missing GPIO number for %s.\n", line, otname); + continue; + } + + if (*t == '-') { + p_audio_config->achan[channel].octrl[ot].out_gpio_num = atoi(t+1); + p_audio_config->achan[channel].octrl[ot].ptt_invert = 1; + } + else { + p_audio_config->achan[channel].octrl[ot].out_gpio_num = atoi(t); + p_audio_config->achan[channel].octrl[ot].ptt_invert = 0; + } + p_audio_config->achan[channel].octrl[ot].ptt_method = PTT_METHOD_GPIO; +#endif + } + else if (strcasecmp(t, "LPT") == 0) { + +/* Parallel printer case, x86 Linux only. */ + +#if ( defined(__i386__) || defined(__x86_64__) ) && ( defined(__linux__) || defined(__unix__) ) + + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file line %d: Missing LPT bit number for %s.\n", line, otname); + continue; + } + + if (*t == '-') { + p_audio_config->achan[channel].octrl[ot].ptt_lpt_bit = atoi(t+1); + p_audio_config->achan[channel].octrl[ot].ptt_invert = 1; + } + else { + p_audio_config->achan[channel].octrl[ot].ptt_lpt_bit = atoi(t); + p_audio_config->achan[channel].octrl[ot].ptt_invert = 0; + } + p_audio_config->achan[channel].octrl[ot].ptt_method = PTT_METHOD_LPT; +#else + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file line %d: %s with LPT is only available on x86 Linux.\n", line, otname); +#endif + } + else if (strcasecmp(t, "RIG") == 0) { +#ifdef USE_HAMLIB + + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file line %d: Missing model number for hamlib.\n", line); + continue; + } + if (strcasecmp(t, "AUTO") == 0) { + p_audio_config->achan[channel].octrl[ot].ptt_model = -1; + } + else { + if ( ! alldigits(t)) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file line %d: A rig number, not a name, is required here.\n", line); + dw_printf ("For example, if you have a Yaesu FT-847, specify 101.\n"); + dw_printf ("See https://github.com/Hamlib/Hamlib/wiki/Supported-Radios for more details.\n"); + continue; + } + int n = atoi(t); + if (n < 1 || n > 9999) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file line %d: Unreasonable model number %d for hamlib.\n", line, n); + continue; + } + p_audio_config->achan[channel].octrl[ot].ptt_model = n; + } + + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file line %d: Missing port for hamlib.\n", line); + continue; + } + strlcpy (p_audio_config->achan[channel].octrl[ot].ptt_device, t, sizeof(p_audio_config->achan[channel].octrl[ot].ptt_device)); + + // Optional serial port rate for CAT control PTT. + + t = split(NULL,0); + if (t != NULL) { + if ( ! alldigits(t)) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file line %d: An optional number is required here for CAT serial port speed: %s\n", line, t); + continue; + } + int n = atoi(t); + p_audio_config->achan[channel].octrl[ot].ptt_rate = n; + } + + t = split(NULL,0); + if (t != NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file line %d: %s was not expected after model & port for hamlib.\n", line, t); + } + + p_audio_config->achan[channel].octrl[ot].ptt_method = PTT_METHOD_HAMLIB; + +#else +#if __WIN32__ + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file line %d: Windows version of direwolf does not support HAMLIB.\n", line); + exit (EXIT_FAILURE); +#else + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file line %d: %s with RIG is only available when hamlib support is enabled.\n", line, otname); + dw_printf ("You must rebuild direwolf with hamlib support.\n"); + dw_printf ("See User Guide for details.\n"); +#endif + +#endif + } + else if (strcasecmp(t, "CM108") == 0) { + +/* CM108 - GPIO of USB sound card. case, Linux and Windows only. */ + +#if USE_CM108 + + if (ot != OCTYPE_PTT) { + // Future project: Allow DCD and CON via the same device. + // This gets more complicated because we can't selectively change a single GPIO bit. + // We would need to keep track of what is currently there, change one bit, in our local + // copy of the status and then write out the byte for all of the pins. + // Let's keep it simple with just PTT for the first stab at this. + + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file line %d: PTT CM108 option is only valid for PTT, not %s.\n", line, otname); + continue; + } + + p_audio_config->achan[channel].octrl[ot].out_gpio_num = 3; // All known designs use GPIO 3. + // User can override for special cases. + p_audio_config->achan[channel].octrl[ot].ptt_invert = 0; // High for transmit. + strcpy (p_audio_config->achan[channel].octrl[ot].ptt_device, ""); + + // Try to find PTT device for audio output device. + // Simplifiying assumption is that we have one radio per USB Audio Adapter. + // Failure at this point is not an error. + // See if config file sets it explicitly before complaining. + + cm108_find_ptt (p_audio_config->adev[ACHAN2ADEV(channel)].adevice_out, + p_audio_config->achan[channel].octrl[ot].ptt_device, + (int)sizeof(p_audio_config->achan[channel].octrl[ot].ptt_device)); + + while ((t = split(NULL,0)) != NULL) { + if (*t == '-') { + p_audio_config->achan[channel].octrl[ot].out_gpio_num = atoi(t+1); + p_audio_config->achan[channel].octrl[ot].ptt_invert = 1; + } + else if (isdigit(*t)) { + p_audio_config->achan[channel].octrl[ot].out_gpio_num = atoi(t); + p_audio_config->achan[channel].octrl[ot].ptt_invert = 0; + } +#if __WIN32__ + else if (*t == '\\') { + strlcpy (p_audio_config->achan[channel].octrl[ot].ptt_device, t, sizeof(p_audio_config->achan[channel].octrl[ot].ptt_device)); + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file line %d: Found \"%s\" when expecting GPIO number or device name like \\\\?\\hid#vid_0d8c&... .\n", line, t); + continue; + } +#else + else if (*t == '/') { + strlcpy (p_audio_config->achan[channel].octrl[ot].ptt_device, t, sizeof(p_audio_config->achan[channel].octrl[ot].ptt_device)); + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file line %d: Found \"%s\" when expecting GPIO number or device name like /dev/hidraw1.\n", line, t); + continue; + } +#endif + } + if (p_audio_config->achan[channel].octrl[ot].out_gpio_num < 1 || p_audio_config->achan[channel].octrl[ot].out_gpio_num > 8) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file line %d: CM108 GPIO number %d is not in range of 1 thru 8.\n", line, + p_audio_config->achan[channel].octrl[ot].out_gpio_num); + continue; + } + if (strlen(p_audio_config->achan[channel].octrl[ot].ptt_device) == 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file line %d: Could not determine USB Audio GPIO PTT device for audio output %s.\n", line, + p_audio_config->adev[ACHAN2ADEV(channel)].adevice_out); +#if __WIN32__ + dw_printf ("You must explicitly mention a HID path.\n"); +#else + dw_printf ("You must explicitly mention a device name such as /dev/hidraw1.\n"); +#endif + dw_printf ("Run \"cm108\" utility to get a list.\n"); + dw_printf ("See Interface Guide for details.\n"); + continue; + } + p_audio_config->achan[channel].octrl[ot].ptt_method = PTT_METHOD_CM108; + +#else + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file line %d: %s with CM108 is only available when USB Audio GPIO support is enabled.\n", line, otname); + dw_printf ("You must rebuild direwolf with CM108 Audio Adapter GPIO PTT support.\n"); + dw_printf ("See Interface Guide for details.\n"); + rtfm(); + exit (EXIT_FAILURE); +#endif + } + else { + +/* serial port case. */ + + strlcpy (p_audio_config->achan[channel].octrl[ot].ptt_device, t, sizeof(p_audio_config->achan[channel].octrl[ot].ptt_device)); + + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file line %d: Missing RTS or DTR after %s device name.\n", + line, otname); + continue; + } + + if (strcasecmp(t, "rts") == 0) { + p_audio_config->achan[channel].octrl[ot].ptt_line = PTT_LINE_RTS; + p_audio_config->achan[channel].octrl[ot].ptt_invert = 0; + } + else if (strcasecmp(t, "dtr") == 0) { + p_audio_config->achan[channel].octrl[ot].ptt_line = PTT_LINE_DTR; + p_audio_config->achan[channel].octrl[ot].ptt_invert = 0; + } + else if (strcasecmp(t, "-rts") == 0) { + p_audio_config->achan[channel].octrl[ot].ptt_line = PTT_LINE_RTS; + p_audio_config->achan[channel].octrl[ot].ptt_invert = 1; + } + else if (strcasecmp(t, "-dtr") == 0) { + p_audio_config->achan[channel].octrl[ot].ptt_line = PTT_LINE_DTR; + p_audio_config->achan[channel].octrl[ot].ptt_invert = 1; + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file line %d: Expected RTS or DTR after %s device name.\n", + line, otname); + continue; + } + + + p_audio_config->achan[channel].octrl[ot].ptt_method = PTT_METHOD_SERIAL; + + + /* In version 1.2, we allow a second one for same serial port. */ + /* Some interfaces want the two control lines driven with opposite polarity. */ + /* e.g. PTT COM1 RTS -DTR */ + + t = split(NULL,0); + if (t != NULL) { + + if (strcasecmp(t, "rts") == 0) { + p_audio_config->achan[channel].octrl[ot].ptt_line2 = PTT_LINE_RTS; + p_audio_config->achan[channel].octrl[ot].ptt_invert2 = 0; + } + else if (strcasecmp(t, "dtr") == 0) { + p_audio_config->achan[channel].octrl[ot].ptt_line2 = PTT_LINE_DTR; + p_audio_config->achan[channel].octrl[ot].ptt_invert2 = 0; + } + else if (strcasecmp(t, "-rts") == 0) { + p_audio_config->achan[channel].octrl[ot].ptt_line2 = PTT_LINE_RTS; + p_audio_config->achan[channel].octrl[ot].ptt_invert2 = 1; + } + else if (strcasecmp(t, "-dtr") == 0) { + p_audio_config->achan[channel].octrl[ot].ptt_line2 = PTT_LINE_DTR; + p_audio_config->achan[channel].octrl[ot].ptt_invert2 = 1; + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file line %d: Expected RTS or DTR after first RTS or DTR.\n", + line); + continue; + } + + /* Would not make sense to specify the same one twice. */ + + if (p_audio_config->achan[channel].octrl[ot].ptt_line == p_audio_config->achan[channel].octrl[ot].ptt_line2) { + dw_printf ("Config file line %d: Doesn't make sense to specify the some control line twice.\n", + line); + } + + } /* end of second serial port control line. */ + } /* end of serial port case. */ + + } /* end of PTT, DCD, CON */ + +/* + * INPUTS + * + * TXINH - TX holdoff input + * + * TXINH GPIO [-]gpio-num (only type supported so far) + */ + + else if (strcasecmp(t, "TXINH") == 0) { + char itname[8]; + + strlcpy (itname, "TXINH", sizeof(itname)); + + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file line %d: Missing input type name for %s command.\n", line, itname); + continue; + } + + if (strcasecmp(t, "GPIO") == 0) { + +#if __WIN32__ + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file line %d: %s with GPIO is only available on Linux.\n", line, itname); +#else + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file line %d: Missing GPIO number for %s.\n", line, itname); + continue; + } + + if (*t == '-') { + p_audio_config->achan[channel].ictrl[ICTYPE_TXINH].in_gpio_num = atoi(t+1); + p_audio_config->achan[channel].ictrl[ICTYPE_TXINH].invert = 1; + } + else { + p_audio_config->achan[channel].ictrl[ICTYPE_TXINH].in_gpio_num = atoi(t); + p_audio_config->achan[channel].ictrl[ICTYPE_TXINH].invert = 0; + } + p_audio_config->achan[channel].ictrl[ICTYPE_TXINH].method = PTT_METHOD_GPIO; +#endif + } + } + + +/* + * DWAIT n - Extra delay for receiver squelch. n = 10 mS units. + */ + + else if (strcasecmp(t, "DWAIT") == 0) { + int n; + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing delay time for DWAIT command.\n", line); + continue; + } + n = atoi(t); + if (n >= 0 && n <= 255) { + p_audio_config->achan[channel].dwait = n; + } + else { + p_audio_config->achan[channel].dwait = DEFAULT_DWAIT; + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Invalid delay time for DWAIT. Using %d.\n", + line, p_audio_config->achan[channel].dwait); + } + } + +/* + * SLOTTIME n - For non-digipeat transmit delay timing. n = 10 mS units. + */ + + else if (strcasecmp(t, "SLOTTIME") == 0) { + int n; + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing delay time for SLOTTIME command.\n", line); + continue; + } + n = atoi(t); + if (n >= 0 && n <= 255) { + p_audio_config->achan[channel].slottime = n; + } + else { + p_audio_config->achan[channel].slottime = DEFAULT_SLOTTIME; + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Invalid delay time for persist algorithm. Using %d.\n", + line, p_audio_config->achan[channel].slottime); + } + } + +/* + * PERSIST - For non-digipeat transmit delay timing. + */ + + else if (strcasecmp(t, "PERSIST") == 0) { + int n; + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing probability for PERSIST command.\n", line); + continue; + } + n = atoi(t); + if (n >= 0 && n <= 255) { + p_audio_config->achan[channel].persist = n; + } + else { + p_audio_config->achan[channel].persist = DEFAULT_PERSIST; + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Invalid probability for persist algorithm. Using %d.\n", + line, p_audio_config->achan[channel].persist); + } + } + +/* + * TXDELAY n - For transmit delay timing. n = 10 mS units. + */ + + else if (strcasecmp(t, "TXDELAY") == 0) { + int n; + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing time for TXDELAY command.\n", line); + continue; + } + n = atoi(t); + if (n >= 0 && n <= 255) { + p_audio_config->achan[channel].txdelay = n; + } + else { + p_audio_config->achan[channel].txdelay = DEFAULT_TXDELAY; + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Invalid time for transmit delay. Using %d.\n", + line, p_audio_config->achan[channel].txdelay); + } + } + +/* + * TXTAIL n - For transmit timing. n = 10 mS units. + */ + + else if (strcasecmp(t, "TXTAIL") == 0) { + int n; + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing time for TXTAIL command.\n", line); + continue; + } + n = atoi(t); + if (n >= 0 && n <= 255) { + p_audio_config->achan[channel].txtail = n; + } + else { + p_audio_config->achan[channel].txtail = DEFAULT_TXTAIL; + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Invalid time for transmit timing. Using %d.\n", + line, p_audio_config->achan[channel].txtail); + } + } + +/* + * FULLDUP {on|off} - Full Duplex + */ + else if (strcasecmp(t, "FULLDUP") == 0) { + + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing parameter for FULLDUP command. Expecting ON or OFF.\n", line); + continue; + } + if (strcasecmp(t, "ON") == 0) { + p_audio_config->achan[channel].fulldup = 1; + } + else if (strcasecmp(t, "OFF") == 0) { + p_audio_config->achan[channel].fulldup = 0; + } + else { + p_audio_config->achan[channel].fulldup = 0; + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Expected ON or OFF for FULLDUP.\n", line); + } + } + +/* + * SPEECH script + * + * Specify script for text-to-speech function. + */ + + else if (strcasecmp(t, "SPEECH") == 0) { + + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing script for Text-to-Speech function.\n", line); + continue; + } + + /* See if we can run it. */ + + if (xmit_speak_it(t, -1, " ") == 0) { + if (strlcpy (p_audio_config->tts_script, t, sizeof(p_audio_config->tts_script)) >= sizeof(p_audio_config->tts_script)) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Script for text-to-speech function is too long.\n", line); + } + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Error trying to run Text-to-Speech function.\n", line); + continue; + } + } + +/* + * FX25TX n - Enable FX.25 transmission. Default off. + * 0 = off, 1 = auto mode, others are suggestions for testing + * or special cases. 16, 32, 64 is number of parity bytes to add. + * Also set by "-X n" command line option. + * V1.7 changed from global to per-channel setting. + */ + + else if (strcasecmp(t, "FX25TX") == 0) { + int n; + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing FEC mode for FX25TX command.\n", line); + continue; + } + n = atoi(t); + if (n >= 0 && n < 200) { + p_audio_config->achan[channel].fx25_strength = n; + p_audio_config->achan[channel].layer2_xmit = LAYER2_FX25; + } + else { + p_audio_config->achan[channel].fx25_strength = 1; + p_audio_config->achan[channel].layer2_xmit = LAYER2_FX25; + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Unreasonable value for FX.25 transmission mode. Using %d.\n", + line, p_audio_config->achan[channel].fx25_strength); + } + } + +/* + * FX25AUTO n - Enable Automatic use of FX.25 for connected mode. + * Automatically enable, for that session only, when an identical + * frame is sent more than this number of times. + * Default 5 based on half of default RETRY. + * 0 to disable feature. + * Current a global setting. Could be per channel someday. + */ + + else if (strcasecmp(t, "FX25AUTO") == 0) { + int n; + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing count for FX25AUTO command.\n", line); + continue; + } + n = atoi(t); + if (n >= 0 && n < 20) { + p_audio_config->fx25_auto_enable = n; + } + else { + p_audio_config->fx25_auto_enable = AX25_N2_RETRY_DEFAULT / 2; + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Unreasonable count for connected mode automatic FX.25. Using %d.\n", + line, p_audio_config->fx25_auto_enable); + } + } + +/* + * IL2PTX [ + - ] [ 0 1 ] - Enable IL2P transmission. Default off. + * "+" means normal polarity. Redundant since it is the default. + * (command line -I for first channel) + * "-" means inverted polarity. Do not use for 1200 bps. + * (command line -i for first channel) + * "0" means weak FEC. Not recommended. + * "1" means stronger FEC. "Max FEC." Default if not specified. + */ + + else if (strcasecmp(t, "IL2PTX") == 0) { + + p_audio_config->achan[channel].layer2_xmit = LAYER2_IL2P; + p_audio_config->achan[channel].il2p_max_fec = 1; + p_audio_config->achan[channel].il2p_invert_polarity = 0; + + while ((t = split(NULL,0)) != NULL) { + for (char *c = t; *c != '\0'; c++) { + switch (*c) { + case '+': + p_audio_config->achan[channel].il2p_invert_polarity = 0; + break; + case '-': + p_audio_config->achan[channel].il2p_invert_polarity = 1; + break; + case '0': + p_audio_config->achan[channel].il2p_max_fec = 0; + break; + case '1': + p_audio_config->achan[channel].il2p_max_fec = 1; + break; + default: + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Invalid parameter '%c' fol IL2PTX command.\n", line, *c); + continue; + break; + } + } + } + } + + +/* + * ==================== APRS Digipeater parameters ==================== + */ + +/* + * DIGIPEAT from-chan to-chan alias-pattern wide-pattern [ OFF|DROP|MARK|TRACE | ATGP=alias ] + * + * ATGP is an ugly hack for the specific need of ATGP which needs more that 8 digipeaters. + * DO NOT put this in the User Guide. On a need to know basis. + */ + + else if (strcasecmp(t, "DIGIPEAT") == 0 || strcasecmp(t, "DIGIPEATER") == 0) { + int from_chan, to_chan; + int e; + char message[100]; + + + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: Missing FROM-channel on line %d.\n", line); + continue; + } + if ( ! alldigits(t)) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file, line %d: '%s' is not allowed for FROM-channel. It must be a number.\n", + line, t); + continue; + } + from_chan = atoi(t); + if (from_chan < 0 || from_chan >= MAX_CHANS) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: FROM-channel must be in range of 0 to %d on line %d.\n", + MAX_CHANS-1, line); + continue; + } + + // Channels specified must be radio channels or network TNCs. + + if (p_audio_config->chan_medium[from_chan] != MEDIUM_RADIO && + p_audio_config->chan_medium[from_chan] != MEDIUM_NETTNC) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file, line %d: FROM-channel %d is not valid.\n", + line, from_chan); + continue; + } + + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: Missing TO-channel on line %d.\n", line); + continue; + } + if ( ! alldigits(t)) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file, line %d: '%s' is not allowed for TO-channel. It must be a number.\n", + line, t); + continue; + } + to_chan = atoi(t); + if (to_chan < 0 || to_chan >= MAX_CHANS) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: TO-channel must be in range of 0 to %d on line %d.\n", + MAX_CHANS-1, line); + continue; + } + + if (p_audio_config->chan_medium[to_chan] != MEDIUM_RADIO && + p_audio_config->chan_medium[to_chan] != MEDIUM_NETTNC) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file, line %d: TO-channel %d is not valid.\n", + line, to_chan); + continue; + } + + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: Missing alias pattern on line %d.\n", line); + continue; + } + e = regcomp (&(p_digi_config->alias[from_chan][to_chan]), t, REG_EXTENDED|REG_NOSUB); + if (e != 0) { + regerror (e, &(p_digi_config->alias[from_chan][to_chan]), message, sizeof(message)); + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: Invalid alias matching pattern on line %d:\n%s\n", + line, message); + continue; + } + + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: Missing wide pattern on line %d.\n", line); + continue; + } + e = regcomp (&(p_digi_config->wide[from_chan][to_chan]), t, REG_EXTENDED|REG_NOSUB); + if (e != 0) { + regerror (e, &(p_digi_config->wide[from_chan][to_chan]), message, sizeof(message)); + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: Invalid wide matching pattern on line %d:\n%s\n", + line, message); + continue; + } + + p_digi_config->enabled[from_chan][to_chan] = 1; + p_digi_config->preempt[from_chan][to_chan] = PREEMPT_OFF; + + t = split(NULL,0); + if (t != NULL) { + if (strcasecmp(t, "OFF") == 0) { + p_digi_config->preempt[from_chan][to_chan] = PREEMPT_OFF; + t = split(NULL,0); + } + else if (strcasecmp(t, "DROP") == 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file, line %d: Preemptive digipeating DROP option is discouraged.\n", line); + dw_printf ("It can create a via path which is misleading about the actual path taken.\n"); + dw_printf ("PREEMPT is the best choice for this feature.\n"); + p_digi_config->preempt[from_chan][to_chan] = PREEMPT_DROP; + t = split(NULL,0); + } + else if (strcasecmp(t, "MARK") == 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file, line %d: Preemptive digipeating MARK option is discouraged.\n", line); + dw_printf ("It can create a via path which is misleading about the actual path taken.\n"); + dw_printf ("PREEMPT is the best choice for this feature.\n"); + p_digi_config->preempt[from_chan][to_chan] = PREEMPT_MARK; + t = split(NULL,0); + } + else if ((strcasecmp(t, "TRACE") == 0) || (strncasecmp(t, "PREEMPT", 7) == 0)){ + p_digi_config->preempt[from_chan][to_chan] = PREEMPT_TRACE; + t = split(NULL,0); + } + else if (strncasecmp(t, "ATGP=", 5) == 0) { + strlcpy (p_digi_config->atgp[from_chan][to_chan], t+5, sizeof(p_digi_config->atgp[from_chan][to_chan]));; + t = split(NULL,0); + } + } + + if (t != NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file, line %d: Found \"%s\" where end of line was expected.\n", line, t); + } + } + +/* + * DEDUPE - Time to suppress digipeating of duplicate APRS packets. + */ + + else if (strcasecmp(t, "DEDUPE") == 0) { + int n; + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing time for DEDUPE command.\n", line); + continue; + } + n = atoi(t); + if (n >= 0 && n < 600) { + p_digi_config->dedupe_time = n; + } + else { + p_digi_config->dedupe_time = DEFAULT_DEDUPE; + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Unreasonable value for dedupe time. Using %d.\n", + line, p_digi_config->dedupe_time); + } + } + +/* + * REGEN - Signal regeneration. + */ + + else if (strcasecmp(t, "regen") == 0) { + int from_chan, to_chan; + + + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: Missing FROM-channel on line %d.\n", line); + continue; + } + if ( ! alldigits(t)) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file, line %d: '%s' is not allowed for FROM-channel. It must be a number.\n", + line, t); + continue; + } + from_chan = atoi(t); + if (from_chan < 0 || from_chan >= MAX_CHANS) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: FROM-channel must be in range of 0 to %d on line %d.\n", + MAX_CHANS-1, line); + continue; + } + + // Only radio channels are valid for regenerate. + + if (p_audio_config->chan_medium[from_chan] != MEDIUM_RADIO) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file, line %d: FROM-channel %d is not valid.\n", + line, from_chan); + continue; + } + + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: Missing TO-channel on line %d.\n", line); + continue; + } + if ( ! alldigits(t)) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file, line %d: '%s' is not allowed for TO-channel. It must be a number.\n", + line, t); + continue; + } + to_chan = atoi(t); + if (to_chan < 0 || to_chan >= MAX_CHANS) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: TO-channel must be in range of 0 to %d on line %d.\n", + MAX_CHANS-1, line); + continue; + } + if (p_audio_config->chan_medium[to_chan] != MEDIUM_RADIO) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file, line %d: TO-channel %d is not valid.\n", + line, to_chan); + continue; + } + + + p_digi_config->regen[from_chan][to_chan] = 1; + + } + + +/* + * ==================== Connected Digipeater parameters ==================== + */ + +/* + * CDIGIPEAT from-chan to-chan [ alias-pattern ] + */ + + else if (strcasecmp(t, "CDIGIPEAT") == 0 || strcasecmp(t, "CDIGIPEATER") == 0) { + int from_chan, to_chan; + int e; + char message[100]; + + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: Missing FROM-channel on line %d.\n", line); + continue; + } + if ( ! alldigits(t)) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file, line %d: '%s' is not allowed for FROM-channel. It must be a number.\n", + line, t); + continue; + } + from_chan = atoi(t); + if (from_chan < 0 || from_chan >= MAX_CHANS) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: FROM-channel must be in range of 0 to %d on line %d.\n", + MAX_CHANS-1, line); + continue; + } + + // For connected mode Link layer, only internal modems should be allowed. + // A network TNC probably would not provide information about channel status. + // There is discussion about this in the document called + // Why-is-9600-only-twice-as-fast-as-1200.pdf + + if (p_audio_config->chan_medium[from_chan] != MEDIUM_RADIO) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file, line %d: FROM-channel %d is not valid.\n", + line, from_chan); + dw_printf ("Only internal modems can be used for connected mode packet.\n"); + continue; + } + + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: Missing TO-channel on line %d.\n", line); + continue; + } + if ( ! alldigits(t)) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file, line %d: '%s' is not allowed for TO-channel. It must be a number.\n", + line, t); + continue; + } + to_chan = atoi(t); + if (to_chan < 0 || to_chan >= MAX_CHANS) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: TO-channel must be in range of 0 to %d on line %d.\n", + MAX_CHANS-1, line); + continue; + } + if (p_audio_config->chan_medium[to_chan] != MEDIUM_RADIO) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file, line %d: TO-channel %d is not valid.\n", + line, to_chan); + dw_printf ("Only internal modems can be used for connected mode packet.\n"); + continue; + } + + t = split(NULL,0); + if (t != NULL) { + e = regcomp (&(p_cdigi_config->alias[from_chan][to_chan]), t, REG_EXTENDED|REG_NOSUB); + if (e == 0) { + p_cdigi_config->has_alias[from_chan][to_chan] = 1; + } + else { + regerror (e, &(p_cdigi_config->alias[from_chan][to_chan]), message, sizeof(message)); + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: Invalid alias matching pattern on line %d:\n%s\n", + line, message); + continue; + } + t = split(NULL,0); + } + + p_cdigi_config->enabled[from_chan][to_chan] = 1; + + if (t != NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file, line %d: Found \"%s\" where end of line was expected.\n", line, t); + } + } + + +/* + * ==================== Packet Filtering for APRS digipeater or IGate ==================== + */ + +/* + * FILTER from-chan to-chan filter_specification_expression + * FILTER from-chan IG filter_specification_expression + * FILTER IG to-chan filter_specification_expression + * + * + * Note that we have three different config file filter commands: + * + * FILTER - Originally for APRS digipeating but later enhanced + * to include IGate client side. Maybe it should be + * renamed AFILTER to make it clearer after adding CFILTER. + * + * Both internal modem and NET TNC channels allowed here. + * "IG" should be used for the IGate, NOT a virtual channel + * assigned to it. + * + * CFILTER - Similar for connected moded digipeater. + * + * Only internal modems can be used because they provide + * information about radio channel status. + * A remote network TNC might not provide the necessary + * status for correct operation. + * There is discussion about this in the document called + * Why-is-9600-only-twice-as-fast-as-1200.pdf + * + * IGFILTER - APRS-IS (IGate) server side - completely different. + * I'm not happy with this name because IG sounds like IGate + * which is really the client side. More comments later. + * Maybe it should be called subscribe or something like that + * because the subscriptions are cumulative. + */ + + else if (strcasecmp(t, "FILTER") == 0) { + int from_chan, to_chan; + + + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: Missing FROM-channel on line %d.\n", line); + continue; + } + if (*t == 'i' || *t == 'I') { + from_chan = MAX_CHANS; + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: FILTER IG ... on line %d.\n", line); + dw_printf ("Warning! Don't mess with IS>RF filtering unless you are an expert and have an unusual situation.\n"); + dw_printf ("Warning! The default is fine for nearly all situations.\n"); + dw_printf ("Warning! Be sure to read carefully and understand Successful-APRS-Gateway-Operation.pdf .\n"); + dw_printf ("Warning! If you insist, be sure to add \" | i/180 \" so you don't break messaging.\n"); + } + else { + from_chan = isdigit(*t) ? atoi(t) : -999; + if (from_chan < 0 || from_chan >= MAX_CHANS) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: Filter FROM-channel must be in range of 0 to %d or \"IG\" on line %d.\n", + MAX_CHANS-1, line); + continue; + } + + if (p_audio_config->chan_medium[from_chan] != MEDIUM_RADIO && + p_audio_config->chan_medium[from_chan] != MEDIUM_NETTNC) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file, line %d: FROM-channel %d is not valid.\n", + line, from_chan); + continue; + } + if (p_audio_config->chan_medium[from_chan] == MEDIUM_IGATE) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file, line %d: Use 'IG' rather than %d for FROM-channel.\n", + line, from_chan); + continue; + } + } + + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: Missing TO-channel on line %d.\n", line); + continue; + } + if (*t == 'i' || *t == 'I') { + to_chan = MAX_CHANS; + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: FILTER ... IG ... on line %d.\n", line); + dw_printf ("Warning! Don't mess with RF>IS filtering unless you are an expert and have an unusual situation.\n"); + dw_printf ("Warning! Expected behavior is for everything to go from RF to IS.\n"); + dw_printf ("Warning! The default is fine for nearly all situations.\n"); + dw_printf ("Warning! Be sure to read carefully and understand Successful-APRS-Gateway-Operation.pdf .\n"); + } + else { + to_chan = isdigit(*t) ? atoi(t) : -999; + if (to_chan < 0 || to_chan >= MAX_CHANS) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: Filter TO-channel must be in range of 0 to %d or \"IG\" on line %d.\n", + MAX_CHANS-1, line); + continue; + } + if (p_audio_config->chan_medium[to_chan] != MEDIUM_RADIO && + p_audio_config->chan_medium[to_chan] != MEDIUM_NETTNC) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file, line %d: TO-channel %d is not valid.\n", + line, to_chan); + continue; + } + if (p_audio_config->chan_medium[to_chan] == MEDIUM_IGATE) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file, line %d: Use 'IG' rather than %d for TO-channel.\n", + line, to_chan); + continue; + } + } + + t = split(NULL,1); /* Take rest of line including spaces. */ + + if (t == NULL) { + t = " "; /* Empty means permit nothing. */ + } + + if (p_digi_config->filter_str[from_chan][to_chan] != NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file, line %d: Replacing previous filter for same from/to pair:\n %s\n", + line, p_digi_config->filter_str[from_chan][to_chan]); + free (p_digi_config->filter_str[from_chan][to_chan]); + p_digi_config->filter_str[from_chan][to_chan] = NULL; + } + + p_digi_config->filter_str[from_chan][to_chan] = strdup(t); + +//TODO: Do a test run to see errors now instead of waiting. + + } + + +/* + * ==================== Packet Filtering for connected digipeater ==================== + */ + +/* + * CFILTER from-chan to-chan filter_specification_expression + * + * Why did I put this here? + * What would be a useful use case? Perhaps block by source or destination? + */ + + else if (strcasecmp(t, "CFILTER") == 0) { + int from_chan, to_chan; + + + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: Missing FROM-channel on line %d.\n", line); + continue; + } + + from_chan = isdigit(*t) ? atoi(t) : -999; + if (from_chan < 0 || from_chan >= MAX_CHANS) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: Filter FROM-channel must be in range of 0 to %d on line %d.\n", + MAX_CHANS-1, line); + continue; + } + + // DO NOT allow a network TNC here. + // Must be internal modem to have necessary knowledge about channel status. + + if (p_audio_config->chan_medium[from_chan] != MEDIUM_RADIO) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file, line %d: FROM-channel %d is not valid.\n", + line, from_chan); + continue; + } + + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: Missing TO-channel on line %d.\n", line); + continue; + } + + to_chan = isdigit(*t) ? atoi(t) : -999; + if (to_chan < 0 || to_chan >= MAX_CHANS) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: Filter TO-channel must be in range of 0 to %d on line %d.\n", + MAX_CHANS-1, line); + continue; + } + if (p_audio_config->chan_medium[to_chan] != MEDIUM_RADIO) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file, line %d: TO-channel %d is not valid.\n", + line, to_chan); + continue; + } + + t = split(NULL,1); /* Take rest of line including spaces. */ + + if (t == NULL) { + t = " "; /* Empty means permit nothing. */ + } + + p_cdigi_config->cfilter_str[from_chan][to_chan] = strdup(t); + +//TODO1.2: Do a test run to see errors now instead of waiting. + + } + + +/* + * ==================== APRStt gateway ==================== + */ + +/* + * TTCORRAL - How to handle unknown positions + * + * TTCORRAL latitude longitude offset-or-ambiguity + */ + + else if (strcasecmp(t, "TTCORRAL") == 0) { + + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing latitude for TTCORRAL command.\n", line); + continue; + } + p_tt_config->corral_lat = parse_ll(t,LAT,line); + + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing longitude for TTCORRAL command.\n", line); + continue; + } + p_tt_config->corral_lon = parse_ll(t,LON,line); + + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing longitude for TTCORRAL command.\n", line); + continue; + } + p_tt_config->corral_offset = parse_ll(t,LAT,line); + if (p_tt_config->corral_offset == 1 || + p_tt_config->corral_offset == 2 || + p_tt_config->corral_offset == 3) { + p_tt_config->corral_ambiguity = p_tt_config->corral_offset; + p_tt_config->corral_offset = 0; + } + + //dw_printf ("DEBUG: corral %f %f %f %d\n", p_tt_config->corral_lat, + // p_tt_config->corral_lon, p_tt_config->corral_offset, p_tt_config->corral_ambiguity); + } + +/* + * TTPOINT - Define a point represented by touch tone sequence. + * + * TTPOINT pattern latitude longitude + */ + else if (strcasecmp(t, "TTPOINT") == 0) { + + struct ttloc_s *tl; + int j; + + assert (p_tt_config->ttloc_size >= 2); + assert (p_tt_config->ttloc_len >= 0 && p_tt_config->ttloc_len <= p_tt_config->ttloc_size); + + // Should make this a function/macro instead of repeating code. + /* Allocate new space, but first, if already full, make larger. */ + if (p_tt_config->ttloc_len == p_tt_config->ttloc_size) { + p_tt_config->ttloc_size += p_tt_config->ttloc_size / 2; + p_tt_config->ttloc_ptr = realloc (p_tt_config->ttloc_ptr, sizeof(struct ttloc_s) * p_tt_config->ttloc_size); + } + p_tt_config->ttloc_len++; + assert (p_tt_config->ttloc_len >= 0 && p_tt_config->ttloc_len <= p_tt_config->ttloc_size); + + tl = &(p_tt_config->ttloc_ptr[p_tt_config->ttloc_len-1]); + tl->type = TTLOC_POINT; + strlcpy(tl->pattern, "", sizeof(tl->pattern)); + tl->point.lat = 0; + tl->point.lon = 0; + + /* Pattern: B and digits */ + + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing pattern for TTPOINT command.\n", line); + continue; + } + strlcpy (tl->pattern, t, sizeof(tl->pattern)); + + if (t[0] != 'B') { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: TTPOINT pattern must begin with upper case 'B'.\n", line); + } + for (j=1; j<(int)(strlen(t)); j++) { + if ( ! isdigit(t[j])) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: TTPOINT pattern must be B and digits only.\n", line); + } + } + + /* Latitude */ + + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing latitude for TTPOINT command.\n", line); + continue; + } + tl->point.lat = parse_ll(t,LAT,line); + + /* Longitude */ + + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing longitude for TTPOINT command.\n", line); + continue; + } + tl->point.lon = parse_ll(t,LON,line); + + /* temp debugging */ + + //for (j=0; jttloc_len; j++) { + // dw_printf ("debug ttloc %d/%d %s\n", j, p_tt_config->ttloc_size, + // p_tt_config->ttloc_ptr[j].pattern); + //} + } + +/* + * TTVECTOR - Touch tone location with bearing and distance. + * + * TTVECTOR pattern latitude longitude scale unit + */ + else if (strcasecmp(t, "TTVECTOR") == 0) { + + struct ttloc_s *tl; + int j; + double scale; + double meters; + + assert (p_tt_config->ttloc_size >= 2); + assert (p_tt_config->ttloc_len >= 0 && p_tt_config->ttloc_len <= p_tt_config->ttloc_size); + + /* Allocate new space, but first, if already full, make larger. */ + if (p_tt_config->ttloc_len == p_tt_config->ttloc_size) { + p_tt_config->ttloc_size += p_tt_config->ttloc_size / 2; + p_tt_config->ttloc_ptr = realloc (p_tt_config->ttloc_ptr, sizeof(struct ttloc_s) * p_tt_config->ttloc_size); + } + p_tt_config->ttloc_len++; + assert (p_tt_config->ttloc_len >= 0 && p_tt_config->ttloc_len <= p_tt_config->ttloc_size); + + tl = &(p_tt_config->ttloc_ptr[p_tt_config->ttloc_len-1]); + tl->type = TTLOC_VECTOR; + strlcpy(tl->pattern, "", sizeof(tl->pattern)); + tl->vector.lat = 0; + tl->vector.lon = 0; + tl->vector.scale = 1; + + /* Pattern: B5bbbd... */ + + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing pattern for TTVECTOR command.\n", line); + continue; + } + strlcpy (tl->pattern, t, sizeof(tl->pattern)); + + if (t[0] != 'B') { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: TTVECTOR pattern must begin with upper case 'B'.\n", line); + } + if (strncmp(t+1, "5bbb", 4) != 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: TTVECTOR pattern would normally contain \"5bbb\".\n", line); + } + for (j=1; j<(int)(strlen(t)); j++) { + if ( ! isdigit(t[j]) && t[j] != 'b' && t[j] != 'd') { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: TTVECTOR pattern must contain only B, digits, b, and d.\n", line); + } + } + + /* Latitude */ + + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing latitude for TTVECTOR command.\n", line); + continue; + } + tl->vector.lat = parse_ll(t,LAT,line); + + /* Longitude */ + + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing longitude for TTVECTOR command.\n", line); + continue; + } + tl->vector.lon = parse_ll(t,LON,line); + + /* Longitude */ + + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing scale for TTVECTOR command.\n", line); + continue; + } + scale = atof(t); + + /* Unit. */ + + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing unit for TTVECTOR command.\n", line); + continue; + } + meters = 0; + for (j=0; jvector.scale = scale * meters; + + //dw_printf ("ttvector: %f meters\n", tl->vector.scale); + + /* temp debugging */ + + //for (j=0; jttloc_len; j++) { + // dw_printf ("debug ttloc %d/%d %s\n", j, p_tt_config->ttloc_size, + // p_tt_config->ttloc_ptr[j].pattern); + //} + } + +/* + * TTGRID - Define a grid for touch tone locations. + * + * TTGRID pattern min-latitude min-longitude max-latitude max-longitude + */ + else if (strcasecmp(t, "TTGRID") == 0) { + + struct ttloc_s *tl; + int j; + + assert (p_tt_config->ttloc_size >= 2); + assert (p_tt_config->ttloc_len >= 0 && p_tt_config->ttloc_len <= p_tt_config->ttloc_size); + + /* Allocate new space, but first, if already full, make larger. */ + if (p_tt_config->ttloc_len == p_tt_config->ttloc_size) { + p_tt_config->ttloc_size += p_tt_config->ttloc_size / 2; + p_tt_config->ttloc_ptr = realloc (p_tt_config->ttloc_ptr, sizeof(struct ttloc_s) * p_tt_config->ttloc_size); + } + p_tt_config->ttloc_len++; + assert (p_tt_config->ttloc_len >= 0 && p_tt_config->ttloc_len <= p_tt_config->ttloc_size); + + tl = &(p_tt_config->ttloc_ptr[p_tt_config->ttloc_len-1]); + tl->type = TTLOC_GRID; + strlcpy(tl->pattern, "", sizeof(tl->pattern)); + tl->grid.lat0 = 0; + tl->grid.lon0 = 0; + tl->grid.lat9 = 0; + tl->grid.lon9 = 0; + + /* Pattern: B [digit] x... y... */ + + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing pattern for TTGRID command.\n", line); + continue; + } + strlcpy (tl->pattern, t, sizeof(tl->pattern)); + + if (t[0] != 'B') { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: TTGRID pattern must begin with upper case 'B'.\n", line); + } + for (j=1; j<(int)(strlen(t)); j++) { + if ( ! isdigit(t[j]) && t[j] != 'x' && t[j] != 'y') { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: TTGRID pattern must be B, optional digit, xxx, yyy.\n", line); + } + } + + /* Minimum Latitude - all zeros in received data */ + + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing minimum latitude for TTGRID command.\n", line); + continue; + } + tl->grid.lat0 = parse_ll(t,LAT,line); + + /* Minimum Longitude - all zeros in received data */ + + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing minimum longitude for TTGRID command.\n", line); + continue; + } + tl->grid.lon0 = parse_ll(t,LON,line); + + /* Maximum Latitude - all nines in received data */ + + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing maximum latitude for TTGRID command.\n", line); + continue; + } + tl->grid.lat9 = parse_ll(t,LAT,line); + + /* Maximum Longitude - all nines in received data */ + + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing maximum longitude for TTGRID command.\n", line); + continue; + } + tl->grid.lon9 = parse_ll(t,LON,line); + + /* temp debugging */ + + // dw_printf ("CONFIG TTGRID min %f %f\n", tl->grid.lat0, tl->grid.lon0); + // dw_printf ("CONFIG TTGRID max %f %f\n", tl->grid.lat9, tl->grid.lon9); + + //for (j=0; jttloc_len; j++) { + // dw_printf ("debug ttloc %d/%d %s\n", j, p_tt_config->ttloc_size, + // p_tt_config->ttloc_ptr[j].pattern); + //} + } + +/* + * TTUTM - Specify UTM zone for touch tone locations. + * + * TTUTM pattern zone [ scale [ x-offset y-offset ] ] + */ + else if (strcasecmp(t, "TTUTM") == 0) { + + struct ttloc_s *tl; + int j; + double dlat, dlon; + long lerr; + + + assert (p_tt_config->ttloc_size >= 2); + assert (p_tt_config->ttloc_len >= 0 && p_tt_config->ttloc_len <= p_tt_config->ttloc_size); + + /* Allocate new space, but first, if already full, make larger. */ + if (p_tt_config->ttloc_len == p_tt_config->ttloc_size) { + p_tt_config->ttloc_size += p_tt_config->ttloc_size / 2; + p_tt_config->ttloc_ptr = realloc (p_tt_config->ttloc_ptr, sizeof(struct ttloc_s) * p_tt_config->ttloc_size); + } + p_tt_config->ttloc_len++; + assert (p_tt_config->ttloc_len >= 0 && p_tt_config->ttloc_len <= p_tt_config->ttloc_size); + + tl = &(p_tt_config->ttloc_ptr[p_tt_config->ttloc_len-1]); + tl->type = TTLOC_UTM; + strlcpy(tl->pattern, "", sizeof(tl->pattern)); + tl->utm.lzone = 0; + tl->utm.scale = 1; + tl->utm.x_offset = 0; + tl->utm.y_offset = 0; + + /* Pattern: B [digit] x... y... */ + + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing pattern for TTUTM command.\n", line); + p_tt_config->ttloc_len--; + continue; + } + strlcpy (tl->pattern, t, sizeof(tl->pattern)); + + if (t[0] != 'B') { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: TTUTM pattern must begin with upper case 'B'.\n", line); + p_tt_config->ttloc_len--; + continue; + } + for (j=1; j < (int)(strlen(t)); j++) { + if ( ! isdigit(t[j]) && t[j] != 'x' && t[j] != 'y') { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: TTUTM pattern must be B, optional digit, xxx, yyy.\n", line); + // Bail out somehow. continue would match inner for. + } + } + + /* Zone 1 - 60 and optional latitudinal letter. */ + + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing zone for TTUTM command.\n", line); + p_tt_config->ttloc_len--; + continue; + } + + tl->utm.lzone = parse_utm_zone (t, &(tl->utm.latband), &(tl->utm.hemi)); + + /* Optional scale. */ + + t = split(NULL,0); + if (t != NULL) { + + tl->utm.scale = atof(t); + + /* Optional x offset. */ + + t = split(NULL,0); + if (t != NULL) { + + tl->utm.x_offset = atof(t); + + /* Optional y offset. */ + + t = split(NULL,0); + if (t != NULL) { + + tl->utm.y_offset = atof(t); + } + } + } + + /* Practice run to see if conversion might fail later with actual location. */ + + lerr = Convert_UTM_To_Geodetic(tl->utm.lzone, tl->utm.hemi, + tl->utm.x_offset + 5 * tl->utm.scale, + tl->utm.y_offset + 5 * tl->utm.scale, + &dlat, &dlon); + + if (lerr != 0) { + char message [300]; + + utm_error_string (lerr, message); + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Invalid UTM location: \n%s\n", line, message); + p_tt_config->ttloc_len--; + continue; + } + } + +/* + * TTUSNG, TTMGRS - Specify zone/square for touch tone locations. + * + * TTUSNG pattern zone_square + * TTMGRS pattern zone_square + */ + else if (strcasecmp(t, "TTUSNG") == 0 || strcasecmp(t, "TTMGRS") == 0) { + + struct ttloc_s *tl; + int j; + int num_x, num_y; + double lat, lon; + long lerr; + char message[300]; + + assert (p_tt_config->ttloc_size >= 2); + assert (p_tt_config->ttloc_len >= 0 && p_tt_config->ttloc_len <= p_tt_config->ttloc_size); + + /* Allocate new space, but first, if already full, make larger. */ + if (p_tt_config->ttloc_len == p_tt_config->ttloc_size) { + p_tt_config->ttloc_size += p_tt_config->ttloc_size / 2; + p_tt_config->ttloc_ptr = realloc (p_tt_config->ttloc_ptr, sizeof(struct ttloc_s) * p_tt_config->ttloc_size); + } + p_tt_config->ttloc_len++; + assert (p_tt_config->ttloc_len >= 0 && p_tt_config->ttloc_len <= p_tt_config->ttloc_size); + + tl = &(p_tt_config->ttloc_ptr[p_tt_config->ttloc_len-1]); + +// TODO1.2: in progress... + if (strcasecmp(t, "TTMGRS") == 0) { + tl->type = TTLOC_MGRS; + } + else { + tl->type = TTLOC_USNG; + } + strlcpy(tl->pattern, "", sizeof(tl->pattern)); + strlcpy(tl->mgrs.zone, "", sizeof(tl->mgrs.zone)); + + /* Pattern: B [digit] x... y... */ + + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing pattern for TTUSNG/TTMGRS command.\n", line); + p_tt_config->ttloc_len--; + continue; + } + strlcpy (tl->pattern, t, sizeof(tl->pattern)); + + if (t[0] != 'B') { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: TTUSNG/TTMGRS pattern must begin with upper case 'B'.\n", line); + p_tt_config->ttloc_len--; + continue; + } + num_x = 0; + num_y = 0; + for (j=1; j<(int)(strlen(t)); j++) { + if ( ! isdigit(t[j]) && t[j] != 'x' && t[j] != 'y') { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: TTUSNG/TTMGRS pattern must be B, optional digit, xxx, yyy.\n", line); + // Bail out somehow. continue would match inner for. + } + if (t[j] == 'x') num_x++; + if (t[j] == 'y') num_y++; + } + if (num_x < 1 || num_x > 5 || num_x != num_y) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: TTUSNG/TTMGRS must have 1 to 5 x and same number y.\n", line); + p_tt_config->ttloc_len--; + continue; + } + + /* Zone 1 - 60 and optional latitudinal letter. */ + + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing zone & square for TTUSNG/TTMGRS command.\n", line); + p_tt_config->ttloc_len--; + continue; + } + strlcpy (tl->mgrs.zone, t, sizeof(tl->mgrs.zone)); + + /* Try converting it rather do our own error checking. */ + + if (tl->type == TTLOC_MGRS) { + lerr = Convert_MGRS_To_Geodetic (tl->mgrs.zone, &lat, &lon); + } + else { + lerr = Convert_USNG_To_Geodetic (tl->mgrs.zone, &lat, &lon); + } + if (lerr != 0) { + + mgrs_error_string (lerr, message); + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Invalid USNG/MGRS zone & square: %s\n%s\n", line, tl->mgrs.zone, message); + p_tt_config->ttloc_len--; + continue; + } + + /* Should be the end. */ + + t = split(NULL,0); + if (t != NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Unexpected stuff at end ignored: %s\n", line, t); + } + } + +/* + * TTMHEAD - Define pattern to be used for Maidenhead Locator. + * + * TTMHEAD pattern [ prefix ] + * + * Pattern would be B[0-9A-D]xxxx... + * Optional prefix is 10, 6, or 4 digits. + * + * The total number of digts in both must be 4, 6, 10, or 12. + */ + else if (strcasecmp(t, "TTMHEAD") == 0) { + +// TODO1.3: TTMHEAD needs testing. + + struct ttloc_s *tl; + int j; + int k; + int count_x; + int count_other; + + + assert (p_tt_config->ttloc_size >= 2); + assert (p_tt_config->ttloc_len >= 0 && p_tt_config->ttloc_len <= p_tt_config->ttloc_size); + + /* Allocate new space, but first, if already full, make larger. */ + if (p_tt_config->ttloc_len == p_tt_config->ttloc_size) { + p_tt_config->ttloc_size += p_tt_config->ttloc_size / 2; + p_tt_config->ttloc_ptr = realloc (p_tt_config->ttloc_ptr, sizeof(struct ttloc_s) * p_tt_config->ttloc_size); + } + p_tt_config->ttloc_len++; + assert (p_tt_config->ttloc_len > 0 && p_tt_config->ttloc_len <= p_tt_config->ttloc_size); + + tl = &(p_tt_config->ttloc_ptr[p_tt_config->ttloc_len-1]); + tl->type = TTLOC_MHEAD; + strlcpy(tl->pattern, "", sizeof(tl->pattern)); + strlcpy(tl->mhead.prefix, "", sizeof(tl->mhead.prefix)); + + /* Pattern: B, optional additional button, some number of xxxx... for matching */ + + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing pattern for TTMHEAD command.\n", line); + p_tt_config->ttloc_len--; + continue; + } + strlcpy (tl->pattern, t, sizeof(tl->pattern)); + + if (t[0] != 'B') { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: TTMHEAD pattern must begin with upper case 'B'.\n", line); + p_tt_config->ttloc_len--; + continue; + } + + /* Optionally one of 0-9ABCD */ + + if (strchr("ABCD", t[1]) != NULL || isdigit(t[1])) { + j = 2; + } + else { + j = 1; + } + + count_x = 0; + count_other = 0; + for (k = j ; k < (int)(strlen(t)); k++) { + if (t[k] == 'x') count_x++; + else count_other++; + } + + if (count_other != 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: TTMHEAD must have only lower case x to match received data.\n", line); + p_tt_config->ttloc_len--; + continue; + } + + // optional prefix + + t = split(NULL,0); + if (t != NULL) { + char mh[30]; + + strlcpy(tl->mhead.prefix, t, sizeof(tl->mhead.prefix)); + + if (!alldigits(t) || (strlen(t) != 4 && strlen(t) != 6 && strlen(t) != 10)) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: TTMHEAD prefix must be 4, 6, or 10 digits.\n", line); + p_tt_config->ttloc_len--; + continue; + } + if (tt_mhead_to_text(t, 0, mh, sizeof(mh)) != 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: TTMHEAD prefix not a valid DTMF sequence.\n", line); + p_tt_config->ttloc_len--; + continue; + } + } + + k = strlen(tl->mhead.prefix) + count_x; + + if (k != 4 && k != 6 && k != 10 && k != 12 ) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: TTMHEAD prefix and user data must have a total of 4, 6, 10, or 12 digits.\n", line); + p_tt_config->ttloc_len--; + continue; + } + + } + + +/* + * TTSATSQ - Define pattern to be used for Satellite square. + * + * TTSATSQ pattern + * + * Pattern would be B[0-9A-D]xxxx + * + * Must have exactly 4 x. + */ + + else if (strcasecmp(t, "TTSATSQ") == 0) { + +// TODO1.2: TTSATSQ To be continued... + + struct ttloc_s *tl; + int j; + + assert (p_tt_config->ttloc_size >= 2); + assert (p_tt_config->ttloc_len >= 0 && p_tt_config->ttloc_len <= p_tt_config->ttloc_size); + + /* Allocate new space, but first, if already full, make larger. */ + if (p_tt_config->ttloc_len == p_tt_config->ttloc_size) { + p_tt_config->ttloc_size += p_tt_config->ttloc_size / 2; + p_tt_config->ttloc_ptr = realloc (p_tt_config->ttloc_ptr, sizeof(struct ttloc_s) * p_tt_config->ttloc_size); + } + p_tt_config->ttloc_len++; + assert (p_tt_config->ttloc_len > 0 && p_tt_config->ttloc_len <= p_tt_config->ttloc_size); + + tl = &(p_tt_config->ttloc_ptr[p_tt_config->ttloc_len-1]); + tl->type = TTLOC_SATSQ; + strlcpy(tl->pattern, "", sizeof(tl->pattern)); + tl->point.lat = 0; + tl->point.lon = 0; + + /* Pattern: B, optional additional button, exactly xxxx for matching */ + + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing pattern for TTSATSQ command.\n", line); + p_tt_config->ttloc_len--; + continue; + } + strlcpy (tl->pattern, t, sizeof(tl->pattern)); + + if (t[0] != 'B') { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: TTSATSQ pattern must begin with upper case 'B'.\n", line); + p_tt_config->ttloc_len--; + continue; + } + + /* Optionally one of 0-9ABCD */ + + if (strchr("ABCD", t[1]) != NULL || isdigit(t[1])) { + j = 2; + } + else { + j = 1; + } + + if (strcmp(t+j, "xxxx") != 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: TTSATSQ pattern must end with exactly xxxx in lower case.\n", line); + p_tt_config->ttloc_len--; + continue; + } + + /* temp debugging */ + + //for (j=0; jttloc_len; j++) { + // dw_printf ("debug ttloc %d/%d %s\n", j, p_tt_config->ttloc_size, + // p_tt_config->ttloc_ptr[j].pattern); + //} + } + +/* + * TTAMBIG - Define pattern to be used for Object Location Ambiguity. + * + * TTAMBIG pattern + * + * Pattern would be B[0-9A-D]x + * + * Must have exactly one x. + */ + + else if (strcasecmp(t, "TTAMBIG") == 0) { + +// TODO1.3: TTAMBIG To be continued... + + struct ttloc_s *tl; + int j; + + assert (p_tt_config->ttloc_size >= 2); + assert (p_tt_config->ttloc_len >= 0 && p_tt_config->ttloc_len <= p_tt_config->ttloc_size); + + /* Allocate new space, but first, if already full, make larger. */ + if (p_tt_config->ttloc_len == p_tt_config->ttloc_size) { + p_tt_config->ttloc_size += p_tt_config->ttloc_size / 2; + p_tt_config->ttloc_ptr = realloc (p_tt_config->ttloc_ptr, sizeof(struct ttloc_s) * p_tt_config->ttloc_size); + } + p_tt_config->ttloc_len++; + assert (p_tt_config->ttloc_len > 0 && p_tt_config->ttloc_len <= p_tt_config->ttloc_size); + + tl = &(p_tt_config->ttloc_ptr[p_tt_config->ttloc_len-1]); + tl->type = TTLOC_AMBIG; + strlcpy(tl->pattern, "", sizeof(tl->pattern)); + + /* Pattern: B, optional additional button, exactly x for matching */ + + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing pattern for TTAMBIG command.\n", line); + p_tt_config->ttloc_len--; + continue; + } + strlcpy (tl->pattern, t, sizeof(tl->pattern)); + + if (t[0] != 'B') { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: TTAMBIG pattern must begin with upper case 'B'.\n", line); + p_tt_config->ttloc_len--; + continue; + } + + /* Optionally one of 0-9ABCD */ + + if (strchr("ABCD", t[1]) != NULL || isdigit(t[1])) { + j = 2; + } + else { + j = 1; + } + + if (strcmp(t+j, "x") != 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: TTAMBIG pattern must end with exactly one x in lower case.\n", line); + p_tt_config->ttloc_len--; + continue; + } + + /* temp debugging */ + + //for (j=0; jttloc_len; j++) { + // dw_printf ("debug ttloc %d/%d %s\n", j, p_tt_config->ttloc_size, + // p_tt_config->ttloc_ptr[j].pattern); + //} + } + + +/* + * TTMACRO - Define compact message format with full expansion + * + * TTMACRO pattern definition + * + * pattern can contain: + * 0-9 which must match exactly. + * In version 1.2, also allow A,B,C,D for exact match. + * x, y, z which are used for matching of variable fields. + * + * definition can contain: + * 0-9, A, B, C, D, *, #, x, y, z. + * Not sure why # was included in there. + * + * new for version 1.3 - in progress + * + * AA{objname} + * AB{symbol} + * AC{call} + * + * These provide automatic conversion from plain text to the TT encoding. + * + */ + else if (strcasecmp(t, "TTMACRO") == 0) { + + struct ttloc_s *tl; + int j; + int p_count[3], d_count[3]; + int tt_error = 0; + + assert (p_tt_config->ttloc_size >= 2); + assert (p_tt_config->ttloc_len >= 0 && p_tt_config->ttloc_len <= p_tt_config->ttloc_size); + + /* Allocate new space, but first, if already full, make larger. */ + if (p_tt_config->ttloc_len == p_tt_config->ttloc_size) { + p_tt_config->ttloc_size += p_tt_config->ttloc_size / 2; + p_tt_config->ttloc_ptr = realloc (p_tt_config->ttloc_ptr, sizeof(struct ttloc_s) * p_tt_config->ttloc_size); + } + p_tt_config->ttloc_len++; + assert (p_tt_config->ttloc_len >= 0 && p_tt_config->ttloc_len <= p_tt_config->ttloc_size); + + tl = &(p_tt_config->ttloc_ptr[p_tt_config->ttloc_len-1]); + tl->type = TTLOC_MACRO; + strlcpy(tl->pattern, "", sizeof(tl->pattern)); + + /* Pattern: Any combination of digits, x, y, and z. */ + /* Also make note of which letters are used in pattern and definition. */ + /* Version 1.2: also allow A,B,C,D in the pattern. */ + + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing pattern for TTMACRO command.\n", line); + p_tt_config->ttloc_len--; + continue; + } + strlcpy (tl->pattern, t, sizeof(tl->pattern)); + + p_count[0] = p_count[1] = p_count[2] = 0; + + for (j=0; j<(int)(strlen(t)); j++) { + if ( strchr ("0123456789ABCDxyz", t[j]) == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: TTMACRO pattern can contain only digits, A, B, C, D, and lower case x, y, or z.\n", line); + p_tt_config->ttloc_len--; + continue; + } + /* Count how many x, y, z in the pattern. */ + if (t[j] >= 'x' && t[j] <= 'z') { + p_count[t[j]-'x']++; + } + } + + //text_color_set(DW_COLOR_DEBUG); + //dw_printf ("Line %d: TTMACRO pattern \"%s\" p_count = %d %d %d.\n", line, t, p_count[0], p_count[1], p_count[2]); + + /* Next we should find the definition. */ + /* It can contain touch tone characters and lower case x, y, z for substitutions. */ + + t = split(NULL,1);; + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing definition for TTMACRO command.\n", line); + tl->macro.definition = ""; /* Don't die on null pointer later. */ + p_tt_config->ttloc_len--; + continue; + } + + /* Make a pass over the definition, looking for the xx{...} substitutions. */ + /* These are done just once when reading the configuration file. */ + + char *pi; + char *ps; + char stemp[100]; // text inside of xx{...} + char ttemp[300]; // Converted to tone sequences. + char otemp[1000]; // Result after any substitutions. + char t2[2]; + + strlcpy (otemp, "", sizeof(otemp)); + t2[1] = '\0'; + pi = t; + while (*pi == ' ' || *pi == '\t') { + pi++; + } + for ( ; *pi != '\0'; pi++) { + + if (strncmp(pi, "AC{", 3) == 0) { + + // Convert to fixed length 10 digit callsign. + + pi += 3; + ps = stemp; + while (*pi != '}' && *pi != '*' && *pi != '\0') { + *ps++ = *pi++; + } + if (*pi == '}') { + *ps = '\0'; + if (tt_text_to_call10 (stemp, 0, ttemp) == 0) { + //text_color_set(DW_COLOR_DEBUG); + //dw_printf ("DEBUG Line %d: AC{%s} -> AC%s\n", line, stemp, ttemp); + strlcat (otemp, "AC", sizeof(otemp)); + strlcat (otemp, ttemp, sizeof(otemp)); + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: AC{%s} could not be converted to tones for callsign.\n", line, stemp); + tt_error++; + } + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: AC{... is missing matching } in TTMACRO definition.\n", line); + tt_error++; + } + } + + else if (strncmp(pi, "AA{", 3) == 0) { + + // Convert to object name. + + pi += 3; + ps = stemp; + while (*pi != '}' && *pi != '*' && *pi != '\0') { + *ps++ = *pi++; + } + if (*pi == '}') { + *ps = '\0'; + if (strlen(stemp) > 9) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Object name %s has been truncated to 9 characters.\n", line, stemp); + stemp[9] = '\0'; + } + if (tt_text_to_two_key (stemp, 0, ttemp) == 0) { + //text_color_set(DW_COLOR_DEBUG); + //dw_printf ("DEBUG Line %d: AA{%s} -> AA%s\n", line, stemp, ttemp); + strlcat (otemp, "AA", sizeof(otemp)); + strlcat (otemp, ttemp, sizeof(otemp)); + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: AA{%s} could not be converted to tones for object name.\n", line, stemp); + tt_error++; + } + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: AA{... is missing matching } in TTMACRO definition.\n", line); + tt_error++; + } + } + + else if (strncmp(pi, "AB{", 3) == 0) { + + // Attempt conversion from description to symbol code. + + pi += 3; + ps = stemp; + while (*pi != '}' && *pi != '*' && *pi != '\0') { + *ps++ = *pi++; + } + if (*pi == '}') { + char symtab; + char symbol; + + *ps = '\0'; + + // First try to find something matching the description. + + if (symbols_code_from_description (' ', stemp, &symtab, &symbol) == 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Couldn't convert \"%s\" to APRS symbol code. Using default.\n", line, stemp); + symtab = '\\'; // Alternate + symbol = 'A'; // Box + } + + // Convert symtab(overlay) & symbol to tone sequence. + + symbols_to_tones (symtab, symbol, ttemp, sizeof(ttemp)); + + //text_color_set(DW_COLOR_DEBUG); + //dw_printf ("DEBUG config file Line %d: AB{%s} -> %s\n", line, stemp, ttemp); + + strlcat (otemp, ttemp, sizeof(otemp)); + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: AB{... is missing matching } in TTMACRO definition.\n", line); + tt_error++; + } + } + + else if (strncmp(pi, "CA{", 3) == 0) { + + // Convert to enhanced comment that can contain any ASCII character. + + pi += 3; + ps = stemp; + while (*pi != '}' && *pi != '*' && *pi != '\0') { + *ps++ = *pi++; + } + if (*pi == '}') { + *ps = '\0'; + if (tt_text_to_ascii2d (stemp, 0, ttemp) == 0) { + //text_color_set(DW_COLOR_DEBUG); + //dw_printf ("DEBUG Line %d: CA{%s} -> CA%s\n", line, stemp, ttemp); + strlcat (otemp, "CA", sizeof(otemp)); + strlcat (otemp, ttemp, sizeof(otemp)); + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: CA{%s} could not be converted to tones for enhanced comment.\n", line, stemp); + tt_error++; + } + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: CA{... is missing matching } in TTMACRO definition.\n", line); + tt_error++; + } + } + + + else if (strchr("0123456789ABCD*#xyz", *pi) != NULL) { + t2[0] = *pi; + strlcat (otemp, t2, sizeof(otemp)); + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: TTMACRO definition can contain only 0-9, A, B, C, D, *, #, x, y, z.\n", line); + tt_error++; + } + } + + /* Make sure that number of x, y, z, in pattern and definition match. */ + + d_count[0] = d_count[1] = d_count[2] = 0; + + for (j=0; j<(int)(strlen(otemp)); j++) { + if (otemp[j] >= 'x' && otemp[j] <= 'z') { + d_count[otemp[j]-'x']++; + } + } + + /* A little validity checking. */ + + for (j=0; j<3; j++) { + if (p_count[j] > 0 && d_count[j] == 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: '%c' is in TTMACRO pattern but is not used in definition.\n", line, 'x'+j); + } + if (d_count[j] > 0 && p_count[j] == 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: '%c' is referenced in TTMACRO definition but does not appear in the pattern.\n", line, 'x'+j); + } + } + + //text_color_set(DW_COLOR_DEBUG); + //dw_printf ("DEBUG Config Line %d: %s -> %s\n", line, t, otemp); + + if (tt_error == 0) { + tl->macro.definition = strdup(otemp); + } + else { + p_tt_config->ttloc_len--; + } + } + +/* + * TTOBJ - TT Object Report options. + * + * TTOBJ recv-chan where-to [ via-path ] + * + * whereto is any combination of transmit channel, APP, IG. + */ + + + else if (strcasecmp(t, "TTOBJ") == 0) { + int r, x = -1; + int app = 0; + int ig = 0; + char *p; + + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing DTMF receive channel for TTOBJ command.\n", line); + continue; + } + + r = atoi(t); + if (r < 0 || r > MAX_CHANS-1) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: DTMF receive channel must be in range of 0 to %d on line %d.\n", + MAX_CHANS-1, line); + continue; + } + + // I suppose we need internal modem channel here. + // otherwise a DTMF decoder would not be available. + + if (p_audio_config->chan_medium[r] != MEDIUM_RADIO) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file, line %d: TTOBJ DTMF receive channel %d is not valid.\n", + line, r); + continue; + } + + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing transmit channel for TTOBJ command.\n", line); + continue; + } + + // Can have any combination of number, APP, IG. + // Would it be easier with strtok? + + for (p = t; *p != '\0'; p++) { + + if (isdigit(*p)) { + x = *p - '0'; + if (x < 0 || x > MAX_CHANS-1) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: Transmit channel must be in range of 0 to %d on line %d.\n", MAX_CHANS-1, line); + x = -1; + } + else if (p_audio_config->chan_medium[x] != MEDIUM_RADIO && + p_audio_config->chan_medium[x] != MEDIUM_NETTNC) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file, line %d: TTOBJ transmit channel %d is not valid.\n", line, x); + x = -1; + } + } + else if (*p == 'a' || *p == 'A') { + app = 1; + } + else if (*p == 'i' || *p == 'I') { + ig = 1; + } + else if (strchr("pPgG,", *p) != NULL) { + ; + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file, line %d: Expected comma separated list with some combination of transmit channel, APP, and IG.\n", line); + } + } + +// This enables the DTMF decoder on the specified channel. +// Additional channels can be enabled with the DTMF command. +// Note that DTMF command does not enable the APRStt gateway. + + + //text_color_set(DW_COLOR_DEBUG); + //dw_printf ("Debug TTOBJ r=%d, x=%d, app=%d, ig=%d\n", r, x, app, ig); + + p_audio_config->achan[r].dtmf_decode = DTMF_DECODE_ON; + p_tt_config->gateway_enabled = 1; + p_tt_config->obj_recv_chan = r; + p_tt_config->obj_xmit_chan = x; + p_tt_config->obj_send_to_app = app; + p_tt_config->obj_send_to_ig = ig; + + t = split(NULL,0); + if (t != NULL) { + + if (check_via_path(t) >= 0) { + strlcpy (p_tt_config->obj_xmit_via, t, sizeof(p_tt_config->obj_xmit_via)); + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file, line %d: invalid via path.\n", line); + } + } + } + +/* + * TTERR - TT responses for success or errors. + * + * TTERR msg_id method text... + */ + + else if (strcasecmp(t, "TTERR") == 0) { + int n, msg_num; + char *p; + char method[AX25_MAX_ADDR_LEN]; + int ssid; + int heard; + + + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing message identifier for TTERR command.\n", line); + continue; + } + + msg_num = -1; + for (n=0; n= 0 && msg_num < TT_ERROR_MAXP1); + + strlcpy (p_tt_config->response[msg_num].method, method, sizeof(p_tt_config->response[msg_num].method)); + +// TODO1.3: Need SSID too! + + strlcpy (p_tt_config->response[msg_num].mtext, t, sizeof(p_tt_config->response[msg_num].mtext)); + p_tt_config->response[msg_num].mtext[TT_MTEXT_LEN-1] = '\0'; + + } + +/* + * TTSTATUS - TT custom status messages. + * + * TTSTATUS status_id text... + */ + + else if (strcasecmp(t, "TTSTATUS") == 0) { + int status_num; + + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing status number for TTSTATUS command.\n", line); + continue; + } + + status_num = atoi(t); + + if (status_num < 1 || status_num > 9) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Status number for TTSTATUS command must be in range of 1 to 9.\n", line); + continue; + } + + t = split(NULL,1);; + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing status text for TTSTATUS command.\n", line); + continue; + } + + //text_color_set(DW_COLOR_DEBUG); + //dw_printf ("Line %d: TTSTATUS debug %d \"%s\"\n", line, status_num, t); + + while (*t == ' ' || *t == '\t') t++; // remove leading white space. + + strlcpy (p_tt_config->status[status_num], t, sizeof(p_tt_config->status[status_num])); + } + + +/* + * TTCMD - Command to run when valid sequence is received. + * Any text generated will be sent back to user. + * + * TTCMD ... + */ + + else if (strcasecmp(t, "TTCMD") == 0) { + + t = split(NULL,1); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing command for TTCMD command.\n", line); + continue; + } + + strlcpy (p_tt_config->ttcmd, t, sizeof(p_tt_config->ttcmd)); + } + + +/* + * ==================== Internet gateway ==================== + */ + +/* + * IGSERVER - Name of IGate server. + * + * IGSERVER hostname [ port ] -- original implementation. + * + * IGSERVER hostname:port -- more in line with usual conventions. + */ + + else if (strcasecmp(t, "IGSERVER") == 0) { + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing IGate server name for IGSERVER command.\n", line); + continue; + } + strlcpy (p_igate_config->t2_server_name, t, sizeof(p_igate_config->t2_server_name)); + + /* If there is a : in the name, split it out as the port number. */ + + t = strchr (p_igate_config->t2_server_name, ':'); + if (t != NULL) { + *t = '\0'; + t++; + int n = atoi(t); + if (n >= MIN_IP_PORT_NUMBER && n <= MAX_IP_PORT_NUMBER) { + p_igate_config->t2_server_port = n; + } + else { + p_igate_config->t2_server_port = DEFAULT_IGATE_PORT; + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Invalid port number for IGate server. Using default %d.\n", + line, p_igate_config->t2_server_port); + } + } + + /* Alternatively, the port number could be separated by white space. */ + + t = split(NULL,0); + if (t != NULL) { + int n = atoi(t); + if (n >= MIN_IP_PORT_NUMBER && n <= MAX_IP_PORT_NUMBER) { + p_igate_config->t2_server_port = n; + } + else { + p_igate_config->t2_server_port = DEFAULT_IGATE_PORT; + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Invalid port number for IGate server. Using default %d.\n", + line, p_igate_config->t2_server_port); + } + } + //dw_printf ("DEBUG server=%s port=%d\n", p_igate_config->t2_server_name, p_igate_config->t2_server_port); + //exit (0); + } + +/* + * IGLOGIN - Login callsign and passcode for IGate server + * + * IGLOGIN callsign passcode + */ + + else if (strcasecmp(t, "IGLOGIN") == 0) { + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing login callsign for IGLOGIN command.\n", line); + continue; + } + // TODO: Wouldn't hurt to do validity checking of format. + strlcpy (p_igate_config->t2_login, t, sizeof(p_igate_config->t2_login)); + + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing passcode for IGLOGIN command.\n", line); + continue; + } + strlcpy (p_igate_config->t2_passcode, t, sizeof(p_igate_config->t2_passcode)); + } + +/* + * IGTXVIA - Transmit channel and VIA path for messages from IGate server + * + * IGTXVIA channel [ path ] + */ + + else if (strcasecmp(t, "IGTXVIA") == 0) { + int n; + + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing transmit channel for IGTXVIA command.\n", line); + continue; + } + + n = atoi(t); + if (n < 0 || n > MAX_CHANS-1) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: Transmit channel must be in range of 0 to %d on line %d.\n", + MAX_CHANS-1, line); + continue; + } + p_igate_config->tx_chan = n; + + t = split(NULL,0); + if (t != NULL) { + +#if 1 // proper checking + + n = check_via_path(t); + if (n >= 0) { + p_igate_config->max_digi_hops = n; + p_igate_config->tx_via[0] = ','; + strlcpy (p_igate_config->tx_via + 1, t, sizeof(p_igate_config->tx_via)-1); + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file, line %d: invalid via path.\n", line); + } + +#else // previously + + char *p; + p_igate_config->tx_via[0] = ','; + strlcpy (p_igate_config->tx_via + 1, t, sizeof(p_igate_config->tx_via)-1); + for (p = p_igate_config->tx_via; *p != '\0'; p++) { + if (islower(*p)) { + *p = toupper(*p); /* silently force upper case. */ + } + } +#endif + } + } + +/* + * IGFILTER - IGate Server side filters. + * Is this name too confusing. Too similar to FILTER IG 0 ... + * Maybe SSFILTER suggesting Server Side. + * SUBSCRIBE might be better because it's not a filter that limits. + * + * IGFILTER filter-spec ... + */ + + else if (strcasecmp(t, "IGFILTER") == 0) { + + t = split(NULL,1); /* Take rest of line as one string. */ + + if (p_igate_config->t2_filter != NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Warning - Earlier IGFILTER value will be replaced by this one.\n", line); + continue; + } + + if (t != NULL && strlen(t) > 0) { + p_igate_config->t2_filter = strdup (t); + } + } + + +/* + * IGTXLIMIT - Limit transmissions during 1 and 5 minute intervals. + * + * IGTXLIMIT one-minute-limit five-minute-limit + */ + + else if (strcasecmp(t, "IGTXLIMIT") == 0) { + int n; + + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing one minute limit for IGTXLIMIT command.\n", line); + continue; + } + + n = atoi(t); + if (n < 1) { + p_igate_config->tx_limit_1 = 1; + } + else if (n <= IGATE_TX_LIMIT_1_MAX) { + p_igate_config->tx_limit_1 = n; + } + else { + p_igate_config->tx_limit_1 = IGATE_TX_LIMIT_1_MAX; + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: One minute transmit limit has been reduced to %d.\n", + line, p_igate_config->tx_limit_1); + dw_printf ("You won't make friends by setting a limit this high.\n"); + } + + + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing five minute limit for IGTXLIMIT command.\n", line); + continue; + } + + n = atoi(t); + if (n < 1) { + p_igate_config->tx_limit_5 = 1; + } + else if (n <= IGATE_TX_LIMIT_5_MAX) { + p_igate_config->tx_limit_5 = n; + } + else { + p_igate_config->tx_limit_5 = IGATE_TX_LIMIT_5_MAX; + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Five minute transmit limit has been reduced to %d.\n", + line, p_igate_config->tx_limit_5); + dw_printf ("You won't make friends by setting a limit this high.\n"); + } + } + + +/* + * IGMSP - Number of times to send position of message sender. + * + * IGMSP n + */ + + else if (strcasecmp(t, "IGMSP") == 0) { + + t = split(NULL,0); + if (t != NULL) { + + int n = atoi(t); + if (n >= 0 && n <= 10) { + p_igate_config->igmsp = n; + } + else { + p_igate_config->igmsp = 1; + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Unreasonable number of times for message sender position. Using default 1.\n", line); + } + } + else { + p_igate_config->igmsp = 1; + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing number of times for message sender position. Using default 1.\n", line); + } + } + + + +/* + * SATGATE - Special SATgate mode to delay packets heard directly. + * + * SATGATE [ n ] + */ + + else if (strcasecmp(t, "SATGATE") == 0) { + + text_color_set(DW_COLOR_INFO); + dw_printf ("Line %d: SATGATE is pretty useless and will be removed in a future version.\n", line); + + t = split(NULL,0); + if (t != NULL) { + + int n = atoi(t); + if (n >= MIN_SATGATE_DELAY && n <= MAX_SATGATE_DELAY) { + p_igate_config->satgate_delay = n; + } + else { + p_igate_config->satgate_delay = DEFAULT_SATGATE_DELAY; + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Unreasonable SATgate delay. Using default.\n", line); + } + } + else { + p_igate_config->satgate_delay = DEFAULT_SATGATE_DELAY; + } + } + + + +/* + * ==================== All the left overs ==================== + */ + +/* + * AGWPORT - Port number for "AGW TCPIP Socket Interface" + * + * In version 1.2 we allow 0 to disable listening. + */ + + else if (strcasecmp(t, "AGWPORT") == 0) { + int n; + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing port number for AGWPORT command.\n", line); + continue; + } + n = atoi(t); + t = split(NULL,0); + if (t != NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Unexpected \"%s\" after the port number.\n", line, t); + dw_printf ("Perhaps you were trying to use feature available only with KISSPORT.\n"); + continue; + } + if ((n >= MIN_IP_PORT_NUMBER && n <= MAX_IP_PORT_NUMBER) || n == 0) { + p_misc_config->agwpe_port = n; + } + else { + p_misc_config->agwpe_port = DEFAULT_AGWPE_PORT; + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Invalid port number for AGW TCPIP Socket Interface. Using %d.\n", + line, p_misc_config->agwpe_port); + } + } + +/* + * KISSPORT port [ chan ] - Port number for KISS over IP. + */ + + // Previously we allowed only a single TCP port for KISS. + // An increasing number of people want to run multiple radios. + // Unfortunately, most applications don't know how to deal with multi-radio TNCs. + // They ignore the channel on receive and always transmit to channel 0. + // Running multiple instances of direwolf is a work-around but this leads to + // more complex configuration and we lose the cross-channel digipeating capability. + // In release 1.7 we add a new feature to assign a single radio channel to a TCP port. + // e.g. + // KISSPORT 8001 # default, all channels. Radio channel = KISS channel. + // + // KISSPORT 7000 0 # Only radio channel 0 for receive. + // # Transmit to radio channel 0, ignoring KISS channel. + // + // KISSPORT 7001 1 # Only radio channel 1 for receive. KISS channel set to 0. + // # Transmit to radio channel 1, ignoring KISS channel. + +// FIXME + else if (strcasecmp(t, "KISSPORT") == 0) { + int n; + int tcp_port = 0; + int chan = -1; // optional. default to all if not specified. + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing TCP port number for KISSPORT command.\n", line); + continue; + } + n = atoi(t); + if ((n >= MIN_IP_PORT_NUMBER && n <= MAX_IP_PORT_NUMBER) || n == 0) { + tcp_port = n; + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Invalid TCP port number for KISS TCPIP Socket Interface.\n", line); + dw_printf ("Use something in the range of %d to %d.\n", MIN_IP_PORT_NUMBER, MAX_IP_PORT_NUMBER); + continue; + } + + t = split(NULL,0); + if (t != NULL) { + chan = atoi(t); + if (chan < 0 || chan >= MAX_CHANS) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Invalid channel %d for KISSPORT command. Must be in range 0 thru %d.\n", line, chan, MAX_CHANS-1); + continue; + } + } + + // "KISSPORT 0" is used to remove the default entry. + + if (tcp_port == 0) { + p_misc_config->kiss_port[0] = 0; // Should all be wiped out? + } + else { + + // Try to find an empty slot. + // A duplicate TCP port number will overwrite the previous value. + + int slot = -1; + for (int i = 0; i < MAX_KISS_TCP_PORTS && slot == -1; i++) { + if (p_misc_config->kiss_port[i] == tcp_port) { + slot = i; + if ( ! (slot == 0 && tcp_port == DEFAULT_KISS_PORT)) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Warning: Duplicate TCP port %d will overwrite previous value.\n", line, tcp_port); + } + } + else if (p_misc_config->kiss_port[i] == 0) { + slot = i; + } + } + if (slot >= 0) { + p_misc_config->kiss_port[slot] = tcp_port; + p_misc_config->kiss_chan[slot] = chan; + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Too many KISSPORT commands.\n", line); + } + } + } + +/* + * NULLMODEM name [ speed ] - Device name for serial port or our end of the virtual "null modem" + * SERIALKISS name [ speed ] + * + * Version 1.5: Added SERIALKISS which is equivalent to NULLMODEM. + * The original name sort of made sense when it was used only for one end of a virtual + * null modem cable on Windows only. Now it is also available for Linux. + * TODO1.5: In retrospect, this doesn't seem like such a good name. + */ + + else if (strcasecmp(t, "NULLMODEM") == 0 || strcasecmp(t, "SERIALKISS") == 0) { + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: Missing serial port name on line %d.\n", line); + continue; + } + else { + if (strlen(p_misc_config->kiss_serial_port) > 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: Warning serial port name on line %d replaces earlier value.\n", line); + } + strlcpy (p_misc_config->kiss_serial_port, t, sizeof(p_misc_config->kiss_serial_port)); + p_misc_config->kiss_serial_speed = 0; + p_misc_config->kiss_serial_poll = 0; + } + + t = split(NULL,0); + if (t != NULL) { + p_misc_config->kiss_serial_speed = atoi(t); + } + } + +/* + * SERIALKISSPOLL name - Poll for serial port name that might come and go. + * e.g. /dev/rfcomm0 for bluetooth. + */ + + else if (strcasecmp(t, "SERIALKISSPOLL") == 0) { + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: Missing serial port name on line %d.\n", line); + continue; + } + else { + if (strlen(p_misc_config->kiss_serial_port) > 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: Warning serial port name on line %d replaces earlier value.\n", line); + } + strlcpy (p_misc_config->kiss_serial_port, t, sizeof(p_misc_config->kiss_serial_port)); + p_misc_config->kiss_serial_speed = 0; + p_misc_config->kiss_serial_poll = 1; // set polling. + } + } + + +/* + * KISSCOPY - Data from network KISS client is copied to all others. + * This does not apply to pseudo terminal KISS. + */ + + else if (strcasecmp(t, "KISSCOPY") == 0) { + p_misc_config->kiss_copy = 1; + } + + +/* + * DNSSD - Enable or disable (1/0) dns-sd, DNS Service Discovery announcements + * DNSSDNAME - Set DNS-SD service name, defaults to "Dire Wolf on " + */ + + else if (strcasecmp(t, "DNSSD") == 0) { + int n; + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing integer value for DNSSD command.\n", line); + continue; + } + n = atoi(t); + if (n == 0 || n == 1) { + p_misc_config->dns_sd_enabled = n; + } else { + p_misc_config->dns_sd_enabled = 0; + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Invalid integer value for DNSSD. Disabling dns-sd.\n", line); + } + } + + else if (strcasecmp(t, "DNSSDNAME") == 0) { + t = split(NULL, 1); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing service name for DNSSDNAME.\n", line); + continue; + } + else { + strlcpy(p_misc_config->dns_sd_name, t, sizeof(p_misc_config->dns_sd_name)); + } + } + + + +/* + * GPSNMEA serial-device [ speed ] - Direct connection to GPS receiver. + */ + else if (strcasecmp(t, "gpsnmea") == 0) { + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file, line %d: Missing serial port name for GPS receiver.\n", line); + continue; + } + strlcpy (p_misc_config->gpsnmea_port, t, sizeof(p_misc_config->gpsnmea_port)); + + t = split(NULL,0); + if (t != NULL) { + int n = atoi(t); + p_misc_config->gpsnmea_speed = n; + } + else { + p_misc_config->gpsnmea_speed = 4800; // The standard at one time. + } + } + +/* + * GPSD - Use GPSD server. + * + * GPSD [ host [ port ] ] + */ + else if (strcasecmp(t, "gpsd") == 0) { + +#if __WIN32__ + + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file, line %d: The GPSD interface is not available for Windows.\n", line); + continue; + +#elif ENABLE_GPSD + + strlcpy (p_misc_config->gpsd_host, "localhost", sizeof(p_misc_config->gpsd_host)); + p_misc_config->gpsd_port = atoi(DEFAULT_GPSD_PORT); + + t = split(NULL,0); + if (t != NULL) { + strlcpy (p_misc_config->gpsd_host, t, sizeof(p_misc_config->gpsd_host)); + + t = split(NULL,0); + if (t != NULL) { + + int n = atoi(t); + if ((n >= MIN_IP_PORT_NUMBER && n <= MAX_IP_PORT_NUMBER) || n == 0) { + p_misc_config->gpsd_port = n; + } + else { + p_misc_config->gpsd_port = atoi(DEFAULT_GPSD_PORT); + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Invalid port number for GPSD Socket Interface. Using default of %d.\n", + line, p_misc_config->gpsd_port); + } + } + } +#else + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file, line %d: The GPSD interface has not been enabled.\n", line); + dw_printf ("Install gpsd and libgps-dev packages then rebuild direwolf.\n"); + continue; +#endif + + } + +/* + * WAYPOINT - Generate WPL and AIS NMEA sentences for display on map. + * + * WAYPOINT serial-device [ formats ] + * WAYPOINT host:udpport [ formats ] + * + */ + else if (strcasecmp(t, "waypoint") == 0) { + + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: Missing output device for WAYPOINT on line %d.\n", line); + continue; + } + + /* If there is a ':' in the name, split it into hostname:udpportnum. */ + /* Otherwise assume it is serial port name. */ + + char *p = strchr (t, ':'); + if (p != NULL) { + *p = '\0'; + int n = atoi(p+1); + if (n >= MIN_IP_PORT_NUMBER && n <= MAX_IP_PORT_NUMBER) { + strlcpy (p_misc_config->waypoint_udp_hostname, t, sizeof(p_misc_config->waypoint_udp_hostname)); + if (strlen(p_misc_config->waypoint_udp_hostname) == 0) { + strlcpy (p_misc_config->waypoint_udp_hostname, "localhost", sizeof(p_misc_config->waypoint_udp_hostname)); + } + p_misc_config->waypoint_udp_portnum = n; + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Invalid UDP port number %d for sending waypoints.\n", line, n); + } + } + else { + strlcpy (p_misc_config->waypoint_serial_port, t, sizeof(p_misc_config->waypoint_serial_port)); + } + + /* Anything remaining is the formats to enable. */ + + t = split(NULL,1); + if (t != NULL) { + for ( ; *t != '\0' ; t++ ) { + switch (toupper(*t)) { + case 'N': + p_misc_config->waypoint_formats |= WPL_FORMAT_NMEA_GENERIC; + break; + case 'G': + p_misc_config->waypoint_formats |= WPL_FORMAT_GARMIN; + break; + case 'M': + p_misc_config->waypoint_formats |= WPL_FORMAT_MAGELLAN; + break; + case 'K': + p_misc_config->waypoint_formats |= WPL_FORMAT_KENWOOD; + break; + case 'A': + p_misc_config->waypoint_formats |= WPL_FORMAT_AIS; + break; + case ' ': + case ',': + break; + default: + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: Invalid output format '%c' for WAYPOINT on line %d.\n", *t, line); + break; + } + } + } + } + +/* + * LOGDIR - Directory name for automatically named daily log files. Use "." for current working directory. + */ + else if (strcasecmp(t, "logdir") == 0) { + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: Missing directory name for LOGDIR on line %d.\n", line); + continue; + } + else { + if (strlen(p_misc_config->log_path) > 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: LOGDIR on line %d is replacing an earlier LOGDIR or LOGFILE.\n", line); + } + p_misc_config->log_daily_names = 1; + strlcpy (p_misc_config->log_path, t, sizeof(p_misc_config->log_path)); + } + t = split(NULL,0); + if (t != NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: LOGDIR on line %d should have directory path and nothing more.\n", line); + } + } + +/* + * LOGFILE - Log file name, including any directory part. + */ + else if (strcasecmp(t, "logfile") == 0) { + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: Missing file name for LOGFILE on line %d.\n", line); + continue; + } + else { + if (strlen(p_misc_config->log_path) > 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: LOGFILE on line %d is replacing an earlier LOGDIR or LOGFILE.\n", line); + } + p_misc_config->log_daily_names = 0; + strlcpy (p_misc_config->log_path, t, sizeof(p_misc_config->log_path)); + } + t = split(NULL,0); + if (t != NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: LOGFILE on line %d should have file name and nothing more.\n", line); + } + } + +/* + * BEACON channel delay every message + * + * Original handcrafted style. Removed in version 1.0. + */ + + else if (strcasecmp(t, "BEACON") == 0) { + + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file, line %d: Old style 'BEACON' has been replaced with new commands.\n", line); + dw_printf ("Use PBEACON, OBEACON, TBEACON, or CBEACON instead.\n"); + + } + + +/* + * PBEACON keyword=value ... + * OBEACON keyword=value ... + * TBEACON keyword=value ... + * CBEACON keyword=value ... + * IBEACON keyword=value ... + * + * New style with keywords for options. + */ + +// TODO: maybe add proportional pathing so multiple beacon timing does not need to be manually constructed? +// http://www.aprs.org/newN/ProportionalPathing.txt + + else if (strcasecmp(t, "PBEACON") == 0 || + strcasecmp(t, "OBEACON") == 0 || + strcasecmp(t, "TBEACON") == 0 || + strcasecmp(t, "CBEACON") == 0 || + strcasecmp(t, "IBEACON") == 0) { + + if (p_misc_config->num_beacons < MAX_BEACONS) { + + memset (&(p_misc_config->beacon[p_misc_config->num_beacons]), 0, sizeof(struct beacon_s)); + if (strcasecmp(t, "PBEACON") == 0) { + p_misc_config->beacon[p_misc_config->num_beacons].btype = BEACON_POSITION; + } + else if (strcasecmp(t, "OBEACON") == 0) { + p_misc_config->beacon[p_misc_config->num_beacons].btype = BEACON_OBJECT; + } + else if (strcasecmp(t, "TBEACON") == 0) { + p_misc_config->beacon[p_misc_config->num_beacons].btype = BEACON_TRACKER; + } + else if (strcasecmp(t, "IBEACON") == 0) { + p_misc_config->beacon[p_misc_config->num_beacons].btype = BEACON_IGATE; + } + else { + p_misc_config->beacon[p_misc_config->num_beacons].btype = BEACON_CUSTOM; + } + + /* Save line number because some errors will be reported later. */ + p_misc_config->beacon[p_misc_config->num_beacons].lineno = line; + + if (beacon_options(t + strlen("xBEACON") + 1, &(p_misc_config->beacon[p_misc_config->num_beacons]), line, p_audio_config)) { + p_misc_config->num_beacons++; + } + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: Maximum number of beacons exceeded on line %d.\n", line); + continue; + } + } + + +/* + * SMARTBEACONING [ fast_speed fast_rate slow_speed slow_rate turn_time turn_angle turn_slope ] + * + * Parameters must be all or nothing. + */ + + else if (strcasecmp(t, "SMARTBEACON") == 0 || + strcasecmp(t, "SMARTBEACONING") == 0) { + + int n; + +#define SB_NUM(name,sbvar,minn,maxx,unit) \ + t = split(NULL,0); \ + if (t == NULL) { \ + if (strcmp(name, "fast speed") == 0) { \ + p_misc_config->sb_configured = 1; \ + continue; \ + } \ + text_color_set(DW_COLOR_ERROR); \ + dw_printf ("Line %d: Missing %s for SmartBeaconing.\n", line, name); \ + continue; \ + } \ + n = atoi(t); \ + if (n >= minn && n <= maxx) { \ + p_misc_config->sbvar = n; \ + } \ + else { \ + text_color_set(DW_COLOR_ERROR); \ + dw_printf ("Line %d: Invalid %s for SmartBeaconing. Using default %d %s.\n", \ + line, name, p_misc_config->sbvar, unit); \ + } + +#define SB_TIME(name,sbvar,minn,maxx,unit) \ + t = split(NULL,0); \ + if (t == NULL) { \ + text_color_set(DW_COLOR_ERROR); \ + dw_printf ("Line %d: Missing %s for SmartBeaconing.\n", line, name); \ + continue; \ + } \ + n = parse_interval(t,line); \ + if (n >= minn && n <= maxx) { \ + p_misc_config->sbvar = n; \ + } \ + else { \ + text_color_set(DW_COLOR_ERROR); \ + dw_printf ("Line %d: Invalid %s for SmartBeaconing. Using default %d %s.\n", \ + line, name, p_misc_config->sbvar, unit); \ + } + + + SB_NUM ("fast speed", sb_fast_speed, 2, 90, "MPH") + SB_TIME ("fast rate", sb_fast_rate, 10, 300, "seconds") + + SB_NUM ("slow speed", sb_slow_speed, 1, 30, "MPH") + SB_TIME ("slow rate", sb_slow_rate, 30, 3600, "seconds") + + SB_TIME ("turn time", sb_turn_time, 5, 180, "seconds") + SB_NUM ("turn angle", sb_turn_angle, 5, 90, "degrees") + SB_NUM ("turn slope", sb_turn_slope, 1, 255, "deg*mph") + + /* If I was ambitious, I might allow optional */ + /* unit at end for miles or km / hour. */ + + p_misc_config->sb_configured = 1; + } + + +/* + * ==================== AX.25 connected mode ==================== + */ + + +/* + * FRACK n - Number of seconds to wait for ack to transmission. + */ + + else if (strcasecmp(t, "FRACK") == 0) { + int n; + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing value for FRACK.\n", line); + continue; + } + n = atoi(t); + if (n >= AX25_T1V_FRACK_MIN && n <= AX25_T1V_FRACK_MAX) { + p_misc_config->frack = n; + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Invalid FRACK time. Using default %d.\n", line, p_misc_config->frack); + } + } + + +/* + * RETRY n - Number of times to retry before giving up. + */ + + else if (strcasecmp(t, "RETRY") == 0) { + int n; + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing value for RETRY.\n", line); + continue; + } + n = atoi(t); + if (n >= AX25_N2_RETRY_MIN && n <= AX25_N2_RETRY_MAX) { + p_misc_config->retry = n; + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Invalid RETRY number. Using default %d.\n", line, p_misc_config->retry); + } + } + + +/* + * PACLEN n - Maximum number of bytes in information part. + */ + + else if (strcasecmp(t, "PACLEN") == 0) { + int n; + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing value for PACLEN.\n", line); + continue; + } + n = atoi(t); + if (n >= AX25_N1_PACLEN_MIN && n <= AX25_N1_PACLEN_MAX) { + p_misc_config->paclen = n; + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Invalid PACLEN value. Using default %d.\n", line, p_misc_config->paclen); + } + } + + +/* + * MAXFRAME n - Max frames to send before ACK. mod 8 "Window" size. + * + * Window size would make more sense but everyone else calls it MAXFRAME. + */ + + else if (strcasecmp(t, "MAXFRAME") == 0) { + int n; + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing value for MAXFRAME.\n", line); + continue; + } + n = atoi(t); + if (n >= AX25_K_MAXFRAME_BASIC_MIN && n <= AX25_K_MAXFRAME_BASIC_MAX) { + p_misc_config->maxframe_basic = n; + } + else { + p_misc_config->maxframe_basic = AX25_K_MAXFRAME_BASIC_DEFAULT; + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Invalid MAXFRAME value outside range of %d to %d. Using default %d.\n", + line, AX25_K_MAXFRAME_BASIC_MIN, AX25_K_MAXFRAME_BASIC_MAX, p_misc_config->maxframe_basic); + } + } + + + +/* + * EMAXFRAME n - Max frames to send before ACK. mod 128 "Window" size. + */ + + else if (strcasecmp(t, "EMAXFRAME") == 0) { + int n; + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing value for EMAXFRAME.\n", line); + continue; + } + n = atoi(t); + if (n >= AX25_K_MAXFRAME_EXTENDED_MIN && n <= AX25_K_MAXFRAME_EXTENDED_MAX) { + p_misc_config->maxframe_extended = n; + } + else { + p_misc_config->maxframe_extended = AX25_K_MAXFRAME_EXTENDED_DEFAULT; + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Invalid EMAXFRAME value outside of range %d to %d. Using default %d.\n", + line, AX25_K_MAXFRAME_EXTENDED_MIN, AX25_K_MAXFRAME_EXTENDED_MAX, p_misc_config->maxframe_extended); + } + } + +/* + * MAXV22 n - Max number of SABME sent before trying SABM. + */ + + else if (strcasecmp(t, "MAXV22") == 0) { + int n; + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing value for MAXV22.\n", line); + continue; + } + n = atoi(t); + if (n >= 0 && n <= AX25_N2_RETRY_MAX) { + p_misc_config->maxv22 = n; + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Invalid MAXV22 number. Will use half of RETRY.\n", line); + } + } + + +/* + * V20 address [ address ... ] - Stations known to support only AX.25 v2.0. + * When connecting to these, skip SABME and go right to SABM. + * Possible to have multiple and they are cumulative. + */ + + else if (strcasecmp(t, "V20") == 0) { + + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing address(es) for V20.\n", line); + continue; + } + + while (t != NULL) { + int const strict = 2; + char call_no_ssid[AX25_MAX_ADDR_LEN]; + int ssid, heard; + + if (ax25_parse_addr (AX25_DESTINATION, t, strict, call_no_ssid, &ssid, &heard)) { + p_misc_config->v20_addrs = (char**)realloc (p_misc_config->v20_addrs, sizeof(char*) * (p_misc_config->v20_count + 1)); + p_misc_config->v20_addrs[p_misc_config->v20_count++] = strdup(t); + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Invalid station address for V20 command.\n", line); + + // continue processing any others following. + } + t = split(NULL,0); + } + } + + +/* + * NOXID address [ address ... ] - Stations known not to understand XID. + * After connecting to these (with v2.2 obviously), don't try using XID command. + * AX.25 for Linux is the one known case so far. + * Possible to have multiple and they are cumulative. + */ + + else if (strcasecmp(t, "NOXID") == 0) { + + t = split(NULL,0); + if (t == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Missing address(es) for NOXID.\n", line); + continue; + } + + while (t != NULL) { + int const strict = 2; + char call_no_ssid[AX25_MAX_ADDR_LEN]; + int ssid, heard; + + if (ax25_parse_addr (AX25_DESTINATION, t, strict, call_no_ssid, &ssid, &heard)) { + p_misc_config->noxid_addrs = (char**)realloc (p_misc_config->noxid_addrs, sizeof(char*) * (p_misc_config->noxid_count + 1)); + p_misc_config->noxid_addrs[p_misc_config->noxid_count++] = strdup(t); + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Invalid station address for NOXID command.\n", line); + + // continue processing any others following. + } + t = split(NULL,0); + } + } + + +/* + * Invalid command. + */ + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: Unrecognized command '%s' on line %d.\n", t, line); + } + + } + + fclose (fp); + +/* + * A little error checking for option interactions. + */ + +/* + * Require that MYCALL be set when digipeating or IGating. + * + * Suggest that beaconing be enabled when digipeating. + */ + int i, j, k, b; + + for (i=0; ienabled[i][j]) { + + if ( strcmp(p_audio_config->achan[i].mycall, "") == 0 || + strcmp(p_audio_config->achan[i].mycall, "NOCALL") == 0 || + strcmp(p_audio_config->achan[i].mycall, "N0CALL") == 0) { + + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: MYCALL must be set for receive channel %d before digipeating is allowed.\n", i); + p_digi_config->enabled[i][j] = 0; + } + + if ( strcmp(p_audio_config->achan[j].mycall, "") == 0 || + strcmp(p_audio_config->achan[j].mycall, "NOCALL") == 0 || + strcmp(p_audio_config->achan[j].mycall, "N0CALL") == 0) { + + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: MYCALL must be set for transmit channel %d before digipeating is allowed.\n", i); + p_digi_config->enabled[i][j] = 0; + } + + b = 0; + for (k=0; knum_beacons; k++) { + if (p_misc_config->beacon[k].sendto_chan == j) b++; + } + if (b == 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: Beaconing should be configured for channel %d when digipeating is enabled.\n", j); + // It's a recommendation, not a requirement. + // Was there some good reason to turn it off in earlier version? + //p_digi_config->enabled[i][j] = 0; + } + } + +/* Connected mode digipeating. */ + + if (p_cdigi_config->enabled[i][j]) { + + if ( strcmp(p_audio_config->achan[i].mycall, "") == 0 || + strcmp(p_audio_config->achan[i].mycall, "NOCALL") == 0 || + strcmp(p_audio_config->achan[i].mycall, "N0CALL") == 0) { + + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: MYCALL must be set for receive channel %d before digipeating is allowed.\n", i); + p_cdigi_config->enabled[i][j] = 0; + } + + if ( strcmp(p_audio_config->achan[j].mycall, "") == 0 || + strcmp(p_audio_config->achan[j].mycall, "NOCALL") == 0 || + strcmp(p_audio_config->achan[j].mycall, "N0CALL") == 0) { + + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: MYCALL must be set for transmit channel %d before digipeating is allowed.\n", i); + p_cdigi_config->enabled[i][j] = 0; + } + + b = 0; + for (k=0; knum_beacons; k++) { + if (p_misc_config->beacon[k].sendto_chan == j) b++; + } + if (b == 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: Beaconing should be configured for channel %d when digipeating is enabled.\n", j); + // It's a recommendation, not a requirement. + } + } + } + +/* When IGate is enabled, all radio channels must have a callsign associated. */ + + if (strlen(p_igate_config->t2_login) > 0 && + (p_audio_config->chan_medium[i] == MEDIUM_RADIO || p_audio_config->chan_medium[i] == MEDIUM_NETTNC)) { + + if (strcmp(p_audio_config->achan[i].mycall, "NOCALL") == 0 || strcmp(p_audio_config->achan[i].mycall, "N0CALL") == 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: MYCALL must be set for receive channel %d before Rx IGate is allowed.\n", i); + strlcpy (p_igate_config->t2_login, "", sizeof(p_igate_config->t2_login)); + } + // Currently we can have only one transmit channel. + // This might be generalized someday to allow more. + if (p_igate_config->tx_chan >= 0 && + ( strcmp(p_audio_config->achan[p_igate_config->tx_chan].mycall, "") == 0 || + strcmp(p_audio_config->achan[p_igate_config->tx_chan].mycall, "NOCALL") == 0 || + strcmp(p_audio_config->achan[p_igate_config->tx_chan].mycall, "N0CALL") == 0)) { + + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: MYCALL must be set for transmit channel %d before Tx IGate is allowed.\n", i); + p_igate_config->tx_chan = -1; + } + } + } + +// Apply default IS>RF IGate filter if none specified. New in 1.4. +// This will handle eventual case of multiple transmit channels. + + if (strlen(p_igate_config->t2_login) > 0) { + for (j=0; jchan_medium[j] == MEDIUM_RADIO || p_audio_config->chan_medium[j] == MEDIUM_NETTNC) { + if (p_digi_config->filter_str[MAX_CHANS][j] == NULL) { + p_digi_config->filter_str[MAX_CHANS][j] = strdup("i/180"); + } + } + } + } + +// Terrible hack. But what can we do? + + if (p_misc_config->maxv22 < 0) { + p_misc_config->maxv22 = p_misc_config->retry / 3; + } + +} /* end config_init */ + + +/* + * Parse the PBEACON or OBEACON options. + * Returns 1 for success, 0 for serious error. + */ + +// FIXME: provide error messages when non applicable option is used for particular beacon type. +// e.g. IBEACON DELAY=1 EVERY=1 SENDTO=IG OVERLAY=R SYMBOL="igate" LAT=37^44.46N LONG=122^27.19W COMMENT="N1KOL-1 IGATE" +// Just ignores overlay, symbol, lat, long, and comment. + +static int beacon_options(char *cmd, struct beacon_s *b, int line, struct audio_s *p_audio_config) +{ + char *t; + char temp_symbol[100]; + int ok; + char zone[8]; + double easting = G_UNKNOWN; + double northing = G_UNKNOWN; + + strlcpy (temp_symbol, "", sizeof(temp_symbol)); + strlcpy (zone, "", sizeof(zone)); + + b->sendto_type = SENDTO_XMIT; + b->sendto_chan = 0; + b->delay = 60; + b->slot = G_UNKNOWN; + b->every = 600; + //b->delay = 6; // temp test. + //b->every = 3600; + b->lat = G_UNKNOWN; + b->lon = G_UNKNOWN; + b->ambiguity = 0; + b->alt_m = G_UNKNOWN; + b->symtab = '/'; + b->symbol = '-'; /* house */ + b->freq = G_UNKNOWN; + b->tone = G_UNKNOWN; + b->offset = G_UNKNOWN; + b->source = NULL; + b->dest = NULL; + + while ((t = split(NULL,0)) != NULL) { + + char keyword[20]; + char value[1000]; + char *e; + char *p; + + + e = strchr(t, '='); + if (e == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: No = found in, %s, on line %d.\n", t, line); + return (0); + } + *e = '\0'; + strlcpy (keyword, t, sizeof(keyword)); + strlcpy (value, e+1, sizeof(value)); + +// QUICK TEMP EXPERIMENT, maybe permanent new feature. +// Recognize \xnn as hexadecimal value. Handy for UTF-8 in comment. +// Maybe recognize the <0xnn> form that we print. +// +// # Convert between languages here: https://translate.google.com/ then +// # Convert to UTF-8 bytes here: https://codebeautify.org/utf8-converter +// +// pbeacon delay=0:05 every=0:30 sendto=R0 lat=12.5N long=69.97W comment="\xe3\x82\xa2\xe3\x83\x9e\xe3\x83\x81\xe3\x83\xa5\xe3\x82\xa2\xe7\x84\xa1\xe7\xb7\x9a \xce\xa1\xce\xb1\xce\xb4\xce\xb9\xce\xbf\xce\xb5\xcf\x81\xce\xb1\xcf\x83\xce\xb9\xcf\x84\xce\xb5\xcf\x87\xce\xbd\xce\xb9\xcf\x83\xce\xbc\xcf\x8c\xcf\x82" + + char temp[256]; + int tlen = 0; + + for (char *p = value; *p != '\0'; ) { + if (p[0] == '\\' && p[1] == 'x' && strlen(p) >= 4 && isxdigit(p[2]) && isxdigit(p[3])) { + int n = 0; + for (int i = 2; i < 4; i++) { + n = n * 16; + if (islower(p[i])) { + n += p[i] - 'a' + 10; + } + else if (isupper(p[i])) { + n += p[i] - 'A' + 10; + } + else { // must be digit due to isxdigit test above. + n += p[i] - '0'; + } + } + temp[tlen++] = n; + p += 4; + } + else { + temp[tlen++] = *p++; + } + } + temp[tlen] = '\0'; + strlcpy (value, temp, sizeof(value)); + +// end + if (strcasecmp(keyword, "DELAY") == 0) { + b->delay = parse_interval(value,line); + } + else if (strcasecmp(keyword, "SLOT") == 0) { + int n = parse_interval(value,line); + if ( n < 1 || n > 3600) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file, line %d: Beacon time slot, %d, must be in range of 1 to 3600 seconds.\n", line, n); + continue; + } + b->slot = n; + } + else if (strcasecmp(keyword, "EVERY") == 0) { + b->every = parse_interval(value,line); + } + else if (strcasecmp(keyword, "SENDTO") == 0) { + if (value[0] == 'i' || value[0] == 'I') { + b->sendto_type = SENDTO_IGATE; + b->sendto_chan = 0; + } + else if (value[0] == 'r' || value[0] == 'R') { + int n = atoi(value+1); + if (( n < 0 || n >= MAX_CHANS || p_audio_config->chan_medium[n] == MEDIUM_NONE) + && p_audio_config->chan_medium[n] != MEDIUM_IGATE) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file, line %d: Simulated receive on channel %d is not valid.\n", line, n); + continue; + } + b->sendto_type = SENDTO_RECV; + b->sendto_chan = n; + } + else if (value[0] == 't' || value[0] == 'T' || value[0] == 'x' || value[0] == 'X') { + int n = atoi(value+1); + if (( n < 0 || n >= MAX_CHANS || p_audio_config->chan_medium[n] == MEDIUM_NONE) + && p_audio_config->chan_medium[n] != MEDIUM_IGATE) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file, line %d: Send to channel %d is not valid.\n", line, n); + continue; + } + + b->sendto_type = SENDTO_XMIT; + b->sendto_chan = n; + } + else { + int n = atoi(value); + if (( n < 0 || n >= MAX_CHANS || p_audio_config->chan_medium[n] == MEDIUM_NONE) + && p_audio_config->chan_medium[n] != MEDIUM_IGATE) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file, line %d: Send to channel %d is not valid.\n", line, n); + continue; + } + b->sendto_type = SENDTO_XMIT; + b->sendto_chan = n; + } + } + else if (strcasecmp(keyword, "SOURCE") == 0) { + b->source = strdup(value); + for (p = b->source; *p != '\0'; p++) { + if (islower(*p)) { + *p = toupper(*p); /* silently force upper case. */ + } + } + if (strlen(b->source) > 9) { + b->source[9] = '\0'; + } + } + else if (strcasecmp(keyword, "DEST") == 0) { + b->dest = strdup(value); + for (p = b->dest; *p != '\0'; p++) { + if (islower(*p)) { + *p = toupper(*p); /* silently force upper case. */ + } + } + if (strlen(b->dest) > 9) { + b->dest[9] = '\0'; + } + } + else if (strcasecmp(keyword, "VIA") == 0) { + +#if 1 // proper checking + + if (check_via_path(value) >= 0) { + b->via = strdup(value); + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file, line %d: invalid via path.\n", line); + } + + +#else // previously + + b->via = strdup(value); + for (p = b->via; *p != '\0'; p++) { + if (islower(*p)) { + *p = toupper(*p); /* silently force upper case. */ + } + } +#endif + } + else if (strcasecmp(keyword, "INFO") == 0) { + b->custom_info = strdup(value); + } + else if (strcasecmp(keyword, "INFOCMD") == 0) { + b->custom_infocmd = strdup(value); + } + else if (strcasecmp(keyword, "OBJNAME") == 0) { + strlcpy(b->objname, value, sizeof(b->objname)); + } + else if (strcasecmp(keyword, "LAT") == 0) { + b->lat = parse_ll (value, LAT, line); + } + else if (strcasecmp(keyword, "LONG") == 0 || strcasecmp(keyword, "LON") == 0) { + b->lon = parse_ll (value, LON, line); + } + else if (strcasecmp(keyword, "AMBIGUITY") == 0 || strcasecmp(keyword, "AMBIG") == 0) { + int n = atoi(value); + if (n >= 0 && n <= 4) { + b->ambiguity = n; + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: Location ambiguity, on line %d, must be in range of 0 to 4.\n", line); + } + } + else if (strcasecmp(keyword, "ALT") == 0 || strcasecmp(keyword, "ALTITUDE") == 0) { + + char *unit = strpbrk(value, "abcedfghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"); + if (unit != NULL) { + float meters = 0; + for (int j=0; jalt_m = atof(value); + } + else { + // valid unit + b->alt_m = atof(value) * meters; + } + } else { + // no unit specified + b->alt_m = atof(value); + } + } + else if (strcasecmp(keyword, "ZONE") == 0) { + strlcpy(zone, value, sizeof(zone)); + } + else if (strcasecmp(keyword, "EAST") == 0 || strcasecmp(keyword, "EASTING") == 0) { + easting = atof(value); + } + else if (strcasecmp(keyword, "NORTH") == 0 || strcasecmp(keyword, "NORTHING") == 0) { + northing = atof(value); + } + else if (strcasecmp(keyword, "SYMBOL") == 0) { + /* Defer processing in case overlay appears later. */ + strlcpy (temp_symbol, value, sizeof(temp_symbol)); + } + else if (strcasecmp(keyword, "OVERLAY") == 0) { + if (strlen(value) == 1 && (isupper(value[0]) || isdigit(value[0]))) { + b->symtab = value[0]; + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: Overlay must be one character in range of 0-9 or A-Z, upper case only, on line %d.\n", line); + } + } + else if (strcasecmp(keyword, "POWER") == 0) { + b->power = atoi(value); + } + else if (strcasecmp(keyword, "HEIGHT") == 0) { // This is in feet. + b->height = atoi(value); + // TODO: ability to add units suffix, e.g. 10m + } + else if (strcasecmp(keyword, "GAIN") == 0) { + b->gain = atoi(value); + } + else if (strcasecmp(keyword, "DIR") == 0 || strcasecmp(keyword, "DIRECTION") == 0) { + strlcpy(b->dir, value, sizeof(b->dir)); + } + else if (strcasecmp(keyword, "FREQ") == 0) { + b->freq = atof(value); + } + else if (strcasecmp(keyword, "TONE") == 0) { + b->tone = atof(value); + } + else if (strcasecmp(keyword, "OFFSET") == 0 || strcasecmp(keyword, "OFF") == 0) { + b->offset = atof(value); + } + else if (strcasecmp(keyword, "COMMENT") == 0) { + b->comment = strdup(value); + } + else if (strcasecmp(keyword, "COMMENTCMD") == 0) { + b->commentcmd = strdup(value); + } + else if (strcasecmp(keyword, "COMPRESS") == 0 || strcasecmp(keyword, "COMPRESSED") == 0) { + b->compress = atoi(value); + } + else if (strcasecmp(keyword, "MESSAGING") == 0) { + b->messaging = atoi(value); + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file, line %d: Invalid option keyword, %s.\n", line, keyword); + return (0); + } + } + + if (b->custom_info != NULL && b->custom_infocmd != NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file, line %d: Can't use both INFO and INFOCMD at the same time.\n", line); + } + + if (b->compress && b->ambiguity != 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file, line %d: Position ambiguity can't be used with compressed location format.\n", line); + b->ambiguity = 0; + } + +/* + * Convert UTM coordinates to lat / long. + */ + if (strlen(zone) > 0 || easting != G_UNKNOWN || northing != G_UNKNOWN) { + + if (strlen(zone) > 0 && easting != G_UNKNOWN && northing != G_UNKNOWN) { + + long lzone; + char latband, hemi; + long lerr; + double dlat, dlon; + + lzone = parse_utm_zone (zone, &latband, &hemi); + + lerr = Convert_UTM_To_Geodetic(lzone, hemi, easting, northing, &dlat, &dlon); + + if (lerr == 0) { + b->lat = R2D(dlat); + b->lon = R2D(dlon); + } + else { + char message [300]; + + utm_error_string (lerr, message); + text_color_set(DW_COLOR_ERROR); + dw_printf ("Line %d: Invalid UTM location: \n%s\n", line, message); + } + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file, line %d: When any of ZONE, EASTING, NORTHING specified, they must all be specified.\n", line); + } + } + +/* + * Process symbol now that we have any later overlay. + * + * FIXME: Someone who used this was surprised to end up with Solar Powser (S-). + * overlay=S symbol="/-" + * We should complain if overlay used with symtab other than \. + */ + if (strlen(temp_symbol) > 0) { + + if (strlen(temp_symbol) == 2 && + (temp_symbol[0] == '/' || temp_symbol[0] == '\\' || isupper(temp_symbol[0]) || isdigit(temp_symbol[0])) && + temp_symbol[1] >= '!' && temp_symbol[1] <= '~') { + + /* Explicit table and symbol. */ + + if (isupper(b->symtab) || isdigit(b->symtab)) { + b->symbol = temp_symbol[1]; + } + else { + b->symtab = temp_symbol[0]; + b->symbol = temp_symbol[1]; + } + } + else { + + /* Try to look up by description. */ + ok = symbols_code_from_description (b->symtab, temp_symbol, &(b->symtab), &(b->symbol)); + if (!ok) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file, line %d: Could not find symbol matching %s.\n", line, temp_symbol); + } + } + } + +/* Check is here because could be using default channel when SENDTO= is not specified. */ + + if (b->sendto_type == SENDTO_XMIT) { + + if (( b->sendto_chan < 0 || b->sendto_chan >= MAX_CHANS || p_audio_config->chan_medium[b->sendto_chan] == MEDIUM_NONE) + && p_audio_config->chan_medium[b->sendto_chan] != MEDIUM_IGATE) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file, line %d: Send to channel %d is not valid.\n", line, b->sendto_chan); + return (0); + } + + if (p_audio_config->chan_medium[b->sendto_chan] == MEDIUM_IGATE) { // Prevent subscript out of bounds. + // Will be using call from chan 0 later. + if ( strcmp(p_audio_config->achan[0].mycall, "") == 0 || + strcmp(p_audio_config->achan[0].mycall, "NOCALL") == 0 || + strcmp(p_audio_config->achan[0].mycall, "N0CALL") == 0 ) { + + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: MYCALL must be set for channel %d before beaconing is allowed.\n", 0); + return (0); + } + } else { + if ( strcmp(p_audio_config->achan[b->sendto_chan].mycall, "") == 0 || + strcmp(p_audio_config->achan[b->sendto_chan].mycall, "NOCALL") == 0 || + strcmp(p_audio_config->achan[b->sendto_chan].mycall, "N0CALL") == 0 ) { + + text_color_set(DW_COLOR_ERROR); + dw_printf ("Config file: MYCALL must be set for channel %d before beaconing is allowed.\n", b->sendto_chan); + return (0); + } + } + } + + return (1); +} + +/* end config.c */ diff --git a/src/config.h b/src/config.h new file mode 100644 index 00000000..360ac492 --- /dev/null +++ b/src/config.h @@ -0,0 +1,262 @@ + +/*---------------------------------------------------------------------------- + * + * Name: config.h + * + * Purpose: + * + * Description: + * + *-----------------------------------------------------------------------------*/ + + +#ifndef CONFIG_H +#define CONFIG_H 1 + +#include "audio.h" /* for struct audio_s */ +#include "digipeater.h" /* for struct digi_config_s */ +#include "cdigipeater.h" /* for struct cdigi_config_s */ +#include "aprs_tt.h" /* for struct tt_config_s */ +#include "igate.h" /* for struct igate_config_s */ + +/* + * All the leftovers. + * This wasn't thought out. It just happened. + */ + +enum beacon_type_e { BEACON_IGNORE, BEACON_POSITION, BEACON_OBJECT, BEACON_TRACKER, BEACON_CUSTOM, BEACON_IGATE }; + +enum sendto_type_e { SENDTO_XMIT, SENDTO_IGATE, SENDTO_RECV }; + + +#define MAX_BEACONS 30 +#define MAX_KISS_TCP_PORTS (MAX_CHANS+1) + +struct misc_config_s { + + int agwpe_port; /* TCP Port number for the "AGW TCPIP Socket Interface" */ + + // Previously we allowed only a single TCP port for KISS. + // An increasing number of people want to run multiple radios. + // Unfortunately, most applications don't know how to deal with multi-radio TNCs. + // They ignore the channel on receive and always transmit to channel 0. + // Running multiple instances of direwolf is a work-around but this leads to + // more complex configuration and we lose the cross-channel digipeating capability. + // In release 1.7 we add a new feature to assign a single radio channel to a TCP port. + // e.g. + // KISSPORT 8001 # default, all channels. Radio channel = KISS channel. + // + // KISSPORT 7000 0 # Only radio channel 0 for receive. + // # Transmit to radio channel 0, ignoring KISS channel. + // + // KISSPORT 7001 1 # Only radio channel 1 for receive. KISS channel set to 0. + // # Transmit to radio channel 1, ignoring KISS channel. + + int kiss_port[MAX_KISS_TCP_PORTS]; /* TCP Port number for the "TCP KISS" protocol. */ + int kiss_chan[MAX_KISS_TCP_PORTS]; /* Radio Channel number for this port or -1 for all. */ + + int kiss_copy; /* Data from network KISS client is copied to all others. */ + int enable_kiss_pt; /* Enable pseudo terminal for KISS. */ + /* Want this to be off by default because it hangs */ + /* after a while if nothing is reading from other end. */ + + char kiss_serial_port[20]; + /* Serial port name for our end of the */ + /* virtual null modem for native Windows apps. */ + /* Version 1.5 add same capability for Linux. */ + + int kiss_serial_speed; /* Speed, in bps, for the KISS serial port. */ + /* If 0, just leave what was already there. */ + + int kiss_serial_poll; /* When using Bluetooth KISS, the /dev/rfcomm0 device */ + /* will appear and disappear as the remote application */ + /* opens and closes the virtual COM port. */ + /* When this is non-zero, we will check periodically to */ + /* see if the device has appeared and we will open it. */ + + char gpsnmea_port[20]; /* Serial port name for reading NMEA sentences from GPS. */ + /* e.g. COM22, /dev/ttyACM0 */ + + int gpsnmea_speed; /* Speed for above, baud, default 4800. */ + + char gpsd_host[20]; /* Host for gpsd server. */ + /* e.g. localhost, 192.168.1.2 */ + + int gpsd_port; /* Port number for gpsd server. */ + /* Default is 2947. */ + + + char waypoint_serial_port[20]; /* Serial port name for sending NMEA waypoint sentences */ + /* to a GPS map display or other mapping application. */ + /* e.g. COM22, /dev/ttyACM0 */ + /* Currently no option for setting non-standard speed. */ + /* This was done in 2014 and no one has complained yet. */ + + char waypoint_udp_hostname[80]; /* Destination host when using UDP. */ + + int waypoint_udp_portnum; /* UDP port. */ + + int waypoint_formats; /* Which sentence formats should be generated? */ + +#define WPL_FORMAT_NMEA_GENERIC 0x01 /* N $GPWPL */ +#define WPL_FORMAT_GARMIN 0x02 /* G $PGRMW */ +#define WPL_FORMAT_MAGELLAN 0x04 /* M $PMGNWPL */ +#define WPL_FORMAT_KENWOOD 0x08 /* K $PKWDWPL */ +#define WPL_FORMAT_AIS 0x10 /* A !AIVDM */ + + + int log_daily_names; /* True to generate new log file each day. */ + + char log_path[80]; /* Either directory or full file name depending on above. */ + + int dns_sd_enabled; /* DNS Service Discovery announcement enabled. */ + char dns_sd_name[64]; /* Name announced on dns-sd; defaults to "Dire Wolf on " */ + + int sb_configured; /* TRUE if SmartBeaconing is configured. */ + int sb_fast_speed; /* MPH */ + int sb_fast_rate; /* seconds */ + int sb_slow_speed; /* MPH */ + int sb_slow_rate; /* seconds */ + int sb_turn_time; /* seconds */ + int sb_turn_angle; /* degrees */ + int sb_turn_slope; /* degrees * MPH */ + +// AX.25 connected mode. + + int frack; /* Number of seconds to wait for ack to transmission. */ + + int retry; /* Number of times to retry before giving up. */ + + int paclen; /* Max number of bytes in information part of frame. */ + + int maxframe_basic; /* Max frames to send before ACK. mod 8 "Window" size. */ + + int maxframe_extended; /* Max frames to send before ACK. mod 128 "Window" size. */ + + int maxv22; /* Maximum number of unanswered SABME frames sent before */ + /* switching to SABM. This is to handle the case of an old */ + /* TNC which simply ignores SABME rather than replying with FRMR. */ + + char **v20_addrs; /* Stations known to understand only AX.25 v2.0 so we don't */ + /* waste time trying v2.2 first. */ + + int v20_count; /* Number of station addresses in array above. */ + + char **noxid_addrs; /* Stations known not to understand XID command so don't */ + /* waste time sending it and eventually giving up. */ + /* AX.25 for Linux is the one known case, so far, where */ + /* SABME is implemented but XID is not. */ + + int noxid_count; /* Number of station addresses in array above. */ + + +// Beacons. + + int num_beacons; /* Number of beacons defined. */ + + struct beacon_s { + + enum beacon_type_e btype; /* Position or object. */ + + int lineno; /* Line number from config file for later error messages. */ + + enum sendto_type_e sendto_type; + + /* SENDTO_XMIT - Usually beacons go to a radio transmitter. */ + /* chan, below is the channel number. */ + /* SENDTO_IGATE - Send to IGate, probably to announce my position */ + /* rather than relying on someone else to hear */ + /* me on the radio and report me. */ + /* SENDTO_RECV - Pretend this was heard on the specified */ + /* radio channel. Mostly for testing. It is a */ + /* convenient way to send packets to attached apps. */ + + int sendto_chan; /* Transmit or simulated receive channel for above. Should be 0 for IGate. */ + + int delay; /* Seconds to delay before first transmission. */ + + int slot; /* Seconds after hour for slotted time beacons. */ + /* If specified, it overrides any 'delay' value. */ + + int every; /* Time between transmissions, seconds. */ + /* Remains fixed for PBEACON and OBEACON. */ + /* Dynamically adjusted for TBEACON. */ + + time_t next; /* Unix time to transmit next one. */ + + char *source; /* NULL or explicit AX.25 source address to use */ + /* instead of the mycall value for the channel. */ + + char *dest; /* NULL or explicit AX.25 destination to use */ + /* instead of the software version such as APDW11. */ + + int compress; /* Use more compact form? */ + + char objname[10]; /* Object name. Any printable characters. */ + + char *via; /* Path, e.g. "WIDE1-1,WIDE2-1" or NULL. */ + + char *custom_info; /* Info part for handcrafted custom beacon. */ + /* Ignore the rest below if this is set. */ + + char *custom_infocmd; /* Command to generate info part. */ + /* Again, other options below are then ignored. */ + + int messaging; /* Set messaging attribute for position report. */ + /* i.e. Data Type Indicator of '=' rather than '!' */ + + double lat; /* Latitude and longitude. */ + double lon; + int ambiguity; /* Number of lower digits to trim from location. 0 (default), 1, 2, 3, 4. */ + float alt_m; /* Altitude in meters. */ + + char symtab; /* Symbol table: / or \ or overlay character. */ + char symbol; /* Symbol code. */ + + float power; /* For PHG. */ + float height; /* HAAT in feet */ + float gain; /* Original protocol spec was unclear. */ + /* Addendum 1.1 clarifies it is dBi not dBd. */ + + char dir[3]; /* 1 or 2 of N,E,W,S, or empty for omni. */ + + float freq; /* MHz. */ + float tone; /* Hz. */ + float offset; /* MHz. */ + + char *comment; /* Comment or NULL. */ + char *commentcmd; /* Command to append more to Comment or NULL. */ + + + } beacon[MAX_BEACONS]; + +}; + + +#define MIN_IP_PORT_NUMBER 1024 +#define MAX_IP_PORT_NUMBER 49151 + + +#define DEFAULT_AGWPE_PORT 8000 /* Like everyone else. */ +#define DEFAULT_KISS_PORT 8001 /* Above plus 1. */ + + +#define DEFAULT_NULLMODEM "COM3" /* should be equiv. to /dev/ttyS2 on Cygwin */ + + + + +extern void config_init (char *fname, struct audio_s *p_modem, + struct digi_config_s *digi_config, + struct cdigi_config_s *cdigi_config, + struct tt_config_s *p_tt_config, + struct igate_config_s *p_igate_config, + struct misc_config_s *misc_config); + + + +#endif /* CONFIG_H */ + +/* end config.h */ + + diff --git a/decode_aprs.c b/src/decode_aprs.c similarity index 52% rename from decode_aprs.c rename to src/decode_aprs.c index 73253145..ab933278 100644 --- a/decode_aprs.c +++ b/src/decode_aprs.c @@ -1,7 +1,7 @@ // // This file is part of Dire Wolf, an amateur radio packet TNC. // -// Copyright (C) 2011,2012,2013,2014 John Langner, WB2OSZ +// Copyright (C) 2011, 2012, 2013, 2014, 2015, 2017, 2022 John Langner, WB2OSZ // // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by @@ -17,6 +17,7 @@ // along with this program. If not, see . // +// TODO: Better error messages for examples here: http://lists.tapr.org/pipermail/aprssig_lists.tapr.org/2023-July/date.html /*------------------------------------------------------------------ * @@ -26,38 +27,35 @@ * * Description: Present the packet contents in human readable format. * This is a fairly complete implementation with error messages - * pointing out various specication violations. + * pointing out various specification violations. * * Assumptions: ax25_from_frame() has been called to * separate the header and information. * *------------------------------------------------------------------*/ +#include "direwolf.h" + #include #include #include #include /* for atof */ #include /* for strtok */ -#if __WIN32__ -char *strsep(char **stringp, const char *delim); -#endif + #include /* for pow */ #include /* for isdigit */ #include -#ifndef _POSIX_C_SOURCE -#define _POSIX_C_SOURCE 1 -#endif #include "regex.h" -#include "direwolf.h" #include "ax25_pad.h" #include "textcolor.h" #include "symbols.h" #include "latlong.h" -//#include "nmea.h" +#include "dwgpsnmea.h" #include "decode_aprs.h" #include "telemetry.h" +#include "ais.h" #define TRUE 1 @@ -105,22 +103,24 @@ static void aprs_ll_pos_time (decode_aprs_t *A, unsigned char *, int); static void aprs_raw_nmea (decode_aprs_t *A, unsigned char *, int); static void aprs_mic_e (decode_aprs_t *A, packet_t, unsigned char *, int); //static void aprs_compressed_pos (decode_aprs_t *A, unsigned char *, int); -static void aprs_message (decode_aprs_t *A, unsigned char *, int); +static void aprs_message (decode_aprs_t *A, unsigned char *, int, int quiet); static void aprs_object (decode_aprs_t *A, unsigned char *, int); static void aprs_item (decode_aprs_t *A, unsigned char *, int); static void aprs_station_capabilities (decode_aprs_t *A, char *, int); static void aprs_status_report (decode_aprs_t *A, char *, int); -static void aprs_telemetry (decode_aprs_t *A, char *, int); +static void aprs_general_query (decode_aprs_t *A, char *, int, int quiet); +static void aprs_directed_station_query (decode_aprs_t *A, char *addressee, char *query, int quiet); +static void aprs_telemetry (decode_aprs_t *A, char *info, int info_len, int quiet); +static void aprs_user_defined (decode_aprs_t *A, char *, int); static void aprs_raw_touch_tone (decode_aprs_t *A, char *, int); static void aprs_morse_code (decode_aprs_t *A, char *, int); static void aprs_positionless_weather_report (decode_aprs_t *A, unsigned char *, int); static void weather_data (decode_aprs_t *A, char *wdata, int wind_prefix); static void aprs_ultimeter (decode_aprs_t *A, char *, int); -static void third_party_header (decode_aprs_t *A, char *, int); static void decode_position (decode_aprs_t *A, position_t *ppos); static void decode_compressed_position (decode_aprs_t *A, compressed_position_t *ppos); -static double get_latitude_8 (char *p); -static double get_longitude_9 (char *p); +static double get_latitude_8 (char *p, int quiet); +static double get_longitude_9 (char *p, int quiet); static time_t get_timestamp (decode_aprs_t *A, char *p); static int get_maidenhead (decode_aprs_t *A, char *p); static int data_extension_comment (decode_aprs_t *A, char *pdext); @@ -130,6 +130,7 @@ static void process_comment (decode_aprs_t *A, char *pstart, int clen); + /*------------------------------------------------------------------ * * Function: decode_aprs @@ -138,9 +139,17 @@ static void process_comment (decode_aprs_t *A, char *pstart, int clen); * * Inputs: pp - APRS packet object. * + * quiet - Suppress error messages. + * + * third_party_src - Specify when parsing a third party header. + * (decode_aprs is called recursively.) + * This is mostly found when an IGate transmits a message + * that came via APRS-IS. + * NULL when not third party payload. + * * Outputs: A-> g_symbol_table, g_symbol_code, * g_lat, g_lon, - * g_speed, g_course, g_altitude, + * g_speed_mph, g_course, g_altitude_ft, * g_comment * ... and many others... * @@ -149,54 +158,154 @@ static void process_comment (decode_aprs_t *A, char *pstart, int clen); * *------------------------------------------------------------------*/ -void decode_aprs (decode_aprs_t *A, packet_t pp) +void decode_aprs (decode_aprs_t *A, packet_t pp, int quiet, char *third_party_src) { + //dw_printf ("DEBUG decode_aprs quiet=%d, third_party=%p\n", quiet, third_party_src); - char dest[AX25_MAX_ADDR_LEN]; unsigned char *pinfo; int info_len; info_len = ax25_get_info (pp, &pinfo); - memset (A, 0, sizeof (*A)); + //dw_printf ("DEBUG decode_aprs info=\"%s\"\n", pinfo); + + if (third_party_src == NULL) { + memset (A, 0, sizeof (*A)); + } + + A->g_quiet = quiet; - sprintf (A->g_msg_type, "Unknown message type %c", *pinfo); + if (isprint(*pinfo)) { + snprintf (A->g_data_type_desc, sizeof(A->g_data_type_desc), "ERROR!!! Unknown APRS Data Type Indicator \"%c\"", *pinfo); + } + else { + snprintf (A->g_data_type_desc, sizeof(A->g_data_type_desc), "ERROR!!! Unknown APRS Data Type Indicator: unprintable 0x%02x", *pinfo); + } - A->g_symbol_table = '/'; /* Default to primary table. */ + A->g_symbol_table = '/'; /* Default to primary table. */ A->g_symbol_code = ' '; /* What should we have for default symbol? */ A->g_lat = G_UNKNOWN; A->g_lon = G_UNKNOWN; - //strcpy (A->g_maidenhead, ""); - //strcpy (A->g_name, ""); - A->g_speed = G_UNKNOWN; + A->g_speed_mph = G_UNKNOWN; A->g_course = G_UNKNOWN; A->g_power = G_UNKNOWN; A->g_height = G_UNKNOWN; A->g_gain = G_UNKNOWN; - //strcpy (A->g_directivity, ""); A->g_range = G_UNKNOWN; - A->g_altitude = G_UNKNOWN; - //strcpy(A->g_mfr, ""); - //strcpy(A->g_mic_e_status, ""); + A->g_altitude_ft = G_UNKNOWN; A->g_freq = G_UNKNOWN; A->g_tone = G_UNKNOWN; A->g_dcs = G_UNKNOWN; A->g_offset = G_UNKNOWN; - //strcpy (A->g_weather, ""); - //strcpy (A->g_comment, ""); + + A->g_footprint_lat = G_UNKNOWN; + A->g_footprint_lon = G_UNKNOWN; + A->g_footprint_radius = G_UNKNOWN; + +// TODO: Complain if obsolete WIDE or RELAY is found in via path. + +// TODO: complain if unused WIDEn is see in path. +// There is a report of UIDIGI decrementing ssid 1 to 0 and not marking it used. +// http://lists.tapr.org/pipermail/aprssig_lists.tapr.org/2022-May/049397.html + +// TODO: Complain if used digi is found after unused. Should never happen. + + +// If third-party header, try to decode just the payload. + + if (*pinfo == '}') { + + //dw_printf ("DEBUG decode_aprs recursively process third party header\n"); + + // This must not be strict because the addresses in third party payload doesn't + // need to adhere to the AX.25 address format (i.e. 6 upper case alphanumeric.) + // SSID can be 2 alphanumeric characters. + // Addresses can include lower case, e.g. q construct. + + // e.g. WR2X-2>APRS,WA1PLE-13*:} + // K1BOS-B>APOSB,TCPIP,WR2X-2*:@122015z4221.42ND07111.93W&/A=000000SharkRF openSPOT3 MMDVM446.025 MA/SW + + packet_t pp_payload = ax25_from_text ((char*)pinfo+1, 0); + if (pp_payload != NULL) { + char payload_src[AX25_MAX_ADDR_LEN]; + memset(payload_src, 0, sizeof(payload_src)); + memcpy(payload_src, (char*)pinfo+1, sizeof(payload_src)-1); + char *q = strchr(payload_src, '>'); + if (q != NULL) *q = '\0'; + A->g_has_thirdparty_header = 1; + decode_aprs (A, pp_payload, quiet, payload_src); // 1 means used recursively + ax25_delete (pp_payload); + return; + } + else { + strlcpy (A->g_data_type_desc, "Third Party Header: Unable to parse payload.", sizeof(A->g_data_type_desc)); + ax25_get_addr_with_ssid (pp, AX25_SOURCE, A->g_src); + ax25_get_addr_with_ssid (pp, AX25_DESTINATION, A->g_dest); + } + } /* * Extract source and destination including the SSID. */ - - ax25_get_addr_with_ssid (pp, AX25_SOURCE, A->g_src); - ax25_get_addr_with_ssid (pp, AX25_DESTINATION, dest); + if (third_party_src != NULL) { + strlcpy (A->g_src, third_party_src, sizeof(A->g_src)); + } + else { + ax25_get_addr_with_ssid (pp, AX25_SOURCE, A->g_src); + } + ax25_get_addr_with_ssid (pp, AX25_DESTINATION, A->g_dest); + + //dw_printf ("DEBUG decode_aprs source=%s, dest=%s\n", A->g_src, A->g_dest); + + +/* + * Report error if the information part contains a nul character. + * There are two known cases where this can happen. + * + * - The Kenwood TM-D710A sometimes sends packets like this: + * + * VA3AJ-9>T2QU6X,VE3WRC,WIDE1,K8UNS,WIDE2*:4P<0x00><0x0f>4T<0x00><0x0f>4X<0x00><0x0f>4\<0x00>`nW<0x1f>oS8>/]"6M}driving fast= + * K4JH-9>S5UQ6X,WR4AGC-3*,WIDE1*:4P<0x00><0x0f>4T<0x00><0x0f>4X<0x00><0x0f>4\<0x00>`jP}l"&>/]"47}QRV from the EV = + * + * Notice that the data type indicator of "4" is not valid. If we remove + * 4P<0x00><0x0f>4T<0x00><0x0f>4X<0x00><0x0f>4\<0x00> we are left with a good MIC-E format. + * This same thing has been observed from others and is intermittent. + * + * - AGW Tracker can send UTF-16 if an option is selected. This can introduce nul bytes. + * This is wrong, it should be using UTF-8. + */ + + if ( ( ! A->g_quiet ) && ( (int)strlen((char*)pinfo) != info_len) ) { + + text_color_set(DW_COLOR_ERROR); + dw_printf("'nul' character found in Information part. This should never happen with APRS.\n"); + dw_printf("If this is meant to be APRS, %s is transmitting with defective software.\n", A->g_src); + + if (strcmp((char*)pinfo, "4P") == 0) { + dw_printf("The TM-D710 will do this intermittently. A firmware upgrade is needed to fix it.\n"); + } + } + +/* + * Application might be in the destination field for most message types. + * MIC-E format has part of location in the destination field. + */ + + switch (*pinfo) { /* "DTI" data type identifier. */ + + case '\'': /* Old Mic-E Data */ + case '`': /* Current Mic-E Data */ + break; + default: + decode_tocall (A, A->g_dest); + break; + } switch (*pinfo) { /* "DTI" data type identifier. */ @@ -207,16 +316,17 @@ void decode_aprs (decode_aprs_t *A, packet_t pp) if (strncmp((char*)pinfo, "!!", 2) == 0) { - aprs_ultimeter (A, (char*)pinfo, info_len); + aprs_ultimeter (A, (char*)pinfo, info_len); // TODO: produce obsolete error. } else { aprs_ll_pos (A, pinfo, info_len); } + A->g_packet_type = packet_type_position; break; - //case '#': /* Peet Bros U-II Weather station */ + //case '#': /* Peet Bros U-II Weather station */ // TODO: produce obsolete error. //case '*': /* Peet Bros U-II Weather station */ //break; @@ -224,11 +334,13 @@ void decode_aprs (decode_aprs_t *A, packet_t pp) if (strncmp((char*)pinfo, "$ULTW", 5) == 0) { - aprs_ultimeter (A, (char*)pinfo, info_len); + aprs_ultimeter (A, (char*)pinfo, info_len); // TODO: produce obsolete error. + A->g_packet_type = packet_type_weather; } else { aprs_raw_nmea (A, pinfo, info_len); + A->g_packet_type = packet_type_position; } break; @@ -236,64 +348,98 @@ void decode_aprs (decode_aprs_t *A, packet_t pp) case '`': /* Current Mic-E Data (not used in TM-D700) */ aprs_mic_e (A, pp, pinfo, info_len); + A->g_packet_type = packet_type_position; break; case ')': /* Item. */ aprs_item (A, pinfo, info_len); + A->g_packet_type = packet_type_item; break; case '/': /* Position with timestamp (no APRS messaging) */ case '@': /* Position with timestamp (with APRS messaging) */ aprs_ll_pos_time (A, pinfo, info_len); + A->g_packet_type = packet_type_position; break; - case ':': /* Message */ + case ':': /* "Message" (special APRS meaning): for one person, a group, or a bulletin. */ + /* Directed Station Query */ + /* Telemetry metadata. */ + + aprs_message (A, pinfo, info_len, quiet); + + switch (A->g_message_subtype) { + case message_subtype_message: + case message_subtype_ack: + case message_subtype_rej: + A->g_packet_type = packet_type_message; + break; - aprs_message (A, pinfo, info_len); + case message_subtype_nws: + A->g_packet_type = packet_type_nws; + break; + + case message_subtype_bulletin: + default: + break; + + case message_subtype_telem_parm: + case message_subtype_telem_unit: + case message_subtype_telem_eqns: + case message_subtype_telem_bits: + A->g_packet_type = packet_type_telemetry; + break; + + case message_subtype_directed_query: + A->g_packet_type = packet_type_query; + break; + } break; case ';': /* Object */ aprs_object (A, pinfo, info_len); + A->g_packet_type = packet_type_object; break; case '<': /* Station Capabilities */ aprs_station_capabilities (A, (char*)pinfo, info_len); + A->g_packet_type = packet_type_capabilities; break; case '>': /* Status Report */ aprs_status_report (A, (char*)pinfo, info_len); + A->g_packet_type = packet_type_status; break; - //case '?': /* Query */ - //break; + + case '?': /* General Query */ + + aprs_general_query (A, (char*)pinfo, info_len, quiet); + A->g_packet_type = packet_type_query; + break; case 'T': /* Telemetry */ - aprs_telemetry (A, (char*)pinfo, info_len); + + aprs_telemetry (A, (char*)pinfo, info_len, quiet); + A->g_packet_type = packet_type_telemetry; break; case '_': /* Positionless Weather Report */ aprs_positionless_weather_report (A, pinfo, info_len); + A->g_packet_type = packet_type_weather; break; case '{': /* user defined data */ - /* http://www.aprs.org/aprs11/expfmts.txt */ - if (strncmp((char*)pinfo, "{tt", 3) == 0) { - aprs_raw_touch_tone (A, (char*)pinfo, info_len); - } - else if (strncmp((char*)pinfo, "{mc", 3) == 0) { - aprs_morse_code (A, (char*)pinfo, info_len); - } - else { - //aprs_user_defined (A, pinfo, info_len); - } + aprs_user_defined (A, (char*)pinfo, info_len); + A->g_packet_type = packet_type_userdefined; break; case 't': /* Raw touch tone data - NOT PART OF STANDARD */ @@ -302,6 +448,7 @@ void decode_aprs (decode_aprs_t *A, packet_t pp) /* Might move into user defined data, above. */ aprs_raw_touch_tone (A, (char*)pinfo, info_len); + // no packet type for t/ filter break; case 'm': /* Morse Code data - NOT PART OF STANDARD */ @@ -311,13 +458,12 @@ void decode_aprs (decode_aprs_t *A, packet_t pp) /* Might move into user defined data, above. */ aprs_morse_code (A, (char*)pinfo, info_len); + // no packet type for t/ filter break; - case '}': /* third party header */ - - third_party_header (A, (char*)pinfo, info_len); - break; + //case '}': /* third party header */ + // was already caught earlier. //case '\r': /* CR or LF? */ //case '\n': @@ -331,28 +477,27 @@ void decode_aprs (decode_aprs_t *A, packet_t pp) /* - * Look in other locations if not found in information field. + * Priority order for determining the symbol is: + * - Information part, where appropriate. Already done above. + * - Destination field starting with GPS, SPC, or SYM. + * - Source SSID - Confusing to most people. Even I forgot about it when + * someone questioned where the symbol came from. It's in the APRS + * protocol spec, end of Chapter 20. */ if (A->g_symbol_table == ' ' || A->g_symbol_code == ' ') { - symbols_from_dest_or_src (*pinfo, A->g_src, dest, &A->g_symbol_table, &A->g_symbol_code); - } - -/* - * Application might be in the destination field for most message types. - * MIC-E format has part of location in the destination field. - */ + // A symbol on a "message" makes no sense and confuses people. + // Third party too. Set from the payload. + // Maybe eliminate for a couple others. - switch (*pinfo) { /* "DTI" data type identifier. */ + //dw_printf ("DEBUG decode_aprs@end1 third_party=%d, symbol_table=%c, symbol_code=%c, *pinfo=%c\n", third_party, A->g_symbol_table, A->g_symbol_code, *pinfo); - case '\'': /* Old Mic-E Data */ - case '`': /* Current Mic-E Data */ - break; + if (*pinfo != ':' && *pinfo != '}') { + symbols_from_dest_or_src (*pinfo, A->g_src, A->g_dest, &A->g_symbol_table, &A->g_symbol_code); + } - default: - decode_tocall (A, dest); - break; + //dw_printf ("DEBUG decode_aprs@end2 third_party=%d, symbol_table=%c, symbol_code=%c, *pinfo=%c\n", third_party, A->g_symbol_table, A->g_symbol_code, *pinfo); } } /* end decode_aprs */ @@ -360,8 +505,7 @@ void decode_aprs (decode_aprs_t *A, packet_t pp) void decode_aprs_print (decode_aprs_t *A) { - char stemp[200]; - //char tmp2[2]; + char stemp[500]; double absll; char news; int deg; @@ -369,54 +513,95 @@ void decode_aprs_print (decode_aprs_t *A) { char s_lat[30]; char s_lon[30]; int n; - char symbol_description[100]; /* * First line has: - * - message type + * - packet type * - object name * - symbol * - manufacturer/application * - mic-e status * - power/height/gain, range */ - strcpy (stemp, A->g_msg_type); + strlcpy (stemp, A->g_data_type_desc, sizeof(stemp)); + + //dw_printf ("DEBUG decode_aprs_print stemp1=%s\n", stemp); if (strlen(A->g_name) > 0) { - strcat (stemp, ", \""); - strcat (stemp, A->g_name); - strcat (stemp, "\""); + strlcat (stemp, ", \"", sizeof(stemp)); + strlcat (stemp, A->g_name, sizeof(stemp)); + strlcat (stemp, "\"", sizeof(stemp)); } - symbols_get_description (A->g_symbol_table, A->g_symbol_code, symbol_description); - strcat (stemp, ", "); - strcat (stemp, symbol_description); + //dw_printf ("DEBUG decode_aprs_print stemp2=%s\n", stemp); + + //dw_printf ("DEBUG decode_aprs_print symbol_code=%c=0x%02x\n", A->g_symbol_code, A->g_symbol_code); + + if (A->g_symbol_code != ' ') { + char symbol_description[100]; + symbols_get_description (A->g_symbol_table, A->g_symbol_code, symbol_description, sizeof(symbol_description)); + + //dw_printf ("DEBUG decode_aprs_print symbol_description_description=%s\n", symbol_description); + + strlcat (stemp, ", ", sizeof(stemp)); + strlcat (stemp, symbol_description, sizeof(stemp)); + } + + //dw_printf ("DEBUG decode_aprs_print stemp3=%s mfr=%s\n", stemp, A->g_mfr); if (strlen(A->g_mfr) > 0) { - strcat (stemp, ", "); - strcat (stemp, A->g_mfr); + if (strcmp(A->g_dest, "APRS") == 0 || + strcmp(A->g_dest, "BEACON") == 0 || + strcmp(A->g_dest, "ID") == 0) { + strlcat (stemp, "\nUse of \"", sizeof(stemp)); + strlcat (stemp, A->g_dest, sizeof(stemp)); + strlcat (stemp, "\" in the destination field is obsolete.", sizeof(stemp)); + strlcat (stemp, " You can help to improve the quality of APRS signals.", sizeof(stemp)); + strlcat (stemp, "\nTell the sender (", sizeof(stemp)); + strlcat (stemp, A->g_src, sizeof(stemp)); + strlcat (stemp, ") to use the proper product identifier from", sizeof(stemp)); + strlcat (stemp, " https://github.com/aprsorg/aprs-deviceid ", sizeof(stemp)); + } + else { + strlcat (stemp, ", ", sizeof(stemp)); + strlcat (stemp, A->g_mfr, sizeof(stemp)); + } } + //dw_printf ("DEBUG decode_aprs_print stemp4=%s\n", stemp); + if (strlen(A->g_mic_e_status) > 0) { - strcat (stemp, ", "); - strcat (stemp, A->g_mic_e_status); + strlcat (stemp, ", ", sizeof(stemp)); + strlcat (stemp, A->g_mic_e_status, sizeof(stemp)); } + //dw_printf ("DEBUG decode_aprs_print stemp5=%s\n", stemp); if (A->g_power > 0) { char phg[100]; - sprintf (phg, ", %d W height=%d %ddBi %s", A->g_power, A->g_height, A->g_gain, A->g_directivity); - strcat (stemp, phg); + /* Protocol spec doesn't mention whether this is dBd or dBi. */ + /* Clarified later. */ + /* http://eng.usna.navy.mil/~bruninga/aprs/aprs11.html */ + /* "The Antenna Gain in the PHG format on page 28 is in dBi." */ + + snprintf (phg, sizeof(phg), ", %d W height(HAAT)=%dft=%.0fm %ddBi %s", A->g_power, A->g_height, DW_FEET_TO_METERS(A->g_height), A->g_gain, A->g_directivity); + strlcat (stemp, phg, sizeof(stemp)); } if (A->g_range > 0) { char rng[100]; - sprintf (rng, ", range=%.1f", A->g_range); - strcat (stemp, rng); + snprintf (rng, sizeof(rng), ", range=%.1f", A->g_range); + strlcat (stemp, rng, sizeof(stemp)); + } + + if (strncmp(stemp, "ERROR", 5) == 0) { + text_color_set(DW_COLOR_ERROR); + } + else { + text_color_set(DW_COLOR_DECODED); } - text_color_set(DW_COLOR_DECODED); dw_printf("%s\n", stemp); /* @@ -435,40 +620,23 @@ void decode_aprs_print (decode_aprs_t *A) { * * Any example was checked for each hemihemisphere using * http://www.amsat.org/cgi-bin/gridconv - * - * Bug: This does not check for invalid values. */ if (strlen(A->g_maidenhead) > 0) { - dw_printf("Grid square = %s, ", A->g_maidenhead); if (A->g_lat == G_UNKNOWN && A->g_lon == G_UNKNOWN) { - - A->g_lon = (toupper(A->g_maidenhead[0]) - 'A') * 20 - 180; - A->g_lat = (toupper(A->g_maidenhead[1]) - 'A') * 10 - 90; - A->g_lon += (A->g_maidenhead[2] - '0') * 2; - A->g_lat += (A->g_maidenhead[3] - '0'); - - if (strlen(A->g_maidenhead) >=6) { - A->g_lon += (toupper(A->g_maidenhead[4]) - 'A') * 5.0 / 60.0; - A->g_lat += (toupper(A->g_maidenhead[5]) - 'A') * 2.5 / 60.0; - - A->g_lon += 2.5 / 60.0; /* Move from corner to center of square */ - A->g_lat += 1.25 / 60.0; - } - else { - A->g_lon += 1.0; /* Move from corner to center of square */ - A->g_lat += 0.5; - } + ll_from_grid_square (A->g_maidenhead, &(A->g_lat), &(A->g_lon)); } + + dw_printf("Grid square = %s, ", A->g_maidenhead); } - strcpy (stemp, ""); + strlcpy (stemp, "", sizeof(stemp)); if (A->g_lat != G_UNKNOWN || A->g_lon != G_UNKNOWN) { -// Have location but it is posible one part is invalid. +// Have location but it is possible one part is invalid. if (A->g_lat != G_UNKNOWN) { @@ -482,10 +650,10 @@ void decode_aprs_print (decode_aprs_t *A) { } deg = (int) absll; min = (absll - deg) * 60.0; - sprintf (s_lat, "%c %02d%s%07.4f", news, deg, CH_DEGREE, min); + snprintf (s_lat, sizeof(s_lat), "%c %02d%s%07.4f", news, deg, CH_DEGREE, min); } else { - strcpy (s_lat, "Invalid Latitude"); + strlcpy (s_lat, "Invalid Latitude", sizeof(s_lat)); } if (A->g_lon != G_UNKNOWN) { @@ -500,72 +668,72 @@ void decode_aprs_print (decode_aprs_t *A) { } deg = (int) absll; min = (absll - deg) * 60.0; - sprintf (s_lon, "%c %03d%s%07.4f", news, deg, CH_DEGREE, min); + snprintf (s_lon, sizeof(s_lon), "%c %03d%s%07.4f", news, deg, CH_DEGREE, min); } else { - strcpy (s_lon, "Invalid Longitude"); + strlcpy (s_lon, "Invalid Longitude", sizeof(s_lon)); } - sprintf (stemp, "%s, %s", s_lat, s_lon); + snprintf (stemp, sizeof(stemp), "%s, %s", s_lat, s_lon); } if (strlen(A->g_aprstt_loc) > 0) { - if (strlen(stemp) > 0) strcat (stemp, ", "); - strcat (stemp, A->g_aprstt_loc); + if (strlen(stemp) > 0) strlcat (stemp, ", ", sizeof(stemp)); + strlcat (stemp, A->g_aprstt_loc, sizeof(stemp)); }; - if (A->g_speed != G_UNKNOWN) { - char spd[20]; + if (A->g_speed_mph != G_UNKNOWN) { + char spd[32]; - if (strlen(stemp) > 0) strcat (stemp, ", "); - sprintf (spd, "%.0f MPH", A->g_speed); - strcat (stemp, spd); + if (strlen(stemp) > 0) strlcat (stemp, ", ", sizeof(stemp)); + snprintf (spd, sizeof(spd), "%.0f km/h (%.0f MPH)", DW_MILES_TO_KM(A->g_speed_mph), A->g_speed_mph); + strlcat (stemp, spd, sizeof(stemp)); }; if (A->g_course != G_UNKNOWN) { char cse[20]; - if (strlen(stemp) > 0) strcat (stemp, ", "); - sprintf (cse, "course %.0f", A->g_course); - strcat (stemp, cse); + if (strlen(stemp) > 0) strlcat (stemp, ", ", sizeof(stemp)); + snprintf (cse, sizeof(cse), "course %.0f", A->g_course); + strlcat (stemp, cse, sizeof(stemp)); }; - if (A->g_altitude != G_UNKNOWN) { - char alt[20]; + if (A->g_altitude_ft != G_UNKNOWN) { + char alt[32]; - if (strlen(stemp) > 0) strcat (stemp, ", "); - sprintf (alt, "alt %.0f ft", A->g_altitude); - strcat (stemp, alt); + if (strlen(stemp) > 0) strlcat (stemp, ", ", sizeof(stemp)); + snprintf (alt, sizeof(alt), "alt %.0f m (%.0f ft)", DW_FEET_TO_METERS(A->g_altitude_ft), A->g_altitude_ft); + strlcat (stemp, alt, sizeof(stemp)); }; if (A->g_freq != G_UNKNOWN) { char ftemp[30]; - sprintf (ftemp, ", %.3f MHz", A->g_freq); - strcat (stemp, ftemp); + snprintf (ftemp, sizeof(ftemp), ", %.3f MHz", A->g_freq); + strlcat (stemp, ftemp, sizeof(stemp)); } if (A->g_offset != G_UNKNOWN) { char ftemp[30]; if (A->g_offset % 1000 == 0) { - sprintf (ftemp, ", %+dM", A->g_offset/1000); + snprintf (ftemp, sizeof(ftemp), ", %+dM", A->g_offset/1000); } else { - sprintf (ftemp, ", %+dk", A->g_offset); + snprintf (ftemp, sizeof(ftemp), ", %+dk", A->g_offset); } - strcat (stemp, ftemp); + strlcat (stemp, ftemp, sizeof(stemp)); } if (A->g_tone != G_UNKNOWN) { if (A->g_tone == 0) { - strcat (stemp, ", no PL"); + strlcat (stemp, ", no PL", sizeof(stemp)); } else { char ftemp[30]; - sprintf (ftemp, ", PL %.1f", A->g_tone); - strcat (stemp, ftemp); + snprintf (ftemp, sizeof(ftemp), ", PL %.1f", A->g_tone); + strlcat (stemp, ftemp, sizeof(stemp)); } } @@ -573,8 +741,8 @@ void decode_aprs_print (decode_aprs_t *A) { char ftemp[30]; - sprintf (ftemp, ", DCS %03o", A->g_dcs); - strcat (stemp, ftemp); + snprintf (ftemp, sizeof(ftemp), ", DCS %03o", A->g_dcs); + strlcat (stemp, ftemp, sizeof(stemp)); } if (strlen (stemp) > 0) { @@ -601,17 +769,13 @@ void decode_aprs_print (decode_aprs_t *A) { A->g_weather[n-1] = '\0'; n--; } - if (n > 0) { - //int j; - + if (n > 0) { ax25_safe_print (A->g_weather, -1, 0); dw_printf("\n"); } if (strlen(A->g_telemetry) > 0) { - //int j; - ax25_safe_print (A->g_telemetry, -1, 0); dw_printf("\n"); } @@ -639,19 +803,43 @@ void decode_aprs_print (decode_aprs_t *A) { * 0xf8 is degree in Microsoft code page 437. * To be part of a valid UTF-8 sequence, it would need to be followed by 10xxxxxx. */ - for (j=0; jg_comment[j] == (char)0xb0 && (j == 0 || ! (A->g_comment[j-1] & 0x80))) { - text_color_set(DW_COLOR_ERROR); - dw_printf("Character code 0xb0 is probably an attempt at a degree symbol.\n"); - dw_printf("The correct encoding is 0xc2 0xb0 in UTF-8.\n"); - } - } - for (j=0; jg_comment[j] == (char)0xf8 && (j == n-1 || (A->g_comment[j+1] & 0xc0) != 0xc0)) { - text_color_set(DW_COLOR_ERROR); - dw_printf("Character code 0xf8 is probably an attempt at a degree symbol.\n"); - dw_printf("The correct encoding is 0xc2 0xb0 in UTF-8.\n"); - } + +// For values 00-7F, ASCII, Unicode, and ISO Latin-1 are all the same. +// ISO Latin-1 adds 80-FF range with a few common symbols, such as degree, and +// letters, with diacritical marks, for many European languages. +// Unicode range 80-FF is called "Latin-1 Supplement." Exactly the same as ISO Latin-1. +// For UTF-8, an additional byte is inserted. +// Unicode UTF-8 +// ------- ----- +// 8x C2 8x Insert C2, keep original +// 9x C2 9x " +// Ax C2 Ax " +// Bx C2 Bx " +// Cx C3 8x Insert C3, subtract 40 from original +// Dx C3 9x " +// Ex C3 Ax " +// Fx C3 Bx " +// +// Can we use this knowledge to provide guidance on other ISO Latin-1 characters besides degree? +// Should we? +// Reference: https://www.fileformat.info/info/unicode/utf8test.htm + + if ( ! A->g_quiet) { + + for (j=0; jg_comment[j]) == 0xb0 && (j == 0 || ! (A->g_comment[j-1] & 0x80))) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Character code 0xb0 is probably an attempt at a degree symbol.\n"); + dw_printf("The correct encoding is 0xc2 0xb0 in UTF-8.\n"); + } + } + for (j=0; jg_comment[j]) == 0xf8 && (j == n-1 || (A->g_comment[j+1] & 0xc0) != 0xc0)) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Character code 0xf8 is probably an attempt at a degree symbol.\n"); + dw_printf("The correct encoding is 0xc2 0xb0 in UTF-8.\n"); + } + } } } } @@ -669,7 +857,7 @@ void decode_aprs_print (decode_aprs_t *A) { * Inputs: info - Pointer to Information field. * ilen - Information field length. * - * Outputs: A->g_lat, A->g_lon, A->g_symbol_table, A->g_symbol_code, A->g_speed, A->g_course, A->g_altitude. + * Outputs: A->g_lat, A->g_lon, A->g_symbol_table, A->g_symbol_code, A->g_speed_mph, A->g_course, A->g_altitude_ft. * * Description: Type identifier '=' has APRS messaging. * Type identifier '!' does not have APRS messaging. @@ -704,7 +892,7 @@ static void aprs_ll_pos (decode_aprs_t *A, unsigned char *info, int ilen) } *q; - strcpy (A->g_msg_type, "Position"); + strlcpy (A->g_data_type_desc, "Position", sizeof(A->g_data_type_desc)); p = (struct aprs_ll_pos_s *)info; q = (struct aprs_compressed_pos_s *)info; @@ -718,8 +906,34 @@ static void aprs_ll_pos (decode_aprs_t *A, unsigned char *info, int ilen) /* In this case, we expect 7 byte "data extension" */ /* for the wind direction and speed. */ - strcpy (A->g_msg_type, "Weather Report"); + strlcpy (A->g_data_type_desc, "Weather Report", sizeof(A->g_data_type_desc)); weather_data (A, p->comment, TRUE); +/* +Here is an interesting case. +The protocol spec states that a position report with symbol _ is a special case +and the information part must contain wxnow.txt format weather data. +But, here we see it being generated like a normal position report. + +N8VIM>BEACON,AB1OC-10*,WIDE2-1:!4240.85N/07133.99W_PHG72604/ Pepperell, MA. WX. 442.9+ PL100<0x0d> +Didn't find wind direction in form c999. +Didn't find wind speed in form s999. +Didn't find wind gust in form g999. +Didn't find temperature in form t999. +Weather Report, WEATHER Station (blue) +N 42 40.8500, W 071 33.9900 +, "PHG72604/ Pepperell, MA. WX. 442.9+ PL100" + +It seems, to me, that this is a violation of the protocol spec. +Then, immediately following, we have a positionless weather report in Ultimeter format. + +N8VIM>APN391,AB1OC-10*,WIDE2-1:$ULTW006F00CA01421C52275800008A00000102FA000F04A6000B002A<0x0d><0x0a> +Ultimeter, Kantronics KPC-3 rom versions +wind 6.9 mph, direction 284, temperature 32.2, barometer 29.75, humidity 76 + +aprs.fi merges these two together. Is that anywhere in the protocol spec or +just a heuristic added after noticing a pair of packets like this? +*/ + } else { /* Regular position report. */ @@ -737,7 +951,7 @@ static void aprs_ll_pos (decode_aprs_t *A, unsigned char *info, int ilen) /* compressed data so we don't expect a 7 byte "data */ /* extension" for them. */ - strcpy (A->g_msg_type, "Weather Report"); + strlcpy (A->g_data_type_desc, "Weather Report", sizeof(A->g_data_type_desc)); weather_data (A, q->comment, FALSE); } else { @@ -765,7 +979,7 @@ static void aprs_ll_pos (decode_aprs_t *A, unsigned char *info, int ilen) * Inputs: info - Pointer to Information field. * ilen - Information field length. * - * Outputs: A->g_lat, A->g_lon, A->g_symbol_table, A->g_symbol_code, A->g_speed, A->g_course, A->g_altitude. + * Outputs: A->g_lat, A->g_lon, A->g_symbol_table, A->g_symbol_code, A->g_speed_mph, A->g_course, A->g_altitude_ft. * * Description: Type identifier '@' has APRS messaging. * Type identifier '/' does not have APRS messaging. @@ -807,7 +1021,7 @@ static void aprs_ll_pos_time (decode_aprs_t *A, unsigned char *info, int ilen) } *q; - strcpy (A->g_msg_type, "Position with time"); + strlcpy (A->g_data_type_desc, "Position with time", sizeof(A->g_data_type_desc)); time_t ts = 0; @@ -826,7 +1040,7 @@ static void aprs_ll_pos_time (decode_aprs_t *A, unsigned char *info, int ilen) /* In this case, we expect 7 byte "data extension" */ /* for the wind direction and speed. */ - strcpy (A->g_msg_type, "Weather Report"); + strlcpy (A->g_data_type_desc, "Weather Report", sizeof(A->g_data_type_desc)); weather_data (A, p->comment, TRUE); } else { @@ -847,7 +1061,7 @@ static void aprs_ll_pos_time (decode_aprs_t *A, unsigned char *info, int ilen) /* compressed data so we don't expect a 7 byte "data */ /* extension" for them. */ - strcpy (A->g_msg_type, "Weather Report"); + strlcpy (A->g_data_type_desc, "Weather Report", sizeof(A->g_data_type_desc)); weather_data (A, q->comment, FALSE); } else { @@ -857,6 +1071,7 @@ static void aprs_ll_pos_time (decode_aprs_t *A, unsigned char *info, int ilen) } } + (void)(ts); // suppress 'set but not used' warning. } @@ -869,7 +1084,7 @@ static void aprs_ll_pos_time (decode_aprs_t *A, unsigned char *info, int ilen) * Inputs: info - Pointer to Information field. * ilen - Information field length. * - * Outputs: ??? TBD + * Outputs: A-> ... * * Description: APRS recognizes raw ASCII data strings conforming to the NMEA 0183 * Version 2.0 specification, originating from navigation equipment such @@ -882,222 +1097,41 @@ static void aprs_ll_pos_time (decode_aprs_t *A, unsigned char *info, int ilen) * VTG Velocity and Track Data * WPL Way Point Location * + * We presently recognize only RMC and GGA. + * * Examples: $GPGGA,102705,5157.9762,N,00029.3256,W,1,04,2.0,75.7,M,47.6,M,,*62 * $GPGLL,2554.459,N,08020.187,W,154027.281,A * $GPRMC,063909,A,3349.4302,N,11700.3721,W,43.022,89.3,291099,13.6,E*52 * $GPVTG,318.7,T,,M,35.1,N,65.0,K*69 * - * *------------------------------------------------------------------*/ -static void nmea_checksum (char *sent) -{ - char *p; - char *next; - unsigned char cs; - - -// Do we have valid checksum? - - cs = 0; - for (p = sent+1; *p != '*' && *p != '\0'; p++) { - cs ^= *p; - } - - p = strchr (sent, '*'); - if (p == NULL) { - text_color_set (DW_COLOR_INFO); - dw_printf("Missing GPS checksum.\n"); - return; - } - if (cs != strtoul(p+1, NULL, 16)) { - text_color_set (DW_COLOR_ERROR); - dw_printf("GPS checksum error. Expected %02x but found %s.\n", cs, p+1); - return; - } - *p = '\0'; // Remove the checksum. -} static void aprs_raw_nmea (decode_aprs_t *A, unsigned char *info, int ilen) { - char stemp[256]; - char *ptype; - char *next; - - - strcpy (A->g_msg_type, "Raw NMEA"); - - strncpy (stemp, (char *)info, ilen); - stemp[ilen] = '\0'; - nmea_checksum (stemp); - - next = stemp; - ptype = strsep(&next, ","); - - if (strcmp(ptype, "$GPGGA") == 0) - { - char *ptime; /* Time, hhmmss[.sss] */ - char *plat; /* Latitude */ - char *pns; /* North/South */ - char *plon; /* Longitude */ - char *pew; /* East/West */ - char *pquality; /* Fix Quality: 0=invalid, 1=GPS, 2=DGPS */ - char *pnsat; /* Number of satellites. */ - char *phdop; /* Horizontal dilution of precision. */ - char *paltitude; /* Altitude, meters above mean sea level. */ - char *pm; /* "M" = meters */ - /* Various other stuff... */ - - - ptime = strsep(&next, ","); - plat = strsep(&next, ","); - pns = strsep(&next, ","); - plon = strsep(&next, ","); - pew = strsep(&next, ","); - pquality = strsep(&next, ","); - pnsat = strsep(&next, ","); - phdop = strsep(&next, ","); - paltitude = strsep(&next, ","); - pm = strsep(&next, ","); - - /* Process time??? */ - - if (plat != NULL && strlen(plat) > 0) { - A->g_lat = latitude_from_nmea(plat, pns); - } - if (plon != NULL && strlen(plon) > 0) { - A->g_lon = longitude_from_nmea(plon, pew); - } - if (paltitude != NULL && strlen(paltitude) > 0) { - A->g_altitude = DW_METERS_TO_FEET(atof(paltitude)); - } - } - else if (strcmp(ptype, "$GPGLL") == 0) + if (strncmp((char*)info, "$GPRMC,", 7) == 0 || + strncmp((char*)info, "$GNRMC,", 7) == 0) { - char *plat; /* Latitude */ - char *pns; /* North/South */ - char *plon; /* Longitude */ - char *pew; /* East/West */ - /* optional Time hhmmss[.sss] */ - /* optional 'A' for data valid */ - - plat = strsep(&next, ","); - pns = strsep(&next, ","); - plon = strsep(&next, ","); - pew = strsep(&next, ","); - - if (plat != NULL && strlen(plat) > 0) { - A->g_lat = latitude_from_nmea(plat, pns); - } - if (plon != NULL && strlen(plon) > 0) { - A->g_lon = longitude_from_nmea(plon, pew); - } + float speed_knots = G_UNKNOWN; + (void) dwgpsnmea_gprmc ((char*)info, A->g_quiet, &(A->g_lat), &(A->g_lon), &speed_knots, &(A->g_course)); + A->g_speed_mph = DW_KNOTS_TO_MPH(speed_knots); + strlcpy (A->g_data_type_desc, "Raw GPS data", sizeof(A->g_data_type_desc)); } - else if (strcmp(ptype, "$GPRMC") == 0) + else if (strncmp((char*)info, "$GPGGA,", 7) == 0 || + strncmp((char*)info, "$GNGGA,", 7) == 0) { - //char *ptime, *pstatus, *plat, *pns, *plon, *pew, *pspeed, *ptrack, *pdate; - - char *ptime; /* Time, hhmmss[.sss] */ - char *pstatus; /* Status, A=Active (valid position), V=Void */ - char *plat; /* Latitude */ - char *pns; /* North/South */ - char *plon; /* Longitude */ - char *pew; /* East/West */ - char *pknots; /* Speed over ground, knots. */ - char *pcourse; /* True course, degrees. */ - char *pdate; /* Date, ddmmyy */ - /* Magnetic variation */ - /* In version 3.00, mode is added: A D E N (see below) */ - /* Checksum */ - - ptime = strsep(&next, ","); - pstatus = strsep(&next, ","); - plat = strsep(&next, ","); - pns = strsep(&next, ","); - plon = strsep(&next, ","); - pew = strsep(&next, ","); - pknots = strsep(&next, ","); - pcourse = strsep(&next, ","); - pdate = strsep(&next, ","); - - /* process time ??? date ??? */ - - if (plat != NULL && strlen(plat) > 0) { - A->g_lat = latitude_from_nmea(plat, pns); - } - if (plon != NULL && strlen(plon) > 0) { - A->g_lon = longitude_from_nmea(plon, pew); - } - if (pknots != NULL && strlen(pknots) > 0) { - A->g_speed = DW_KNOTS_TO_MPH(atof(pknots)); - } - if (pcourse != NULL && strlen(pcourse) > 0) { - A->g_course = atof(pcourse); - } - } - else if (strcmp(ptype, "$GPVTG") == 0) - { - - /* Speed and direction but NO location! */ - - char *ptcourse; /* True course, degrees. */ - char *pt; /* "T" */ - char *pmcourse; /* Magnetic course, degrees. */ - char *pm; /* "M" */ - char *pknots; /* Ground speed, knots. */ - char *pn; /* "N" = Knots */ - char *pkmh; /* Ground speed, km/hr */ - char *pk; /* "K" = Kilometers per hour */ - char *pmode; /* New in NMEA 0183 version 3.0 */ - /* Mode: A=Autonomous, D=Differential, */ - - ptcourse = strsep(&next, ","); - pt = strsep(&next, ","); - pmcourse = strsep(&next, ","); - pm = strsep(&next, ","); - pknots = strsep(&next, ","); - pn = strsep(&next, ","); - pkmh = strsep(&next, ","); - pk = strsep(&next, ","); - pmode = strsep(&next, ","); - - if (pknots != NULL && strlen(pknots) > 0) { - A->g_speed = DW_KNOTS_TO_MPH(atof(pknots)); - } - if (ptcourse != NULL && strlen(ptcourse) > 0) { - A->g_course = atof(ptcourse); - } + float alt_meters = G_UNKNOWN; + int num_sat = 0; + (void) dwgpsnmea_gpgga ((char*)info, A->g_quiet, &(A->g_lat), &(A->g_lon), &alt_meters, &num_sat); + A->g_altitude_ft = DW_METERS_TO_FEET(alt_meters); + strlcpy (A->g_data_type_desc, "Raw GPS data", sizeof(A->g_data_type_desc)); } - else if (strcmp(ptype, "$GPWPL") == 0) - { - //char *plat, *pns, *plon, *pew, *pident; - - char *plat; /* Latitude */ - char *pns; /* North/South */ - char *plon; /* Longitude */ - char *pew; /* East/West */ - char *pident; /* Identifier for Waypoint. rules??? */ - /* checksum */ - - plat = strsep(&next, ","); - pns = strsep(&next, ","); - plon = strsep(&next, ","); - pew = strsep(&next, ","); - pident = strsep(&next, ","); - - if (plat != NULL && strlen(plat) > 0) { - A->g_lat = latitude_from_nmea(plat, pns); - } - if (plon != NULL && strlen(plon) > 0) { - A->g_lon = longitude_from_nmea(plon, pew); - } - /* do something with identifier? */ + // TODO (low): add a few other sentence types. - } -} +} /* end aprs_raw_nmea */ @@ -1105,7 +1139,9 @@ static void aprs_raw_nmea (decode_aprs_t *A, unsigned char *info, int ilen) * * Function: aprs_mic_e * - * Purpose: Decode MIC-E (also Kenwood D7 & D700) packet. + * Purpose: Decode MIC-E (e.g. Kenwood D7 & D700) packet. + * This format is an overzelous quest to make the packet as short as possible. + * It uses non-printable characters and hacks wrapped in kludges. * * Inputs: info - Pointer to Information field. * ilen - Information field length. @@ -1114,29 +1150,120 @@ static void aprs_raw_nmea (decode_aprs_t *A, unsigned char *info, int ilen) * * Description: * - * Destination Address Field — + * AX.25 Destination Address Field - * - * The 7-byte Destination Address field contains + * The 6-byte Destination Address field contains * the following encoded information: * - * * The 6 latitude digits. - * * A 3-bit Mic-E message identifier, specifying one of 7 Standard Mic-E - * Message Codes or one of 7 Custom Message Codes or an Emergency - * Message Code. - * * The North/South and West/East Indicators. - * * The Longitude Offset Indicator. - * * The generic APRS digipeater path code. - * + * Byte 1: Lat digit 1, message bit A + * Byte 2: Lat digit 2, message bit B + * Byte 3: Lat digit 3, message bit C + * Byte 4: Lat digit 4, N/S lat indicator + * Byte 5: Lat digit 5, Longitude offset + * Byte 6: Lat digit 6, W/E Long indicator + * * * "Although the destination address appears to be quite unconventional, it is * still a valid AX.25 address, consisting only of printable 7-bit ASCII values." * - * References: Mic-E TYPE CODES -- http://www.aprs.org/aprs12/mic-e-types.txt + * AX.25 Information Field - Starts with ' or ` + * + * Bytes 1,2,3: Longitude + * Bytes 4,5,6: Speed and Course + * Byte 6: Symbol code + * Byte 7: Symbol Table ID + * + * The rest of it is a complicated comment field which can hold various information + * and must be intrepreted in a particular order. At this point we look for any + * prefix and/or suffix to identify the equipment type. + * + * References: Mic-E TYPE CODES -- http://www.aprs.org/aprs12/mic-e-types.txt + * Mic-E TEST EXAMPLES -- http://www.aprs.org/aprs12/mic-e-examples.txt + * + * Next, we have what Addedum 1.2 calls the "type byte." This prefix can be + * space Original MIC-E. + * > Kenwood HT. + * ] Kenwood Mobile. + * none. + * + * We also need to look at the last byte or two + * for a possible suffix to distinguish equipment types. Examples: + * >...... is D7 + * >......= is D72 + * >......^ is D74 + * + * For other brands, it gets worse. There might a 2 character suffix. + * The prefix indicates whether messaging-capable. Examples: + * `....._.% Yaesu FTM-400DR + * `......_) Yaesu FTM-100D + * `......_3 Yaesu FT5D + * + * '......|3 Byonics TinyTrack3 + * '......|4 Byonics TinyTrack4 + * + * Any prefix and suffix must be removed before futher processsing. + * + * Pick one: MIC-E Telemetry Data or "Status Text" (called a comment everywhere else). + * + * If the character after the symbol table id is "," (comma) or 0x1d, we have telemetry. + * (Is this obsoleted by the base-91 telemetry?) + * + * ` Two 2-character hexadecimal numbers. (Channels 1 & 3) + * ' Five 2-character hexadecimal numbers. + * + * Anything left over is a comment which can contain various types of information. + * + * If present, the MIC-E compressed altitude must be first. + * It is three base-91 characters followed by "}". + * Examples: "4T} "4T} ]"4T} + * + * We can also have frequency specification -- http://www.aprs.org/info/freqspec.txt + * + * Warning: Some Kenwood radios add CR at the end, in apparent violation of the spec. + * Watch out so it doesn't get included when looking for equipment type suffix. * * Mic-E TEST EXAMPLES -- http://www.aprs.org/aprs12/mic-e-examples.txt * - * Examples: `b9Z!4y>/>"4N}Paul's_TH-D7 + * Examples: Observed on the air. + * + * KB1HNZ-9>TSSP5P,W1IMD,WIDE1,KQ1L-8,N3LLO-3,WIDE2*:`b6,l}#>/]"48}449.225MHz<0xff><0xff><0xff><0xff><0xff><0xff><0xff><0xff><0xff><0xff><0xff><0xff><0xff><0xff><0xff><0xff><0xff><0xff><0xff><0xff><0xff><0xff><0xff><0xff><0xff><0xff><0xff><0xff>=<0x0d> + * + * ` b6, l}# >/ ] "48} 449.225MHz ...... = <0x0d> + * mic-e long. cs sym prefix alt. freq comment suffix must-ignore + * Kenwood D710 + *--------------- + * + * N1JDU-9>ECCU8Y,W1MHL*,WIDE2-1:'cZ<0x7f>l#H>/]Go fly a kite!<0x0d> + * + * ' cZ<0x7f> l#H >/ ] ..... <0x0d> + * mic-e long. cs sym prefix comment no-suffix must-ignore + * Kenwood D700 + *--------------- * - * TODO: Destination SSID can contain generic digipeater path. + * KC1HHO-7>T2PX5R,WA1PLE-4,WIDE1*,WIDE2-1:`c_snp(k/`"4B}official relay station NTS_(<0x0d> + * + * ` c_s np( k/ ` "4B} ....... _( <0x0d> + * mic-e long. cs sym prefix alt comment suffix must-ignore + * FT2D + *--------------- + * + * N1CMD-12>T3PQ1Y,KA1GJU-3,WIDE1,WA1PLE-4*:`cP#l!Fk/'"7H}|!%&-']|!w`&!|3 + * + * ` cP# l!F k/ ' "7H} |!%&-']| !w`&! |3 + * mic-e long. cs sym prefix alt base91telemetry DAO suffix + * TinyTrack3 + *--------------- + * + * W1STJ-3>T2UR4X,WA1PLE-4,WIDE1*,WIDE2-1:`c@&l#.-/`"5,}146.685MHz T100 -060 146.520 Simplex or Voice Alert_%<0x0d> + * + * ` c@& l#. -/ ` "5,} 146.685MHz T100 -060 .............. _% <0x0d> + * mic-e long. cs sym prefix alt frequency-specification comment suffix must-ignore + * FTM-400DR + *--------------- + * + * + * + * + * TODO: Destination SSID can contain generic digipeater path. (?) * * Bugs: Doesn't handle ambiguous position. "space" treated as zero. * Invalid data results in a message but latitude is not set to unknown. @@ -1159,6 +1286,7 @@ N1ZZN-9>T2SP0W:`c_Vm6hk/ "49}Originl Mic-E (leading space) N1ZZN-9>T2SP0W:`c_Vm6hk/>"49}TH-D7A walkie Talkie N1ZZN-9>T2SP0W:`c_Vm6hk/>"49}TH-D72 walkie Talkie= +W6GPS>S4PT3R:`p(1oR0K\>TH-D74A^ N1ZZN-9>T2SP0W:`c_Vm6hk/]"49}TM-D700 MObile Radio N1ZZN-9>T2SP0W:`c_Vm6hk/]"49}TM-D710 Mobile Radio= @@ -1175,7 +1303,7 @@ N1ZZN-9>T2SP0W:'c_Vm6hk/`"49}Byonics TinyTrack4|4 # The next group starts with metacharacter "T" which can be any of space > ] ` ' # But space is for original Mic-E, # > and ] are for Kenwood, -# so ` ' would probably be less ambigous choices but any appear to be valid. +# so ` ' would probably be less ambiguous choices but any appear to be valid. N1ZZN-9>T2SP0W:'c_Vm6hk/`"49}Hamhud\9 N1ZZN-9>T2SP0W:'c_Vm6hk/`"49}Argent/9 @@ -1202,7 +1330,7 @@ MIC-E, JEEP, In Service */ -static int mic_e_digit (char c, int mask, int *std_msg, int *cust_msg) +static int mic_e_digit (decode_aprs_t *A, char c, int mask, int *std_msg, int *cust_msg) { if (c >= '0' && c <= '9') { @@ -1237,8 +1365,10 @@ static int mic_e_digit (char c, int mask, int *std_msg, int *cust_msg) return (0); } - text_color_set(DW_COLOR_ERROR); - dw_printf("Invalid character \"%c\" in MIC-E destination/latitude.\n", c); + if ( ! A->g_quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Invalid character \"%c\" in MIC-E destination/latitude.\n", c); + } return (0); } @@ -1254,7 +1384,7 @@ static void aprs_mic_e (decode_aprs_t *A, packet_t pp, unsigned char *info, int char sym_table_id; } *p; - char dest[10]; + char dest[12]; int ch; int n; int offset; @@ -1264,7 +1394,7 @@ static void aprs_mic_e (decode_aprs_t *A, packet_t pp, unsigned char *info, int const char *cust_text[8] = {"Emergency", "Custom-6", "Custom-5", "Custom-4", "Custom-3", "Custom-2", "Custom-1", "Custom-0" }; unsigned char *pfirst, *plast; - strcpy (A->g_msg_type, "MIC-E"); + strlcpy (A->g_data_type_desc, "MIC-E", sizeof(A->g_data_type_desc)); p = (struct aprs_mic_e_s *)info; @@ -1273,15 +1403,15 @@ static void aprs_mic_e (decode_aprs_t *A, packet_t pp, unsigned char *info, int ax25_get_addr_with_ssid (pp, AX25_DESTINATION, dest); - A->g_lat = mic_e_digit(dest[0], 4, &std_msg, &cust_msg) * 10 + - mic_e_digit(dest[1], 2, &std_msg, &cust_msg) + - (mic_e_digit(dest[2], 1, &std_msg, &cust_msg) * 1000 + - mic_e_digit(dest[3], 0, &std_msg, &cust_msg) * 100 + - mic_e_digit(dest[4], 0, &std_msg, &cust_msg) * 10 + - mic_e_digit(dest[5], 0, &std_msg, &cust_msg)) / 6000.0; + A->g_lat = mic_e_digit(A, dest[0], 4, &std_msg, &cust_msg) * 10 + + mic_e_digit(A, dest[1], 2, &std_msg, &cust_msg) + + (mic_e_digit(A, dest[2], 1, &std_msg, &cust_msg) * 1000 + + mic_e_digit(A, dest[3], 0, &std_msg, &cust_msg) * 100 + + mic_e_digit(A, dest[4], 0, &std_msg, &cust_msg) * 10 + + mic_e_digit(A, dest[5], 0, &std_msg, &cust_msg)) / 6000.0; -/* 4th character of desination indicates north / south. */ +/* 4th character of destination indicates north / south. */ if ((dest[3] >= '0' && dest[3] <= '9') || dest[3] == 'L') { /* South */ @@ -1293,8 +1423,10 @@ static void aprs_mic_e (decode_aprs_t *A, packet_t pp, unsigned char *info, int } else { - text_color_set(DW_COLOR_ERROR); - dw_printf("Invalid MIC-E N/S encoding in 4th character of destination.\n"); + if ( ! A->g_quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Invalid MIC-E N/S encoding in 4th character of destination.\n"); + } } @@ -1312,14 +1444,16 @@ static void aprs_mic_e (decode_aprs_t *A, packet_t pp, unsigned char *info, int else { offset = 0; - text_color_set(DW_COLOR_ERROR); - dw_printf("Invalid MIC-E Longitude Offset in 5th character of destination.\n"); + if ( ! A->g_quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Invalid MIC-E Longitude Offset in 5th character of destination.\n"); + } } /* First character of information field is longitude in degrees. */ /* It is possible for the unprintable DEL character to occur here. */ -/* 5th character of desination indicates longitude offset of +100. */ +/* 5th character of destination indicates longitude offset of +100. */ /* Not quite that simple :-( */ ch = p->lon[0]; @@ -1342,9 +1476,11 @@ static void aprs_mic_e (decode_aprs_t *A, packet_t pp, unsigned char *info, int } else { - A->g_lon = G_UNKNOWN; - text_color_set(DW_COLOR_ERROR); - dw_printf("Invalid character 0x%02x for MIC-E Longitude Degrees.\n", ch); + A->g_lon = G_UNKNOWN; + if ( ! A->g_quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Invalid character 0x%02x for MIC-E Longitude Degrees.\n", ch); + } } /* Second character of information field is A->g_longitude minutes. */ @@ -1378,8 +1514,10 @@ static void aprs_mic_e (decode_aprs_t *A, packet_t pp, unsigned char *info, int } else { A->g_lon = G_UNKNOWN; - text_color_set(DW_COLOR_ERROR); - dw_printf("Invalid character 0x%02x for MIC-E Longitude Minutes.\n", ch); + if ( ! A->g_quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Invalid character 0x%02x for MIC-E Longitude Minutes.\n", ch); + } } /* Third character of information field is longitude hundredths of minutes. */ @@ -1396,13 +1534,15 @@ static void aprs_mic_e (decode_aprs_t *A, packet_t pp, unsigned char *info, int } else { A->g_lon = G_UNKNOWN; - text_color_set(DW_COLOR_ERROR); - dw_printf("Invalid character 0x%02x for MIC-E Longitude hundredths of Minutes.\n", ch); + if ( ! A->g_quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Invalid character 0x%02x for MIC-E Longitude hundredths of Minutes.\n", ch); + } } } } -/* 6th character of destintation indicates east / west. */ +/* 6th character of destination indicates east / west. */ /* * Example of apparently invalid encoding. 6th character missing. @@ -1425,8 +1565,10 @@ static void aprs_mic_e (decode_aprs_t *A, packet_t pp, unsigned char *info, int } else { - text_color_set(DW_COLOR_ERROR); - dw_printf("Invalid MIC-E E/W encoding in 6th character of destination.\n"); + if ( ! A->g_quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Invalid MIC-E E/W encoding in 6th character of destination.\n"); + } } /* Symbol table and codes like everyone else. */ @@ -1437,24 +1579,26 @@ static void aprs_mic_e (decode_aprs_t *A, packet_t pp, unsigned char *info, int if (A->g_symbol_table != '/' && A->g_symbol_table != '\\' && ! isupper(A->g_symbol_table) && ! isdigit(A->g_symbol_table)) { - text_color_set(DW_COLOR_ERROR); - dw_printf("Invalid symbol table code not one of / \\ A-Z 0-9\n"); + if ( ! A->g_quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Invalid symbol table code not one of / \\ A-Z 0-9\n"); + } A->g_symbol_table = '/'; } /* Message type from two 3-bit codes. */ if (std_msg == 0 && cust_msg == 0) { - strcpy (A->g_mic_e_status, "Emergency"); + strlcpy (A->g_mic_e_status, "Emergency", sizeof(A->g_mic_e_status)); } else if (std_msg == 0 && cust_msg != 0) { - strcpy (A->g_mic_e_status, cust_text[cust_msg]); + strlcpy (A->g_mic_e_status, cust_text[cust_msg], sizeof(A->g_mic_e_status)); } else if (std_msg != 0 && cust_msg == 0) { - strcpy (A->g_mic_e_status, std_text[std_msg]); + strlcpy (A->g_mic_e_status, std_text[std_msg], sizeof(A->g_mic_e_status)); } else { - strcpy (A->g_mic_e_status, "Unknown MIC-E Message Type"); + strlcpy (A->g_mic_e_status, "Unknown MIC-E Message Type", sizeof(A->g_mic_e_status)); } /* Speed and course from next 3 bytes. */ @@ -1462,7 +1606,7 @@ static void aprs_mic_e (decode_aprs_t *A, packet_t pp, unsigned char *info, int n = ((p->speed_course[0] - 28) * 10) + ((p->speed_course[1] - 28) / 10); if (n >= 800) n -= 800; - A->g_speed = DW_KNOTS_TO_MPH(n); + A->g_speed_mph = DW_KNOTS_TO_MPH(n); n = ((p->speed_course[1] - 28) % 10) * 100 + (p->speed_course[2] - 28); if (n >= 400) n -= 400; @@ -1481,7 +1625,7 @@ static void aprs_mic_e (decode_aprs_t *A, packet_t pp, unsigned char *info, int /* Now try to pick out manufacturer and other optional items. */ /* The telemetry field, in the original spec, is no longer used. */ - strcpy (A->g_mfr, "Unknown manufacturer"); + strlcpy (A->g_mfr, "Unknown manufacturer", sizeof(A->g_mfr)); pfirst = info + sizeof(struct aprs_mic_e_s); plast = info + ilen - 1; @@ -1497,36 +1641,64 @@ static void aprs_mic_e (decode_aprs_t *A, packet_t pp, unsigned char *info, int #define isT(c) ((c) == ' ' || (c) == '>' || (c) == ']' || (c) == '`' || (c) == '\'') +// Last Updated Dec. 2021 + +// This does not change very often but I'm wondering if we could parse +// http://www.aprs.org/aprs12/mic-e-types.txt similar to how we use tocalls.txt. + +// TODO: Use https://github.com/aprsorg/aprs-deviceid rather than hardcoding. if (isT(*pfirst)) { - - if (*pfirst == ' ') { strcpy (A->g_mfr, "Original MIC-E"); pfirst++; } - else if (*pfirst == '>' && *plast == '=') { strcpy (A->g_mfr, "Kenwood TH-D72"); pfirst++; plast--; } - else if (*pfirst == '>') { strcpy (A->g_mfr, "Kenwood TH-D7A"); pfirst++; } +// "legacy" formats. + + if (*pfirst == ' ' ) { strlcpy (A->g_mfr, "Original MIC-E", sizeof(A->g_mfr)); pfirst++; } + + else if (*pfirst == '>' && *plast == '=') { strlcpy (A->g_mfr, "Kenwood TH-D72", sizeof(A->g_mfr)); pfirst++; plast--; } + else if (*pfirst == '>' && *plast == '^') { strlcpy (A->g_mfr, "Kenwood TH-D74", sizeof(A->g_mfr)); pfirst++; plast--; } + else if (*pfirst == '>' && *plast == '&') { strlcpy (A->g_mfr, "Kenwood TH-D75", sizeof(A->g_mfr)); pfirst++; plast--; } + else if (*pfirst == '>' ) { strlcpy (A->g_mfr, "Kenwood TH-D7A", sizeof(A->g_mfr)); pfirst++; } + + else if (*pfirst == ']' && *plast == '=') { strlcpy (A->g_mfr, "Kenwood TM-D710", sizeof(A->g_mfr)); pfirst++; plast--; } + else if (*pfirst == ']' ) { strlcpy (A->g_mfr, "Kenwood TM-D700", sizeof(A->g_mfr)); pfirst++; } + +// ` should be used for message capable devices. + + else if (*pfirst == '`' && *(plast-1) == '_' && *plast == ' ') { strlcpy (A->g_mfr, "Yaesu VX-8", sizeof(A->g_mfr)); pfirst++; plast-=2; } + else if (*pfirst == '`' && *(plast-1) == '_' && *plast == '"') { strlcpy (A->g_mfr, "Yaesu FTM-350", sizeof(A->g_mfr)); pfirst++; plast-=2; } + else if (*pfirst == '`' && *(plast-1) == '_' && *plast == '#') { strlcpy (A->g_mfr, "Yaesu VX-8G", sizeof(A->g_mfr)); pfirst++; plast-=2; } + else if (*pfirst == '`' && *(plast-1) == '_' && *plast == '$') { strlcpy (A->g_mfr, "Yaesu FT1D", sizeof(A->g_mfr)); pfirst++; plast-=2; } + else if (*pfirst == '`' && *(plast-1) == '_' && *plast == '%') { strlcpy (A->g_mfr, "Yaesu FTM-400DR", sizeof(A->g_mfr)); pfirst++; plast-=2; } + else if (*pfirst == '`' && *(plast-1) == '_' && *plast == ')') { strlcpy (A->g_mfr, "Yaesu FTM-100D", sizeof(A->g_mfr)); pfirst++; plast-=2; } + else if (*pfirst == '`' && *(plast-1) == '_' && *plast == '(') { strlcpy (A->g_mfr, "Yaesu FT2D", sizeof(A->g_mfr)); pfirst++; plast-=2; } + else if (*pfirst == '`' && *(plast-1) == '_' && *plast == '0') { strlcpy (A->g_mfr, "Yaesu FT3D", sizeof(A->g_mfr)); pfirst++; plast-=2; } + else if (*pfirst == '`' && *(plast-1) == '_' && *plast == '3') { strlcpy (A->g_mfr, "Yaesu FT5D", sizeof(A->g_mfr)); pfirst++; plast-=2; } + else if (*pfirst == '`' && *(plast-1) == '_' && *plast == '1') { strlcpy (A->g_mfr, "Yaesu FTM-300D", sizeof(A->g_mfr)); pfirst++; plast-=2; } + else if (*pfirst == '`' && *(plast-1) == '_' && *plast == '5') { strlcpy (A->g_mfr, "Yaesu FTM-500D", sizeof(A->g_mfr)); pfirst++; plast-=2; } + + else if (*pfirst == '`' && *(plast-1) == ' ' && *plast == 'X') { strlcpy (A->g_mfr, "AP510", sizeof(A->g_mfr)); pfirst++; plast-=2; } + + else if (*pfirst == '`' && *(plast-1) == '(' && *plast == '5') { strlcpy (A->g_mfr, "Anytone D578UV", sizeof(A->g_mfr)); pfirst++; plast-=2; } + else if (*pfirst == '`' ) { strlcpy (A->g_mfr, "Generic Mic-Emsg", sizeof(A->g_mfr)); pfirst++; } - else if (*pfirst == ']' && *plast == '=') { strcpy (A->g_mfr, "Kenwood TM-D710"); pfirst++; plast--; } - else if (*pfirst == ']') { strcpy (A->g_mfr, "Kenwood TM-D700"); pfirst++; } +// ' should be used for trackers (not message capable). - else if (*pfirst == '`' && *(plast-1) == '_' && *plast == ' ') { strcpy (A->g_mfr, "Yaesu VX-8"); pfirst++; plast-=2; } - else if (*pfirst == '`' && *(plast-1) == '_' && *plast == '"') { strcpy (A->g_mfr, "Yaesu FTM-350"); pfirst++; plast-=2; } - else if (*pfirst == '`' && *(plast-1) == '_' && *plast == '#') { strcpy (A->g_mfr, "Yaesu VX-8G"); pfirst++; plast-=2; } - else if (*pfirst == '`' && *(plast-1) == '_' && *plast == '$') { strcpy (A->g_mfr, "Yaesu FT1D"); pfirst++; plast-=2; } - else if (*pfirst == '`' && *(plast-1) == '_' && *plast == '%') { strcpy (A->g_mfr, "Yaesu FTM-400DR"); pfirst++; plast-=2; } + else if (*pfirst == '\'' && *(plast-1) == '(' && *plast == '5') { strlcpy (A->g_mfr, "Anytone D578UV", sizeof(A->g_mfr)); pfirst++; plast-=2; } + else if (*pfirst == '\'' && *(plast-1) == '(' && *plast == '8') { strlcpy (A->g_mfr, "Anytone D878UV", sizeof(A->g_mfr)); pfirst++; plast-=2; } - else if (*pfirst == '\'' && *(plast-1) == '|' && *plast == '3') { strcpy (A->g_mfr, "Byonics TinyTrack3"); pfirst++; plast-=2; } - else if (*pfirst == '\'' && *(plast-1) == '|' && *plast == '4') { strcpy (A->g_mfr, "Byonics TinyTrack4"); pfirst++; plast-=2; } + else if (*pfirst == '\'' && *(plast-1) == '|' && *plast == '3') { strlcpy (A->g_mfr, "Byonics TinyTrack3", sizeof(A->g_mfr)); pfirst++; plast-=2; } + else if (*pfirst == '\'' && *(plast-1) == '|' && *plast == '4') { strlcpy (A->g_mfr, "Byonics TinyTrack4", sizeof(A->g_mfr)); pfirst++; plast-=2; } - else if (*(plast-1) == '\\') { strcpy (A->g_mfr, "Hamhud ?"); pfirst++; plast-=2; } - else if (*(plast-1) == '/') { strcpy (A->g_mfr, "Argent ?"); pfirst++; plast-=2; } - else if (*(plast-1) == '^') { strcpy (A->g_mfr, "HinzTec anyfrog"); pfirst++; plast-=2; } - else if (*(plast-1) == '*') { strcpy (A->g_mfr, "APOZxx www.KissOZ.dk Tracker. OZ1EKD and OZ7HVO"); pfirst++; plast-=2; } - else if (*(plast-1) == '~') { strcpy (A->g_mfr, "OTHER"); pfirst++; plast-=2; } + else if (*pfirst == '\'' && *(plast-1) == ':' && *plast == '4') { strlcpy (A->g_mfr, "SCS GmbH & Co. P4dragon DR-7400 modems", sizeof(A->g_mfr)); pfirst++; plast-=2; } + else if (*pfirst == '\'' && *(plast-1) == ':' && *plast == '8') { strlcpy (A->g_mfr, "SCS GmbH & Co. P4dragon DR-7800 modems", sizeof(A->g_mfr)); pfirst++; plast-=2; } - // Should Original Mic-E and Kenwood be moved down to here? + else if (*pfirst == '\'' ) { strlcpy (A->g_mfr, "Generic McTrackr", sizeof(A->g_mfr)); pfirst++; } - else if (*pfirst == '`') { strcpy (A->g_mfr, "Mic-Emsg"); pfirst++; plast-=2; } - else if (*pfirst == '\'') { strcpy (A->g_mfr, "McTrackr"); pfirst++; plast-=2; } + else if ( *(plast-1) == '\\' ) { strlcpy (A->g_mfr, "Hamhud ?", sizeof(A->g_mfr)); pfirst++; plast-=2; } + else if ( *(plast-1) == '/' ) { strlcpy (A->g_mfr, "Argent ?", sizeof(A->g_mfr)); pfirst++; plast-=2; } + else if ( *(plast-1) == '^' ) { strlcpy (A->g_mfr, "HinzTec anyfrog", sizeof(A->g_mfr)); pfirst++; plast-=2; } + else if ( *(plast-1) == '*' ) { strlcpy (A->g_mfr, "APOZxx www.KissOZ.dk Tracker. OZ1EKD and OZ7HVO", sizeof(A->g_mfr)); pfirst++; plast-=2; } + else if ( *(plast-1) == '~' ) { strlcpy (A->g_mfr, "Unknown OTHER", sizeof(A->g_mfr)); pfirst++; plast-=2; } } /* @@ -1552,14 +1724,16 @@ static void aprs_mic_e (decode_aprs_t *A, packet_t pp, unsigned char *info, int if (plast > pfirst && pfirst[3] == '}') { - A->g_altitude = DW_METERS_TO_FEET((pfirst[0]-33)*91*91 + (pfirst[1]-33)*91 + (pfirst[2]-33) - 10000); + A->g_altitude_ft = DW_METERS_TO_FEET((pfirst[0]-33)*91*91 + (pfirst[1]-33)*91 + (pfirst[2]-33) - 10000); if ( ! isdigit91(pfirst[0]) || ! isdigit91(pfirst[1]) || ! isdigit91(pfirst[2])) { - text_color_set(DW_COLOR_ERROR); - dw_printf("Invalid character in MIC-E altitude. Must be in range of '!' to '{'.\n"); - dw_printf("Bogus altitude of %.0f changed to unknown.\n", A->g_altitude); - A->g_altitude = G_UNKNOWN; + if ( ! A->g_quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Invalid character in MIC-E altitude. Must be in range of '!' to '{'.\n"); + dw_printf("Bogus altitude of %.0f changed to unknown.\n", A->g_altitude_ft); + } + A->g_altitude_ft = G_UNKNOWN; } pfirst += 4; @@ -1574,51 +1748,205 @@ static void aprs_mic_e (decode_aprs_t *A, packet_t pp, unsigned char *info, int * * Function: aprs_message * - * Purpose: Decode "Message Format" + * Purpose: Decode "Message Format." + * The word message is used loosely all over the place, but it has a very specific meaning here. * - * Inputs: info - Pointer to Information field. + * Inputs: info - Pointer to Information field. Be careful not to modify it here! * ilen - Information field length. + * quiet - suppress error messages. * - * Outputs: ??? TBD + * Outputs: A->g_data_type_desc Text description for screen display. * - * Description: An APRS message is a text string with a specifed addressee. + * A->g_addressee To whom is it addressed. + * Could be a specific station, alias, bulletin, etc. + * For telemetry metadata is is about this station, + * not being sent to it. + * + * A->g_message_subtype Subtype so caller might avoid replicating + * all the code to distinguish them. + * + * A->g_message_number Message number if any. Required for ack/rej. + * + * Description: An APRS message is a text string with a specified addressee. * * It's a lot more complicated with different types of addressees * and replies with acknowledgement or rejection. * - * Displaying and logging these messages could be useful. + * Is it an elegant generalization to lump all of these special cases + * together or was it a big mistake that will cause confusion and incorrect + * implementations? The decision to put telemetry metadata here is baffling. * - * Examples: - * + * + * Cases: :BLNxxxxxx: ... Bulletin. + * :NWSxxxxxx: ... National Weather Service Bulletin. + * http://www.aprs.org/APRS-docs/WX.TXT + * :SKYxxxxxx: ... Need reference. + * :CWAxxxxxx: ... Need reference. + * :BOMxxxxxx: ... Australian version. + * + * :xxxxxxxxx:PARM. Telemetry metadata, parameter name + * :xxxxxxxxx:UNIT. Telemetry metadata, unit/label + * :xxxxxxxxx:EQNS. Telemetry metadata, Equation Coefficients + * :xxxxxxxxx:BITS. Telemetry metadata, Bit Sense/Project Name + * :xxxxxxxxx:? Directed Station Query + * :xxxxxxxxx:ackNNNN Message acknowledged (received) + * :xxxxxxxxx:rejNNNNN Message rejected (unable to accept) + * + * :xxxxxxxxx: ... Message with no message number. + * (Text may not contain the { character because + * it indicates beginning of optional message number.) + * :xxxxxxxxx: ... {NNNNN Message with message number, 1 to 5 alphanumeric. + * :xxxxxxxxx: ... {mm} Message with new style message number. + * :xxxxxxxxx: ... {mm}aa Message with new style message number and ack. + * + * + * Reference: http://www.aprs.org/txt/messages101.txt + * http://www.aprs.org/aprs11/replyacks.txt <-- New (1999) adding ack to outgoing message. * *------------------------------------------------------------------*/ -static void aprs_message (decode_aprs_t *A, unsigned char *info, int ilen) +static void aprs_message (decode_aprs_t *A, unsigned char *info, int ilen, int quiet) { struct aprs_message_s { char dti; /* : */ char addressee[9]; char colon; /* : */ - char message[73]; /* 0-67 characters for message */ - /* { followed by 1-5 characters for message number */ + char message[256-1-9-1]; /* Officially up to 67 characters for message text. */ + /* Relaxing seemingly arbitrary restriction here; it doesn't need to fit on a punched card. */ + /* Wouldn't surprise me if others did not pay attention to the limit. */ + /* Optional '{' followed by 1-5 alphanumeric characters for message number */ + + /* If the first character is '?' it is a Directed Station Query. */ } *p; char addressee[AX25_MAX_ADDR_LEN]; int i; - p = (struct aprs_message_s *)info; - memset (addressee, 0, sizeof(addressee)); - strncpy (addressee, p->addressee, sizeof(p->addressee)); + strlcpy (A->g_data_type_desc, "APRS Message", sizeof(A->g_data_type_desc)); + A->g_message_subtype = message_subtype_message; /* until found otherwise */ - /* Trim trailing spaces. */ - i = strlen(addressee) - 1; - while (i >= 0 && addressee[i] == ' ') { - addressee[i--] = '\0'; + if (ilen < 11) { + if (! quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf("APRS Message must have a minimum of 11 characters for : 9 character addressee :\n"); + } + A->g_message_subtype = message_subtype_invalid; + return; } + if (p->colon != ':') { + if (! quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf("APRS Message must begin with ':' 9 character addressee ':'\n"); + dw_printf("Spaces must be added to shorter addressee to make 9 characters.\n"); + } + A->g_message_subtype = message_subtype_invalid; + return; + } + + memset (addressee, 0, sizeof(addressee)); + memcpy (addressee, p->addressee, sizeof(p->addressee)); // copy exactly 9 bytes. + + /* Trim trailing spaces. */ + i = strlen(addressee) - 1; + while (i >= 0 && addressee[i] == ' ') { + addressee[i--] = '\0'; + } + + // Anytone AT-D878UV 2 plus would pad out station name to 6 characters + // before appending the SSID. e.g. "AE7MK -5 " + + // Test cases. First is valid. Others should produce errors: + // + // cbeacon sendto=r0 delay=0:10 info=":AE7MK-5 :test0" + // cbeacon sendto=r0 delay=0:15 info=":AE7MK-5:test1" + // cbeacon sendto=r0 delay=0:20 info=":AE7MK -5 :test2" + // cbeacon sendto=r0 delay=0:25 info=":AE7 -5 :test3" + + static regex_t bad_addressee_re; /* Probably bad addressee. */ + static int first_time = 1; + + if (first_time) { + char emsg[100]; + int e = regcomp (&bad_addressee_re, "[A-Z0-9]+ +-[0-9]", REG_EXTENDED); + if (e) { + regerror (e, &bad_addressee_re, emsg, sizeof(emsg)); + dw_printf("%s:%d: %s\n", __FILE__, __LINE__, emsg); + } + first_time = 0; + } + +#define MAXMATCH_AT 2 + regmatch_t match[MAXMATCH_AT]; + + if (regexec (&bad_addressee_re, addressee, MAXMATCH_AT, match, 0) == 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Malformed addressee with space between station name and SSID.\n"); + dw_printf("Please tell message sender this is invalid.\n"); + } + + strlcpy (A->g_addressee, addressee, sizeof(A->g_addressee)); + +/* + * Addressee starting with BLN or NWS is a bulletin. + */ + if (strlen(addressee) >= 3 && strncmp(addressee,"BLN",3) == 0) { + + // Interpret 3 cases of identifiers. + // BLN9 "general bulletin" has a single digit. + // BLNX "announcement" has a single uppercase letter. + // BLN9xxxxx "group bulletin" has single digit group id and group name up to 5 characters. + + if (strlen(addressee) == 4 && isdigit(addressee[3])) { + snprintf (A->g_data_type_desc, sizeof(A->g_data_type_desc), "General Bulletin with identifier \"%s\"", addressee+3); + } + else if (strlen(addressee) == 4 && isupper(addressee[3])) { + snprintf (A->g_data_type_desc, sizeof(A->g_data_type_desc), "Announcement with identifier \"%s\"", addressee+3); + } + if (strlen(addressee) >=5 && isdigit(addressee[3])) { + snprintf (A->g_data_type_desc, sizeof(A->g_data_type_desc), "Group Bulletin with identifier \"%c\", group name \"%s\"", addressee[3], addressee+4); + } + else { + // Not one of the official formats. + snprintf (A->g_data_type_desc, sizeof(A->g_data_type_desc), "Bulletin with identifier \"%s\"", addressee+3); + } + A->g_message_subtype = message_subtype_bulletin; + strlcpy (A->g_comment, p->message, sizeof(A->g_comment)); + } + + + // Weather bulletins have addressee starting with NWS, SKY, CWA, or BOM. + // The protocol spec and http://www.aprs.org/APRS-docs/WX.TXT state that + // the 3 letter prefix must be followed by a dash. + // However, https://www.aprs-is.net/WX/ also lists the underscore + // alternative for the compressed format. Xastir implements this. + + else if (strlen(addressee) >= 3 && strncmp(addressee,"NWS",3) == 0) { + + if (strlen(addressee) >=4 && addressee[3] == '-') { + snprintf (A->g_data_type_desc, sizeof(A->g_data_type_desc), "Weather bulletin with identifier \"%s\"", addressee+4); + } + else if (strlen(addressee) >=4 && addressee[3] == '_') { + snprintf (A->g_data_type_desc, sizeof(A->g_data_type_desc), "Compressed Weather bulletin with identifier \"%s\"", addressee+4); + } + else { + snprintf (A->g_data_type_desc, sizeof(A->g_data_type_desc), "Weather bulletin is missing - or _ after %.3s", addressee); + } + A->g_message_subtype = message_subtype_nws; + strlcpy (A->g_comment, p->message, sizeof(A->g_comment)); + } + + else if (strlen(addressee) >= 3 && (strncmp(addressee,"SKY",3) == 0 || strncmp(addressee,"CWA",3) == 0 || strncmp(addressee,"BOM",3) == 0)) { + // SKY... or CWA... https://www.aprs-is.net/WX/ + snprintf (A->g_data_type_desc, sizeof(A->g_data_type_desc), "Weather bulletin with identifier \"%s\"", addressee+4); + A->g_message_subtype = message_subtype_nws; + strlcpy (A->g_comment, p->message, sizeof(A->g_comment)); + } + + /* * Special message formats contain telemetry metadata. * It applies to the addressee, not the sender. @@ -1630,28 +1958,163 @@ static void aprs_message (decode_aprs_t *A, unsigned char *info, int ilen) * Why not use other characters after the "T" for metadata? */ - if (strncmp(p->message,"PARM.",5) == 0) { - sprintf (A->g_msg_type, "Telemetry Parameter Name Message for \"%s\"", addressee); + else if (strncmp(p->message,"PARM.",5) == 0) { + snprintf (A->g_data_type_desc, sizeof(A->g_data_type_desc), "Telemetry Parameter Name for \"%s\"", addressee); + A->g_message_subtype = message_subtype_telem_parm; telemetry_name_message (addressee, p->message+5); } else if (strncmp(p->message,"UNIT.",5) == 0) { - sprintf (A->g_msg_type, "Telemetry Unit/Label Message for \"%s\"", addressee); + snprintf (A->g_data_type_desc, sizeof(A->g_data_type_desc), "Telemetry Unit/Label for \"%s\"", addressee); + A->g_message_subtype = message_subtype_telem_unit; telemetry_unit_label_message (addressee, p->message+5); } else if (strncmp(p->message,"EQNS.",5) == 0) { - sprintf (A->g_msg_type, "Telemetry Equation Coefficents Message for \"%s\"", addressee); - telemetry_coefficents_message (addressee, p->message+5); + snprintf (A->g_data_type_desc, sizeof(A->g_data_type_desc), "Telemetry Equation Coefficients for \"%s\"", addressee); + A->g_message_subtype = message_subtype_telem_eqns; + telemetry_coefficents_message (addressee, p->message+5, quiet); } else if (strncmp(p->message,"BITS.",5) == 0) { - sprintf (A->g_msg_type, "Telemetry Bit Sense/Project Name Message for \"%s\"", addressee); - telemetry_bit_sense_message (addressee, p->message+5); + snprintf (A->g_data_type_desc, sizeof(A->g_data_type_desc), "Telemetry Bit Sense/Project Name for \"%s\"", addressee); + A->g_message_subtype = message_subtype_telem_bits; + telemetry_bit_sense_message (addressee, p->message+5, quiet); + } + +/* + * If first character of message is "?" it is a query directed toward a specific station. + */ + + else if (p->message[0] == '?') { + + strlcpy (A->g_data_type_desc, "Directed Station Query", sizeof(A->g_data_type_desc)); + A->g_message_subtype = message_subtype_directed_query; + + aprs_directed_station_query (A, addressee, p->message+1, quiet); + } + +/* ack or rej? Message number is required for these. */ + + else if (strncasecmp(p->message,"ack",3) == 0) { + if (strncmp(p->message,"ack",3) != 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf("ERROR: \"%s\" must be lower case \"ack\"\n", p->message); + } + else { + strlcpy (A->g_message_number, p->message + 3, sizeof(A->g_message_number)); + if (strlen(A->g_message_number) == 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf("ERROR: Message number is missing after \"ack\".\n"); + } + } + + // Xastir puts a carriage return on the end. + char *p = strchr(A->g_message_number, '\r'); + if (p != NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf("The APRS protocol specification says nothing about a possible carriage return after the\n"); + dw_printf("message id. Adding CR might prevent proper interoperability with with other applications.\n"); + *p = '\0'; + } + + if (strlen(A->g_message_number) >= 3 && A->g_message_number[2] == '}') A->g_message_number[2] = '\0'; + snprintf (A->g_data_type_desc, sizeof(A->g_data_type_desc), "\"%s\" ACKnowledged message number \"%s\" from \"%s\"", A->g_src, A->g_message_number, addressee); + A->g_message_subtype = message_subtype_ack; } + else if (strncasecmp(p->message,"rej",3) == 0) { + if (strncmp(p->message,"rej",3) != 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf("ERROR: \"%s\" must be lower case \"rej\"\n", p->message); + } + else { + strlcpy (A->g_message_number, p->message + 3, sizeof(A->g_message_number)); + if (strlen(A->g_message_number) == 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf("ERROR: Message number is missing after \"rej\".\n"); + } + } + + // Xastir puts a carriage return on the end. + char *p = strchr(A->g_message_number, '\r'); + if (p != NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf("The APRS protocol specification says nothing about a possible carriage return after the\n"); + dw_printf("message id. Adding CR might prevent proper interoperability with with other applications.\n"); + *p = '\0'; + } + + if (strlen(A->g_message_number) >= 3 && A->g_message_number[2] == '}') A->g_message_number[2] = '\0'; + snprintf (A->g_data_type_desc, sizeof(A->g_data_type_desc), "\"%s\" REJected message number \"%s\" from \"%s\"", A->g_src, A->g_message_number, addressee); + A->g_message_subtype = message_subtype_ack; + } + +// Message to a particular station or a bulletin. +// message number is optional here. +// Test cases. Wrap in third party too. +// A>B::WA1XYX-15:Howdy y'all +// A>B::WA1XYX-15:Howdy y'all{12345 +// A>B::WA1XYX-15:Howdy y'all{12} +// A>B::WA1XYX-15:Howdy y'all{12}34 +// A>B::WA1XYX-15:Howdy y'all{toolong +// X>Y:}A>B::WA1XYX-15:Howdy y'all +// X>Y:}A>B::WA1XYX-15:Howdy y'all{12345 +// X>Y:}A>B::WA1XYX-15:Howdy y'all{12} +// X>Y:}A>B::WA1XYX-15:Howdy y'all{12}34 +// X>Y:}A>B::WA1XYX-15:Howdy y'all{toolong + else { - sprintf (A->g_msg_type, "APRS Message for \"%s\"", addressee); + // Normal messaage case. Look for message number. + char *pno = strchr(p->message, '{'); + if (pno != NULL) { + strlcpy (A->g_message_number, pno+1, sizeof(A->g_message_number)); + + // Xastir puts a carriage return on the end. + char *p = strchr(A->g_message_number, '\r'); + if (p != NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf("The APRS protocol specification says nothing about a possible carriage return after the\n"); + dw_printf("message id. Adding CR might prevent proper interoperability with with other applications.\n"); + *p = '\0'; + } + + int mlen = strlen(A->g_message_number); + if (mlen < 1 || mlen > 5) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Message number \"%s\" has length outside range of 1 to 5.\n", A->g_message_number); + } + + // TODO: Complain if not alphanumeric. + + char ack[8] = ""; + + if (mlen >= 3 && A->g_message_number[2] == '}') { + // New (1999) style. + A->g_message_number[2] = '\0'; + strlcpy (ack, A->g_message_number + 3, sizeof(ack)); + } + + if (strlen(ack) > 0) { + // With ACK. Message number should be 2 characters. + snprintf (A->g_data_type_desc, sizeof(A->g_data_type_desc), "APRS Message, number \"%s\", from \"%s\" to \"%s\", with ACK for \"%s\"", A->g_message_number, A->g_src, addressee, ack); + } + else { + // Message number can be 1-5 characters. + snprintf (A->g_data_type_desc, sizeof(A->g_data_type_desc), "APRS Message, number \"%s\", from \"%s\" to \"%s\"", A->g_message_number, A->g_src, addressee); + } + } + else { + // No message number. + snprintf (A->g_data_type_desc, sizeof(A->g_data_type_desc), "APRS Message, with no number, from \"%s\" to \"%s\"", A->g_src, addressee); + } + + A->g_message_subtype = message_subtype_message; /* No location so don't use process_comment () */ - strcpy (A->g_comment, p->message); + strlcpy (A->g_comment, p->message, sizeof(A->g_comment)); + // Remove message number when displaying message text. + pno = strchr(A->g_comment, '{'); + if (pno != NULL) { + *pno = '\0'; + } } } @@ -1667,7 +2130,7 @@ static void aprs_message (decode_aprs_t *A, unsigned char *info, int ilen) * Inputs: info - Pointer to Information field. * ilen - Information field length. * - * Outputs: A->g_object_name, A->g_lat, A->g_lon, A->g_symbol_table, A->g_symbol_code, A->g_speed, A->g_course, A->g_altitude. + * Outputs: A->g_object_name, A->g_lat, A->g_lon, A->g_symbol_table, A->g_symbol_code, A->g_speed_mph, A->g_course, A->g_altitude_ft. * * Description: Message has a 9 character object name which could be quite different than * the source station. @@ -1711,19 +2174,23 @@ static void aprs_object (decode_aprs_t *A, unsigned char *info, int ilen) p = (struct aprs_object_s *)info; q = (struct aprs_compressed_object_s *)info; - strncpy (A->g_name, p->name, 9); - A->g_name[9] = '\0'; + //assert (sizeof(A->g_name) > sizeof(p->name)); + + memset (A->g_name, 0, sizeof(A->g_name)); + memcpy (A->g_name, p->name, sizeof(p->name)); // copy exactly 9 bytes. + + /* Trim trailing spaces. */ i = strlen(A->g_name) - 1; while (i >= 0 && A->g_name[i] == ' ') { A->g_name[i--] = '\0'; } - if (p->live_killed == '*') - strcpy (A->g_msg_type, "Object"); + if (p->live_killed == '*') + strlcpy (A->g_data_type_desc, "Object", sizeof(A->g_data_type_desc)); else if (p->live_killed == '_') - strcpy (A->g_msg_type, "Killed Object"); + strlcpy (A->g_data_type_desc, "Killed Object", sizeof(A->g_data_type_desc)); else - strcpy (A->g_msg_type, "Object - invalid live/killed"); + strlcpy (A->g_data_type_desc, "Object - invalid live/killed", sizeof(A->g_data_type_desc)); ts = get_timestamp (A, p->time_stamp); @@ -1736,7 +2203,7 @@ static void aprs_object (decode_aprs_t *A, unsigned char *info, int ilen) /* In this case, we expect 7 byte "data extension" */ /* for the wind direction and speed. */ - strcpy (A->g_msg_type, "Weather Report with Object"); + strlcpy (A->g_data_type_desc, "Weather Report with Object", sizeof(A->g_data_type_desc)); weather_data (A, p->comment, TRUE); } else { @@ -1755,7 +2222,7 @@ static void aprs_object (decode_aprs_t *A, unsigned char *info, int ilen) /* of weather report and object with compressed */ /* position. */ - strcpy (A->g_msg_type, "Weather Report with Object"); + strlcpy (A->g_data_type_desc, "Weather Report with Object", sizeof(A->g_data_type_desc)); weather_data (A, q->comment, FALSE); } else { @@ -1765,7 +2232,9 @@ static void aprs_object (decode_aprs_t *A, unsigned char *info, int ilen) } } -} + (void)(ts); + +} /* end aprs_object */ /*------------------------------------------------------------------ @@ -1777,7 +2246,7 @@ static void aprs_object (decode_aprs_t *A, unsigned char *info, int ilen) * Inputs: info - Pointer to Information field. * ilen - Information field length. * - * Outputs: A->g_object_name, A->g_lat, A->g_lon, A->g_symbol_table, A->g_symbol_code, A->g_speed, A->g_course, A->g_altitude. + * Outputs: A->g_object_name, A->g_lat, A->g_lon, A->g_symbol_table, A->g_symbol_code, A->g_speed_mph, A->g_course, A->g_altitude_ft. * * Description: An "item" is very much like an "object" except * @@ -1793,30 +2262,39 @@ static void aprs_item (decode_aprs_t *A, unsigned char *info, int ilen) { struct aprs_item_s { - char dti; /* ) */ - char name[9]; /* Actually variable length 3 - 9 bytes. */ - char live_killed; /* ! for live or _ for killed */ - position_t pos; - char comment[43]; /* First 7 bytes could be data extension. */ + char dti; /* ')' */ + char name[10]; /* Actually variable length 3 - 9 bytes. */ + /* DON'T refer to the rest of this structure; */ + /* the offsets will be wrong! */ + /* We make it 10 here so we don't get subscript out of bounds */ + /* warning when looking for following '!' or '_' character. */ + + char live_killed__; /* ! for live or _ for killed */ + position_t pos__; + char comment__[43]; /* First 7 bytes could be data extension. */ } *p; struct aprs_compressed_item_s { - char dti; /* ) */ - char name[9]; /* Actually variable length 3 - 9 bytes. */ - char live_killed; /* ! for live or _ for killed */ - compressed_position_t cpos; - char comment[40]; /* No data extension in this case. */ + char dti; /* ')' */ + char name[10]; /* Actually variable length 3 - 9 bytes. */ + /* DON'T refer to the rest of this structure; */ + /* the offsets will be wrong! */ + + char live_killed__; /* ! for live or _ for killed */ + compressed_position_t cpos__; + char comment__[40]; /* No data extension in this case. */ } *q; - time_t ts = 0; int i; char *ppos; p = (struct aprs_item_s *)info; q = (struct aprs_compressed_item_s *)info; + (void)(q); + memset (A->g_name, 0, sizeof(A->g_name)); i = 0; while (i < 9 && p->name[i] != '!' && p->name[i] != '_') { A->g_name[i] = p->name[i]; @@ -1825,13 +2303,15 @@ static void aprs_item (decode_aprs_t *A, unsigned char *info, int ilen) } if (p->name[i] == '!') - strcpy (A->g_msg_type, "Item"); + strlcpy (A->g_data_type_desc, "Item", sizeof(A->g_data_type_desc)); else if (p->name[i] == '_') - strcpy (A->g_msg_type, "Killed Item"); + strlcpy (A->g_data_type_desc, "Killed Item", sizeof(A->g_data_type_desc)); else { - text_color_set(DW_COLOR_ERROR); - dw_printf("Item name too long or not followed by ! or _.\n"); - strcpy (A->g_msg_type, "Object - invalid live/killed"); + if ( ! A->g_quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Item name too long or not followed by ! or _.\n"); + } + strlcpy (A->g_data_type_desc, "Object - invalid live/killed", sizeof(A->g_data_type_desc)); } ppos = p->name + i + 1; @@ -1875,12 +2355,14 @@ static void aprs_item (decode_aprs_t *A, unsigned char *info, int ilen) static void aprs_station_capabilities (decode_aprs_t *A, char *info, int ilen) { - strcpy (A->g_msg_type, "Station Capabilities"); + strlcpy (A->g_data_type_desc, "Station Capabilities", sizeof(A->g_data_type_desc)); - // Is process_comment() applicable? + // process_comment() not applicable here because it + // extracts information found in certain formats. - strcpy (A->g_comment, info+1); -} + strlcpy (A->g_comment, info+1, sizeof(A->g_comment)); + +} /* end aprs_station_capabilities */ @@ -1960,7 +2442,7 @@ static void aprs_status_report (decode_aprs_t *A, char *info, int ilen) } *ps; - strcpy (A->g_msg_type, "Status Report"); + strlcpy (A->g_data_type_desc, "Status Report", sizeof(A->g_data_type_desc)); pt = (struct aprs_status_time_s *)info; pm4 = (struct aprs_status_m4_s *)info; @@ -1978,16 +2460,20 @@ static void aprs_status_report (decode_aprs_t *A, char *info, int ilen) isdigit(pt->ztime[5]) && pt->ztime[6] == 'z') { - strcpy (A->g_comment, pt->comment); + // process_comment() not applicable here because it + // extracts information found in certain formats. + + strlcpy (A->g_comment, pt->comment, sizeof(A->g_comment)); } /* * Do we have format with 6 character Maidenhead locator? */ + else if (get_maidenhead (A, pm6->mhead6) == 6) { - strncpy (A->g_maidenhead, pm6->mhead6, 6); - A->g_maidenhead[6] = '\0'; + memset (A->g_maidenhead, 0, sizeof(A->g_maidenhead)); + memcpy (A->g_maidenhead, pm6->mhead6, sizeof(pm6->mhead6)); A->g_symbol_table = pm6->sym_table_id; A->g_symbol_code = pm6->symbol_code; @@ -1995,17 +2481,24 @@ static void aprs_status_report (decode_aprs_t *A, char *info, int ilen) if (A->g_symbol_table != '/' && A->g_symbol_table != '\\' && ! isupper(A->g_symbol_table) && ! isdigit(A->g_symbol_table)) { - text_color_set(DW_COLOR_ERROR); - dw_printf("Invalid symbol table code '%c' not one of / \\ A-Z 0-9\n", A->g_symbol_table); + if ( ! A->g_quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Invalid symbol table code '%c' not one of / \\ A-Z 0-9\n", A->g_symbol_table); + } A->g_symbol_table = '/'; } if (pm6->space != ' ' && pm6->space != '\0') { - text_color_set(DW_COLOR_ERROR); - dw_printf("Error: Found '%c' instead of space required after symbol code.\n", pm6->space); + if ( ! A->g_quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Error: Found '%c' instead of space required after symbol code.\n", pm6->space); + } } - strcpy (A->g_comment, pm6->comment); + // process_comment() not applicable here because it + // extracts information found in certain formats. + + strlcpy (A->g_comment, pm6->comment, sizeof(A->g_comment)); } /* @@ -2013,8 +2506,8 @@ static void aprs_status_report (decode_aprs_t *A, char *info, int ilen) */ else if (get_maidenhead (A, pm4->mhead4) == 4) { - strncpy (A->g_maidenhead, pm4->mhead4, 4); - A->g_maidenhead[4] = '\0'; + memset (A->g_maidenhead, 0, sizeof(A->g_maidenhead)); + memcpy (A->g_maidenhead, pm4->mhead4, sizeof(pm4->mhead4)); A->g_symbol_table = pm4->sym_table_id; A->g_symbol_code = pm4->symbol_code; @@ -2022,24 +2515,31 @@ static void aprs_status_report (decode_aprs_t *A, char *info, int ilen) if (A->g_symbol_table != '/' && A->g_symbol_table != '\\' && ! isupper(A->g_symbol_table) && ! isdigit(A->g_symbol_table)) { - text_color_set(DW_COLOR_ERROR); - dw_printf("Invalid symbol table code '%c' not one of / \\ A-Z 0-9\n", A->g_symbol_table); + if ( ! A->g_quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Invalid symbol table code '%c' not one of / \\ A-Z 0-9\n", A->g_symbol_table); + } A->g_symbol_table = '/'; } if (pm4->space != ' ' && pm4->space != '\0') { - text_color_set(DW_COLOR_ERROR); - dw_printf("Error: Found '%c' instead of space required after symbol code.\n", pm4->space); + if ( ! A->g_quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Error: Found '%c' instead of space required after symbol code.\n", pm4->space); + } } - strcpy (A->g_comment, pm4->comment); + // process_comment() not applicable here because it + // extracts information found in certain formats. + + strlcpy (A->g_comment, pm4->comment, sizeof(A->g_comment)); } /* * Whole thing is status text. */ else { - strcpy (A->g_comment, ps->comment); + strlcpy (A->g_comment, ps->comment, sizeof(A->g_comment)); } @@ -2068,13 +2568,252 @@ static void aprs_status_report (decode_aprs_t *A, char *info, int ilen) erp = (p - '0') * (p - '0') * 10; } - // TODO: put result somewhere. + // TODO (low): put result somewhere. // could use A->g_directivity and need new variable for erp. *hp = '\0'; + + (void)(beam); + (void)(erp); } } -} + +} /* end aprs_status_report */ + + +/*------------------------------------------------------------------ + * + * Function: aprs_general_query + * + * Purpose: Decode "General Query" for all stations. + * + * Inputs: info - Pointer to Information field. First character should be "?". + * ilen - Information field length. + * quiet - suppress error messages. + * + * Outputs: A - Decoded packet structure + * A->g_query_type + * A->g_query_lat (optional) + * A->g_query_lon (optional) + * A->g_query_radius (optional) + * + * Description: Formats are: + * + * ?query? + * ?query?lat,long,radius + * + * 'query' is one of APRS, IGATE, WX, ... + * optional footprint, in degrees and miles radius, means only + * those in the specified circle should respond. + * + * Examples from specification, Chapter 15: + * + * ?APRS? + * ?APRS? 34.02,-117.15,0200 + * ?IGATE? + * + *------------------------------------------------------------------*/ + +/* +https://groups.io/g/direwolf/topic/95961245#7357 + +What APRS queries should DireWolf respond to? Well, it should be configurable whether it responds to queries at all, in case some other application is using DireWolf as a dumb TNC (KISS or AGWPE style) and wants to handle the queries itself. + +Assuming query responding is enabled, the following broadcast queries should be supported (if the corresponding data is configured in DireWolf): + +?APRS (I am an APRS station) +?IGATE (I am operating as a I-gate) +?WX (I am providing local weather data in my beacon) + +*/ + + +static void aprs_general_query (decode_aprs_t *A, char *info, int ilen, int quiet) +{ + char *q2; + char *p; + char *tok; + char stemp[256]; + double lat, lon; + float radius; + + strlcpy (A->g_data_type_desc, "General Query", sizeof(A->g_data_type_desc)); + +/* + * First make a copy because we will modify it while parsing it. + */ + + strlcpy (stemp, info, sizeof(stemp)); + +/* + * There should be another "?" after the query type. + */ + q2 = strchr(stemp+1, '?'); + if (q2 == NULL) { + if ( ! A->g_quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf("General Query must have ? after the query type.\n"); + } + return; + } + + *q2 = '\0'; + strlcpy (A->g_query_type, stemp+1, sizeof(A->g_query_type)); + +// TODO: remove debug + + text_color_set(DW_COLOR_DEBUG); + dw_printf("DEBUG: General Query type = \"%s\"\n", A->g_query_type); + + p = q2 + 1; + if (strlen(p) == 0) { + return; + } + +/* + * Try to extract footprint. + * Spec says positive coordinate would be preceded by space + * and radius must be exactly 4 digits. We are more forgiving. + */ + tok = strsep(&p, ","); + if (tok != NULL) { + lat = atof(tok); + tok = strsep(&p, ","); + if (tok != NULL) { + lon = atof(tok); + tok = strsep(&p, ","); + if (tok != NULL) { + radius = atof(tok); + + if (lat < -90 || lat > 90) { + if ( ! A->g_quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Invalid latitude for General Query footprint.\n"); + } + return; + } + + if (lon < -180 || lon > 180) { + if ( ! A->g_quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Invalid longitude for General Query footprint.\n"); + } + return; + } + + if (radius <= 0 || radius > 9999) { + if ( ! A->g_quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Invalid radius for General Query footprint.\n"); + } + return; + } + + A->g_footprint_lat = lat; + A->g_footprint_lon = lon; + A->g_footprint_radius = radius; + } + else { + if ( ! A->g_quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Can't get radius for General Query footprint.\n"); + } + return; + } + } + else { + if ( ! A->g_quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Can't get longitude for General Query footprint.\n"); + } + return; + } + } + else { + if ( ! A->g_quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Can't get latitude for General Query footprint.\n"); + } + return; + } + +// TODO: remove debug + + text_color_set(DW_COLOR_DEBUG); + dw_printf("DEBUG: General Query footprint = %.6f %.6f %.2f\n", lat, lon, radius); + + +} /* end aprs_general_query */ + + + +/*------------------------------------------------------------------ + * + * Function: aprs_directed_station_query + * + * Purpose: Decode "Directed Station Query" aimed at specific station. + * This is actually a special format of the more general "message." + * + * Inputs: addressee - To whom it is directed. + * Redundant because it is already in A->addressee. + * + * query - What's left over after ":addressee:?" in info part. + * + * quiet - suppress error messages. + * + * Outputs: A - Decoded packet structure + * A->g_query_type + * A->g_query_callsign (optional) + * + * Description: The caller has already removed the :addressee:? part so we are left + * with a query type of exactly 5 characters and optional "callsign + * of heard station." + * + * Examples from specification, Chapter 15. Our "query" argument. + * + * :KH2Z :?APRSD APRSD + * :KH2Z :?APRSHVN0QBF APRSHVN0QBF + * :KH2Z :?APRST APRST + * :KH2Z :?PING? PING? + * + * "PING?" contains "?" only to pad it out to exactly 5 characters. + * + *------------------------------------------------------------------*/ + +/* +https://groups.io/g/direwolf/topic/95961245#7357 + +The following directed queries (sent as bodies of APRS text messages) would also be useful (if corresponding data configured): + +?APRSP (force my current beacon) +?APRST and ?PING (trace my path to requestor) +?APRSD (all stations directly heard [no digipeat hops] by local station) +?APRSO (any Objects/Items originated by this station) +?APRSH (how often or how many times the specified 3rd station was heard by the queried station) +?APRSS (immediately send the Status message if configured) (can DireWolf do Status messages?) + +Lynn KJ4ERJ and I have implemented a non-standard query which might be useful: + +?VER (send the human-readable software version of the queried station) + +Hope this is useful. It's just my $.02. + +Andrew, KA2DDO +author of YAAC +*/ + +static void aprs_directed_station_query (decode_aprs_t *A, char *addressee, char *query, int quiet) +{ + //char query_type[20]; /* Does the query type always need to be exactly 5 characters? */ + /* If not, how would we know where the extra optional information starts? */ + + //char callsign[AX25_MAX_ADDR_LEN]; + + //if (strlen(query) < 5) ... + + +} /* end aprs_directed_station_query */ + /*------------------------------------------------------------------ @@ -2085,8 +2824,10 @@ static void aprs_status_report (decode_aprs_t *A, char *info, int ilen) * * Inputs: info - Pointer to Information field. * ilen - Information field length. + * quiet - suppress error messages. * - * Outputs: ??? + * Outputs: A->g_telemetry + * A->g_comment * * Description: TBD. * @@ -2097,17 +2838,67 @@ static void aprs_status_report (decode_aprs_t *A, char *info, int ilen) * *------------------------------------------------------------------*/ -static void aprs_telemetry (decode_aprs_t *A, char *info, int ilen) +static void aprs_telemetry (decode_aprs_t *A, char *info, int ilen, int quiet) { - strcpy (A->g_msg_type, "Telemetry"); + strlcpy (A->g_data_type_desc, "Telemetry", sizeof(A->g_data_type_desc)); - telemetry_data_original (A->g_src, info, A->g_telemetry, A->g_comment); + telemetry_data_original (A->g_src, info, quiet, A->g_telemetry, sizeof(A->g_telemetry), A->g_comment, sizeof(A->g_comment)); } /* end aprs_telemetry */ +/*------------------------------------------------------------------ + * + * Function: aprs_user_defined + * + * Purpose: Decode user defined data. + * + * Inputs: info - Pointer to Information field. + * ilen - Information field length. + * + * Description: APRS Protocol Specification, Chapter 18 + * User IDs allocated here: http://www.aprs.org/aprs11/expfmts.txt + * + *------------------------------------------------------------------*/ + +static void aprs_user_defined (decode_aprs_t *A, char *info, int ilen) +{ + if (strncmp(info, "{tt", 3) == 0 || // Historical. + strncmp(info, "{DT", 3) == 0) { // Official after registering {D* + aprs_raw_touch_tone (A, info, ilen); + } + else if (strncmp(info, "{mc", 3) == 0 || // Historical. + strncmp(info, "{DM", 3) == 0) { // Official after registering {D* + aprs_morse_code (A, info, ilen); + } + else if (info[0] == '{' && info[1] == USER_DEF_USER_ID && info[2] == USER_DEF_TYPE_AIS) { + double lat, lon; + float knots, course; + float alt_meters; + + ais_parse (info+3, 0, A->g_data_type_desc, sizeof(A->g_data_type_desc), A->g_name, sizeof(A->g_name), + &lat, &lon, &knots, &course, &alt_meters, &(A->g_symbol_table), &(A->g_symbol_code), + A->g_comment, sizeof(A->g_comment)); + + A->g_lat = lat; + A->g_lon = lon; + A->g_speed_mph = DW_KNOTS_TO_MPH(knots); + A->g_course = course; + A->g_altitude_ft = DW_METERS_TO_FEET(alt_meters); + strcpy (A->g_mfr, ""); + } + else if (strncmp(info, "{{", 2) == 0) { + snprintf (A->g_data_type_desc, sizeof(A->g_data_type_desc), "User-Defined Experimental"); + } + else { + snprintf (A->g_data_type_desc, sizeof(A->g_data_type_desc), "User-Defined Data"); + } + +} /* end aprs_user_defined */ + + /*------------------------------------------------------------------ * * Function: aprs_raw_touch_tone @@ -2127,14 +2918,14 @@ static void aprs_telemetry (decode_aprs_t *A, char *info, int ilen) static void aprs_raw_touch_tone (decode_aprs_t *A, char *info, int ilen) { - strcpy (A->g_msg_type, "Raw Touch Tone Data"); + strlcpy (A->g_data_type_desc, "Raw Touch Tone Data", sizeof(A->g_data_type_desc)); /* Just copy the info field without the message type. */ if (*info == '{') - strcpy (A->g_comment, info+3); + strlcpy (A->g_comment, info+3, sizeof(A->g_comment)); else - strcpy (A->g_comment, info+1); + strlcpy (A->g_comment, info+1, sizeof(A->g_comment)); } /* end aprs_raw_touch_tone */ @@ -2158,14 +2949,14 @@ static void aprs_raw_touch_tone (decode_aprs_t *A, char *info, int ilen) static void aprs_morse_code (decode_aprs_t *A, char *info, int ilen) { - strcpy (A->g_msg_type, "Morse Code Data"); + strlcpy (A->g_data_type_desc, "Morse Code Data", sizeof(A->g_data_type_desc)); /* Just copy the info field without the message type. */ if (*info == '{') - strcpy (A->g_comment, info+3); + strlcpy (A->g_comment, info+3, sizeof(A->g_comment)); else - strcpy (A->g_comment, info+1); + strlcpy (A->g_comment, info+1, sizeof(A->g_comment)); } /* end aprs_morse_code */ @@ -2198,9 +2989,9 @@ static void aprs_positionless_weather_report (decode_aprs_t *A, unsigned char *i } *p; - strcpy (A->g_msg_type, "Positionless Weather Report"); + strlcpy (A->g_data_type_desc, "Positionless Weather Report", sizeof(A->g_data_type_desc)); - time_t ts = 0; + //time_t ts = 0; p = (struct aprs_positionless_weather_s *)info; @@ -2227,7 +3018,7 @@ static void aprs_positionless_weather_report (decode_aprs_t *A, unsigned char *i * TODO: call this context instead and have 3 enumerated values. * * Global In: A->g_course - Wind info for compressed location. - * A->g_speed + * A->g_speed_mph * * Outputs: A->g_weather * @@ -2236,7 +3027,7 @@ static void aprs_positionless_weather_report (decode_aprs_t *A, unsigned char *i * For human-readable locations, we expect wind direction * and speed in a format like this: 999/999. * For compressed location, this has already been - * processed and put in A->g_course and A->g_speed. + * processed and put in A->g_course and A->g_speed_mph. * Otherwise, for positionless weather data, the * wind is in the form c999s999. * @@ -2260,7 +3051,7 @@ static void aprs_positionless_weather_report (decode_aprs_t *A, unsigned char *i static int getwdata (char **wpp, char ch, int dlen, float *val) { - char stemp[8]; + char stemp[8]; // larger than maximum dlen. int i; @@ -2289,8 +3080,8 @@ static int getwdata (char **wpp, char ch, int dlen, float *val) } } - strncpy (stemp, (*wpp)+1, dlen); - stemp[dlen] = '\0'; + memset (stemp, 0, sizeof(stemp)); + memcpy (stemp, (*wpp)+1, dlen); *val = atof(stemp); //dw_printf("debug: getwdata returning %f\n", *val); @@ -2319,37 +3110,41 @@ static void weather_data (decode_aprs_t *A, char *wdata, int wind_prefix) } if (sscanf (wp+4, "%3d", &n)) { - A->g_speed = DW_KNOTS_TO_MPH(n); /* yes, in knots */ + A->g_speed_mph = DW_KNOTS_TO_MPH(n); /* yes, in knots */ } wp += 7; } - else if ( A->g_speed == G_UNKNOWN) { + else if ( A->g_speed_mph == G_UNKNOWN) { if ( ! getwdata (&wp, 'c', 3, &A->g_course)) { - text_color_set(DW_COLOR_ERROR); - dw_printf("Didn't find wind direction in form c999.\n"); + if ( ! A->g_quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Didn't find wind direction in form c999.\n"); + } } - if ( ! getwdata (&wp, 's', 3, &A->g_speed)) { /* MPH here */ - text_color_set(DW_COLOR_ERROR); - dw_printf("Didn't find wind speed in form s999.\n"); + if ( ! getwdata (&wp, 's', 3, &A->g_speed_mph)) { /* MPH here */ + if ( ! A->g_quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Didn't find wind speed in form s999.\n"); + } } } // At this point, we should have the wind direction and speed // from one of three methods. - if (A->g_speed != G_UNKNOWN) { - char ctemp[30]; + if (A->g_speed_mph != G_UNKNOWN) { - sprintf (A->g_weather, "wind %.1f mph", A->g_speed); + snprintf (A->g_weather, sizeof(A->g_weather), "wind %.1f mph", A->g_speed_mph); if (A->g_course != G_UNKNOWN) { - sprintf (ctemp, ", direction %.0f", A->g_course); - strcat (A->g_weather, ctemp); + char ctemp[40]; + snprintf (ctemp, sizeof(ctemp), ", direction %.0f", A->g_course); + strlcat (A->g_weather, ctemp, sizeof(A->g_weather)); } } /* We don't want this to show up on the location line. */ - A->g_speed = G_UNKNOWN; + A->g_speed_mph = G_UNKNOWN; A->g_course = G_UNKNOWN; /* @@ -2360,26 +3155,30 @@ static void weather_data (decode_aprs_t *A, char *wdata, int wind_prefix) */ if (getwdata (&wp, 'g', 3, &fval)) { if (fval != G_UNKNOWN) { - char ctemp[30]; - sprintf (ctemp, ", gust %.0f", fval); - strcat (A->g_weather, ctemp); + char ctemp[40]; + snprintf (ctemp, sizeof(ctemp), ", gust %.0f", fval); + strlcat (A->g_weather, ctemp, sizeof(A->g_weather)); } } else { - text_color_set(DW_COLOR_ERROR); - dw_printf("Didn't find wind gust in form g999.\n"); + if ( ! A->g_quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Didn't find wind gust in form g999.\n"); + } } if (getwdata (&wp, 't', 3, &fval)) { if (fval != G_UNKNOWN) { - char ctemp[30]; - sprintf (ctemp, ", temperature %.0f", fval); - strcat (A->g_weather, ctemp); + char ctemp[40]; + snprintf (ctemp, sizeof(ctemp), ", temperature %.0f", fval); + strlcat (A->g_weather, ctemp, sizeof(A->g_weather)); } } else { - text_color_set(DW_COLOR_ERROR); - dw_printf("Didn't find temperature in form t999.\n"); + if ( ! A->g_quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Didn't find temperature in form t999.\n"); + } } /* @@ -2393,9 +3192,9 @@ static void weather_data (decode_aprs_t *A, char *wdata, int wind_prefix) /* r = rainfall, 1/100 inch, last hour */ if (fval != G_UNKNOWN) { - char ctemp[30]; - sprintf (ctemp, ", rain %.2f in last hour", fval / 100.); - strcat (A->g_weather, ctemp); + char ctemp[40]; + snprintf (ctemp, sizeof(ctemp), ", rain %.2f in last hour", fval / 100.); + strlcat (A->g_weather, ctemp, sizeof(A->g_weather)); } } else if (getwdata (&wp, 'p', 3, &fval)) { @@ -2403,9 +3202,9 @@ static void weather_data (decode_aprs_t *A, char *wdata, int wind_prefix) /* p = rainfall, 1/100 inch, last 24 hours */ if (fval != G_UNKNOWN) { - char ctemp[30]; - sprintf (ctemp, ", rain %.2f in last 24 hours", fval / 100.); - strcat (A->g_weather, ctemp); + char ctemp[40]; + snprintf (ctemp, sizeof(ctemp), ", rain %.2f in last 24 hours", fval / 100.); + strlcat (A->g_weather, ctemp, sizeof(A->g_weather)); } } else if (getwdata (&wp, 'P', 3, &fval)) { @@ -2413,9 +3212,9 @@ static void weather_data (decode_aprs_t *A, char *wdata, int wind_prefix) /* P = rainfall, 1/100 inch, since midnight */ if (fval != G_UNKNOWN) { - char ctemp[30]; - sprintf (ctemp, ", rain %.2f since midnight", fval / 100.); - strcat (A->g_weather, ctemp); + char ctemp[40]; + snprintf (ctemp, sizeof(ctemp), ", rain %.2f since midnight", fval / 100.); + strlcat (A->g_weather, ctemp, sizeof(A->g_weather)); } } else if (getwdata (&wp, 'h', 2, &fval)) { @@ -2425,8 +3224,8 @@ static void weather_data (decode_aprs_t *A, char *wdata, int wind_prefix) if (fval != G_UNKNOWN) { char ctemp[30]; if (fval == 0) fval = 100; - sprintf (ctemp, ", humidity %.0f", fval); - strcat (A->g_weather, ctemp); + snprintf (ctemp, sizeof(ctemp), ", humidity %.0f", fval); + strlcat (A->g_weather, ctemp, sizeof(A->g_weather)); } } else if (getwdata (&wp, 'b', 5, &fval)) { @@ -2435,10 +3234,10 @@ static void weather_data (decode_aprs_t *A, char *wdata, int wind_prefix) /* Here, display as inches of mercury. */ if (fval != G_UNKNOWN) { - char ctemp[30]; + char ctemp[40]; fval = DW_MBAR_TO_INHG(fval * 0.1); - sprintf (ctemp, ", barometer %.2f", fval); - strcat (A->g_weather, ctemp); + snprintf (ctemp, sizeof(ctemp), ", barometer %.2f", fval); + strlcat (A->g_weather, ctemp, sizeof(A->g_weather)); } } else if (getwdata (&wp, 'L', 3, &fval)) { @@ -2446,9 +3245,9 @@ static void weather_data (decode_aprs_t *A, char *wdata, int wind_prefix) /* L = Luminosity, watts/ sq meter, 000-999 */ if (fval != G_UNKNOWN) { - char ctemp[30]; - sprintf (ctemp, ", %.0f watts/m^2", fval); - strcat (A->g_weather, ctemp); + char ctemp[40]; + snprintf (ctemp, sizeof(ctemp), ", %.0f watts/m^2", fval); + strlcat (A->g_weather, ctemp, sizeof(A->g_weather)); } } else if (getwdata (&wp, 'l', 3, &fval)) { @@ -2456,9 +3255,9 @@ static void weather_data (decode_aprs_t *A, char *wdata, int wind_prefix) /* l = Luminosity, watts/ sq meter, 1000-1999 */ if (fval != G_UNKNOWN) { - char ctemp[30]; - sprintf (ctemp, ", %.0f watts/m^2", fval + 1000); - strcat (A->g_weather, ctemp); + char ctemp[40]; + snprintf (ctemp, sizeof(ctemp), ", %.0f watts/m^2", fval + 1000); + strlcat (A->g_weather, ctemp, sizeof(A->g_weather)); } } else if (getwdata (&wp, 's', 3, &fval)) { @@ -2469,9 +3268,9 @@ static void weather_data (decode_aprs_t *A, char *wdata, int wind_prefix) /* position in the message so there is no confusion. */ if (fval != G_UNKNOWN) { - char ctemp[30]; - sprintf (ctemp, ", %.1f snow in 24 hours", fval); - strcat (A->g_weather, ctemp); + char ctemp[40]; + snprintf (ctemp, sizeof(ctemp), ", %.1f snow in 24 hours", fval); + strlcat (A->g_weather, ctemp, sizeof(A->g_weather)); } } else if (getwdata (&wp, 's', 3, &fval)) { @@ -2479,9 +3278,9 @@ static void weather_data (decode_aprs_t *A, char *wdata, int wind_prefix) /* # = Raw rain counter */ if (fval != G_UNKNOWN) { - char ctemp[30]; - sprintf (ctemp, ", raw rain counter %.f", fval); - strcat (A->g_weather, ctemp); + char ctemp[40]; + snprintf (ctemp, sizeof(ctemp), ", raw rain counter %.f", fval); + strlcat (A->g_weather, ctemp, sizeof(A->g_weather)); } } else if (getwdata (&wp, 'X', 3, &fval)) { @@ -2493,9 +3292,9 @@ static void weather_data (decode_aprs_t *A, char *wdata, int wind_prefix) // TODO: decode this properly if (fval != G_UNKNOWN) { - char ctemp[30]; - sprintf (ctemp, ", nuclear Radiation %.f", fval); - strcat (A->g_weather, ctemp); + char ctemp[40]; + snprintf (ctemp, sizeof(ctemp), ", nuclear Radiation %.f", fval); + strlcat (A->g_weather, ctemp, sizeof(A->g_weather)); } } @@ -2517,8 +3316,8 @@ static void weather_data (decode_aprs_t *A, char *wdata, int wind_prefix) * / {UIV32N} */ - strcat (A->g_weather, ", \""); - strcat (A->g_weather, wp); + strlcat (A->g_weather, ", \"", sizeof(A->g_weather)); + strlcat (A->g_weather, wp, sizeof(A->g_weather)); /* * Drop any CR / LF character at the end. */ @@ -2532,10 +3331,11 @@ static void weather_data (decode_aprs_t *A, char *wdata, int wind_prefix) A->g_weather[n-1] = '\0'; } - strcat (A->g_weather, "\""); + strlcat (A->g_weather, "\"", sizeof(A->g_weather)); return; -} + +} /* end weather_data */ /*------------------------------------------------------------------ @@ -2594,7 +3394,7 @@ static void aprs_ultimeter (decode_aprs_t *A, char *info, int ilen) int n; - strcpy (A->g_msg_type, "Ultimeter"); + strlcpy (A->g_data_type_desc, "Ultimeter", sizeof(A->g_data_type_desc)); if (*info == '$') { @@ -2623,7 +3423,7 @@ static void aprs_ultimeter (decode_aprs_t *A, char *info, int ilen) baro = DW_MBAR_TO_INHG(h_baro * 0.1); ohumid = h_ohumid * 0.1; - sprintf (A->g_weather, "wind %.1f mph, direction %.0f, temperature %.1f, barometer %.2f, humidity %.0f", + snprintf (A->g_weather, sizeof(A->g_weather), "wind %.1f mph, direction %.0f, temperature %.1f, barometer %.2f, humidity %.0f", windpeak, wdir, otemp, baro, ohumid); } } @@ -2664,7 +3464,7 @@ static void aprs_ultimeter (decode_aprs_t *A, char *info, int ilen) wdir = (h_wdir & 0xff) * 360. / 256.; otemp = h_otemp * 0.1; - sprintf (A->g_weather, "wind %.1f mph, direction %.0f, temperature %.1f\n", + snprintf (A->g_weather, sizeof(A->g_weather), "wind %.1f mph, direction %.0f, temperature %.1f\n", windpeak, wdir, otemp); } @@ -2673,32 +3473,6 @@ static void aprs_ultimeter (decode_aprs_t *A, char *info, int ilen) } /* end aprs_ultimeter */ -/*------------------------------------------------------------------ - * - * Function: third_party_header - * - * Purpose: Decode packet from a third party network. - * - * Inputs: info - Pointer to Information field. - * ilen - Information field length. - * - * Outputs: A->g_comment - * - * Description: - * - *------------------------------------------------------------------*/ - -static void third_party_header (decode_aprs_t *A, char *info, int ilen) -{ - int n; - - strcpy (A->g_msg_type, "Third Party Header"); - - /* more later? */ - -} /* end third_party_header */ - - /*------------------------------------------------------------------ * @@ -2722,8 +3496,8 @@ static void third_party_header (decode_aprs_t *A, char *info, int ilen) static void decode_position (decode_aprs_t *A, position_t *ppos) { - A->g_lat = get_latitude_8 (ppos->lat); - A->g_lon = get_longitude_9 (ppos->lon); + A->g_lat = get_latitude_8 (ppos->lat, A->g_quiet); + A->g_lon = get_longitude_9 (ppos->lon, A->g_quiet); A->g_symbol_table = ppos->sym_table_id; A->g_symbol_code = ppos->symbol_code; @@ -2744,7 +3518,7 @@ static void decode_position (decode_aprs_t *A, position_t *ppos) * * One of the following: * A->g_course & A->g_speeed - * A->g_altitude + * A->g_altitude_ft * A->g_range * * Description: The compressed position provides resolution of around ??? @@ -2775,8 +3549,10 @@ static void decode_compressed_position (decode_aprs_t *A, compressed_position_t } else { - text_color_set(DW_COLOR_ERROR); - dw_printf("Invalid character in compressed latitude. Must be in range of '!' to '{'.\n"); + if ( ! A->g_quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Invalid character in compressed latitude. Must be in range of '!' to '{'.\n"); + } A->g_lat = G_UNKNOWN; } @@ -2786,8 +3562,10 @@ static void decode_compressed_position (decode_aprs_t *A, compressed_position_t } else { - text_color_set(DW_COLOR_ERROR); - dw_printf("Invalid character in compressed longitude. Must be in range of '!' to '{'.\n"); + if ( ! A->g_quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Invalid character in compressed longitude. Must be in range of '!' to '{'.\n"); + } A->g_lon = G_UNKNOWN; } @@ -2801,8 +3579,10 @@ static void decode_compressed_position (decode_aprs_t *A, compressed_position_t A->g_symbol_table = pcpos->sym_table_id - 'a' + '0'; } else { - text_color_set(DW_COLOR_ERROR); - dw_printf("Invalid symbol table id for compressed position.\n"); + if ( ! A->g_quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Invalid symbol table id for compressed position.\n"); + } A->g_symbol_table = '/'; } @@ -2812,7 +3592,7 @@ static void decode_compressed_position (decode_aprs_t *A, compressed_position_t ; /* ignore other two bytes */ } else if (((pcpos->t - 33) & 0x18) == 0x10) { - A->g_altitude = pow(1.002, (pcpos->c - 33) * 91 + pcpos->s - 33); + A->g_altitude_ft = pow(1.002, (pcpos->c - 33) * 91 + pcpos->s - 33); } else if (pcpos->c == '{') { @@ -2822,7 +3602,7 @@ static void decode_compressed_position (decode_aprs_t *A, compressed_position_t { /* For a weather station, this is wind information. */ A->g_course = (pcpos->c - 33) * 4; - A->g_speed = DW_KNOTS_TO_MPH(pow(1.08, pcpos->s - 33) - 1.0); + A->g_speed_mph = DW_KNOTS_TO_MPH(pow(1.08, pcpos->s - 33) - 1.0); } } @@ -2860,7 +3640,7 @@ static void decode_compressed_position (decode_aprs_t *A, compressed_position_t * *------------------------------------------------------------------*/ -double get_latitude_8 (char *p) +double get_latitude_8 (char *p, int quiet) { struct lat_s { unsigned char deg[2]; @@ -2877,26 +3657,32 @@ double get_latitude_8 (char *p) if (isdigit(plat->deg[0])) result += ((plat->deg[0]) - '0') * 10; else { - text_color_set(DW_COLOR_ERROR); - dw_printf("Invalid character in latitude. Expected 0-9 for tens of degrees.\n"); + if ( ! quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Invalid character in latitude. Found '%c' when expecting 0-9 for tens of degrees.\n", plat->deg[0]); + } return (G_UNKNOWN); } if (isdigit(plat->deg[1])) result += ((plat->deg[1]) - '0') * 1; else { - text_color_set(DW_COLOR_ERROR); - dw_printf("Invalid character in latitude. Expected 0-9 for degrees.\n"); + if ( ! quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Invalid character in latitude. Found '%c' when expecting 0-9 for degrees.\n", plat->deg[1]); + } return (G_UNKNOWN); } - if (plat->minn[0] >= '0' || plat->minn[0] <= '5') + if (plat->minn[0] >= '0' && plat->minn[0] <= '5') result += ((plat->minn[0]) - '0') * (10. / 60.); else if (plat->minn[0] == ' ') ; else { - text_color_set(DW_COLOR_ERROR); - dw_printf("Invalid character in latitude. Expected 0-5 for tens of minutes.\n"); + if ( ! quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Invalid character in latitude. Found '%c' when expecting 0-5 for tens of minutes.\n", plat->minn[0]); + } return (G_UNKNOWN); } @@ -2905,14 +3691,18 @@ double get_latitude_8 (char *p) else if (plat->minn[1] == ' ') ; else { - text_color_set(DW_COLOR_ERROR); - dw_printf("Invalid character in latitude. Expected 0-9 for minutes.\n"); + if ( ! quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Invalid character in latitude. Found '%c' when expecting 0-9 for minutes.\n", plat->minn[1]); + } return (G_UNKNOWN); } if (plat->dot != '.') { - text_color_set(DW_COLOR_ERROR); - dw_printf("Unexpected character \"%c\" found where period expected in latitude.\n", plat->dot); + if ( ! quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Unexpected character \"%c\" found where period expected in latitude.\n", plat->dot); + } return (G_UNKNOWN); } @@ -2921,8 +3711,10 @@ double get_latitude_8 (char *p) else if (plat->hmin[0] == ' ') ; else { - text_color_set(DW_COLOR_ERROR); - dw_printf("Invalid character in latitude. Expected 0-9 for tenths of minutes.\n"); + if ( ! quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Invalid character in latitude. Found '%c' when expecting 0-9 for tenths of minutes.\n", plat->hmin[0]); + } return (G_UNKNOWN); } @@ -2931,8 +3723,10 @@ double get_latitude_8 (char *p) else if (plat->hmin[1] == ' ') ; else { - text_color_set(DW_COLOR_ERROR); - dw_printf("Invalid character in latitude. Expected 0-9 for hundredths of minutes.\n"); + if ( ! quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Invalid character in latitude. Found '%c' when expecting 0-9 for hundredths of minutes.\n", plat->hmin[1]); + } return (G_UNKNOWN); } @@ -2942,21 +3736,27 @@ double get_latitude_8 (char *p) return (result); } else if (plat->ns == 'n') { - text_color_set(DW_COLOR_ERROR); - dw_printf("Warning: Lower case n found for latitude hemisphere. Specification requires upper case N or S.\n"); + if ( ! quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Warning: Lower case n found for latitude hemisphere. Specification requires upper case N or S.\n"); + } return (result); } else if (plat->ns == 'S') { return ( - result); } else if (plat->ns == 's') { - text_color_set(DW_COLOR_ERROR); - dw_printf("Warning: Lower case s found for latitude hemisphere. Specification requires upper case N or S.\n"); + if ( ! quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Warning: Lower case s found for latitude hemisphere. Specification requires upper case N or S.\n"); + } return ( - result); } else { - text_color_set(DW_COLOR_ERROR); - dw_printf("Error: '%c' found for latitude hemisphere. Specification requires upper case N or s.\n", plat->ns); + if ( ! quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Error: '%c' found for latitude hemisphere. Specification requires upper case N or S.\n", plat->ns); + } return (G_UNKNOWN); } } @@ -2993,7 +3793,7 @@ double get_latitude_8 (char *p) *------------------------------------------------------------------*/ -double get_longitude_9 (char *p) +double get_longitude_9 (char *p, int quiet) { struct lat_s { unsigned char deg[3]; @@ -3010,34 +3810,42 @@ double get_longitude_9 (char *p) if (plon->deg[0] == '0' || plon->deg[0] == '1') result += ((plon->deg[0]) - '0') * 100; else { - text_color_set(DW_COLOR_ERROR); - dw_printf("Invalid character in longitude. Expected 0 or 1 for hundreds of degrees.\n"); + if ( ! quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Invalid character in longitude. Found '%c' when expecting 0 or 1 for hundreds of degrees.\n", plon->deg[0]); + } return (G_UNKNOWN); } if (isdigit(plon->deg[1])) result += ((plon->deg[1]) - '0') * 10; else { - text_color_set(DW_COLOR_ERROR); - dw_printf("Invalid character in longitude. Expected 0-9 for tens of degrees.\n"); + if ( ! quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Invalid character in longitude. Found '%c' when expecting 0-9 for tens of degrees.\n", plon->deg[1]); + } return (G_UNKNOWN); } if (isdigit(plon->deg[2])) result += ((plon->deg[2]) - '0') * 1; else { - text_color_set(DW_COLOR_ERROR); - dw_printf("Invalid character in longitude. Expected 0-9 for degrees.\n"); + if ( ! quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Invalid character in longitude. Found '%c' when expecting 0-9 for degrees.\n", plon->deg[2]); + } return (G_UNKNOWN); } - if (plon->minn[0] >= '0' || plon->minn[0] <= '5') + if (plon->minn[0] >= '0' && plon->minn[0] <= '5') result += ((plon->minn[0]) - '0') * (10. / 60.); else if (plon->minn[0] == ' ') ; else { - text_color_set(DW_COLOR_ERROR); - dw_printf("Invalid character in longitude. Expected 0-5 for tens of minutes.\n"); + if ( ! quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Invalid character in longitude. Found '%c' when expecting 0-5 for tens of minutes.\n", plon->minn[0]); + } return (G_UNKNOWN); } @@ -3046,14 +3854,18 @@ double get_longitude_9 (char *p) else if (plon->minn[1] == ' ') ; else { - text_color_set(DW_COLOR_ERROR); - dw_printf("Invalid character in longitude. Expected 0-9 for minutes.\n"); + if ( ! quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Invalid character in longitude. Found '%c' when expecting 0-9 for minutes.\n", plon->minn[1]); + } return (G_UNKNOWN); } if (plon->dot != '.') { - text_color_set(DW_COLOR_ERROR); - dw_printf("Unexpected character \"%c\" found where period expected in longitude.\n", plon->dot); + if ( ! quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Unexpected character \"%c\" found where period expected in longitude.\n", plon->dot); + } return (G_UNKNOWN); } @@ -3062,8 +3874,10 @@ double get_longitude_9 (char *p) else if (plon->hmin[0] == ' ') ; else { - text_color_set(DW_COLOR_ERROR); - dw_printf("Invalid character in longitude. Expected 0-9 for tenths of minutes.\n"); + if ( ! quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Invalid character in longitude. Found '%c' when expecting 0-9 for tenths of minutes.\n", plon->hmin[0]); + } return (G_UNKNOWN); } @@ -3072,8 +3886,10 @@ double get_longitude_9 (char *p) else if (plon->hmin[1] == ' ') ; else { - text_color_set(DW_COLOR_ERROR); - dw_printf("Invalid character in longitude. Expected 0-9 for hundredths of minutes.\n"); + if ( ! quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Invalid character in longitude. Found '%c' when expecting 0-9 for hundredths of minutes.\n", plon->hmin[1]); + } return (G_UNKNOWN); } @@ -3083,21 +3899,27 @@ double get_longitude_9 (char *p) return (result); } else if (plon->ew == 'e') { - text_color_set(DW_COLOR_ERROR); - dw_printf("Warning: Lower case e found for longitude hemisphere. Specification requires upper case E or W.\n"); + if ( ! quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Warning: Lower case e found for longitude hemisphere. Specification requires upper case E or W.\n"); + } return (result); } else if (plon->ew == 'W') { return ( - result); } else if (plon->ew == 'w') { - text_color_set(DW_COLOR_ERROR); - dw_printf("Warning: Lower case w found for longitude hemisphere. Specification requires upper case E or W.\n"); + if ( ! quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Warning: Lower case w found for longitude hemisphere. Specification requires upper case E or W.\n"); + } return ( - result); } else { - text_color_set(DW_COLOR_ERROR); - dw_printf("Error: '%c' found for longitude hemisphere. Specification requires upper case E or W.\n", plon->ew); + if ( ! quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Error: '%c' found for longitude hemisphere. Specification requires upper case E or W.\n", plon->ew); + } return (G_UNKNOWN); } } @@ -3117,7 +3939,7 @@ double get_longitude_9 (char *p) * * Day/Hours/Minutes (DHM) format is a fixed 7-character field, consisting of * a 6-digit day/time group followed by a single time indicator character (z or - * /). The day/time group consists of a two-digit day-of-the-month (01–31) and + * /). The day/time group consists of a two-digit day-of-the-month (01-31) and * a four-digit time in hours and minutes. * Times can be expressed in zulu (UTC/GMT) or local time. For example: * @@ -3138,12 +3960,12 @@ double get_longitude_9 (char *p) * Note: This format may not be used in Status Reports. * * Month/Day/Hours/Minutes (MDHM) format is a fixed 8-character field, - * consisting of the month (01–12) and day-of-the-month (01–31), followed by + * consisting of the month (01-12) and day-of-the-month (01-31), followed by * the time in hours and minutes zulu. For example: * * 10092345 is 23 hours 45 minutes zulu on October 9th. * - * This format is only used in reports from stand-alone “positionless” weather + * This format is only used in reports from stand-alone "positionless" weather * stations (i.e. reports that do not contain station position information). * * @@ -3186,6 +4008,8 @@ time_t get_timestamp (decode_aprs_t *A, char *p) time_t ts; ts = time(NULL); + // FIXME: use gmtime_r instead. + // Besides not being thread safe, gmtime could possibly return null. ptm = gmtime(&ts); pdhm = (void *)p; @@ -3255,9 +4079,14 @@ time_t get_timestamp (decode_aprs_t *A, char *p) * It is composed of: * a pair of letters in range A to R. * a pair of digits in range of 0 to 9. - * a pair of letters in range of A to X. + * an optional pair of letters in range of A to X. + * + * The spec says: + * "All letters must be transmitted in upper case. + * Letters may be received in upper case or lower case." * - * The APRS spec says that all letters must be transmitted in upper case. + * Typically the second set of letters is written in lower case. + * An earlier version incorrectly produced an error if lower case found. * * * Examples from APRS spec: @@ -3278,21 +4107,10 @@ int get_maidenhead (decode_aprs_t *A, char *p) /* We have 4 characters matching the rule. */ - if (islower(p[0]) || islower(p[1])) { - text_color_set(DW_COLOR_ERROR); - dw_printf("Warning: Lower case letter in Maidenhead locator. Specification requires upper case.\n"); - } - if (toupper(p[4]) >= 'A' && toupper(p[4]) <= 'X' && toupper(p[5]) >= 'A' && toupper(p[5]) <= 'X') { /* We have 6 characters matching the rule. */ - - if (islower(p[4]) || islower(p[5])) { - text_color_set(DW_COLOR_ERROR); - dw_printf("Warning: Lower case letter in Maidenhead locator. Specification requires upper case.\n"); - } - return 6; } @@ -3317,7 +4135,7 @@ int get_maidenhead (decode_aprs_t *A, char *p) * Outputs: One or more of the following, depending the data found: * * A->g_course - * A->g_speed + * A->g_speed_mph * A->g_power * A->g_height * A->g_gain @@ -3341,7 +4159,7 @@ static int data_extension_comment (decode_aprs_t *A, char *pdext) int n; if (strlen(pdext) < 7) { - strcpy (A->g_comment, pdext); + strlcpy (A->g_comment, pdext, sizeof(A->g_comment)); return 0; } @@ -3368,7 +4186,7 @@ static int data_extension_comment (decode_aprs_t *A, char *pdext) } if (sscanf (pdext+4, "%3d", &n)) { - A->g_speed = DW_KNOTS_TO_MPH(n); + A->g_speed_mph = DW_KNOTS_TO_MPH(n); } /* Bearing and Number/Range/Quality? */ @@ -3391,9 +4209,12 @@ static int data_extension_comment (decode_aprs_t *A, char *pdext) A->g_height = (1 << (pdext[4] - '0')) * 10; A->g_gain = pdext[5] - '0'; if (pdext[6] >= '0' && pdext[6] <= '8') { - strcpy (A->g_directivity, dir[pdext[6]-'0']); + strlcpy (A->g_directivity, dir[pdext[6]-'0'], sizeof(A->g_directivity)); } +// TODO: look for another 0-9 A-Z followed by a / +// http://www.aprs.org/aprs12/probes.txt + process_comment (A, pdext+7, -1); return 1; } @@ -3418,7 +4239,7 @@ static int data_extension_comment (decode_aprs_t *A, char *pdext) A->g_height = (1 << (pdext[4] - '0')) * 10; A->g_gain = pdext[5] - '0'; if (pdext[6] >= '0' && pdext[6] <= '8') { - strcpy (A->g_directivity, dir[pdext[6]-'0']); + strlcpy (A->g_directivity, dir[pdext[6]-'0'], sizeof(A->g_directivity)); } process_comment (A, pdext+7, -1); @@ -3450,12 +4271,24 @@ static int data_extension_comment (decode_aprs_t *A, char *pdext) * * Windows version: File must be in current working directory. * - * Linux version: Search order is current working directory - * then /usr/share/direwolf directory. + * Linux version: Search order is current working directory then + * /usr/local/share/direwolf + * /usr/share/direwolf/tocalls.txt + * + * Mac: Like Linux and then + * /opt/local/share/direwolf * *------------------------------------------------------------------*/ -#define MAX_TOCALLS 150 +// If I was more ambitious, this would dynamically allocate enough +// storage based on the file contents. Just stick in a constant for +// now. This takes an insignificant amount of space and +// I don't anticipate tocalls.txt growing that quickly. +// Version 1.4 - add message if too small instead of silently ignoring the rest. + +// Dec. 2016 tocalls.txt has 153 destination addresses. + +#define MAX_TOCALLS 250 static struct tocalls_s { unsigned char len; @@ -3465,20 +4298,44 @@ static struct tocalls_s { static int num_tocalls = 0; -static int tocall_cmp (const struct tocalls_s *x, const struct tocalls_s *y) +// Make sure the array is null terminated. +// If search order is changed, do the same in symbols.c for consistency. + +static const char *search_locations[] = { + (const char *) "tocalls.txt", // CWD + (const char *) "data/tocalls.txt", // Windows with CMake + (const char *) "../data/tocalls.txt", // ? +#ifndef __WIN32__ + (const char *) "/usr/local/share/direwolf/tocalls.txt", + (const char *) "/usr/share/direwolf/tocalls.txt", +#endif +#if __APPLE__ + // https://groups.yahoo.com/neo/groups/direwolf_packet/conversations/messages/2458 + // Adding the /opt/local tree since macports typically installs there. Users might want their + // INSTALLDIR (see Makefile.macosx) to mirror that. If so, then we need to search the /opt/local + // path as well. + (const char *) "/opt/local/share/direwolf/tocalls.txt", +#endif + (const char *) NULL // Important - Indicates end of list. +}; + +static int tocall_cmp (const void *px, const void *py) { + const struct tocalls_s *x = (struct tocalls_s *)px; + const struct tocalls_s *y = (struct tocalls_s *)py; + if (x->len != y->len) return (y->len - x->len); return (strcmp(x->prefix, y->prefix)); } static void decode_tocall (decode_aprs_t *A, char *dest) { - FILE *fp; - int n; + FILE *fp = 0; + int n = 0; static int first_time = 1; char stuff[100]; - char *p; - char *r; + char *p = NULL; + char *r = NULL; //dw_printf("debug: decode_tocall(\"%s\")\n", dest); @@ -3504,12 +4361,13 @@ static void decode_tocall (decode_aprs_t *A, char *dest) if (first_time) { - fp = fopen("tocalls.txt", "r"); -#ifndef __WIN32__ - if (fp == NULL) { - fp = fopen("/usr/share/direwolf/tocalls.txt", "r"); - } -#endif + n = 0; + fp = NULL; + do { + if(search_locations[n] == NULL) break; + fp = fopen(search_locations[n++], "r"); + } while (fp == NULL); + if (fp != NULL) { while (fgets(stuff, sizeof(stuff), fp) != NULL && num_tocalls < MAX_TOCALLS) { @@ -3519,7 +4377,7 @@ static void decode_tocall (decode_aprs_t *A, char *dest) *p-- = '\0'; } - // printf("debug: %s\n", stuff); + // dw_printf("debug: %s\n", stuff); if (stuff[0] == ' ' && stuff[4] == ' ' && @@ -3538,7 +4396,7 @@ static void decode_tocall (decode_aprs_t *A, char *dest) if (strlen(tocalls[num_tocalls].prefix) > 2) { tocalls[num_tocalls].description = strdup(stuff+14); tocalls[num_tocalls].len = strlen(tocalls[num_tocalls].prefix); - // dw_printf("debug: %d '%s' -> '%s'\n", tocalls[num_tocalls].len, tocalls[num_tocalls].prefix, tocalls[num_tocalls].description); + // dw_printf("debug %d: %d '%s' -> '%s'\n", num_tocalls, tocalls[num_tocalls].len, tocalls[num_tocalls].prefix, tocalls[num_tocalls].description); num_tocalls++; } @@ -3562,11 +4420,15 @@ static void decode_tocall (decode_aprs_t *A, char *dest) if (strlen(tocalls[num_tocalls].prefix) > 2) { tocalls[num_tocalls].description = strdup(stuff+14); tocalls[num_tocalls].len = strlen(tocalls[num_tocalls].prefix); - // dw_printf("debug: %d '%s' -> '%s'\n", tocalls[num_tocalls].len, tocalls[num_tocalls].prefix, tocalls[num_tocalls].description); + // dw_printf("debug %d: %d '%s' -> '%s'\n", num_tocalls, tocalls[num_tocalls].len, tocalls[num_tocalls].prefix, tocalls[num_tocalls].description); num_tocalls++; } } + if (num_tocalls == MAX_TOCALLS) { // oops. might have discarded some. + text_color_set(DW_COLOR_ERROR); + dw_printf("MAX_TOCALLS needs to be larger than %d to handle contents of 'tocalls.txt'.\n", MAX_TOCALLS); + } } fclose(fp); @@ -3577,27 +4439,28 @@ static void decode_tocall (decode_aprs_t *A, char *dest) * models before getting to the more generic APY. */ -#if defined(__WIN32__) || defined(__OpenBSD__) || defined(__FreeBSD__) qsort (tocalls, num_tocalls, sizeof(struct tocalls_s), tocall_cmp); -#else - qsort (tocalls, num_tocalls, sizeof(struct tocalls_s), (__compar_fn_t)tocall_cmp); -#endif + } else { - text_color_set(DW_COLOR_ERROR); - dw_printf("Warning: Could not open 'tocalls.txt'.\n"); - dw_printf("System types in the destination field will not be decoded.\n"); + if ( ! A->g_quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Warning: Could not open 'tocalls.txt'.\n"); + dw_printf("System types in the destination field will not be decoded.\n"); + } } - first_time = 0; + + //for (n=0; n '%s'\n", n, tocalls[n].len, tocalls[n].prefix, tocalls[n].description); + //} } for (n=0; ng_mfr, tocalls[n].description, sizeof(A->g_mfr)-1); - A->g_mfr[sizeof(A->g_mfr)-1] = '\0'; + strlcpy (A->g_mfr, tocalls[n].description, sizeof(A->g_mfr)); return; } } @@ -3622,12 +4485,14 @@ static void decode_tocall (decode_aprs_t *A, char *dest) * *------------------------------------------------------------------*/ +// TODO: potential for buffer overflow here. + static void substr_se (char *dest, const char *src, int start, int endp1) { int len = endp1 - start; if (start < 0 || endp1 < 0 || len <= 0) { - strcpy (dest, ""); + dest[0] = '\0'; return; } memcpy (dest, src + start, len); @@ -3648,7 +4513,7 @@ static void substr_se (char *dest, const char *src, int start, int endp1) * clen - Length of comment or -1 to take it all. * * Outputs: A->g_telemetry - Base 91 telemetry |ss1122| - * A->g_altitude - from /A=123456 + * A->g_altitude_ft - from /A=123456 * A->g_lat - Might be adjusted from !DAO! * A->g_lon - Might be adjusted from !DAO! * A->g_aprstt_loc - Private extension to !DAO! @@ -3675,10 +4540,53 @@ static void substr_se (char *dest, const char *src, int start, int endp1) * * !DAO! APRS precision and Datum option. * - * Protocol reference, end of chaper 6. + * Protocol reference, end of chapter 6. * * /A=123456 Altitude * + * What can appear in a comment? + * + * Chapter 5 of the APRS spec ( http://www.aprs.org/doc/APRS101.PDF ) says: + * + * "The comment may contain any printable ASCII characters (except | and ~, + * which are reserved for TNC channel switching)." + * + * "Printable" would exclude character values less than space (00100000), e.g. + * tab, carriage return, line feed, nul. Sometimes we see carriage return + * (00001010) at the end of APRS packets. This would be in violation of the + * specification. + * + * The base 91 telemetry format (http://he.fi/doc/aprs-base91-comment-telemetry.txt ), + * which is not part of the APRS spec, uses the | character in the comment to delimit encoded + * telemetry data. This would be in violation of the original spec. + * + * The APRS Spec Addendum 1.2 Proposals ( http://www.aprs.org/aprs12/datum.txt) + * adds use of UTF-8 (https://en.wikipedia.org/wiki/UTF-8 )for the free form text in + * messages and comments. It can't be used in the fixed width fields. + * + * Non-ASCII characters are represented by multi-byte sequences. All bytes in these + * multi-byte sequences have the most significant bit set to 1. Using UTF-8 would not + * add any nul (00000000) bytes to the stream. + * + * There are two known cases where we can have a nul character value. + * + * * The Kenwood TM-D710A sometimes sends packets like this: + * + * VA3AJ-9>T2QU6X,VE3WRC,WIDE1,K8UNS,WIDE2*:4P<0x00><0x0f>4T<0x00><0x0f>4X<0x00><0x0f>4\<0x00>`nW<0x1f>oS8>/]"6M}driving fast= + * K4JH-9>S5UQ6X,WR4AGC-3*,WIDE1*:4P<0x00><0x0f>4T<0x00><0x0f>4X<0x00><0x0f>4\<0x00>`jP}l"&>/]"47}QRV from the EV = + * + * Notice that the data type indicator of "4" is not valid. If we remove + * 4P<0x00><0x0f>4T<0x00><0x0f>4X<0x00><0x0f>4\<0x00> we are left with a good MIC-E format. + * This same thing has been observed from others and is intermittent. + * + * * AGW Tracker can send UTF-16 if an option is selected. This can introduce nul bytes. + * This is wrong. It should be using UTF-8 and I'm not going to accommodate it here. + * + * + * The digipeater and IGate functions should pass along anything exactly the + * we received it, even if it is invalid. If different implementations try to fix it up + * somehow, like changing unprintable characters to spaces, we will only make things + * worse and thwart the duplicate detection. * *------------------------------------------------------------------*/ @@ -3728,11 +4636,12 @@ static void process_comment (decode_aprs_t *A, char *pstart, int clen) static regex_t base91_tel_re; /* Base 91 compressed telemetry data. */ + int e; char emsg[100]; #define MAXMATCH 4 regmatch_t match[MAXMATCH]; - char temp[256]; + char temp[sizeof(A->g_comment)]; int keep_going; @@ -3817,9 +4726,7 @@ static void process_comment (decode_aprs_t *A, char *pstart, int clen) dw_printf("%s:%d: %s\n", __FILE__, __LINE__, emsg); } -// TODO: Would like to restrict to even length something like this: ([!-{][!-{]){2,7} - - e = regcomp (&base91_tel_re, "\\|([!-{]{4,14})\\|", REG_EXTENDED); + e = regcomp (&base91_tel_re, "\\|(([!-{][!-{]){2,7})\\|", REG_EXTENDED); if (e) { regerror (e, &base91_tel_re, emsg, sizeof(emsg)); dw_printf("%s:%d: %s\n", __FILE__, __LINE__, emsg); @@ -3828,15 +4735,37 @@ static void process_comment (decode_aprs_t *A, char *pstart, int clen) first_time = 0; } - if (clen >= 0) { - assert (clen < sizeof(A->g_comment)); +/* + * If clen is >= 0, take only specified number of characters. + * Otherwise, take it all. + */ + if (clen < 0) { + clen = strlen(pstart); + } + +/* + * Watch out for buffer overflow. + * KG6AZZ reports that there is a local digipeater that seems to + * malfunction occasionally. It corrupts the packet, as it is + * digipeated, causing the comment to be hundreds of characters long. + */ + + if (clen > (int)(sizeof(A->g_comment) - 1)) { + if ( ! A->g_quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Comment is extremely long, %d characters.\n", clen); + dw_printf("Please report this, along with surrounding lines, so we can find the cause.\n"); + } + clen = sizeof(A->g_comment) - 1; + } + + if (clen > 0) { memcpy (A->g_comment, pstart, (size_t)clen); A->g_comment[clen] = '\0'; } else { - strcpy (A->g_comment, pstart); + A->g_comment[0] = '\0'; } - //dw_printf("\nInitial comment='%s'\n", A->g_comment); /* @@ -3876,13 +4805,15 @@ static void process_comment (decode_aprs_t *A, char *pstart, int clen) } if (strncmp(smtemp, "MHz", 3) != 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf("Warning: \"%s\" has non-standard capitalization and might not be recognized by some systems.\n", smtemp); - dw_printf("For best compatibility, it should be exactly like this: \"MHz\" (upper,upper,lower case)\n"); + if ( ! A->g_quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Warning: \"%s\" has non-standard capitalization and might not be recognized by some systems.\n", smtemp); + dw_printf("For best compatibility, it should be exactly like this: \"MHz\" (upper,upper,lower case)\n"); + } } - strcpy (temp, A->g_comment + match[0].rm_eo); - strcpy (A->g_comment + match[0].rm_so, temp); + strlcpy (temp, A->g_comment + match[0].rm_eo, sizeof(temp)); + strlcpy (A->g_comment + match[0].rm_so, temp, sizeof(A->g_comment)); } else if (strlen(A->g_name) > 0) { @@ -3928,52 +4859,50 @@ static void process_comment (decode_aprs_t *A, char *pstart, int clen) } } if (A->g_tone == G_UNKNOWN) { - text_color_set(DW_COLOR_ERROR); - dw_printf("Bad CTCSS/PL specification: \"%s\"\n", sttemp); - dw_printf("Integer does not correspond to standard tone.\n"); + if ( ! A->g_quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Bad CTCSS/PL specification: \"%s\"\n", sttemp); + dw_printf("Integer does not correspond to standard tone.\n"); + } } - strcpy (temp, A->g_comment + match[0].rm_eo); - strcpy (A->g_comment + match[0].rm_so, temp); + strlcpy (temp, A->g_comment + match[0].rm_eo, sizeof(temp)); + strlcpy (A->g_comment + match[0].rm_so, temp, sizeof(A->g_comment)); } else if (regexec (&std_toff_re, A->g_comment, MAXMATCH, match, 0) == 0) { - printf ("NO tone\n"); + dw_printf ("NO tone\n"); A->g_tone = 0; - strcpy (temp, A->g_comment + match[0].rm_eo); - strcpy (A->g_comment + match[0].rm_so, temp); + strlcpy (temp, A->g_comment + match[0].rm_eo, sizeof(temp)); + strlcpy (A->g_comment + match[0].rm_so, temp, sizeof(A->g_comment)); } else if (regexec (&std_dcs_re, A->g_comment, MAXMATCH, match, 0) == 0) { char sttemp[10]; /* three octal digits */ - int f; - int i; substr_se (sttemp, A->g_comment, match[1].rm_so, match[1].rm_eo); A->g_dcs = strtoul (sttemp, NULL, 8); - strcpy (temp, A->g_comment + match[0].rm_eo); - strcpy (A->g_comment + match[0].rm_so, temp); + strlcpy (temp, A->g_comment + match[0].rm_eo, sizeof(temp)); + strlcpy (A->g_comment + match[0].rm_so, temp, sizeof(A->g_comment)-match[0].rm_so); } else if (regexec (&std_offset_re, A->g_comment, MAXMATCH, match, 0) == 0) { char sttemp[10]; /* includes leading sign */ - int f; substr_se (sttemp, A->g_comment, match[1].rm_so, match[1].rm_eo); A->g_offset = 10 * atoi(sttemp); - strcpy (temp, A->g_comment + match[0].rm_eo); - strcpy (A->g_comment + match[0].rm_so, temp); + strlcpy (temp, A->g_comment + match[0].rm_eo, sizeof(temp)); + strlcpy (A->g_comment + match[0].rm_so, temp, sizeof(A->g_comment)-match[0].rm_so); } else if (regexec (&std_range_re, A->g_comment, MAXMATCH, match, 0) == 0) { char sttemp[10]; /* should be two digits */ char sutemp[10]; /* m for miles or k for km */ - int f; substr_se (sttemp, A->g_comment, match[1].rm_so, match[1].rm_eo); substr_se (sutemp, A->g_comment, match[2].rm_so, match[2].rm_eo); @@ -3985,8 +4914,8 @@ static void process_comment (decode_aprs_t *A, char *pstart, int clen) A->g_range = DW_KM_TO_MILES(atoi(sttemp)); } - strcpy (temp, A->g_comment + match[0].rm_eo); - strcpy (A->g_comment + match[0].rm_so, temp); + strlcpy (temp, A->g_comment + match[0].rm_eo, sizeof(temp)); + strlcpy (A->g_comment + match[0].rm_so, temp, sizeof(A->g_comment)-match[0].rm_so); } else { keep_going = 0; @@ -3995,25 +4924,25 @@ static void process_comment (decode_aprs_t *A, char *pstart, int clen) /* * Telemetry data, in base 91 compressed format appears as 2 to 7 pairs - * of base 91 digits, surrounded by | at start and end. + * of base 91 digits, ! thru {, surrounded by | at start and end. */ if (regexec (&base91_tel_re, A->g_comment, MAXMATCH, match, 0) == 0) { - char tdata[30]; /* Should be 4 to 14 characters. */ + char tdata[30]; /* Should be even number of 4 to 14 characters. */ - //dw_printf("compressed telemetry start=%d, end=%d\n", (int)(match[0].rm_so), (int)(match[0].rm_eo)); + //dw_printf("compressed telemetry start=%d, end=%d\n", (int)(match[0].rm_so), (int)(match[0].rm_eo)); substr_se (tdata, A->g_comment, match[1].rm_so, match[1].rm_eo); - //dw_printf("compressed telemetry data = \"%s\"\n", tdata); + //dw_printf("compressed telemetry data = \"%s\"\n", tdata); - telemetry_data_base91 (A->g_src, tdata, A->g_telemetry); + telemetry_data_base91 (A->g_src, tdata, A->g_telemetry, sizeof(A->g_telemetry)); - strcpy (temp, A->g_comment + match[0].rm_eo); - strcpy (A->g_comment + match[0].rm_so, temp); + strlcpy (temp, A->g_comment + match[0].rm_eo, sizeof(temp)); + strlcpy (A->g_comment + match[0].rm_so, temp, sizeof(A->g_comment)-match[0].rm_so); } @@ -4024,8 +4953,10 @@ static void process_comment (decode_aprs_t *A, char *pstart, int clen) * This would not make sense to use this with a compressed location which * already has much greater resolution. * - * It surprized me to see this in a MIC-E message. + * It surprised me to see this in a MIC-E message. * MIC-E has resolution of .01 minute so it would make sense to have it as an option. + * We also find an example in http://www.aprs.org/aprs12/mic-e-examples.txt + * 'abc123R/'123}FFF.FFFMHztext.../A=123456...!DAO! Mv */ if (regexec (&dao_re, A->g_comment, MAXMATCH, match, 0) == 0) @@ -4035,7 +4966,7 @@ static void process_comment (decode_aprs_t *A, char *pstart, int clen) int a = A->g_comment[match[0].rm_so+2]; int o = A->g_comment[match[0].rm_so+3]; - //dw_printf("start=%d, end=%d\n", (int)(match[0].rm_so), (int)(match[0].rm_eo)); + //dw_printf("DAO start=%d, end=%d\n", (int)(match[0].rm_so), (int)(match[0].rm_eo)); /* @@ -4045,16 +4976,16 @@ static void process_comment (decode_aprs_t *A, char *pstart, int clen) if (d == 'T') { if (a == ' ' && o == ' ') { - sprintf (A->g_aprstt_loc, "APRStt corral location"); + snprintf (A->g_aprstt_loc, sizeof(A->g_aprstt_loc), "APRStt corral location"); } else if (isdigit(a) && o == ' ') { - sprintf (A->g_aprstt_loc, "APRStt location %c of 10", a); + snprintf (A->g_aprstt_loc, sizeof(A->g_aprstt_loc), "APRStt location %c of 10", a); } else if (isdigit(a) && isdigit(o)) { - sprintf (A->g_aprstt_loc, "APRStt location %c%c of 100", a, o); + snprintf (A->g_aprstt_loc, sizeof(A->g_aprstt_loc), "APRStt location %c%c of 100", a, o); } else if (a == 'B' && isdigit(o)) { - sprintf (A->g_aprstt_loc, "APRStt location %c%c...", a, o); + snprintf (A->g_aprstt_loc, sizeof(A->g_aprstt_loc), "APRStt location %c%c...", a, o); } } @@ -4086,11 +5017,44 @@ static void process_comment (decode_aprs_t *A, char *pstart, int clen) * to stretch the numeric range to be 0 to 99. */ +/* + * Here are a couple situations where it is seen. + * + * W8SAT-1>T2UV0P:`qC<0x1f>l!Xu\'"69}WMNI EDS Response Unit #1|+/%0'n|!w:X!|3 + * + * Let's break that down into pieces. + * + * W8SAT-1>T2UV0P:`qC<0x1f>l!Xu\'"69} MIC-E format + * N 42 56.0000, W 085 39.0300, + * 0 MPH, course 160, alt 709 ft + * WMNI EDS Response Unit #1 comment + * |+/%0'n| base 91 telemetry + * !w:X! DAO + * |3 Tiny Track 3 + * + * Comment earlier points out that MIC-E format has resolution of 0.01 minute, + * same as non-compressed format, so the DAO does work out, after thinking + * about it for a while. + * We also find a MIC-E example with !DAO! here: http://www.aprs.org/aprs12/mic-e-examples.txt + * + * Another one: + * + * KS4FUN-12>3X0PRU,W6CX-3,BKELEY,WIDE2*:`2^=l!<0x1c>+/'"48}MT-RTG|%B%p'a|!wqR!|3 + * + * MIC-E, Red Cross, Special + * N 38 00.2588, W 122 06.3354 + * 0 MPH, course 100, alt 108 ft + * MT-RTG comment + * |%B%p'a| Seq=397, A1=443, A2=610 + * !wqR! DAO + * |3 Byonics TinyTrack3 + * + */ + /* * The spec appears to be wrong. It says '}' is the maximum value when it should be '{'. */ - if (isdigit91(a)) { A->g_lat += (a - B91_MIN) * 1.1 / 600000.0 * sign(A->g_lat); } @@ -4099,8 +5063,8 @@ static void process_comment (decode_aprs_t *A, char *pstart, int clen) } } - strcpy (temp, A->g_comment + match[0].rm_eo); - strcpy (A->g_comment + match[0].rm_so, temp); + strlcpy (temp, A->g_comment + match[0].rm_eo, sizeof(temp)); + strlcpy (A->g_comment + match[0].rm_so, temp, sizeof(A->g_comment)-match[0].rm_so); } /* @@ -4112,12 +5076,12 @@ static void process_comment (decode_aprs_t *A, char *pstart, int clen) //dw_printf("start=%d, end=%d\n", (int)(match[0].rm_so), (int)(match[0].rm_eo)); - strcpy (temp, A->g_comment + match[0].rm_eo); + strlcpy (temp, A->g_comment + match[0].rm_eo, sizeof(temp)); A->g_comment[match[0].rm_eo] = '\0'; - A->g_altitude = atoi(A->g_comment + match[0].rm_so + 3); + A->g_altitude_ft = atoi(A->g_comment + match[0].rm_so + 3); - strcpy (A->g_comment + match[0].rm_so, temp); + strlcpy (A->g_comment + match[0].rm_so, temp, sizeof(A->g_comment)-match[0].rm_so); } //dw_printf("Final comment='%s'\n", A->g_comment); @@ -4126,8 +5090,9 @@ static void process_comment (decode_aprs_t *A, char *pstart, int clen) * Finally look for something that looks like frequency or CTCSS tone * in the remaining comment. Point this out and suggest the * standardized format. + * Don't complain if we have already found a valid value. */ - if (regexec (&bad_freq_re, A->g_comment, MAXMATCH, match, 0) == 0) + if (A->g_freq == G_UNKNOWN && regexec (&bad_freq_re, A->g_comment, MAXMATCH, match, 0) == 0) { char bad[30]; char good[30]; @@ -4141,18 +5106,19 @@ static void process_comment (decode_aprs_t *A, char *pstart, int clen) (x >= 420 && x <= 450) || (x >= 902 && x <= 928)) { - sprintf (good, "%07.3fMHz", x); - text_color_set(DW_COLOR_ERROR); - dw_printf("\"%s\" in comment looks like a frequency in non-standard format.\n", bad); - dw_printf("For most systems to recognize it, use exactly this form \"%s\" at beginning of comment.\n", good); - + if ( ! A->g_quiet) { + snprintf (good, sizeof(good), "%07.3fMHz", x); + text_color_set(DW_COLOR_ERROR); + dw_printf("\"%s\" in comment looks like a frequency in non-standard format.\n", bad); + dw_printf("For most systems to recognize it, use exactly this form \"%s\" at beginning of comment.\n", good); + } if (A->g_freq == G_UNKNOWN) { A->g_freq = x; } } } - if (regexec (&bad_tone_re, A->g_comment, MAXMATCH, match, 0) == 0) + if (A->g_tone == G_UNKNOWN && regexec (&bad_tone_re, A->g_comment, MAXMATCH, match, 0) == 0) { char bad1[30]; /* original 99.9 or 999.9 format or one of 67 77 100 123 */ char bad2[30]; /* 99.9 or 999.9 format. ".0" appended for special cases. */ @@ -4160,9 +5126,9 @@ static void process_comment (decode_aprs_t *A, char *pstart, int clen) int i; substr_se (bad1, A->g_comment, match[2].rm_so, match[2].rm_eo); - strcpy (bad2, bad1); + strlcpy (bad2, bad1, sizeof(bad2)); if (strcmp(bad2, "67") == 0 || strcmp(bad2, "77") == 0 || strcmp(bad2, "100") == 0 || strcmp(bad2, "123") == 0) { - strcat (bad2, ".0"); + strlcat (bad2, ".0", sizeof(bad2)); } // TODO: Why wasn't freq/PL recognized here? @@ -4182,11 +5148,12 @@ static void process_comment (decode_aprs_t *A, char *pstart, int clen) for (i = 0; i < NUM_CTCSS; i++) { if (strcmp (s_ctcss[i], bad2) == 0) { - sprintf (good, "T%03d", i_ctcss[i]); - text_color_set(DW_COLOR_ERROR); - dw_printf("\"%s\" in comment looks like it might be a CTCSS tone in non-standard format.\n", bad1); - dw_printf("For most systems to recognize it, use exactly this form \"%s\" at near beginning of comment, after any frequency.\n", good); - + if ( ! A->g_quiet) { + snprintf (good, sizeof(good), "T%03d", i_ctcss[i]); + text_color_set(DW_COLOR_ERROR); + dw_printf("\"%s\" in comment looks like it might be a CTCSS tone in non-standard format.\n", bad1); + dw_printf("For most systems to recognize it, use exactly this form \"%s\" at near beginning of comment, after any frequency.\n", good); + } if (A->g_tone == G_UNKNOWN) { A->g_tone = atof(bad2); } @@ -4196,9 +5163,11 @@ static void process_comment (decode_aprs_t *A, char *pstart, int clen) } if ((A->g_offset == 6000 || A->g_offset == -6000) && A->g_freq >= 144 && A->g_freq <= 148) { - text_color_set(DW_COLOR_ERROR); - dw_printf("A transmit offset of 6 MHz on the 2 meter band doesn't seem right.\n"); - dw_printf("Each unit is 10 kHz so you should probably be using \"-060\" or \"+060\"\n"); + if ( ! A->g_quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf("A transmit offset of 6 MHz on the 2 meter band doesn't seem right.\n"); + dw_printf("Each unit is 10 kHz so you should probably be using \"-060\" or \"+060\"\n"); + } } /* @@ -4227,12 +5196,23 @@ static void process_comment (decode_aprs_t *A, char *pstart, int clen) * * WB2OSZ-1>APN383,qAR,N1EDU-2:!4237.14NS07120.83W#PHG7130Chelmsford, MA * + * New for 1.5: + * + * Also allow hexadecimal bytes for raw AX.25 or KISS. e.g. + * + * 00 82 a0 ae ae 62 60 e0 82 96 68 84 40 40 60 9c 68 b0 ae 86 40 e0 40 ae 92 88 8a 64 63 03 f0 3e 45 4d 36 34 6e 65 2f 23 20 45 63 68 6f 6c 69 6e 6b 20 31 34 35 2e 33 31 30 2f 31 30 30 68 7a 20 54 6f 6e 65 + * + * If it begins with 00 or C0 (which would be impossible for AX.25 address) process as KISS. + * Also print these formats. * * Outputs: stdout * * Description: Compile like this to make a standalone test program. + * Just run "make" and this will be built along with everything else. + * The point I'm trying to make is that DECAMAIN must be defined + * to enable the main program here for a standalone application. * - * gcc -o decode_aprs -DTEST decode_aprs.c ax25_pad.c + * gcc -o decode_aprs -DDECAMAIN decode_aprs.c ax25_pad.c ... * * ./decode_aprs < decode_aprs.txt * @@ -4255,10 +5235,18 @@ static void process_comment (decode_aprs_t *A, char *pstart, int clen) * ax25_from_text recognizes this representation so it can be used * to decode raw data later. * + * TODO: To make it more useful, + * - Remove any leading timestamp. + * - Remove any "qA*" and following from the path. + * - Handle non-APRS frames properly. * *------------------------------------------------------------------*/ -#if TEST +#if DECAMAIN + +#include "kiss_frame.h" + + /* Stub for stand-alone decoder. */ @@ -4268,11 +5256,48 @@ void nmea_send_waypoint (char *wname_in, double dlat, double dlong, char symtab, return; } +// TODO: hex_dump is currently in server.c and we don't want to drag that in. +// Someday put it in a more reasonable place, with other general utilities, and remove the private copy here. + + +static void hex_dump (unsigned char *p, int len) +{ + int n, i, offset; + + offset = 0; + while (len > 0) { + n = len < 16 ? len : 16; + dw_printf (" %03x: ", offset); + for (i=0; i #include @@ -108,6 +109,9 @@ #include "dedupe.h" #include "fcs_calc.h" #include "textcolor.h" +#ifndef DIGITEST +#include "igate.h" +#endif /*------------------------------------------------------------------------------ @@ -205,6 +209,14 @@ void dedupe_remember (packet_t pp, int chan) if (insert_next >= HISTORY_MAX) { insert_next = 0; } + + /* If we send something by digipeater, we don't */ + /* want to do it again if it comes from APRS-IS. */ + /* Not sure about the other way around. */ + +#ifndef DIGITEST + ig_to_tx_remember (pp, chan, 1); +#endif } diff --git a/dedupe.h b/src/dedupe.h similarity index 100% rename from dedupe.h rename to src/dedupe.h diff --git a/src/demod.c b/src/demod.c new file mode 100644 index 00000000..cc522271 --- /dev/null +++ b/src/demod.c @@ -0,0 +1,1124 @@ +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// +// Copyright (C) 2011, 2012, 2013, 2014, 2015, 2016, 2019, 2021 John Langner, WB2OSZ +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . +// + + + +/*------------------------------------------------------------------ + * + * Module: demod.c + * + * Purpose: Common entry point for multiple types of demodulators. + * + * Input: Audio samples from either a file or the "sound card." + * + * Outputs: Calls hdlc_rec_bit() for each bit demodulated. + * + *---------------------------------------------------------------*/ + +#include "direwolf.h" + +#include +#include +#include +#include +#include +#include +#include +#include + +#include "audio.h" +#include "demod.h" +#include "tune.h" +#include "fsk_demod_state.h" +#include "fsk_gen_filter.h" +#include "hdlc_rec.h" +#include "textcolor.h" +#include "demod_9600.h" +#include "demod_afsk.h" +#include "demod_psk.h" + + + +// Properties of the radio channels. + +static struct audio_s *save_audio_config_p; + + + +// Current state of all the decoders. + +static struct demodulator_state_s demodulator_state[MAX_CHANS][MAX_SUBCHANS]; + + +static int sample_sum[MAX_CHANS][MAX_SUBCHANS]; +static int sample_count[MAX_CHANS][MAX_SUBCHANS]; + + +/*------------------------------------------------------------------ + * + * Name: demod_init + * + * Purpose: Initialize the demodulator(s) used for reception. + * + * Inputs: pa - Pointer to audio_s structure with + * various parameters for the modem(s). + * + * Returns: 0 for success, -1 for failure. + * + * + * Bugs: This doesn't do much error checking so don't give it + * anything crazy. + * + *----------------------------------------------------------------*/ + +int demod_init (struct audio_s *pa) +{ + int chan; /* Loop index over number of radio channels. */ + char profile; + + + +/* + * Save audio configuration for later use. + */ + + save_audio_config_p = pa; + + for (chan = 0; chan < MAX_CHANS; chan++) { + + if (save_audio_config_p->chan_medium[chan] == MEDIUM_RADIO) { + + char *p; + char just_letters[16]; + int num_letters; + int have_plus; + + /* + * These are derived from config file parameters. + * + * num_subchan is number of demodulators. + * This can be increased by: + * Multiple frequencies. + * Multiple letters (not sure if I will continue this). + * + * num_slicers is set to max by the "+" option. + */ + + save_audio_config_p->achan[chan].num_subchan = 1; + save_audio_config_p->achan[chan].num_slicers = 1; + + switch (save_audio_config_p->achan[chan].modem_type) { + + case MODEM_OFF: + break; + + case MODEM_AFSK: + case MODEM_EAS: + + if (save_audio_config_p->achan[chan].modem_type == MODEM_EAS) { + if (save_audio_config_p->achan[chan].fix_bits != RETRY_NONE) { + text_color_set(DW_COLOR_INFO); + dw_printf ("Channel %d: FIX_BITS option has been turned off for EAS.\n", chan); + save_audio_config_p->achan[chan].fix_bits = RETRY_NONE; + } + if (save_audio_config_p->achan[chan].passall != 0) { + text_color_set(DW_COLOR_INFO); + dw_printf ("Channel %d: PASSALL option has been turned off for EAS.\n", chan); + save_audio_config_p->achan[chan].passall = 0; + } + } + +/* + * Tear apart the profile and put it back together in a normalized form: + * - At least one letter, supply suitable default if necessary. + * - Upper case only. + * - Any plus will be at the end. + */ + num_letters = 0; + just_letters[num_letters] = '\0'; + have_plus = 0; + for (p = save_audio_config_p->achan[chan].profiles; *p != '\0'; p++) { + + if (islower(*p)) { + just_letters[num_letters] = toupper(*p); + num_letters++; + just_letters[num_letters] = '\0'; + } + + else if (isupper(*p)) { + just_letters[num_letters] = *p; + num_letters++; + just_letters[num_letters] = '\0'; + } + + else if (*p == '+') { + have_plus = 1; + if (p[1] != '\0') { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Channel %d: + option must appear at end of demodulator types \"%s\" \n", + chan, save_audio_config_p->achan[chan].profiles); + } + } + + else if (*p == '-') { + have_plus = -1; + if (p[1] != '\0') { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Channel %d: - option must appear at end of demodulator types \"%s\" \n", + chan, save_audio_config_p->achan[chan].profiles); + } + + } else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Channel %d: Demodulator types \"%s\" can contain only letters and + - characters.\n", + chan, save_audio_config_p->achan[chan].profiles); + } + } + + assert (num_letters == (int)(strlen(just_letters))); + +/* + * Pick a good default demodulator if none specified. + * Previously, we had "D" optimized for 300 bps. + * Gone in 1.7 so it is always "A+". + */ + if (num_letters == 0) { + strlcpy (just_letters, "A", sizeof(just_letters)); + num_letters = strlen(just_letters); + + if (have_plus != -1) have_plus = 1; // Add as default for version 1.2 + // If not explicitly turned off. + } + +/* + * Special case for ARM. + * The higher end ARM chips have loads of power but many people + * are using a single core Pi Zero or similar. + * (I'm still using a model 1 for my digipeater/IGate!) + * Decreasing CPU requirement has a negligible impact on decoding performance. + * + * atest -PA- 01_Track_1.wav --> 1002 packets decoded. + * atest -PA- -D3 01_Track_1.wav --> 997 packets decoded. + * + * Someone concerned about 1/2 of one percent difference can add "-D 1" + */ +#if __arm__ + if (save_audio_config_p->achan[chan].decimate == 0) { + if (save_audio_config_p->adev[ACHAN2ADEV(chan)].samples_per_sec > 40000) { + save_audio_config_p->achan[chan].decimate = 3; + } + } +#endif + +/* + * Number of filter taps is proportional to number of audio samples in a "symbol" duration. + * These can get extremely large for low speeds, e.g. 300 baud. + * In this case, increase the decimation ration. Crude approximation. Could be improved. + */ + if (save_audio_config_p->achan[chan].decimate == 0 && + save_audio_config_p->adev[ACHAN2ADEV(chan)].samples_per_sec > 40000 && + save_audio_config_p->achan[chan].baud < 600) { + + // Avoid enormous number of filter taps. + + save_audio_config_p->achan[chan].decimate = 3; + } + + +/* + * Put it back together again. + */ + assert (num_letters == (int)(strlen(just_letters))); + + /* At this point, have_plus can have 3 values: */ + /* 1 = turned on, either explicitly or by applied default */ + /* -1 = explicitly turned off. change to 0 here so it is false. */ + /* 0 = off by default. */ + + if (have_plus == -1) have_plus = 0; + + strlcpy (save_audio_config_p->achan[chan].profiles, just_letters, sizeof(save_audio_config_p->achan[chan].profiles)); + + assert (strlen(save_audio_config_p->achan[chan].profiles) >= 1); + + if (have_plus) { + strlcat (save_audio_config_p->achan[chan].profiles, "+", sizeof(save_audio_config_p->achan[chan].profiles)); + } + + /* These can be increased later for the multi-frequency case. */ + + save_audio_config_p->achan[chan].num_subchan = num_letters; + save_audio_config_p->achan[chan].num_slicers = 1; + +/* + * Some error checking - Can use only one of these: + * + * - Multiple letters. + * - New + multi-slicer. + * - Multiple frequencies. + */ + + if (have_plus && save_audio_config_p->achan[chan].num_freq > 1) { + + text_color_set(DW_COLOR_ERROR); + dw_printf ("Channel %d: Demodulator + option can't be combined with multiple frequencies.\n", chan); + save_audio_config_p->achan[chan].num_subchan = 1; // Will be set higher later. + save_audio_config_p->achan[chan].num_freq = 1; + } + + if (num_letters > 1 && save_audio_config_p->achan[chan].num_freq > 1) { + + text_color_set(DW_COLOR_ERROR); + dw_printf ("Channel %d: Multiple demodulator types can't be combined with multiple frequencies.\n", chan); + + save_audio_config_p->achan[chan].profiles[1] = '\0'; + num_letters = 1; + } + + if (save_audio_config_p->achan[chan].decimate == 0) { + save_audio_config_p->achan[chan].decimate = 1; + if (strchr (just_letters, 'B') != NULL && save_audio_config_p->adev[ACHAN2ADEV(chan)].samples_per_sec > 40000) { + save_audio_config_p->achan[chan].decimate = 3; + } + } + + text_color_set(DW_COLOR_DEBUG); + dw_printf ("Channel %d: %d baud, AFSK %d & %d Hz, %s, %d sample rate", + chan, save_audio_config_p->achan[chan].baud, + save_audio_config_p->achan[chan].mark_freq, save_audio_config_p->achan[chan].space_freq, + save_audio_config_p->achan[chan].profiles, + save_audio_config_p->adev[ACHAN2ADEV(chan)].samples_per_sec); + if (save_audio_config_p->achan[chan].decimate != 1) + dw_printf (" / %d", save_audio_config_p->achan[chan].decimate); + if (save_audio_config_p->achan[chan].dtmf_decode != DTMF_DECODE_OFF) + dw_printf (", DTMF decoder enabled"); + dw_printf (".\n"); + + +/* + * Initialize the demodulator(s). + * + * We have 3 cases to consider. + */ + +// TODO1.3: revisit this logic now that it is less restrictive. + + if (num_letters > 1) { + int d; + +/* + * Multiple letters, usually for 1200 baud. + * Each one corresponds to a demodulator and subchannel. + * + * An interesting experiment but probably not too useful. + * Can't have multiple frequency pairs. + * In version 1.3 this can be combined with the + option. + */ + + save_audio_config_p->achan[chan].num_subchan = num_letters; + + if (save_audio_config_p->achan[chan].num_subchan != num_letters) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("INTERNAL ERROR, %s:%d, chan=%d, num_subchan(%d) != strlen(\"%s\")\n", + __FILE__, __LINE__, chan, save_audio_config_p->achan[chan].num_subchan, save_audio_config_p->achan[chan].profiles); + } + + if (save_audio_config_p->achan[chan].num_freq != 1) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("INTERNAL ERROR, %s:%d, chan=%d, num_freq(%d) != 1\n", + __FILE__, __LINE__, chan, save_audio_config_p->achan[chan].num_freq); + } + + for (d = 0; d < save_audio_config_p->achan[chan].num_subchan; d++) { + int mark, space; + assert (d >= 0 && d < MAX_SUBCHANS); + + struct demodulator_state_s *D; + D = &demodulator_state[chan][d]; + + profile = save_audio_config_p->achan[chan].profiles[d]; + mark = save_audio_config_p->achan[chan].mark_freq; + space = save_audio_config_p->achan[chan].space_freq; + + if (save_audio_config_p->achan[chan].num_subchan != 1) { + text_color_set(DW_COLOR_DEBUG); + dw_printf (" %d.%d: %c %d & %d\n", chan, d, profile, mark, space); + } + + demod_afsk_init (save_audio_config_p->adev[ACHAN2ADEV(chan)].samples_per_sec / save_audio_config_p->achan[chan].decimate, + save_audio_config_p->achan[chan].baud, + mark, + space, + profile, + D); + + if (have_plus) { + /* I'm not happy about putting this hack here. */ + /* should pass in as a parameter rather than adding on later. */ + + save_audio_config_p->achan[chan].num_slicers = MAX_SLICERS; + D->num_slicers = MAX_SLICERS; + } + + /* For signal level reporting, we want a longer term view. */ + // TODO: Should probably move this into the init functions. + + D->quick_attack = D->agc_fast_attack * 0.2f; + D->sluggish_decay = D->agc_slow_decay * 0.2f; + } + } + else if (have_plus) { + +/* + * PLUS - which (formerly) implies we have only one letter and one frequency pair. + * + * One demodulator feeds multiple slicers, each a subchannel. + */ + + if (num_letters != 1) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("INTERNAL ERROR, %s:%d, chan=%d, strlen(\"%s\") != 1\n", + __FILE__, __LINE__, chan, just_letters); + } + + if (save_audio_config_p->achan[chan].num_freq != 1) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("INTERNAL ERROR, %s:%d, chan=%d, num_freq(%d) != 1\n", + __FILE__, __LINE__, chan, save_audio_config_p->achan[chan].num_freq); + } + + if (save_audio_config_p->achan[chan].num_freq != save_audio_config_p->achan[chan].num_subchan) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("INTERNAL ERROR, %s:%d, chan=%d, num_freq(%d) != num_subchan(%d)\n", + __FILE__, __LINE__, chan, save_audio_config_p->achan[chan].num_freq, save_audio_config_p->achan[chan].num_subchan); + } + + struct demodulator_state_s *D; + D = &demodulator_state[chan][0]; + + /* I'm not happy about putting this hack here. */ + /* This belongs in demod_afsk_init but it doesn't have access to the audio config. */ + + save_audio_config_p->achan[chan].num_slicers = MAX_SLICERS; + + demod_afsk_init (save_audio_config_p->adev[ACHAN2ADEV(chan)].samples_per_sec / save_audio_config_p->achan[chan].decimate, + save_audio_config_p->achan[chan].baud, + save_audio_config_p->achan[chan].mark_freq, + save_audio_config_p->achan[chan].space_freq, + save_audio_config_p->achan[chan].profiles[0], + D); + + if (have_plus) { + /* I'm not happy about putting this hack here. */ + /* should pass in as a parameter rather than adding on later. */ + + save_audio_config_p->achan[chan].num_slicers = MAX_SLICERS; + D->num_slicers = MAX_SLICERS; + } + + /* For signal level reporting, we want a longer term view. */ + + D->quick_attack = D->agc_fast_attack * 0.2f; + D->sluggish_decay = D->agc_slow_decay * 0.2f; + } + else { + int d; +/* + * One letter. + * Can be combined with multiple frequencies. + */ + + if (num_letters != 1) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("INTERNAL ERROR, %s:%d, chan=%d, strlen(\"%s\") != 1\n", + __FILE__, __LINE__, chan, save_audio_config_p->achan[chan].profiles); + } + + save_audio_config_p->achan[chan].num_subchan = save_audio_config_p->achan[chan].num_freq; + + for (d = 0; d < save_audio_config_p->achan[chan].num_freq; d++) { + + int mark, space, k; + assert (d >= 0 && d < MAX_SUBCHANS); + + struct demodulator_state_s *D; + D = &demodulator_state[chan][d]; + + profile = save_audio_config_p->achan[chan].profiles[0]; + + k = d * save_audio_config_p->achan[chan].offset - ((save_audio_config_p->achan[chan].num_freq - 1) * save_audio_config_p->achan[chan].offset) / 2; + mark = save_audio_config_p->achan[chan].mark_freq + k; + space = save_audio_config_p->achan[chan].space_freq + k; + + if (save_audio_config_p->achan[chan].num_freq != 1) { + text_color_set(DW_COLOR_DEBUG); + dw_printf (" %d.%d: %c %d & %d\n", chan, d, profile, mark, space); + } + + demod_afsk_init (save_audio_config_p->adev[ACHAN2ADEV(chan)].samples_per_sec / save_audio_config_p->achan[chan].decimate, + save_audio_config_p->achan[chan].baud, + mark, space, + profile, + D); + + if (have_plus) { + /* I'm not happy about putting this hack here. */ + /* should pass in as a parameter rather than adding on later. */ + + save_audio_config_p->achan[chan].num_slicers = MAX_SLICERS; + D->num_slicers = MAX_SLICERS; + } + + /* For signal level reporting, we want a longer term view. */ + + D->quick_attack = D->agc_fast_attack * 0.2f; + D->sluggish_decay = D->agc_slow_decay * 0.2f; + + } /* for each freq pair */ + } + break; + + case MODEM_QPSK: // New for 1.4 + + // In versions 1.4 and 1.5, V.26 "Alternative A" was used. + // years later, I discover that the MFJ-2400 used "Alternative B." + // It looks like the other two manufacturers use the same but we + // can't be sure until we find one for compatibility testing. + + // In version 1.6 we add a choice for the user. + // If neither one was explicitly specified, print a message and take + // a default. My current thinking is that we default to direwolf <= 1.5 + // compatible for version 1.6 and MFJ compatible after that. + + if (save_audio_config_p->achan[chan].v26_alternative == V26_UNSPECIFIED) { + + text_color_set(DW_COLOR_ERROR); + dw_printf ("Two incompatible versions of 2400 bps QPSK are now available.\n"); + dw_printf ("For compatibility with direwolf <= 1.5, use 'V26A' modem option in config file.\n"); + dw_printf ("For compatibility MFJ-2400 use 'V26B' modem option in config file.\n"); + dw_printf ("Command line options -j and -J can be used for channel 0.\n"); + dw_printf ("For more information, read the Dire Wolf User Guide and\n"); + dw_printf ("2400-4800-PSK-for-APRS-Packet-Radio.pdf.\n"); + dw_printf ("The default is now MFJ-2400 compatibility mode.\n"); + + save_audio_config_p->achan[chan].v26_alternative = V26_DEFAULT; + } + + +// TODO: See how much CPU this takes on ARM and decide if we should have different defaults. + + if (strlen(save_audio_config_p->achan[chan].profiles) == 0) { +//#if __arm__ +// strlcpy (save_audio_config_p->achan[chan].profiles, "R", sizeof(save_audio_config_p->achan[chan].profiles)); +//#else + strlcpy (save_audio_config_p->achan[chan].profiles, "PQRS", sizeof(save_audio_config_p->achan[chan].profiles)); +//#endif + } + save_audio_config_p->achan[chan].num_subchan = strlen(save_audio_config_p->achan[chan].profiles); + + save_audio_config_p->achan[chan].decimate = 1; // think about this later. + text_color_set(DW_COLOR_DEBUG); + dw_printf ("Channel %d: %d bps, QPSK, %s, %d sample rate", + chan, save_audio_config_p->achan[chan].baud, + save_audio_config_p->achan[chan].profiles, + save_audio_config_p->adev[ACHAN2ADEV(chan)].samples_per_sec); + if (save_audio_config_p->achan[chan].decimate != 1) + dw_printf (" / %d", save_audio_config_p->achan[chan].decimate); + + if (save_audio_config_p->achan[chan].v26_alternative == V26_B) + dw_printf (", compatible with MFJ-2400"); + else + dw_printf (", compatible with earlier direwolf"); + + if (save_audio_config_p->achan[chan].dtmf_decode != DTMF_DECODE_OFF) + dw_printf (", DTMF decoder enabled"); + dw_printf (".\n"); + + int d; + for (d = 0; d < save_audio_config_p->achan[chan].num_subchan; d++) { + + assert (d >= 0 && d < MAX_SUBCHANS); + struct demodulator_state_s *D; + D = &demodulator_state[chan][d]; + profile = save_audio_config_p->achan[chan].profiles[d]; + + //text_color_set(DW_COLOR_DEBUG); + //dw_printf ("About to call demod_psk_init for Q-PSK case, modem_type=%d, profile='%c'\n", + // save_audio_config_p->achan[chan].modem_type, profile); + + demod_psk_init (save_audio_config_p->achan[chan].modem_type, + save_audio_config_p->achan[chan].v26_alternative, + save_audio_config_p->adev[ACHAN2ADEV(chan)].samples_per_sec / save_audio_config_p->achan[chan].decimate, + save_audio_config_p->achan[chan].baud, + profile, + D); + + //text_color_set(DW_COLOR_DEBUG); + //dw_printf ("Returned from demod_psk_init\n"); + + /* For signal level reporting, we want a longer term view. */ + /* Guesses based on 9600. Maybe revisit someday. */ + + D->quick_attack = 0.080 * 0.2; + D->sluggish_decay = 0.00012 * 0.2; + } + break; + + case MODEM_8PSK: // New for 1.4 + +// TODO: See how much CPU this takes on ARM and decide if we should have different defaults. + + if (strlen(save_audio_config_p->achan[chan].profiles) == 0) { +//#if __arm__ +// strlcpy (save_audio_config_p->achan[chan].profiles, "V", sizeof(save_audio_config_p->achan[chan].profiles)); +//#else + strlcpy (save_audio_config_p->achan[chan].profiles, "TUVW", sizeof(save_audio_config_p->achan[chan].profiles)); +//#endif + } + save_audio_config_p->achan[chan].num_subchan = strlen(save_audio_config_p->achan[chan].profiles); + + save_audio_config_p->achan[chan].decimate = 1; // think about this later + text_color_set(DW_COLOR_DEBUG); + dw_printf ("Channel %d: %d bps, 8PSK, %s, %d sample rate", + chan, save_audio_config_p->achan[chan].baud, + save_audio_config_p->achan[chan].profiles, + save_audio_config_p->adev[ACHAN2ADEV(chan)].samples_per_sec); + if (save_audio_config_p->achan[chan].decimate != 1) + dw_printf (" / %d", save_audio_config_p->achan[chan].decimate); + if (save_audio_config_p->achan[chan].dtmf_decode != DTMF_DECODE_OFF) + dw_printf (", DTMF decoder enabled"); + dw_printf (".\n"); + + //int d; + for (d = 0; d < save_audio_config_p->achan[chan].num_subchan; d++) { + + assert (d >= 0 && d < MAX_SUBCHANS); + struct demodulator_state_s *D; + D = &demodulator_state[chan][d]; + profile = save_audio_config_p->achan[chan].profiles[d]; + + //text_color_set(DW_COLOR_DEBUG); + //dw_printf ("About to call demod_psk_init for 8-PSK case, modem_type=%d, profile='%c'\n", + // save_audio_config_p->achan[chan].modem_type, profile); + + demod_psk_init (save_audio_config_p->achan[chan].modem_type, + save_audio_config_p->achan[chan].v26_alternative, + save_audio_config_p->adev[ACHAN2ADEV(chan)].samples_per_sec / save_audio_config_p->achan[chan].decimate, + save_audio_config_p->achan[chan].baud, + profile, + D); + + //text_color_set(DW_COLOR_DEBUG); + //dw_printf ("Returned from demod_psk_init\n"); + + /* For signal level reporting, we want a longer term view. */ + /* Guesses based on 9600. Maybe revisit someday. */ + + D->quick_attack = 0.080 * 0.2; + D->sluggish_decay = 0.00012 * 0.2; + } + break; + +//TODO: how about MODEM_OFF case? + + case MODEM_BASEBAND: + case MODEM_SCRAMBLE: + case MODEM_AIS: + default: /* Not AFSK */ + { + + // For AIS we will accept only a good CRC without any fixup attempts. + // Even with that, there are still a lot of CRC false matches with random noise. + + if (save_audio_config_p->achan[chan].modem_type == MODEM_AIS) { + if (save_audio_config_p->achan[chan].fix_bits != RETRY_NONE) { + text_color_set(DW_COLOR_INFO); + dw_printf ("Channel %d: FIX_BITS option has been turned off for AIS.\n", chan); + save_audio_config_p->achan[chan].fix_bits = RETRY_NONE; + } + if (save_audio_config_p->achan[chan].passall != 0) { + text_color_set(DW_COLOR_INFO); + dw_printf ("Channel %d: PASSALL option has been turned off for AIS.\n", chan); + save_audio_config_p->achan[chan].passall = 0; + } + } + + if (strcmp(save_audio_config_p->achan[chan].profiles, "") == 0) { + + /* Apply default if not set earlier. */ + /* Not sure if it should be on for ARM too. */ + /* Need to take a look at CPU usage and performance difference. */ + + /* Version 1.5: Remove special case for ARM. */ + /* We want higher performance to be the default. */ + /* "MODEM 9600 -" can be used on very slow CPU if necessary. */ + + strlcpy (save_audio_config_p->achan[chan].profiles, "+", sizeof(save_audio_config_p->achan[chan].profiles)); + } + +/* + * We need a minimum number of audio samples per bit time for good performance. + * Easier to check here because demod_9600_init might have an adjusted sample rate. + */ + + float ratio = (float)(save_audio_config_p->adev[ACHAN2ADEV(chan)].samples_per_sec) + / (float)(save_audio_config_p->achan[chan].baud); + +/* + * Set reasonable upsample ratio if user did not override. + */ + + if (save_audio_config_p->achan[chan].upsample == 0) { + + if (ratio < 4) { + + // This is extreme. + // No one should be using a sample rate this low but + // amazingly a recording with 22050 rate can be decoded. + // 3 and 4 are the same. Need more tests. + + save_audio_config_p->achan[chan].upsample = 4; + } + else if (ratio < 5) { + + // example: 44100 / 9600 is 4.59 + // 3 is slightly better than 2 or 4. + + save_audio_config_p->achan[chan].upsample = 3; + } + else if (ratio < 10) { + + // example: 48000 / 9600 = 5 + // 3 is slightly better than 2 or 4. + + save_audio_config_p->achan[chan].upsample = 3; + } + else if (ratio < 15) { + + // ... guessing + + save_audio_config_p->achan[chan].upsample = 2; + } + else { // >= 15 + // + // An example of this might be ..... + // Probably no benefit. + + save_audio_config_p->achan[chan].upsample = 1; + } + } + +#ifdef TUNE_UPSAMPLE + save_audio_config_p->achan[chan].upsample = TUNE_UPSAMPLE; +#endif + + text_color_set(DW_COLOR_DEBUG); + dw_printf ("Channel %d: %d baud, %s, %s, %d sample rate x %d", + chan, + save_audio_config_p->achan[chan].baud, + save_audio_config_p->achan[chan].modem_type == MODEM_AIS ? "AIS" : "K9NG/G3RUH", + save_audio_config_p->achan[chan].profiles, + save_audio_config_p->adev[ACHAN2ADEV(chan)].samples_per_sec, + save_audio_config_p->achan[chan].upsample); + if (save_audio_config_p->achan[chan].dtmf_decode != DTMF_DECODE_OFF) + dw_printf (", DTMF decoder enabled"); + dw_printf (".\n"); + + struct demodulator_state_s *D; + D = &demodulator_state[chan][0]; // first subchannel + + + save_audio_config_p->achan[chan].num_subchan = 1; + save_audio_config_p->achan[chan].num_slicers = 1; + + if (strchr(save_audio_config_p->achan[chan].profiles, '+') != NULL) { + + /* I'm not happy about putting this hack here. */ + /* This belongs in demod_9600_init but it doesn't have access to the audio config. */ + + save_audio_config_p->achan[chan].num_slicers = MAX_SLICERS; + } + + + text_color_set(DW_COLOR_INFO); + dw_printf ("The ratio of audio samples per sec (%d) to data rate in baud (%d) is %.1f\n", + save_audio_config_p->adev[ACHAN2ADEV(chan)].samples_per_sec, + save_audio_config_p->achan[chan].baud, + (double)ratio); + if (ratio < 3) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("There is little hope of success with such a low ratio. Use a higher sample rate.\n"); + } + else if (ratio < 5) { + dw_printf ("This is on the low side for best performance. Can you use a higher sample rate?\n"); + if (save_audio_config_p->adev[ACHAN2ADEV(chan)].samples_per_sec == 44100) { + dw_printf ("For example, can you use 48000 rather than 44100?\n"); + } + } + else if (ratio < 6) { + dw_printf ("Increasing the sample rate should improve decoder performance.\n"); + } + else if (ratio > 15) { + dw_printf ("Sample rate is more than adequate. You might lower it if CPU load is a concern.\n"); + } + else { + dw_printf ("This is a suitable ratio for good performance.\n"); + } + + demod_9600_init (save_audio_config_p->achan[chan].modem_type, + save_audio_config_p->adev[ACHAN2ADEV(chan)].samples_per_sec, + save_audio_config_p->achan[chan].upsample, + save_audio_config_p->achan[chan].baud, D); + + if (strchr(save_audio_config_p->achan[chan].profiles, '+') != NULL) { + + /* I'm not happy about putting this hack here. */ + /* should pass in as a parameter rather than adding on later. */ + + save_audio_config_p->achan[chan].num_slicers = MAX_SLICERS; + D->num_slicers = MAX_SLICERS; + } + + /* For signal level reporting, we want a longer term view. */ + + D->quick_attack = D->agc_fast_attack * 0.2f; + D->sluggish_decay = D->agc_slow_decay * 0.2f; + } + break; + + } /* switch on modulation type. */ + + } /* if channel medium is radio */ + +// FIXME dw_printf ("-------- end of loop for chn %d \n", chan); + + } /* for chan ... */ + + // Now the virtual channels. FIXME: could be single loop. + + for (chan = MAX_CHANS; chan < MAX_TOTAL_CHANS; chan++) { + +// FIXME dw_printf ("-------- virtual channel loop %d \n", chan); + + if (chan == save_audio_config_p->igate_vchannel) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("Channel %d: IGate virtual channel.\n", chan); + } + } + + return (0); + +} /* end demod_init */ + + + +/*------------------------------------------------------------------ + * + * Name: demod_get_sample + * + * Purpose: Get one audio sample from the specified sound input source. + * + * Inputs: a - Index for audio device. 0 = first. + * + * Returns: -32768 .. 32767 for a valid audio sample. + * 256*256 for end of file or other error. + * + * Global In: save_audio_config_p->adev[ACHAN2ADEV(chan)].bits_per_sample - So we know whether to + * read 1 or 2 bytes from audio stream. + * + * Description: Grab 1 or two bytes depending on data source. + * + * When processing stereo, the caller will call this + * at twice the normal rate to obtain alternating left + * and right samples. + * + *----------------------------------------------------------------*/ + +#define FSK_READ_ERR (256*256) + +__attribute__((hot)) +int demod_get_sample (int a) +{ + int x1, x2; + signed short sam; /* short to force sign extension. */ + + + assert (save_audio_config_p->adev[a].bits_per_sample == 8 || save_audio_config_p->adev[a].bits_per_sample == 16); + + if (save_audio_config_p->adev[a].bits_per_sample == 8) { + + x1 = audio_get(a); + if (x1 < 0) return(FSK_READ_ERR); + + assert (x1 >= 0 && x1 <= 255); + + /* Scale 0..255 into -32k..+32k */ + + sam = (x1 - 128) * 256; + + } + else { + x1 = audio_get(a); /* lower byte first */ + if (x1 < 0) return(FSK_READ_ERR); + + x2 = audio_get(a); + if (x2 < 0) return(FSK_READ_ERR); + + assert (x1 >= 0 && x1 <= 255); + assert (x2 >= 0 && x2 <= 255); + + sam = ( x2 << 8 ) | x1; + } + + return (sam); +} + + +/*------------------------------------------------------------------- + * + * Name: demod_process_sample + * + * Purpose: (1) Demodulate the AFSK signal. + * (2) Recover clock and data. + * + * Inputs: chan - Audio channel. 0 for left, 1 for right. + * subchan - modem of the channel. + * sam - One sample of audio. + * Should be in range of -32768 .. 32767. + * + * Returns: None + * + * Descripion: We start off with two bandpass filters tuned to + * the given frequencies. In the case of VHF packet + * radio, this would be 1200 and 2200 Hz. + * + * The bandpass filter amplitudes are compared to + * obtain the demodulated signal. + * + * We also have a digital phase locked loop (PLL) + * to recover the clock and pick out data bits at + * the proper rate. + * + * For each recovered data bit, we call: + * + * hdlc_rec (channel, demodulated_bit); + * + * to decode HDLC frames from the stream of bits. + * + * Future: This could be generalized by passing in the name + * of the function to be called for each bit recovered + * from the demodulator. For now, it's simply hard-coded. + * + *--------------------------------------------------------------------*/ + +static volatile int mute_input[MAX_CHANS]; + +// New in 1.7. +// A few people have a really bad audio cross talk situation where they receive their own transmissions. +// It usually doesn't cause a problem but it is confusing to look at. +// "half duplex" setting applied only to the transmit logic. i.e. wait for clear channel before sending. +// Receiving was still active. +// I think the simplest solution is to mute/unmute the audio input at this point if not full duplex. +// This is called from ptt_set for half duplex. + +void demod_mute_input (int chan, int mute_during_xmit) +{ + assert (chan >= 0 && chan < MAX_CHANS); + mute_input[chan] = mute_during_xmit; +} + +__attribute__((hot)) +void demod_process_sample (int chan, int subchan, int sam) +{ + float fsam; + //int k; + + + struct demodulator_state_s *D; + + assert (chan >= 0 && chan < MAX_CHANS); + assert (subchan >= 0 && subchan < MAX_SUBCHANS); + + if (mute_input[chan]) { + sam = 0; + }; + + D = &demodulator_state[chan][subchan]; + + + /* Scale to nice number, actually -2.0 to +2.0 for extra headroom */ + + fsam = sam / 16384.0f; + +/* + * Accumulate measure of the input signal level. + */ + + +/* + * Version 1.2: Try new approach to capturing the amplitude. + * This is same as the later AGC without the normalization step. + * We want decay to be substantially slower to get a longer + * range idea of the received audio. + */ + + if (fsam >= D->alevel_rec_peak) { + D->alevel_rec_peak = fsam * D->quick_attack + D->alevel_rec_peak * (1.0f - D->quick_attack); + } + else { + D->alevel_rec_peak = fsam * D->sluggish_decay + D->alevel_rec_peak * (1.0f - D->sluggish_decay); + } + + if (fsam <= D->alevel_rec_valley) { + D->alevel_rec_valley = fsam * D->quick_attack + D->alevel_rec_valley * (1.0f - D->quick_attack); + } + else { + D->alevel_rec_valley = fsam * D->sluggish_decay + D->alevel_rec_valley * (1.0f - D->sluggish_decay); + } + + +/* + * Select decoder based on modulation type. + */ + + switch (save_audio_config_p->achan[chan].modem_type) { + + case MODEM_OFF: + + // Might have channel only listening to DTMF for APRStt gateway. + // Don't waste CPU time running a demodulator here. + break; + + case MODEM_AFSK: + case MODEM_EAS: + + if (save_audio_config_p->achan[chan].decimate > 1) { + + sample_sum[chan][subchan] += sam; + sample_count[chan][subchan]++; + if (sample_count[chan][subchan] >= save_audio_config_p->achan[chan].decimate) { + demod_afsk_process_sample (chan, subchan, sample_sum[chan][subchan] / save_audio_config_p->achan[chan].decimate, D); + sample_sum[chan][subchan] = 0; + sample_count[chan][subchan] = 0; + } + } + else { + demod_afsk_process_sample (chan, subchan, sam, D); + } + break; + + case MODEM_QPSK: + case MODEM_8PSK: + + if (save_audio_config_p->achan[chan].decimate > 1) { + + text_color_set(DW_COLOR_ERROR); + dw_printf ("Invalid combination of options. Exiting.\n"); + // Would probably work but haven't thought about it or tested yet. + exit (1); + } + else { + demod_psk_process_sample (chan, subchan, sam, D); + } + break; + + case MODEM_BASEBAND: + case MODEM_SCRAMBLE: + case MODEM_AIS: + default: + + demod_9600_process_sample (chan, sam, save_audio_config_p->achan[chan].upsample, D); + break; + + } /* switch modem_type */ + return; + +} /* end demod_process_sample */ + + + + + + +/* Doesn't seem right. Need to revisit this. */ +/* Resulting scale is 0 to almost 100. */ +/* Cranking up the input level produces no more than 97 or 98. */ +/* We currently produce a message when this goes over 90. */ + +alevel_t demod_get_audio_level (int chan, int subchan) +{ + struct demodulator_state_s *D; + alevel_t alevel; + + assert (chan >= 0 && chan < MAX_CHANS); + assert (subchan >= 0 && subchan < MAX_SUBCHANS); + + /* We have to consider two different cases here. */ + /* N demodulators, each with own slicer and HDLC decoder. */ + /* Single demodulator, multiple slicers each with own HDLC decoder. */ + + if (demodulator_state[chan][0].num_slicers > 1) { + subchan = 0; + } + + D = &demodulator_state[chan][subchan]; + + // Take half of peak-to-peak for received audio level. + + alevel.rec = (int) (( D->alevel_rec_peak - D->alevel_rec_valley ) * 50.0f + 0.5f); + + if (save_audio_config_p->achan[chan].modem_type == MODEM_AFSK || + save_audio_config_p->achan[chan].modem_type == MODEM_EAS) { + + /* For AFSK, we have mark and space amplitudes. */ + + alevel.mark = (int) ((D->alevel_mark_peak ) * 100.0f + 0.5f); + alevel.space = (int) ((D->alevel_space_peak ) * 100.0f + 0.5f); + } + else if (save_audio_config_p->achan[chan].modem_type == MODEM_QPSK || + save_audio_config_p->achan[chan].modem_type == MODEM_8PSK) { + alevel.mark = -1; + alevel.space = -1; + } + else { + +#if 1 + /* Display the + and - peaks. */ + /* Normally we'd expect them to be about the same. */ + /* However, with SDR, or other DC coupling, we could have an offset. */ + + alevel.mark = (int) ((D->alevel_mark_peak) * 200.0f + 0.5f); + alevel.space = (int) ((D->alevel_space_peak) * 200.0f - 0.5f); + + +#else + /* Here we have + and - peaks after filtering. */ + /* Take half of the peak to peak. */ + /* The "5/6" factor worked out right for the current low pass filter. */ + /* Will it need to be different if the filter is tweaked? */ + + alevel.mark = (int) ((D->alevel_mark_peak - D->alevel_space_peak) * 100.0f * 5.0f/6.0f + 0.5f); + alevel.space = -1; /* to print one number inside of ( ) */ +#endif + } + return (alevel); +} + + +/* end demod.c */ diff --git a/demod.h b/src/demod.h similarity index 54% rename from demod.h rename to src/demod.h index d47fced0..f1120cd0 100644 --- a/demod.h +++ b/src/demod.h @@ -3,14 +3,18 @@ /* demod.h */ #include "audio.h" /* for struct audio_s */ +#include "ax25_pad.h" /* for alevel_t */ int demod_init (struct audio_s *pa); -int demod_get_sample (void); +void demod_mute_input (int chan, int mute); + +int demod_get_sample (int a); void demod_process_sample (int chan, int subchan, int sam); void demod_print_agc (int chan, int subchan); -int demod_get_audio_level (int chan, int subchan); \ No newline at end of file +alevel_t demod_get_audio_level (int chan, int subchan); + diff --git a/src/demod_9600.c b/src/demod_9600.c new file mode 100644 index 00000000..705d1fa7 --- /dev/null +++ b/src/demod_9600.c @@ -0,0 +1,690 @@ +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// +// Copyright (C) 2011, 2012, 2013, 2015, 2019, 2021 John Langner, WB2OSZ +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . +// + + +//#define DEBUG4 1 /* capture 9600 output to log files */ + + +/*------------------------------------------------------------------ + * + * Module: demod_9600.c + * + * Purpose: Demodulator for baseband signal. + * This is used for AX.25 (with scrambling) and IL2P without. + * + * Input: Audio samples from either a file or the "sound card." + * + * Outputs: Calls hdlc_rec_bit() for each bit demodulated. + * + *---------------------------------------------------------------*/ + +#include "direwolf.h" + +#include +#include +#include +#include +#include +#include +#include +#include + +// Fine tuning for different demodulator types. +// Don't remove this section. It is here for a reason. + +#define DCD_THRESH_ON 32 // Hysteresis: Can miss 0 out of 32 for detecting lock. + // This is best for actual on-the-air signals. + // Still too many brief false matches. +#define DCD_THRESH_OFF 8 // Might want a little more fine tuning. +#define DCD_GOOD_WIDTH 1024 // No more than 1024!!! + +#include "fsk_demod_state.h" // Values above override defaults. + +#include "tune.h" +#include "hdlc_rec.h" +#include "demod_9600.h" +#include "textcolor.h" +#include "dsp.h" + + + + +static float slice_point[MAX_SUBCHANS]; + + +/* Add sample to buffer and shift the rest down. */ + +__attribute__((hot)) __attribute__((always_inline)) +static inline void push_sample (float val, float *buff, int size) +{ + memmove(buff+1,buff,(size-1)*sizeof(float)); + buff[0] = val; +} + + +/* FIR filter kernel. */ + +__attribute__((hot)) __attribute__((always_inline)) +static inline float convolve (const float *__restrict__ data, const float *__restrict__ filter, int filter_size) +{ + float sum = 0.0f; + int j; + +//#pragma GCC ivdep // ignored until gcc 4.9 + for (j=0; j= *ppeak) { + *ppeak = in * fast_attack + *ppeak * (1.0f - fast_attack); + } + else { + *ppeak = in * slow_decay + *ppeak * (1.0f - slow_decay); + } + + if (in <= *pvalley) { + *pvalley = in * fast_attack + *pvalley * (1.0f - fast_attack); + } + else { + *pvalley = in * slow_decay + *pvalley * (1.0f - slow_decay); + } + + if (*ppeak > *pvalley) { + return ((in - 0.5f * (*ppeak + *pvalley)) / (*ppeak - *pvalley)); + } + return (0.0); +} + + +/*------------------------------------------------------------------ + * + * Name: demod_9600_init + * + * Purpose: Initialize the 9600 (or higher) baud demodulator. + * + * Inputs: modem_type - Determines whether scrambling is used. + * + * samples_per_sec - Number of samples per second for audio. + * + * upsample - Factor to upsample the incoming stream. + * After a lot of experimentation, I discovered that + * it works better if the data is upsampled. + * This reduces the jitter for PLL synchronization. + * + * baud - Data rate in bits per second. + * + * D - Address of demodulator state. + * + * Returns: None + * + *----------------------------------------------------------------*/ + +void demod_9600_init (enum modem_t modem_type, int original_sample_rate, int upsample, int baud, struct demodulator_state_s *D) +{ + float fc; + int j; + if (upsample < 1) upsample = 1; + if (upsample > 4) upsample = 4; + + + memset (D, 0, sizeof(struct demodulator_state_s)); + D->modem_type = modem_type; + D->num_slicers = 1; + +// Multiple profiles in future? + +// switch (profile) { + +// case 'J': // upsample x2 with filtering. +// case 'K': // upsample x3 with filtering. +// case 'L': // upsample x4 with filtering. + + + D->lp_filter_len_bits = 1.0; // -U4 = 61 4.59 samples/symbol + + // Works best with odd number in some tests. Even is better in others. + //D->lp_filter_size = ((int) (0.5f * ( D->lp_filter_len_bits * (float)original_sample_rate / (float)baud ))) * 2 + 1; + + // Just round to nearest integer. + D->lp_filter_size = (int) (( D->lp_filter_len_bits * (float)original_sample_rate / baud) + 0.5f); + + D->lp_window = BP_WINDOW_COSINE; + + D->lpf_baud = 1.00; + + D->agc_fast_attack = 0.080; + D->agc_slow_decay = 0.00012; + + D->pll_locked_inertia = 0.89; + D->pll_searching_inertia = 0.67; + +// break; +// } + +#if 0 + text_color_set(DW_COLOR_DEBUG); + dw_printf ("---------- %s (%d, %d) -----------\n", __func__, samples_per_sec, baud); + dw_printf ("filter_len_bits = %.2f\n", D->lp_filter_len_bits); + dw_printf ("lp_filter_size = %d\n", D->lp_filter_size); + dw_printf ("lp_window = %d\n", D->lp_window); + dw_printf ("lpf_baud = %.2f\n", D->lpf_baud); + dw_printf ("samples per bit = %.1f\n", (double)samples_per_sec / baud); +#endif + + + // PLL needs to use the upsampled rate. + + D->pll_step_per_sample = + (int) round(TICKS_PER_PLL_CYCLE * (double) baud / (double)(original_sample_rate * upsample)); + + +#ifdef TUNE_LP_WINDOW + D->lp_window = TUNE_LP_WINDOW; +#endif + +#if TUNE_LP_FILTER_SIZE + D->lp_filter_size = TUNE_LP_FILTER_SIZE; +#endif + +#ifdef TUNE_LPF_BAUD + D->lpf_baud = TUNE_LPF_BAUD; +#endif + +#ifdef TUNE_AGC_FAST + D->agc_fast_attack = TUNE_AGC_FAST; +#endif + +#ifdef TUNE_AGC_SLOW + D->agc_slow_decay = TUNE_AGC_SLOW; +#endif + +#if defined(TUNE_PLL_LOCKED) + D->pll_locked_inertia = TUNE_PLL_LOCKED; +#endif + +#if defined(TUNE_PLL_SEARCHING) + D->pll_searching_inertia = TUNE_PLL_SEARCHING; +#endif + + // Initial filter (before scattering) is based on upsampled rate. + + fc = (float)baud * D->lpf_baud / (float)(original_sample_rate * upsample); + + //dw_printf ("demod_9600_init: call gen_lowpass(fc=%.2f, , size=%d, )\n", fc, D->lp_filter_size); + + gen_lowpass (fc, D->u.bb.lp_filter, D->lp_filter_size * upsample, D->lp_window); + +// New in 1.7 - +// Use a polyphase filter to reduce the CPU load. +// Originally I used zero stuffing to upsample. +// Here is the general idea. +// +// Suppose the input samples are 1 2 3 4 5 6 7 8 9 ... +// Filter coefficients are a b c d e f g h i ... +// +// With original sampling rate, the filtering would involve multiplying and adding: +// +// 1a 2b 3c 4d 5e 6f ... +// +// When upsampling by 3, each of these would need to be evaluated +// for each audio sample: +// +// 1a 0b 0c 2d 0e 0f 3g 0h 0i ... +// 0a 1b 0c 0d 2e 0f 0g 3h 0i ... +// 0a 0b 1c 0d 0e 2f 0g 0h 3i ... +// +// 2/3 of the multiplies are always by a stuffed zero. +// We can do this more efficiently by removing them. +// +// 1a 2d 3g ... +// 1b 2e 3h ... +// 1c 2f 3i ... +// +// We scatter the original filter across multiple shorter filters. +// Each input sample cycles around them to produce the upsampled rate. +// +// a d g ... +// b e h ... +// c f i ... +// +// There are countless sources of information DSP but this one is unique +// in that it is a college course that mentions APRS. +// https://www2.eecs.berkeley.edu/Courses/EE123 +// +// Was the effort worthwhile? Times on an RPi 3. +// +// command: atest -B9600 ~/walkabout9600[abc]-compressed*.wav +// +// These are 3 recordings of a portable system being carried out of +// range and back in again. It is a real world test for weak signals. +// +// options num decoded seconds x realtime +// 1.6 1.7 1.6 1.7 1.6 1.7 +// --- --- --- --- --- --- +// -P- 171 172 23.928 17.967 14.9 19.9 +// -P+ 180 180 54.688 48.772 6.5 7.3 +// -P- -F1 177 178 32.686 26.517 10.9 13.5 +// +// So, it turns out that -P+ doesn't have a dramatic improvement, only +// around 4%, for drastically increased CPU requirements. +// Maybe we should turn that off by default, especially for ARM. +// + + int k = 0; + for (int i = 0; i < D->lp_filter_size; i++) { + D->u.bb.lp_polyphase_1[i] = D->u.bb.lp_filter[k++]; + if (upsample >= 2) { + D->u.bb.lp_polyphase_2[i] = D->u.bb.lp_filter[k++]; + if (upsample >= 3) { + D->u.bb.lp_polyphase_3[i] = D->u.bb.lp_filter[k++]; + if (upsample >= 4) { + D->u.bb.lp_polyphase_4[i] = D->u.bb.lp_filter[k++]; + } + } + } + } + + + /* Version 1.2: Experiment with different slicing levels. */ + // Really didn't help that much because we should have a symmetrical signal. + + for (j = 0; j < MAX_SUBCHANS; j++) { + slice_point[j] = 0.02f * (j - 0.5f * (MAX_SUBCHANS-1)); + //dw_printf ("slice_point[%d] = %+5.2f\n", j, slice_point[j]); + } + +} /* end fsk_demod_init */ + + + +/*------------------------------------------------------------------- + * + * Name: demod_9600_process_sample + * + * Purpose: (1) Filter & slice the signal. + * (2) Descramble it. + * (2) Recover clock and data. + * + * Inputs: chan - Audio channel. 0 for left, 1 for right. + * + * sam - One sample of audio. + * Should be in range of -32768 .. 32767. + * + * Returns: None + * + * Descripion: "9600 baud" packet is FSK for an FM voice transceiver. + * By the time it gets here, it's really a baseband signal. + * At one extreme, we could have a 4800 Hz square wave. + * A the other extreme, we could go a considerable number + * of bit times without any transitions. + * + * The trick is to extract the digital data which has + * been distorted by going thru voice transceivers not + * intended to pass this sort of "audio" signal. + * + * For G3RUH mode, data is "scrambled" to reduce the amount of DC bias. + * The data stream must be unscrambled at the receiving end. + * + * We also have a digital phase locked loop (PLL) + * to recover the clock and pick out data bits at + * the proper rate. + * + * For each recovered data bit, we call: + * + * hdlc_rec (channel, demodulated_bit); + * + * to decode HDLC frames from the stream of bits. + * + * Future: This could be generalized by passing in the name + * of the function to be called for each bit recovered + * from the demodulator. For now, it's simply hard-coded. + * + * After experimentation, I found that this works better if + * the original signal is upsampled by 2x or even 4x. + * + * References: 9600 Baud Packet Radio Modem Design + * http://www.amsat.org/amsat/articles/g3ruh/109.html + * + * The KD2BD 9600 Baud Modem + * http://www.amsat.org/amsat/articles/kd2bd/9k6modem/ + * + * 9600 Baud Packet Handbook + * ftp://ftp.tapr.org/general/9600baud/96man2x0.txt + * + * + *--------------------------------------------------------------------*/ + +inline static void nudge_pll (int chan, int subchan, int slice, float demod_out, struct demodulator_state_s *D); + +static void process_filtered_sample (int chan, float fsam, struct demodulator_state_s *D); + + +__attribute__((hot)) +void demod_9600_process_sample (int chan, int sam, int upsample, struct demodulator_state_s *D) +{ + float fsam; + +#if DEBUG4 + static FILE *demod_log_fp = NULL; + static int log_file_seq = 0; /* Part of log file name */ +#endif + + int subchan = 0; + + assert (chan >= 0 && chan < MAX_CHANS); + assert (subchan >= 0 && subchan < MAX_SUBCHANS); + + /* Scale to nice number for convenience. */ + /* Consistent with the AFSK demodulator, we'd like to use */ + /* only half of the dynamic range to have some headroom. */ + /* i.e. input range +-16k becomes +-1 here and is */ + /* displayed in the heard line as audio level 100. */ + + fsam = (float)sam / 16384.0f; + + // Low pass filter + push_sample (fsam, D->u.bb.audio_in, D->lp_filter_size); + + fsam = convolve (D->u.bb.audio_in, D->u.bb.lp_polyphase_1, D->lp_filter_size); + process_filtered_sample (chan, fsam, D); + if (upsample >= 2) { + fsam = convolve (D->u.bb.audio_in, D->u.bb.lp_polyphase_2, D->lp_filter_size); + process_filtered_sample (chan, fsam, D); + if (upsample >= 3) { + fsam = convolve (D->u.bb.audio_in, D->u.bb.lp_polyphase_3, D->lp_filter_size); + process_filtered_sample (chan, fsam, D); + if (upsample >= 4) { + fsam = convolve (D->u.bb.audio_in, D->u.bb.lp_polyphase_4, D->lp_filter_size); + process_filtered_sample (chan, fsam, D); + } + } + } +} + + +__attribute__((hot)) +static void process_filtered_sample (int chan, float fsam, struct demodulator_state_s *D) +{ + + int subchan = 0; + +/* + * Version 1.2: Capture the post-filtering amplitude for display. + * This is similar to the AGC without the normalization step. + * We want decay to be substantially slower to get a longer + * range idea of the received audio. + * For AFSK, we keep mark and space amplitudes. + * Here we keep + and - peaks because there could be a DC bias. + */ + +// TODO: probably no need for this. Just use D->m_peak, D->m_valley + + if (fsam >= D->alevel_mark_peak) { + D->alevel_mark_peak = fsam * D->quick_attack + D->alevel_mark_peak * (1.0f - D->quick_attack); + } + else { + D->alevel_mark_peak = fsam * D->sluggish_decay + D->alevel_mark_peak * (1.0f - D->sluggish_decay); + } + + if (fsam <= D->alevel_space_peak) { + D->alevel_space_peak = fsam * D->quick_attack + D->alevel_space_peak * (1.0f - D->quick_attack); + } + else { + D->alevel_space_peak = fsam * D->sluggish_decay + D->alevel_space_peak * (1.0f - D->sluggish_decay); + } + +/* + * The input level can vary greatly. + * More importantly, there could be a DC bias which we need to remove. + * + * Normalize the signal with automatic gain control (AGC). + * This works by looking at the minimum and maximum signal peaks + * and scaling the results to be roughly in the -1.0 to +1.0 range. + */ + float demod_out; + int demod_data; /* Still scrambled. */ + + demod_out = agc (fsam, D->agc_fast_attack, D->agc_slow_decay, &(D->m_peak), &(D->m_valley)); + +// TODO: There is potential for multiple decoders with one filter. + +//dw_printf ("peak=%.2f valley=%.2f fsam=%.2f norm=%.2f\n", D->m_peak, D->m_valley, fsam, norm); + + if (D->num_slicers <= 1) { + + /* Normal case of one demodulator to one HDLC decoder. */ + /* Demodulator output is difference between response from two filters. */ + /* AGC should generally keep this around -1 to +1 range. */ + + demod_data = demod_out > 0; + nudge_pll (chan, subchan, 0, demod_out, D); + } + else { + int slice; + + /* Multiple slicers each feeding its own HDLC decoder. */ + + for (slice=0; slicenum_slicers; slice++) { + demod_data = demod_out - slice_point[slice] > 0; + nudge_pll (chan, subchan, slice, demod_out - slice_point[slice], D); + } + } + + // demod_data is used only for debug out. + // suppress compiler warning about it not being used. + (void) demod_data; + +#if DEBUG4 + + if (chan == 0) { + + if (1) { + //if (D->slicer[slice].data_detect) { + char fname[30]; + int slice = 0; + + if (demod_log_fp == NULL) { + log_file_seq++; + snprintf (fname, sizeof(fname), "demod/%04d.csv", log_file_seq); + //if (log_file_seq == 1) mkdir ("demod", 0777); + if (log_file_seq == 1) mkdir ("demod"); + + demod_log_fp = fopen (fname, "w"); + text_color_set(DW_COLOR_DEBUG); + dw_printf ("Starting demodulator log file %s\n", fname); + fprintf (demod_log_fp, "Audio, Filtered, Max, Min, Normalized, Sliced, Clock\n"); + } + + fprintf (demod_log_fp, "%.3f, %.3f, %.3f, %.3f, %.3f, %d, %.2f\n", + fsam + 6, + fsam + 4, + D->m_peak + 4, + D->m_valley + 4, + demod_out + 2, + demod_data + 2, + (D->slicer[slice].data_clock_pll & 0x80000000) ? .5 : .0); + + fflush (demod_log_fp); + } + else { + if (demod_log_fp != NULL) { + fclose (demod_log_fp); + demod_log_fp = NULL; + } + } + } +#endif + +} /* end demod_9600_process_sample */ + + +/*------------------------------------------------------------------- + * + * Name: nudge_pll + * + * Purpose: Update the PLL state for each audio sample. + * + * (2) Descramble it. + * (2) Recover clock and data. + * + * Inputs: chan - Audio channel. 0 for left, 1 for right. + * + * subchan - Which demodulator. We could have several running in parallel. + * + * slice - Determines which Slicing level & HDLC decoder to use. + * + * demod_out_f - Demodulator output, possibly shifted by slicing level + * It will be compared with 0.0 to bit binary value out. + * + * D - Demodulator state for this channel / subchannel. + * + * Returns: None + * + * Description: A PLL is used to sample near the centers of the data bits. + * + * D->data_clock_pll is a SIGNED 32 bit variable. + * When it overflows from a large positive value to a negative value, we + * sample a data bit from the demodulated signal. + * + * Ideally, the the demodulated signal transitions should be near + * zero we we sample mid way between the transitions. + * + * Nudge the PLL by removing some small fraction from the value of + * data_clock_pll, pushing it closer to zero. + * + * This adjustment will never change the sign so it won't cause + * any erratic data bit sampling. + * + * If we adjust it too quickly, the clock will have too much jitter. + * If we adjust it too slowly, it will take too long to lock on to a new signal. + * + * I don't think the optimal value will depend on the audio sample rate + * because this happens for each transition from the demodulator. + * + * Version 1.4: Previously, we would always pull the PLL phase toward 0 after + * after a zero crossing was detetected. This adds extra jitter, + * especially when the ratio of audio sample rate to baud is low. + * Now, we interpolate between the two samples to get an estimate + * on when the zero crossing happened. The PLL is pulled toward + * this point. + * + * Results??? TBD + * + * Version 1.6: New experiment where filter size to extract clock is not the same + * as filter to extract the data bit value. + * + *--------------------------------------------------------------------*/ + +__attribute__((hot)) +inline static void nudge_pll (int chan, int subchan, int slice, float demod_out_f, struct demodulator_state_s *D) +{ + D->slicer[slice].prev_d_c_pll = D->slicer[slice].data_clock_pll; + + // Perform the add as unsigned to avoid signed overflow error. + D->slicer[slice].data_clock_pll = (signed)((unsigned)(D->slicer[slice].data_clock_pll) + (unsigned)(D->pll_step_per_sample)); + + if ( D->slicer[slice].prev_d_c_pll > 1000000000 && D->slicer[slice].data_clock_pll < -1000000000) { + + /* Overflow. Was large positive, wrapped around, now large negative. */ + + hdlc_rec_bit (chan, subchan, slice, demod_out_f > 0, D->modem_type == MODEM_SCRAMBLE, D->slicer[slice].lfsr); + pll_dcd_each_symbol2 (D, chan, subchan, slice); + } + +/* + * Zero crossing? + */ + if ((D->slicer[slice].prev_demod_out_f < 0 && demod_out_f > 0) || + (D->slicer[slice].prev_demod_out_f > 0 && demod_out_f < 0)) { + + // Note: Test for this demodulator, not overall for channel. + + pll_dcd_signal_transition2 (D, slice, D->slicer[slice].data_clock_pll); + + float target = D->pll_step_per_sample * demod_out_f / (demod_out_f - D->slicer[slice].prev_demod_out_f); + + if (D->slicer[slice].data_detect) { + D->slicer[slice].data_clock_pll = (int)(D->slicer[slice].data_clock_pll * D->pll_locked_inertia + target * (1.0f - D->pll_locked_inertia) ); + } + else { + D->slicer[slice].data_clock_pll = (int)(D->slicer[slice].data_clock_pll * D->pll_searching_inertia + target * (1.0f - D->pll_searching_inertia) ); + } + } + + +#if DEBUG5 + + //if (chan == 0) { + if (D->slicer[slice].data_detect) { + + char fname[30]; + + + if (demod_log_fp == NULL) { + seq++; + snprintf (fname, sizeof(fname), "demod96/%04d.csv", seq); + if (seq == 1) mkdir ("demod96" +#ifndef __WIN32__ + , 0777 +#endif + ); + + demod_log_fp = fopen (fname, "w"); + text_color_set(DW_COLOR_DEBUG); + dw_printf ("Starting 9600 decoder log file %s\n", fname); + fprintf (demod_log_fp, "Audio, Peak, Valley, Demod, SData, Descram, Clock\n"); + } + fprintf (demod_log_fp, "%.3f, %.3f, %.3f, %.3f, %.2f, %.2f, %.2f\n", + 0.5f * fsam + 3.5, + 0.5f * D->m_peak + 3.5, + 0.5f * D->m_valley + 3.5, + 0.5f * demod_out + 2.0, + demod_data ? 1.35 : 1.0, + descram ? .9 : .55, + (D->data_clock_pll & 0x80000000) ? .1 : .45); + } + else { + if (demod_log_fp != NULL) { + fclose (demod_log_fp); + demod_log_fp = NULL; + } + } + //} + +#endif + + +/* + * Remember demodulator output (pre-descrambling) so we can compare next time + * for the DPLL sync. + */ + D->slicer[slice].prev_demod_out_f = demod_out_f; + +} /* end nudge_pll */ + + +/* end demod_9600.c */ diff --git a/src/demod_9600.h b/src/demod_9600.h new file mode 100644 index 00000000..51fc15e4 --- /dev/null +++ b/src/demod_9600.h @@ -0,0 +1,25 @@ + + +/* demod_9600.h */ + + +#include "fsk_demod_state.h" + + +void demod_9600_init (enum modem_t modem_type, int original_sample_rate, int upsample, int baud, struct demodulator_state_s *D); + +void demod_9600_process_sample (int chan, int sam, int upsample, struct demodulator_state_s *D); + + + + +/* Undo data scrambling for 9600 baud. */ + +static inline int descramble (int in, int *state) +{ + int out; + + out = (in ^ (*state >> 16) ^ (*state >> 11)) & 1; + *state = (*state << 1) | (in & 1); + return (out); +} diff --git a/src/demod_afsk.c b/src/demod_afsk.c new file mode 100644 index 00000000..b4d6c295 --- /dev/null +++ b/src/demod_afsk.c @@ -0,0 +1,944 @@ +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// +// Copyright (C) 2011, 2012, 2013, 2014, 2015, 2020 John Langner, WB2OSZ +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . +// + + +// #define DEBUG1 1 /* display debugging info */ + +// #define DEBUG3 1 /* print carrier detect changes. */ + +// #define DEBUG4 1 /* capture AFSK demodulator output to log files */ + /* Can be used to make nice plots. */ + +// #define DEBUG5 1 // Write just demodulated bit stream to file. */ + + +/*------------------------------------------------------------------ + * + * Module: demod_afsk.c + * + * Purpose: Demodulator for Audio Frequency Shift Keying (AFSK). + * + * Input: Audio samples from either a file or the "sound card." + * + * Outputs: Calls hdlc_rec_bit() for each bit demodulated. + * + *---------------------------------------------------------------*/ + +#include "direwolf.h" + +#include +#include +#include +#include +#include +#include +#include +#include + +#include "audio.h" +#include "tune.h" +#include "fsk_demod_state.h" +#include "fsk_gen_filter.h" +#include "hdlc_rec.h" +#include "textcolor.h" +#include "demod_afsk.h" +#include "dsp.h" + +#define MIN(a,b) ((a)<(b)?(a):(b)) +#define MAX(a,b) ((a)>(b)?(a):(b)) + +#define TUNE(envvar,param,name,fmt) { \ + char *e = getenv(envvar); \ + if (e != NULL) { \ + param = atof(e); \ + text_color_set (DW_COLOR_ERROR); \ + dw_printf ("TUNE: " name " = " fmt "\n", param); \ + } } + + +// Cosine table indexed by unsigned byte. +static float fcos256_table[256]; + +#define fcos256(x) (fcos256_table[((x)>>24)&0xff]) +#define fsin256(x) (fcos256_table[(((x)>>24)-64)&0xff]) + +static void nudge_pll (int chan, int subchan, int slice, float demod_out, struct demodulator_state_s *D, float amplitude); + + +/* Quick approximation to sqrt(x*x + y*y) */ +/* No benefit for regular PC. */ +/* Might help with microcomputer platform??? */ + +__attribute__((hot)) __attribute__((always_inline)) +static inline float fast_hypot(float x, float y) +{ +#if 0 + x = fabsf(x); + y = fabsf(y); + + if (x > y) { + return (x * .941246f + y * .41f); + } + else { + return (y * .941246f + x * .41f); + } +#else + return (hypotf(x,y)); +#endif +} + + +/* Add sample to buffer and shift the rest down. */ + +__attribute__((hot)) __attribute__((always_inline)) +static inline void push_sample (float val, float *buff, int size) +{ + memmove(buff+1,buff,(size-1)*sizeof(float)); + buff[0] = val; +} + + +/* FIR filter kernel. */ + +__attribute__((hot)) __attribute__((always_inline)) +static inline float convolve (const float *__restrict__ data, const float *__restrict__ filter, int filter_taps) +{ + float sum = 0.0f; + int j; + +//#pragma GCC ivdep // ignored until gcc 4.9 + for (j=0; j= *ppeak) { + *ppeak = in * fast_attack + *ppeak * (1.0f - fast_attack); + } + else { + *ppeak = in * slow_decay + *ppeak * (1.0f - slow_decay); + } + + if (in <= *pvalley) { + *pvalley = in * fast_attack + *pvalley * (1.0f - fast_attack); + } + else { + *pvalley = in * slow_decay + *pvalley * (1.0f - slow_decay); + } + +#if 1 + float x = in; + if (x > *ppeak) x = *ppeak; // experiment: clip to envelope? + if (x < *pvalley) x = *pvalley; +#endif + if (*ppeak > *pvalley) { + + return ((x - 0.5f * (*ppeak + *pvalley)) / (*ppeak - *pvalley)); // my original AGC + + //return (( x - 0.5f * (*ppeak + *pvalley )) * ( *ppeak - *pvalley )); // see note below. + //return (x - 0.5f * (*ppeak + *pvalley)); // not as good either. + } + return (0.0f); +} + + +// K6JQ pointed me to this wonderful article: +// Improved Automatic Threshold Correction Methods for FSK by Kok Chen, W7AY. +// http://www.w7ay.net/site/Technical/ATC/index.html +// +// The stated problem is a little different, selective fading for HF RTTY, but the +// general idea is the similar: Compensating for imbalance of the two tones. +// +// The stronger tone probably has a better S/N ratio so we apply a larger +// weight to it. Effectively it is comparing power rather than amplitude. +// This is the optimal method from the article referenced. +// +// Interesting idea but it did not work as well as the original AGC in this case. +// For VHF FM we are not dealing with rapid deep selective fading of one tone. +// Instead we have an imbalance which is the same for the whole frame. +// It might be interesting to try this with HF SSB packet which is much like RTTY. +// +// I use the term valley rather than noise floor. +// After a little algebra, it looks remarkably similar to the function above. +// +// return (( x - valley ) * ( peak - valley ) - 0.5f * ( peak - valley ) * ( peak - valley )); +// return (( x - valley ) - 0.5f * ( peak - valley )) * ( peak - valley )); +// return (( x - 0.5f * (peak + valley )) * ( peak - valley )); + + + +/* + * for multi-slicer experiment. + */ + +#define MIN_G 0.5f +#define MAX_G 4.0f + +/* TODO: static */ float space_gain[MAX_SUBCHANS]; + + + +/*------------------------------------------------------------------ + * + * Name: demod_afsk_init + * + * Purpose: Initialization for an AFSK demodulator. + * Select appropriate parameters and set up filters. + * + * Inputs: samples_per_sec + * baud + * mark_freq + * space_freq + * + * D - Pointer to demodulator state for given channel. + * + * Outputs: + * + * Returns: None. + * + * Bugs: This doesn't do much error checking so don't give it + * anything crazy. + * + *----------------------------------------------------------------*/ + +void demod_afsk_init (int samples_per_sec, int baud, int mark_freq, + int space_freq, char profile, struct demodulator_state_s *D) +{ + + int j; + + for (j = 0; j < 256; j++) { + fcos256_table[j] = cosf((float)j * 2.0f * (float)M_PI / 256.0f); + } + + memset (D, 0, sizeof(struct demodulator_state_s)); + D->num_slicers = 1; + +#if DEBUG1 + dw_printf ("demod_afsk_init (rate=%d, baud=%d, mark=%d, space=%d, profile=%c\n", + samples_per_sec, baud, mark_freq, space_freq, profile); +#endif + D->profile = profile; + + switch (D->profile) { + + case 'A': // Official name + case 'E': // For compatibility during transition + + D->profile = 'A'; + + /* New in version 1.7 */ + /* This is a simpler version of what has been used all along. */ + /* Rather than convolving each sample with a pre-computed mark and */ + /* space filter, we have two free running local oscillators. */ + /* Also see if we can do better with a Root Raised Cosine filter */ + /* which supposedly reduces intersymbol interference. */ + + D->use_prefilter = 1; /* first, a bandpass filter. */ + + if (baud > 600) { + D->prefilter_baud = 0.155; + // Low cutoff below mark, high cutoff above space + // as fraction of the symbol rate. + // Intuitively you might expect this to be about + // half the symbol rate, e.g. 600 Hz outside + // the two tones of interest for 1200 baud. + // It turns out that narrower is better. + + D->pre_filter_len_sym = 383 * 1200. / 44100.; // about 8 symbols + D->pre_window = BP_WINDOW_TRUNCATED; + } + else { + D->prefilter_baud = 0.87; // TOTO: fine tune + D->pre_filter_len_sym = 1.857; + D->pre_window = BP_WINDOW_COSINE; + } + + // Local oscillators for Mark and Space tones. + + D->u.afsk.m_osc_phase = 0; + D->u.afsk.m_osc_delta = round ( pow(2., 32.) * (double)mark_freq / (double)samples_per_sec ); + + D->u.afsk.s_osc_phase = 0; + D->u.afsk.s_osc_delta = round ( pow(2., 32.) * (double)space_freq / (double)samples_per_sec ); + + D->u.afsk.use_rrc = 1; + TUNE("TUNE_USE_RRC", D->u.afsk.use_rrc, "use_rrc", "%d") + + if (D->u.afsk.use_rrc) { + D->u.afsk.rrc_width_sym = 2.80; + D->u.afsk.rrc_rolloff = 0.20; + } + else { + D->lpf_baud = 0.14; + D->lp_filter_width_sym = 1.388; + D->lp_window = BP_WINDOW_TRUNCATED; + } + + D->agc_fast_attack = 0.70; + D->agc_slow_decay = 0.000090; + + D->pll_locked_inertia = 0.74; + D->pll_searching_inertia = 0.50; + break; + + case 'B': // official name + case 'D': // backward compatibility + + D->profile = 'B'; + + // Experiment for version 1.7. + // Up to this point, I've always used separate mark and space + // filters and compared the amplitudes. + // Another technique for an FM demodulator is to mix with + // the center frequency and look for the rate of change of the phase. + + D->use_prefilter = 1; /* first, a bandpass filter. */ + + if (baud > 600) { + D->prefilter_baud = 0.19; + // Low cutoff below mark, high cutoff above space + // as fraction of the symbol rate. + // Intuitively you might expect this to be about + // half the symbol rate, e.g. 600 Hz outside + // the two tones of interest for 1200 baud. + // It turns out that narrower is better. + + D->pre_filter_len_sym = 8.163; // Filter length in symbol times. + D->pre_window = BP_WINDOW_TRUNCATED; + } + else { + D->prefilter_baud = 0.87; // TOTO: fine tune + D->pre_filter_len_sym = 1.857; + D->pre_window = BP_WINDOW_COSINE; + } + + // Local oscillator for Center frequency. + + D->u.afsk.c_osc_phase = 0; + D->u.afsk.c_osc_delta = round ( pow(2., 32.) * 0.5 * (mark_freq + space_freq) / (double)samples_per_sec ); + + D->u.afsk.use_rrc = 1; + TUNE("TUNE_USE_RRC", D->u.afsk.use_rrc, "use_rrc", "%d") + + if (D->u.afsk.use_rrc) { + D->u.afsk.rrc_width_sym = 2.00; + D->u.afsk.rrc_rolloff = 0.40; + } + else { + D->lpf_baud = 0.5; + D->lp_filter_width_sym = 1.714286; // 63 * 1200. / 44100.; + D->lp_window = BP_WINDOW_TRUNCATED; + } + + // For scaling phase shift into normallized -1 to +1 range for mark and space. + D->u.afsk.normalize_rpsam = 1.0 / (0.5 * abs(mark_freq - space_freq) * 2 * M_PI / samples_per_sec); + + // New "B" demodulator does not use AGC but demod.c needs this to derive "quick" and + // "sluggish" values for overall signal amplitude. That probably should be independent + // of these values. + D->agc_fast_attack = 0.70; + D->agc_slow_decay = 0.000090; + + D->pll_locked_inertia = 0.74; + D->pll_searching_inertia = 0.50; + + D->alevel_mark_peak = -1; // Disable received signal (m/s) display. + D->alevel_space_peak = -1; + break; + + default: + + text_color_set(DW_COLOR_ERROR); + dw_printf ("Invalid AFSK demodulator profile = %c\n", profile); + exit (1); + } + + + TUNE("TUNE_PRE_BAUD", D->prefilter_baud, "prefilter_baud", "%.3f") + TUNE("TUNE_PRE_WINDOW", D->pre_window, "pre_window", "%d") + + TUNE("TUNE_LPF_BAUD", D->lpf_baud, "lpf_baud", "%.3f") + TUNE("TUNE_LP_WINDOW", D->lp_window, "lp_window", "%d") + + TUNE("TUNE_RRC_ROLLOFF", D->u.afsk.rrc_rolloff, "rrc_rolloff", "%.2f") + TUNE("TUNE_RRC_WIDTH_SYM", D->u.afsk.rrc_width_sym, "rrc_width_sym", "%.2f") + + TUNE("TUNE_AGC_FAST", D->agc_fast_attack, "agc_fast_attack", "%.3f") + TUNE("TUNE_AGC_SLOW", D->agc_slow_decay, "agc_slow_decay", "%.6f") + + TUNE("TUNE_PLL_LOCKED", D->pll_locked_inertia, "pll_locked_inertia", "%.2f") + TUNE("TUNE_PLL_SEARCHING", D->pll_searching_inertia, "pll_searching_inertia", "%.2f") + + +/* + * Calculate constants used for timing. + * The audio sample rate must be at least a few times the data rate. + * + * Baud is an integer so we hack in a fine adjustment for EAS. + * Probably makes no difference because the DPLL keeps it in sync. + * + * A fraction if a Hz would make no difference for the filters. + */ + if (baud == 521) { + D->pll_step_per_sample = (int) round((TICKS_PER_PLL_CYCLE * (double)520.83) / ((double)samples_per_sec)); + } + else { + D->pll_step_per_sample = (int) round((TICKS_PER_PLL_CYCLE * (double)baud) / ((double)samples_per_sec)); + } + +/* + * Optionally apply a bandpass ("pre") filter to attenuate + * frequencies outside the range of interest. + */ + + if (D->use_prefilter) { + + // odd number is a little better + D->pre_filter_taps = ((int)( D->pre_filter_len_sym * (float)samples_per_sec / (float)baud )) | 1; + + TUNE("TUNE_PRE_FILTER_TAPS", D->pre_filter_taps, "pre_filter_taps", "%d") + +// TODO: Size comes out to 417 for 1200 bps with 48000 sample rate. +// The message is upsetting. Can we handle this better? + + if (D->pre_filter_taps > MAX_FILTER_SIZE) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("Warning: Calculated pre filter size of %d is too large.\n", D->pre_filter_taps); + dw_printf ("Decrease the audio sample rate or increase the decimation factor.\n"); + dw_printf ("You can use -D2 or -D3, on the command line, to down-sample the audio rate\n"); + dw_printf ("before demodulating. This greatly decreases the CPU requirements with little\n"); + dw_printf ("impact on the decoding performance. This is useful for a slow ARM processor,\n"); + dw_printf ("such as with a Raspberry Pi model 1.\n"); + D->pre_filter_taps = (MAX_FILTER_SIZE - 1) | 1; + } + + float f1 = MIN(mark_freq,space_freq) - D->prefilter_baud * baud; + float f2 = MAX(mark_freq,space_freq) + D->prefilter_baud * baud; +#if 0 + text_color_set(DW_COLOR_DEBUG); + dw_printf ("Generating prefilter %.0f to %.0f Hz.\n", f1, f2); +#endif + f1 = f1 / (float)samples_per_sec; + f2 = f2 / (float)samples_per_sec; + + gen_bandpass (f1, f2, D->pre_filter, D->pre_filter_taps, D->pre_window); + } + +/* + * Now the lowpass filter. + * In version 1.7 a Root Raised Cosine filter is added as an alternative + * to the generic low pass filter. + * In both cases, lp_filter and lp_filter_taps are used but the + * contents will be generated differently. Later code does not care. + */ + if (D->u.afsk.use_rrc) { + + assert (D->u.afsk.rrc_width_sym >= 1 && D->u.afsk.rrc_width_sym <= 16); + assert (D->u.afsk.rrc_rolloff >= 0. && D->u.afsk.rrc_rolloff <= 1.); + + D->lp_filter_taps = ((int) (D->u.afsk.rrc_width_sym * (float)samples_per_sec / baud)) | 1; // odd works better + + TUNE("TUNE_LP_FILTER_TAPS", D->lp_filter_taps, "lp_filter_taps (RRC)", "%d") + + if (D->lp_filter_taps > MAX_FILTER_SIZE) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Calculated RRC low pass filter size of %d is too large.\n", D->lp_filter_taps); + dw_printf ("Decrease the audio sample rate or increase the decimation factor or\n"); + dw_printf ("recompile the application with MAX_FILTER_SIZE larger than %d.\n", MAX_FILTER_SIZE); + D->lp_filter_taps = (MAX_FILTER_SIZE - 1) | 1; + } + + assert (D->lp_filter_taps > 8 && D->lp_filter_taps <= MAX_FILTER_SIZE); + (void)gen_rrc_lowpass (D->lp_filter, D->lp_filter_taps, D->u.afsk.rrc_rolloff, (float)samples_per_sec / baud); + } + else { + D->lp_filter_taps = (int) round( D->lp_filter_width_sym * (float)samples_per_sec / (float)baud ); + + TUNE("TUNE_LP_FILTER_TAPS", D->lp_filter_taps, "lp_filter_taps (FIR)", "%d") + + if (D->lp_filter_taps > MAX_FILTER_SIZE) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("Calculated FIR low pass filter size of %d is too large.\n", D->lp_filter_taps); + dw_printf ("Decrease the audio sample rate or increase the decimation factor or\n"); + dw_printf ("recompile the application with MAX_FILTER_SIZE larger than %d.\n", MAX_FILTER_SIZE); + D->lp_filter_taps = (MAX_FILTER_SIZE - 1) | 1; + } + + assert (D->lp_filter_taps > 8 && D->lp_filter_taps <= MAX_FILTER_SIZE); + + float fc = baud * D->lpf_baud / (float)samples_per_sec; + gen_lowpass (fc, D->lp_filter, D->lp_filter_taps, D->lp_window); + } + + +/* + * Starting with version 1.2 + * try using multiple slicing points instead of the traditional AGC. + */ + space_gain[0] = MIN_G; + float step = powf(10.0, log10f(MAX_G/MIN_G) / (MAX_SUBCHANS-1)); + for (j=1; j= 0 && chan < MAX_CHANS); + assert (subchan >= 0 && subchan < MAX_SUBCHANS); + +/* + * Filters use last 'filter_taps' samples. + * + * First push the older samples down. + * + * Finally, put the most recent at the beginning. + * + * Future project? Can we do better than shifting each time? + */ + + /* Scale to nice number. */ + + float fsam = (float)sam / 16384.0f; + + switch (D->profile) { + + case 'E': + default: + case 'A': { + /* ========== New in Version 1.7 ========== */ + + // Cleaner & simpler than earlier 'A' thru 'E' + + if (D->use_prefilter) { + push_sample (fsam, D->raw_cb, D->pre_filter_taps); + fsam = convolve (D->raw_cb, D->pre_filter, D->pre_filter_taps); + } + + push_sample (fsam * fcos256(D->u.afsk.m_osc_phase), D->u.afsk.m_I_raw, D->lp_filter_taps); + push_sample (fsam * fsin256(D->u.afsk.m_osc_phase), D->u.afsk.m_Q_raw, D->lp_filter_taps); + D->u.afsk.m_osc_phase += D->u.afsk.m_osc_delta; + + push_sample (fsam * fcos256(D->u.afsk.s_osc_phase), D->u.afsk.s_I_raw, D->lp_filter_taps); + push_sample (fsam * fsin256(D->u.afsk.s_osc_phase), D->u.afsk.s_Q_raw, D->lp_filter_taps); + D->u.afsk.s_osc_phase += D->u.afsk.s_osc_delta; + + float m_I = convolve (D->u.afsk.m_I_raw, D->lp_filter, D->lp_filter_taps); + float m_Q = convolve (D->u.afsk.m_Q_raw, D->lp_filter, D->lp_filter_taps); + float m_amp = fast_hypot(m_I, m_Q); + + float s_I = convolve (D->u.afsk.s_I_raw, D->lp_filter, D->lp_filter_taps); + float s_Q = convolve (D->u.afsk.s_Q_raw, D->lp_filter, D->lp_filter_taps); + float s_amp = fast_hypot(s_I, s_Q); + +/* + * Capture the mark and space peak amplitudes for display. + * It uses fast attack and slow decay to get an idea of the + * overall amplitude. + */ + if (m_amp >= D->alevel_mark_peak) { + D->alevel_mark_peak = m_amp * D->quick_attack + D->alevel_mark_peak * (1.0f - D->quick_attack); + } + else { + D->alevel_mark_peak = m_amp * D->sluggish_decay + D->alevel_mark_peak * (1.0f - D->sluggish_decay); + } + + if (s_amp >= D->alevel_space_peak) { + D->alevel_space_peak = s_amp * D->quick_attack + D->alevel_space_peak * (1.0f - D->quick_attack); + } + else { + D->alevel_space_peak = s_amp * D->sluggish_decay + D->alevel_space_peak * (1.0f - D->sluggish_decay); + } + + if (D->num_slicers <= 1) { + + // Which tone is stonger? That's simple with an ideal signal. + // However, we don't see too many ideal signals. + // Due to mismatching pre-emphasis and de-emphasis, the two + // tones will often have greatly different amplitudes so we use + // automatic gain control (AGC) to scale each to the same range + // before comparing. + // This is probably over complicated and could be combined with + // the signal amplitude measurement, above. + // It works so let's move along to other topics. + + float m_norm = agc (m_amp, D->agc_fast_attack, D->agc_slow_decay, &(D->m_peak), &(D->m_valley)); + float s_norm = agc (s_amp, D->agc_fast_attack, D->agc_slow_decay, &(D->s_peak), &(D->s_valley)); + + // The normalized values should be around -0.5 to +0.5 so the difference + // should work out to be around -1 to +1. + // This is important because nudge_pll uses the demod_out amplitude to assign + // a quality or confidence score to the symbol. + + float demod_out = m_norm - s_norm; + + // Tested and it looks good. Range of about -1 to +1. + //printf ("JWL DEBUG demod A with agc = %6.2f\n", demod_out); + + nudge_pll (chan, subchan, 0, demod_out, D, 1.0); + + } + else { + // Multiple slice case. + // Rather than trying to find the best threshold location, use multiple + // slicer thresholds in parallel. + // The best slicing point will vary from packet to packet but should + // remain about the same for a given packet. + + // We are not performing the AGC step here but still want the envelope + // for caluculating the confidence level (or quality) of the sample. + + (void) agc (m_amp, D->agc_fast_attack, D->agc_slow_decay, &(D->m_peak), &(D->m_valley)); + (void) agc (s_amp, D->agc_fast_attack, D->agc_slow_decay, &(D->s_peak), &(D->s_valley)); + + for (int slice=0; slicenum_slicers; slice++) { + float demod_out = m_amp - s_amp * space_gain[slice]; + float amp = 0.5f * (D->m_peak - D->m_valley + (D->s_peak - D->s_valley) * space_gain[slice]); + if (amp < 0.0000001f) amp = 1; // avoid divide by zero with no signal. + + // Tested and it looks good. Range of about -1 to +1 relative to amp. + // Biased one way or the other depending on the space gain. + //printf ("JWL DEBUG demod A with slicer %d: %6.2f / %6.2f = %6.2f\n", slice, demod_out, amp, demod_out/amp); + + nudge_pll (chan, subchan, slice, demod_out, D, amp); + } + } + } + break; + + case 'D': + case 'B': { + /* ========== Version 1.7 Experiment ========== */ + + // New - Convert frequency to a value proportional to frequency. + + if (D->use_prefilter) { + push_sample (fsam, D->raw_cb, D->pre_filter_taps); + fsam = convolve (D->raw_cb, D->pre_filter, D->pre_filter_taps); + } + + push_sample (fsam * fcos256(D->u.afsk.c_osc_phase), D->u.afsk.c_I_raw, D->lp_filter_taps); + push_sample (fsam * fsin256(D->u.afsk.c_osc_phase), D->u.afsk.c_Q_raw, D->lp_filter_taps); + D->u.afsk.c_osc_phase += D->u.afsk.c_osc_delta; + + float c_I = convolve (D->u.afsk.c_I_raw, D->lp_filter, D->lp_filter_taps); + float c_Q = convolve (D->u.afsk.c_Q_raw, D->lp_filter, D->lp_filter_taps); + + float phase = atan2f (c_Q, c_I); + float rate = phase - D->u.afsk.prev_phase; + if (rate > M_PI) rate -= 2 * M_PI; + else if (rate < -M_PI) rate += 2 * M_PI; + D->u.afsk.prev_phase = phase; + + // Rate is radians per audio sample interval or something like that. + // Scale scale that into -1 to +1 for expected tones. + + float norm_rate = rate * D->u.afsk.normalize_rpsam; + + // We really don't have mark and space amplitudes available in this case. + + if (D->num_slicers <= 1) { + + float demod_out = norm_rate; + // Tested and it looks good. Range roughly -1 to +1. + //printf ("JWL DEBUG demod B single = %6.2f\n", demod_out); + + nudge_pll (chan, subchan, 0, demod_out, D, 1.0); + + } + else { + + // This would be useful for HF SSB where a tuning error + // would shift the frequency. Multiple slicing points would + // then compensate for differences in transmit/receive frequencies. + // + // Where should we set the thresholds? + // I'm thinking something like: + // -.5 -.375 -.25 -.125 0 .125 .25 .375 .5 + // + // Assuming a 300 Hz shift, this would put slicing thresholds up + // to +-75 Hz from the center. + + for (int slice=0; slicenum_slicers; slice++) { + + float offset = -0.5 + slice * (1. / (D->num_slicers - 1)); + float demod_out = norm_rate + offset; + + //printf ("JWL DEBUG demod B slice %d, offset = %6.3f, demod_out = %6.2f\n", slice, offset, demod_out); + + nudge_pll (chan, subchan, slice, demod_out, D, 1.0); + } + } + } + break; + } + +#if DEBUG4 + + if (chan == 0) { + if (D->slicer[slice].data_detect) { + char fname[30]; + + + if (demod_log_fp == NULL) { + seq++; + snprintf (fname, sizeof(fname), "demod/%04d.csv", seq); + if (seq == 1) mkdir ("demod", 0777); + + demod_log_fp = fopen (fname, "w"); + text_color_set(DW_COLOR_DEBUG); + dw_printf ("Starting demodulator log file %s\n", fname); + fprintf (demod_log_fp, "Audio, Mark, Space, Demod, Data, Clock\n"); + } + fprintf (demod_log_fp, "%.3f, %.3f, %.3f, %.3f, %.2f, %.2f\n", fsam + 3.5, m_norm + 2, s_norm + 2, + (m_norm - s_norm) / 2 + 1.5, + demod_data ? .9 : .55, + (D->data_clock_pll & 0x80000000) ? .1 : .45); + } + else { + if (demod_log_fp != NULL) { + fclose (demod_log_fp); + demod_log_fp = NULL; + } + } + } + +#endif + + +} /* end demod_afsk_process_sample */ + + + +/* + * Finally, a PLL is used to sample near the centers of the data bits. + * + * D points to a demodulator for a channel/subchannel pair so we don't + * have to keep recalculating it. + * + * D->data_clock_pll is a SIGNED 32 bit variable. + * When it overflows from a large positive value to a negative value, we + * sample a data bit from the demodulated signal. + * + * Ideally, the the demodulated signal transitions should be near + * zero we we sample mid way between the transitions. + * + * Nudge the PLL by removing some small fraction from the value of + * data_clock_pll, pushing it closer to zero. + * + * This adjustment will never change the sign so it won't cause + * any erratic data bit sampling. + * + * If we adjust it too quickly, the clock will have too much jitter. + * If we adjust it too slowly, it will take too long to lock on to a new signal. + * + * Be a little more aggressive about adjusting the PLL + * phase when searching for a signal. Don't change it as much when + * locked on to a signal. + * + * I don't think the optimal value will depend on the audio sample rate + * because this happens for each transition from the demodulator. + */ + +__attribute__((hot)) +static void nudge_pll (int chan, int subchan, int slice, float demod_out, struct demodulator_state_s *D, float amplitude) +{ + D->slicer[slice].prev_d_c_pll = D->slicer[slice].data_clock_pll; + + + // Perform the add as unsigned to avoid signed overflow error. + D->slicer[slice].data_clock_pll = (signed)((unsigned)(D->slicer[slice].data_clock_pll) + (unsigned)(D->pll_step_per_sample)); + + //text_color_set(DW_COLOR_DEBUG); + // dw_printf ("prev = %lx, new data clock pll = %lx\n" D->prev_d_c_pll, D->data_clock_pll); + + if (D->slicer[slice].data_clock_pll < 0 && D->slicer[slice].prev_d_c_pll > 0) { + + /* Overflow - this is where we sample. */ + // Assign it a confidence level or quality, 0 to 100, based on the amplitude. + // Those very close to 0 are suspect. We'll get back to this later. + + int quality = fabsf(demod_out) * 100.0f / amplitude; + if (quality > 100) quality = 100; + +#if DEBUG5 + // Write bit stream to a file. + + static FILE *bsfp = NULL; + static int bcount = 0; + if (chan == 0 && subchan == 0 && slice == 0) { + if (bsfp == NULL) { + bsfp = fopen ("bitstream.txt", "w"); + } + fprintf (bsfp, "%d", demod_out > 0); + bcount++; + if (bcount % 64 == 0) { + fprintf (bsfp, "\n"); + } + } + +#endif + + +#if 1 + hdlc_rec_bit (chan, subchan, slice, demod_out > 0, 0, quality); +#else // TODO: new feature to measure data speed error. +// Maybe hdlc_rec_bit could provide indication when frame starts. + hdlc_rec_bit_new (chan, subchan, slice, demod_out > 0, 0, quality, + &(D->slicer[slice].pll_nudge_total), &(D->slicer[slice].pll_symbol_count)); + D->slicer[slice].pll_symbol_count++; +#endif + pll_dcd_each_symbol2 (D, chan, subchan, slice); + } + + // Transitions nudge the DPLL phase toward the incoming signal. + + int demod_data = demod_out > 0; + if (demod_data != D->slicer[slice].prev_demod_data) { + + pll_dcd_signal_transition2 (D, slice, D->slicer[slice].data_clock_pll); + +// TODO: signed int before = (signed int)(D->slicer[slice].data_clock_pll); // Treat as signed. + if (D->slicer[slice].data_detect) { + D->slicer[slice].data_clock_pll = (int)(D->slicer[slice].data_clock_pll * D->pll_locked_inertia); + } + else { + D->slicer[slice].data_clock_pll = (int)(D->slicer[slice].data_clock_pll * D->pll_searching_inertia); + } +// TODO: D->slicer[slice].pll_nudge_total += (int64_t)((signed int)(D->slicer[slice].data_clock_pll)) - (int64_t)before; + } + +/* + * Remember demodulator output so we can compare next time. + */ + D->slicer[slice].prev_demod_data = demod_data; + +} /* end nudge_pll */ + + +/* end demod_afsk.c */ diff --git a/demod_afsk.h b/src/demod_afsk.h similarity index 100% rename from demod_afsk.h rename to src/demod_afsk.h diff --git a/src/demod_psk.c b/src/demod_psk.c new file mode 100644 index 00000000..bc058185 --- /dev/null +++ b/src/demod_psk.c @@ -0,0 +1,846 @@ +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// +// Copyright (C) 2016, 2019 John Langner, WB2OSZ +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . +// + + +//#define DEBUG1 1 /* display debugging info */ + + +/*------------------------------------------------------------------ + * + * Module: demod_psk.c + * + * Purpose: Demodulator for 2400 and 4800 bits per second Phase Shift Keying (PSK). + * + * Input: Audio samples from either a file or the "sound card." + * + * Outputs: Calls hdlc_rec_bit() for each bit demodulated. + * + * References: MFJ-2400 Product description and manual: + * + * http://www.mfjenterprises.com/Product.php?productid=MFJ-2400 + * http://www.mfjenterprises.com/Downloads/index.php?productid=MFJ-2400&filename=MFJ-2400.pdf&company=mfj + * + * AEA had a 2400 bps packet modem, PK232-2400. + * + * http://www.repeater-builder.com/aea/pk232/pk232-2400-baud-dpsk-modem.pdf + * + * There was also a Kantronics KPC-2400 that had 2400 bps. + * + * http://www.brazoriacountyares.org/winlink-collection/TNC%20manuals/Kantronics/2400_modem_operators_guide@rgf.pdf + * + * + * From what I'm able to gather, they all used the EXAR XR-2123 PSK modem chip. + * + * Can't find the chip specs on the EXAR website so Google it. + * + * http://www.komponenten.es.aau.dk/fileadmin/komponenten/Data_Sheet/Linear/XR2123.pdf + * + * The XR-2123 implements the V.26 / Bell 201 standard: + * + * https://www.itu.int/rec/dologin_pub.asp?lang=e&id=T-REC-V.26-198811-I!!PDF-E&type=items + * https://www.itu.int/rec/dologin_pub.asp?lang=e&id=T-REC-V.26bis-198811-I!!PDF-E&type=items + * https://www.itu.int/rec/dologin_pub.asp?lang=e&id=T-REC-V.26ter-198811-I!!PDF-E&type=items + * + * "bis" and "ter" are from Latin for second and third. + * I used the "ter" version which has phase shifts of 0, 90, 180, and 270 degrees. + * + * There are earlier references to an alternative B which uses other phase shifts offset + * by another 45 degrees. + * + * After getting QPSK working, it was not much more effort to add V.27 with 8 phases. + * + * https://www.itu.int/rec/dologin_pub.asp?lang=e&id=T-REC-V.27bis-198811-I!!PDF-E&type=items + * https://www.itu.int/rec/dologin_pub.asp?lang=e&id=T-REC-V.27ter-198811-I!!PDF-E&type=items + * + * Compatibility: + * V.26 has two variations, A and B. Initially I implemented the A alternative. + * It later turned out that the MFJ-2400 used the B alternative. In version 1.6 you have a + * choice between compatibility with MFJ (and probably the others) or the original implementation. + * + *---------------------------------------------------------------*/ + +#include "direwolf.h" + +#include +#include +#include +#include +#include +#include +#include +#include + +// Fine tuning for different demodulator types. + +#define DCD_THRESH_ON 30 // Hysteresis: Can miss 2 out of 32 for detecting lock. +#define DCD_THRESH_OFF 6 // Might want a little more fine tuning. +#define DCD_GOOD_WIDTH 512 +#include "fsk_demod_state.h" // Values above override defaults. + +#include "audio.h" +#include "tune.h" +#include "fsk_gen_filter.h" +#include "hdlc_rec.h" +#include "textcolor.h" +#include "demod_psk.h" +#include "dsp.h" + + + + + +static const int phase_to_gray_v26[4] = {0, 1, 3, 2}; +static const int phase_to_gray_v27[8] = {1, 0, 2, 3, 7, 6, 4, 5}; + + +static int phase_shift_to_symbol (float phase_shift, int bits_per_symbol, int *bit_quality); + +/* Add sample to buffer and shift the rest down. */ + +__attribute__((hot)) __attribute__((always_inline)) +static inline void push_sample (float val, float *buff, int size) +{ + memmove(buff+1,buff,(size-1)*sizeof(float)); + buff[0] = val; +} + + +/* FIR filter kernel. */ + +__attribute__((hot)) __attribute__((always_inline)) +static inline float convolve (const float *__restrict__ data, const float *__restrict__ filter, int filter_size) +{ + float sum = 0.0; + int j; + +//Does pragma make any difference? Annoying warning on Mac. +//#pragma GCC ivdep + for (j=0; jms_filter_size + * + * Returns: None. + * + * Bugs: This doesn't do much error checking so don't give it + * anything crazy. + * + *----------------------------------------------------------------*/ + +void demod_psk_init (enum modem_t modem_type, enum v26_e v26_alt, int samples_per_sec, int bps, char profile, struct demodulator_state_s *D) +{ + int correct_baud; // baud is not same as bits/sec here! + int carrier_freq; + int j; + + + memset (D, 0, sizeof(struct demodulator_state_s)); + + D->modem_type = modem_type; + D->u.psk.v26_alt = v26_alt; + + D->num_slicers = 1; // Haven't thought about this yet. Is it even applicable? + + +#ifdef TUNE_PROFILE + profile = TUNE_PROFILE; +#endif + + if (modem_type == MODEM_QPSK) { + + assert (D->u.psk.v26_alt != V26_UNSPECIFIED); + + correct_baud = bps / 2; + carrier_freq = 1800; + +#if DEBUG1 + dw_printf ("demod_psk_init QPSK (sample rate=%d, bps=%d, baud=%d, carrier=%d, profile=%c\n", + samples_per_sec, bps, correct_baud, carrier_freq, profile); +#endif + + switch (toupper(profile)) { + + case 'P': /* Self correlation technique. */ + + D->u.psk.use_prefilter = 0; /* No bandpass filter. */ + + D->u.psk.lpf_baud = 0.60; + D->u.psk.lp_filter_width_sym = 1.061; // 39. * 1200. / 44100.; + D->u.psk.lp_window = BP_WINDOW_COSINE; + + D->pll_locked_inertia = 0.95; + D->pll_searching_inertia = 0.50; + + break; + + case 'Q': /* Self correlation technique. */ + + D->u.psk.use_prefilter = 1; /* Add a bandpass filter. */ + D->u.psk.prefilter_baud = 1.3; + D->u.psk.pre_filter_width_sym = 1.497; // 55. * 1200. / 44100.; + D->u.psk.pre_window = BP_WINDOW_COSINE; + + D->u.psk.lpf_baud = 0.60; + D->u.psk.lp_filter_width_sym = 1.061; // 39. * 1200. / 44100.; + D->u.psk.lp_window = BP_WINDOW_COSINE; + + D->pll_locked_inertia = 0.87; + D->pll_searching_inertia = 0.50; + + break; + + default: + text_color_set (DW_COLOR_ERROR); + dw_printf ("Invalid demodulator profile %c for v.26 QPSK. Valid choices are P, Q, R, S. Using default.\n", profile); + // fall thru. + + case 'R': /* Mix with local oscillator. */ + + D->u.psk.psk_use_lo = 1; + + D->u.psk.use_prefilter = 0; /* No bandpass filter. */ + + D->u.psk.lpf_baud = 0.70; + D->u.psk.lp_filter_width_sym = 1.007; // 37. * 1200. / 44100.; + D->u.psk.lp_window = BP_WINDOW_TRUNCATED; + + D->pll_locked_inertia = 0.925; + D->pll_searching_inertia = 0.50; + + break; + + case 'S': /* Mix with local oscillator. */ + + D->u.psk.psk_use_lo = 1; + + D->u.psk.use_prefilter = 1; /* Add a bandpass filter. */ + D->u.psk.prefilter_baud = 0.55; + D->u.psk.pre_filter_width_sym = 2.014; // 74. * 1200. / 44100.; + D->u.psk.pre_window = BP_WINDOW_FLATTOP; + + D->u.psk.lpf_baud = 0.60; + D->u.psk.lp_filter_width_sym = 1.061; // 39. * 1200. / 44100.; + D->u.psk.lp_window = BP_WINDOW_COSINE; + + D->pll_locked_inertia = 0.925; + D->pll_searching_inertia = 0.50; + + break; + } + + D->u.psk.delay_line_width_sym = 1.25; // Delay line > 13/12 * symbol period + + D->u.psk.coffs = (int) round( (11.f / 12.f) * (float)samples_per_sec / (float)correct_baud ); + D->u.psk.boffs = (int) round( (float)samples_per_sec / (float)correct_baud ); + D->u.psk.soffs = (int) round( (13.f / 12.f) * (float)samples_per_sec / (float)correct_baud ); + } + else { + + correct_baud = bps / 3; + carrier_freq = 1800; + +#if DEBUG1 + dw_printf ("demod_psk_init 8-PSK (sample rate=%d, bps=%d, baud=%d, carrier=%d, profile=%c\n", + samples_per_sec, bps, correct_baud, carrier_freq, profile); +#endif + + switch (toupper(profile)) { + + + case 'T': /* Self correlation technique. */ + + D->u.psk.use_prefilter = 0; /* No bandpass filter. */ + + D->u.psk.lpf_baud = 1.15; + D->u.psk.lp_filter_width_sym = 0.871; // 32. * 1200. / 44100.; + D->u.psk.lp_window = BP_WINDOW_COSINE; + + D->pll_locked_inertia = 0.95; + D->pll_searching_inertia = 0.50; + + break; + + case 'U': /* Self correlation technique. */ + + D->u.psk.use_prefilter = 1; /* Add a bandpass filter. */ + D->u.psk.prefilter_baud = 0.9; + D->u.psk.pre_filter_width_sym = 0.571; // 21. * 1200. / 44100.; + D->u.psk.pre_window = BP_WINDOW_FLATTOP; + + D->u.psk.lpf_baud = 1.15; + D->u.psk.lp_filter_width_sym = 0.871; // 32. * 1200. / 44100.; + D->u.psk.lp_window = BP_WINDOW_COSINE; + + D->pll_locked_inertia = 0.87; + D->pll_searching_inertia = 0.50; + + break; + + default: + text_color_set (DW_COLOR_ERROR); + dw_printf ("Invalid demodulator profile %c for v.27 8PSK. Valid choices are T, U, V, W. Using default.\n", profile); + // fall thru. + + case 'V': /* Mix with local oscillator. */ + + D->u.psk.psk_use_lo = 1; + + D->u.psk.use_prefilter = 0; /* No bandpass filter. */ + + D->u.psk.lpf_baud = 0.85; + D->u.psk.lp_filter_width_sym = 0.844; // 31. * 1200. / 44100.; + D->u.psk.lp_window = BP_WINDOW_COSINE; + + D->pll_locked_inertia = 0.925; + D->pll_searching_inertia = 0.50; + + break; + + case 'W': /* Mix with local oscillator. */ + + D->u.psk.psk_use_lo = 1; + + D->u.psk.use_prefilter = 1; /* Add a bandpass filter. */ + D->u.psk.prefilter_baud = 0.85; + D->u.psk.pre_filter_width_sym = 0.844; // 31. * 1200. / 44100.; + D->u.psk.pre_window = BP_WINDOW_COSINE; + + D->u.psk.lpf_baud = 0.85; + D->u.psk.lp_filter_width_sym = 0.844; // 31. * 1200. / 44100.; + D->u.psk.lp_window = BP_WINDOW_COSINE; + + D->pll_locked_inertia = 0.925; + D->pll_searching_inertia = 0.50; + + break; + } + + D->u.psk.delay_line_width_sym = 1.25; // Delay line > 10/9 * symbol period + + D->u.psk.coffs = (int) round( (8.f / 9.f) * (float)samples_per_sec / (float)correct_baud ); + D->u.psk.boffs = (int) round( (float)samples_per_sec / (float)correct_baud ); + D->u.psk.soffs = (int) round( (10.f / 9.f) * (float)samples_per_sec / (float)correct_baud ); + } + + + if (D->u.psk.psk_use_lo) { + D->u.psk.lo_step = (int) round( 256. * 256. * 256. * 256. * carrier_freq / (double)samples_per_sec); + +// Our own sin table for speed later. + + for (j = 0; j < 256; j++) { + D->u.psk.sin_table256[j] = sinf(2.f * (float)M_PI * j / 256.f); + } + } + +#ifdef TUNE_PRE_BAUD + D->u.psk.prefilter_baud = TUNE_PRE_BAUD; +#endif +#ifdef TUNE_PRE_WINDOW + D->u.psk.pre_window = TUNE_PRE_WINDOW; +#endif + +#ifdef TUNE_LPF_BAUD + D->u.psk.lpf_baud = TUNE_LPF_BAUD; +#endif +#ifdef TUNE_LP_WINDOW + D->u.psk.lp_window = TUNE_LP_WINDOW; +#endif + +#if defined(TUNE_PLL_SEARCHING) + D->pll_searching_inertia = TUNE_PLL_SEARCHING; +#endif +#if defined(TUNE_PLL_LOCKED) + D->pll_locked_inertia = TUNE_PLL_LOCKED; +#endif + + +/* + * Calculate constants used for timing. + * The audio sample rate must be at least a few times the data rate. + */ + + D->pll_step_per_sample = (int) round((TICKS_PER_PLL_CYCLE * (double)correct_baud) / ((double)samples_per_sec)); + +/* + * Convert number of symbol times to number of taps. + */ + + D->u.psk.pre_filter_taps = (int) round( D->u.psk.pre_filter_width_sym * (float)samples_per_sec / (float)correct_baud ); + D->u.psk.delay_line_taps = (int) round( D->u.psk.delay_line_width_sym * (float)samples_per_sec / (float)correct_baud ); + D->u.psk.lp_filter_taps = (int) round( D->u.psk.lp_filter_width_sym * (float)samples_per_sec / (float)correct_baud ); + + +#ifdef TUNE_PRE_FILTER_TAPS + D->u.psk.pre_filter_taps = TUNE_PRE_FILTER_TAPS; +#endif + +#ifdef TUNE_lp_filter_taps + D->u.psk.lp_filter_taps = TUNE_lp_filter_taps; +#endif + + + if (D->u.psk.pre_filter_taps > MAX_FILTER_SIZE) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("Calculated pre filter size of %d is too large.\n", D->u.psk.pre_filter_taps); + dw_printf ("Decrease the audio sample rate or increase the baud rate or\n"); + dw_printf ("recompile the application with MAX_FILTER_SIZE larger than %d.\n", + MAX_FILTER_SIZE); + exit (1); + } + + if (D->u.psk.delay_line_taps > MAX_FILTER_SIZE) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("Calculated delay line size of %d is too large.\n", D->u.psk.delay_line_taps); + dw_printf ("Decrease the audio sample rate or increase the baud rate or\n"); + dw_printf ("recompile the application with MAX_FILTER_SIZE larger than %d.\n", + MAX_FILTER_SIZE); + exit (1); + } + + if (D->u.psk.lp_filter_taps > MAX_FILTER_SIZE) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("Calculated low pass filter size of %d is too large.\n", D->u.psk.lp_filter_taps); + dw_printf ("Decrease the audio sample rate or increase the baud rate or\n"); + dw_printf ("recompile the application with MAX_FILTER_SIZE larger than %d.\n", + MAX_FILTER_SIZE); + exit (1); + } + +/* + * Optionally apply a bandpass ("pre") filter to attenuate + * frequencies outside the range of interest. + * It's a tradeoff. Attenuate frequencies outside the the range of interest + * but also distort the signal. This demodulator is not compuationally + * intensive so we can usually run both in parallel. + */ + + if (D->u.psk.use_prefilter) { + float f1, f2; + + f1 = carrier_freq - D->u.psk.prefilter_baud * correct_baud; + f2 = carrier_freq + D->u.psk.prefilter_baud * correct_baud; +#if DEBUG1 + text_color_set(DW_COLOR_DEBUG); + dw_printf ("Generating prefilter %.0f to %.0f Hz.\n", (double)f1, (double)f2); +#endif + if (f1 <= 0) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("Prefilter of %.0f to %.0f Hz doesn't make sense.\n", (double)f1, (double)f2); + f1 = 10; + } + + f1 = f1 / (float)samples_per_sec; + f2 = f2 / (float)samples_per_sec; + + gen_bandpass (f1, f2, D->u.psk.pre_filter, D->u.psk.pre_filter_taps, D->u.psk.pre_window); + } + +/* + * Now the lowpass filter. + */ + + float fc = correct_baud * D->u.psk.lpf_baud / (float)samples_per_sec; + gen_lowpass (fc, D->u.psk.lp_filter, D->u.psk.lp_filter_taps, D->u.psk.lp_window); + +/* + * No point in having multiple numbers for signal level. + */ + + D->alevel_mark_peak = -1; + D->alevel_space_peak = -1; + +#if 0 + // QPSK - CSV format to make plot. + + printf ("Phase shift degrees, bit 0, quality 0, bit 1, quality 1\n"); + for (int degrees = 0; degrees <= 360; degrees++) { + float a = degrees * M_PI * 2./ 360.; + int bit_quality[3]; + + int new_gray = phase_shift_to_symbol (a, 2, bit_quality); + + float offset = 3 * 1.5; + printf ("%d, ", degrees); + printf ("%.3f, ", offset + (new_gray & 1)); offset -= 1.5; + printf ("%.3f, ", offset + (bit_quality[0] / 100.)); offset -= 1.5; + printf ("%.3f, ", offset + ((new_gray >> 1) & 1)); offset -= 1.5; + printf ("%.3f\n", offset + (bit_quality[1] / 100.)); + } +#endif + +#if 0 + // 8-PSK - CSV format to make plot. + + printf ("Phase shift degrees, bit 0, quality 0, bit 1, quality 1, bit 2, quality 2\n"); + for (int degrees = 0; degrees <= 360; degrees++) { + float a = degrees * M_PI * 2./ 360.; + int bit_quality[3]; + + int new_gray = phase_shift_to_symbol (a, 3, bit_quality); + + float offset = 5 * 1.5; + printf ("%d, ", degrees); + printf ("%.3f, ", offset + (new_gray & 1)); offset -= 1.5; + printf ("%.3f, ", offset + (bit_quality[0] / 100.)); offset -= 1.5; + printf ("%.3f, ", offset + ((new_gray >> 1) & 1)); offset -= 1.5; + printf ("%.3f, ", offset + (bit_quality[1] / 100.)); offset -= 1.5; + printf ("%.3f, ", offset + ((new_gray >> 2) & 1)); offset -= 1.5; + printf ("%.3f\n", offset + (bit_quality[2] / 100.)); + } +#endif +} /* demod_psk_init */ + + + +/*------------------------------------------------------------------- + * + * Name: phase_shift_to_symbol + * + * Purpose: Translate phase shift, between two symbols, into 2 or 3 bits. + * + * Inputs: phase_shift - in radians. + * + * bits_per_symbol - 2 for QPSK, 3 for 8PSK. + * + * Outputs: bit_quality[] - Value of 0 (at threshold) to 100 (perfect) for each bit. + * + * Returns: 2 or 3 bit symbol value in Gray code. + * + *--------------------------------------------------------------------*/ + +__attribute__((hot)) __attribute__((always_inline)) +static inline int phase_shift_to_symbol (float phase_shift, int bits_per_symbol, int * __restrict__ bit_quality) +{ +// Number of different symbol states. + assert (bits_per_symbol == 2 || bits_per_symbol == 3); + int N = 1 << bits_per_symbol; + assert (N == 4 || N == 8); + +// Scale angle to 1 per symbol then separate into integer and fractional parts. + float a = phase_shift * (float)N / (M_PI * 2.0f); + while (a >= (float)N) a -= (float)N; + while (a < 0.) a += (float)N; + int i = (int)a; + if (i == N) i = N-1; // Should be < N. Watch out for possible roundoff errors. + float f = a - (float)i; + assert (i >= 0 && i < N); + assert (f >= -0.001f && f <= 1.001f); + +// Interpolate between the ideal angles to get a level of certainty. + int result = 0; + for (int b = 0; b < bits_per_symbol; b++) { + float demod = bits_per_symbol == 2 ? + ((phase_to_gray_v26[i] >> b) & 1) * (1.0f - f) + ((phase_to_gray_v26[(i+1)&3] >> b) & 1) * f : + ((phase_to_gray_v27[i] >> b) & 1) * (1.0f - f) + ((phase_to_gray_v27[(i+1)&7] >> b) & 1) * f; +// Slice to get boolean value and quality measurement. + if (demod >= 0.5f) result |= 1<= 0 && chan < MAX_CHANS); + assert (subchan >= 0 && subchan < MAX_SUBCHANS); + + /* Scale to nice number for plotting during debug. */ + + float fsam = sam / 16384.0f; + +/* + * Optional bandpass filter before the phase detector. + */ + + if (D->u.psk.use_prefilter) { + push_sample (fsam, D->u.psk.audio_in, D->u.psk.pre_filter_taps); + fsam = convolve (D->u.psk.audio_in, D->u.psk.pre_filter, D->u.psk.pre_filter_taps); + } + + if (D->u.psk.psk_use_lo) { +/* + * Mix with local oscillator to obtain phase. + * The absolute phase doesn't matter. + * We are just concerned with the change since the previous symbol. + */ + + float sam_x_cos = fsam * D->u.psk.sin_table256[((D->u.psk.lo_phase >> 24) + 64) & 0xff]; + push_sample (sam_x_cos, D->u.psk.I_raw, D->u.psk.lp_filter_taps); + float I = convolve (D->u.psk.I_raw, D->u.psk.lp_filter, D->u.psk.lp_filter_taps); + + float sam_x_sin = fsam * D->u.psk.sin_table256[(D->u.psk.lo_phase >> 24) & 0xff]; + push_sample (sam_x_sin, D->u.psk.Q_raw, D->u.psk.lp_filter_taps); + float Q = convolve (D->u.psk.Q_raw, D->u.psk.lp_filter, D->u.psk.lp_filter_taps); + + float a = my_atan2f(I,Q); + + // This is just a delay line of one symbol time. + + push_sample (a, D->u.psk.delay_line, D->u.psk.delay_line_taps); + float delta = a - D->u.psk.delay_line[D->u.psk.boffs]; + + int gray; + int bit_quality[3]; + if (D->modem_type == MODEM_QPSK) { + if (D->u.psk.v26_alt == V26_B) { + gray = phase_shift_to_symbol (delta + (float)(-M_PI/4), 2, bit_quality);; // MFJ compatible + } + else { + gray = phase_shift_to_symbol (delta, 2, bit_quality); // Classic + } + } + else { + gray = phase_shift_to_symbol (delta, 3, bit_quality);; // 8-PSK + } + nudge_pll (chan, subchan, slice, gray, D, bit_quality); + + D->u.psk.lo_phase += D->u.psk.lo_step; + } + else { +/* + * Correlate with previous symbol. We are looking for the phase shift. + */ + push_sample (fsam, D->u.psk.delay_line, D->u.psk.delay_line_taps); + + float sam_x_cos = fsam * D->u.psk.delay_line[D->u.psk.coffs]; + push_sample (sam_x_cos, D->u.psk.I_raw, D->u.psk.lp_filter_taps); + float I = convolve (D->u.psk.I_raw, D->u.psk.lp_filter, D->u.psk.lp_filter_taps); + + float sam_x_sin = fsam * D->u.psk.delay_line[D->u.psk.soffs]; + push_sample (sam_x_sin, D->u.psk.Q_raw, D->u.psk.lp_filter_taps); + float Q = convolve (D->u.psk.Q_raw, D->u.psk.lp_filter, D->u.psk.lp_filter_taps); + + int gray; + int bit_quality[3]; + float delta = my_atan2f(I,Q); + + if (D->modem_type == MODEM_QPSK) { + if (D->u.psk.v26_alt == V26_B) { + gray = phase_shift_to_symbol (delta + (float)(M_PI/2), 2, bit_quality); // MFJ compatible + } + else { + gray = phase_shift_to_symbol (delta + (float)(3*M_PI/4), 2, bit_quality); // Classic + } + } + else { + gray = phase_shift_to_symbol (delta + (float)(3*M_PI/2), 3, bit_quality); + } + nudge_pll (chan, subchan, slice, gray, D, bit_quality); + } + +} /* end demod_psk_process_sample */ + + + +__attribute__((hot)) +static void nudge_pll (int chan, int subchan, int slice, int demod_bits, struct demodulator_state_s *D, int *bit_quality) +{ + +/* + * Finally, a PLL is used to sample near the centers of the data bits. + * + * D points to a demodulator for a channel/subchannel pair. + * + * D->data_clock_pll is a SIGNED 32 bit variable. + * When it overflows from a large positive value to a negative value, we + * sample a data bit from the demodulated signal. + * + * Ideally, the the demodulated signal transitions should be near + * zero we we sample mid way between the transitions. + * + * Nudge the PLL by removing some small fraction from the value of + * data_clock_pll, pushing it closer to zero. + * + * This adjustment will never change the sign so it won't cause + * any erratic data bit sampling. + * + * If we adjust it too quickly, the clock will have too much jitter. + * If we adjust it too slowly, it will take too long to lock on to a new signal. + * + * Be a little more aggressive about adjusting the PLL + * phase when searching for a signal. + * Don't change it as much when locked on to a signal. + */ + + D->slicer[slice].prev_d_c_pll = D->slicer[slice].data_clock_pll; + + // Perform the add as unsigned to avoid signed overflow error. + D->slicer[slice].data_clock_pll = (signed)((unsigned)(D->slicer[slice].data_clock_pll) + (unsigned)(D->pll_step_per_sample)); + + if (D->slicer[slice].data_clock_pll < 0 && D->slicer[slice].prev_d_c_pll >= 0) { + + /* Overflow of PLL counter. */ + /* This is where we sample the data. */ + + if (D->modem_type == MODEM_QPSK) { + + int gray = demod_bits; + + hdlc_rec_bit (chan, subchan, slice, (gray >> 1) & 1, 0, bit_quality[1]); + hdlc_rec_bit (chan, subchan, slice, gray & 1, 0, bit_quality[0]); + } + else { + int gray = demod_bits; + + hdlc_rec_bit (chan, subchan, slice, (gray >> 2) & 1, 0, bit_quality[2]); + hdlc_rec_bit (chan, subchan, slice, (gray >> 1) & 1, 0, bit_quality[1]); + hdlc_rec_bit (chan, subchan, slice, gray & 1, 0, bit_quality[0]); + } + pll_dcd_each_symbol2 (D, chan, subchan, slice); + } + +/* + * If demodulated data has changed, + * Pull the PLL phase closer to zero. + * Use "floor" instead of simply casting so the sign won't flip. + * For example if we had -0.7 we want to end up with -1 rather than 0. + */ + +// TODO: demod_9600 has an improved technique. Would it help us here? + + if (demod_bits != D->slicer[slice].prev_demod_data) { + + pll_dcd_signal_transition2 (D, slice, D->slicer[slice].data_clock_pll); + + if (D->slicer[slice].data_detect) { + D->slicer[slice].data_clock_pll = (int)floorf((float)(D->slicer[slice].data_clock_pll) * D->pll_locked_inertia); + } + else { + D->slicer[slice].data_clock_pll = (int)floorf((float)(D->slicer[slice].data_clock_pll) * D->pll_searching_inertia); + } + } + +/* + * Remember demodulator output so we can compare next time. + */ + D->slicer[slice].prev_demod_data = demod_bits; + +} /* end nudge_pll */ + + + +/* end demod_psk.c */ diff --git a/src/demod_psk.h b/src/demod_psk.h new file mode 100644 index 00000000..134b1996 --- /dev/null +++ b/src/demod_psk.h @@ -0,0 +1,7 @@ + +/* demod_psk.h */ + + +void demod_psk_init (enum modem_t modem_type, enum v26_e v26_alt, int samples_per_sec, int bps, char profile, struct demodulator_state_s *D); + +void demod_psk_process_sample (int chan, int subchan, int sam, struct demodulator_state_s *D); diff --git a/digipeater.c b/src/digipeater.c similarity index 54% rename from digipeater.c rename to src/digipeater.c index 7bb570bb..fbe89370 100644 --- a/digipeater.c +++ b/src/digipeater.c @@ -1,7 +1,7 @@ // // This file is part of Dire Wolf, an amateur radio packet TNC. // -// Copyright (C) 2011,2013 John Langner, WB2OSZ +// Copyright (C) 2011, 2013, 2014, 2015 John Langner, WB2OSZ // // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by @@ -23,6 +23,7 @@ * Name: digipeater.c * * Purpose: Act as an APRS digital repeater. + * Similar cdigipeater.c is for connected mode. * * * Description: Decide whether the specified packet should @@ -48,37 +49,54 @@ * Preemptive Digipeating (new in version 0.8) * * http://www.aprs.org/aprs12/preemptive-digipeating.txt - * + * I ignored the part about the RR bits. + * *------------------------------------------------------------------*/ #define DIGIPEATER_C +#include "direwolf.h" #include #include #include #include -//#include /* for isdigit */ +#include /* for isdigit, isupper */ #include "regex.h" -#include +#include -#include "direwolf.h" #include "ax25_pad.h" #include "digipeater.h" #include "textcolor.h" #include "dedupe.h" #include "tq.h" +#include "pfilter.h" -static packet_t digipeat_match (packet_t pp, char *mycall_rec, char *mycall_xmit, - regex_t *uidigi, regex_t *uitrace, int to_chan, enum preempt_e preempt); +static packet_t digipeat_match (int from_chan, packet_t pp, char *mycall_rec, char *mycall_xmit, + regex_t *uidigi, regex_t *uitrace, int to_chan, enum preempt_e preempt, char *atgp, char *type_filter); + /* + * Keep pointer to configuration options. * Set by digipeater_init and used later. */ -static struct digi_config_s my_config; +static struct audio_s *save_audio_config_p; +static struct digi_config_s *save_digi_config_p; + + +/* + * Maintain count of packets digipeated for each combination of from/to channel. + */ + +static int digi_count[MAX_CHANS][MAX_CHANS]; + +int digipeater_get_count (int from_chan, int to_chan) { + return (digi_count[from_chan][to_chan]); +} + /*------------------------------------------------------------------------------ @@ -87,19 +105,21 @@ static struct digi_config_s my_config; * * Purpose: Initialize with stuff from configuration file. * - * Input: p_digi_config - Address of structure with all the - * necessary configuration details. + * Inputs: p_audio_config - Configuration for audio channels. + * + * p_digi_config - Digipeater configuration details. * - * Outputs: Make local copy for later use. + * Outputs: Save pointers to configuration for later use. * * Description: Called once at application startup time. * *------------------------------------------------------------------------------*/ -void digipeater_init (struct digi_config_s *p_digi_config) +void digipeater_init (struct audio_s *p_audio_config, struct digi_config_s *p_digi_config) { - memcpy (&my_config, p_digi_config, sizeof(my_config)); - + save_audio_config_p = p_audio_config; + save_digi_config_p = p_digi_config; + dedupe_init (p_digi_config->dedupe_time); } @@ -126,29 +146,70 @@ void digipeater_init (struct digi_config_s *p_digi_config) void digipeater (int from_chan, packet_t pp) { int to_chan; - packet_t result; // dw_printf ("digipeater()\n"); - assert (from_chan >= 0 && from_chan < my_config.num_chans); + + + // Network TNC is OK for UI frames where we don't care about timing. + + if ( from_chan < 0 || from_chan >= MAX_CHANS || + (save_audio_config_p->chan_medium[from_chan] != MEDIUM_RADIO && + save_audio_config_p->chan_medium[from_chan] != MEDIUM_NETTNC)) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("APRS digipeater: Did not expect to receive on invalid channel %d.\n", from_chan); + } /* * First pass: Look at packets being digipeated to same channel. * - * We want these to get out quickly. + * We want these to get out quickly, bypassing the usual random wait time. + * + * Some may disagree but I followed what WB4APR had to say about it. + * + * http://www.aprs.org/balloons.html + * + * APRS NETWORK FRATRICIDE: Generally, all APRS digipeaters are supposed to transmit + * immediately and all at the same time. They should NOT wait long enough for each + * one to QRM the channel with the same copy of each packet. NO, APRS digipeaters + * are all supposed to STEP ON EACH OTHER with every packet. This makes sure that + * everyone in range of a digi will hear one and only one copy of each packet. + * and that the packet will digipeat OUTWARD and not backward. The goal is that a + * digipeated packet is cleared out of the local area in ONE packet time and not + * N packet times for every N digipeaters that heard the packet. This means no + * PERSIST times, no DWAIT times and no UIDWAIT times. Notice, this is contrary + * to other packet systems that might want to guarantee delivery (but at the + * expense of throughput). APRS wants to clear the channel quickly to maximize throughput. + * + * http://www.aprs.org/kpc3/kpc3+WIDEn.txt + * + * THIRD: Eliminate the settings that are detrimental to the network. + * + * * UIDWAIT should be OFF. (the default). With it on, your digi is not doing the + * fundamental APRS fratricide that is the primary mechanism for minimizing channel + * loading. All digis that hear the same packet are supposed to DIGI it at the SAME + * time so that all those copies only take up one additional time slot. (but outward + * located digs will hear it without collision (and continue outward propagation) + * */ - for (to_chan=0; to_chanenabled[from_chan][to_chan]) { if (to_chan == from_chan) { - result = digipeat_match (pp, my_config.mycall[from_chan], my_config.mycall[to_chan], - &my_config.alias[from_chan][to_chan], &my_config.wide[from_chan][to_chan], - to_chan, my_config.preempt[from_chan][to_chan]); + packet_t result; + + result = digipeat_match (from_chan, pp, save_audio_config_p->achan[from_chan].mycall, + save_audio_config_p->achan[to_chan].mycall, + &save_digi_config_p->alias[from_chan][to_chan], &save_digi_config_p->wide[from_chan][to_chan], + to_chan, save_digi_config_p->preempt[from_chan][to_chan], + save_digi_config_p->atgp[from_chan][to_chan], + save_digi_config_p->filter_str[from_chan][to_chan]); if (result != NULL) { dedupe_remember (pp, to_chan); - tq_append (to_chan, TQ_PRIO_0_HI, result); + tq_append (to_chan, TQ_PRIO_0_HI, result); // High priority queue. + digi_count[from_chan][to_chan]++; } } } @@ -161,15 +222,21 @@ void digipeater (int from_chan, packet_t pp) * These are lower priority */ - for (to_chan=0; to_chanenabled[from_chan][to_chan]) { if (to_chan != from_chan) { - result = digipeat_match (pp, my_config.mycall[from_chan], my_config.mycall[to_chan], - &my_config.alias[from_chan][to_chan], &my_config.wide[from_chan][to_chan], - to_chan, my_config.preempt[from_chan][to_chan]); + packet_t result; + + result = digipeat_match (from_chan, pp, save_audio_config_p->achan[from_chan].mycall, + save_audio_config_p->achan[to_chan].mycall, + &save_digi_config_p->alias[from_chan][to_chan], &save_digi_config_p->wide[from_chan][to_chan], + to_chan, save_digi_config_p->preempt[from_chan][to_chan], + save_digi_config_p->atgp[from_chan][to_chan], + save_digi_config_p->filter_str[from_chan][to_chan]); if (result != NULL) { dedupe_remember (pp, to_chan); - tq_append (to_chan, TQ_PRIO_1_LO, result); + tq_append (to_chan, TQ_PRIO_1_LO, result); // Low priority queue. + digi_count[from_chan][to_chan]++; } } } @@ -185,29 +252,37 @@ void digipeater (int from_chan, packet_t pp) * * Purpose: A simple digipeater for APRS. * - * Input: pp - Pointer to a packet object. + * Input: pp - Pointer to a packet object. * * mycall_rec - Call of my station, with optional SSID, - * associated with the radio channel where the - * packet was received. + * associated with the radio channel where the + * packet was received. * - * mycall_rec - Call of my station, with optional SSID, - * associated with the radio channel where the - * packet was received. Could be the same as - * mycall_rec or different. + * mycall_xmit - Call of my station, with optional SSID, + * associated with the radio channel where the + * packet is to be transmitted. Could be the same as + * mycall_rec or different. * - * alias - Compiled pattern for my station aliases or - * "trapping" (repeating only once). + * alias - Compiled pattern for my station aliases or + * "trapping" (repeating only once). * - * wide - Compiled pattern for normal WIDEn-n digipeating. + * wide - Compiled pattern for normal WIDEn-n digipeating. * * to_chan - Channel number that we are transmitting to. * This is needed to maintain a history for * removing duplicates during specified time period. * - preempt - Option for "preemptive" digipeating. + * preempt - Option for "preemptive" digipeating. + * + * atgp - No tracing if this matches alias prefix. + * Hack added for special needs of ATGP. + * + * filter_str - Filter expression string or NULL. * * Returns: Packet object for transmission or NULL. + * The original packet is not modified. (with one exception, probably obsolete) + * We make a copy and return that modified copy! + * This is very important because we could digipeat from one channel to many. * * Description: The packet will be digipeated if the next unused digipeater * field matches one of the following: @@ -218,43 +293,34 @@ void digipeater (int from_chan, packet_t pp) * *------------------------------------------------------------------------------*/ -static char *dest_ssid_path[16] = { - "", /* Use VIA path */ - "WIDE1-1", - "WIDE2-2", - "WIDE3-3", - "WIDE4-4", - "WIDE5-5", - "WIDE6-6", - "WIDE7-7", - "WIDE1-1", /* North */ - "WIDE1-1", /* South */ - "WIDE1-1", /* East */ - "WIDE1-1", /* West */ - "WIDE2-2", /* North */ - "WIDE2-2", /* South */ - "WIDE2-2", /* East */ - "WIDE2-2" }; /* West */ - - -static packet_t digipeat_match (packet_t pp, char *mycall_rec, char *mycall_xmit, - regex_t *alias, regex_t *wide, int to_chan, enum preempt_e preempt) + +static packet_t digipeat_match (int from_chan, packet_t pp, char *mycall_rec, char *mycall_xmit, + regex_t *alias, regex_t *wide, int to_chan, enum preempt_e preempt, char *atgp, char *filter_str) { + char source[AX25_MAX_ADDR_LEN]; int ssid; int r; char repeater[AX25_MAX_ADDR_LEN]; - packet_t result = NULL; int err; char err_msg[100]; +/* + * First check if filtering has been configured. + */ + if (filter_str != NULL) { + + if (pfilter(from_chan, to_chan, filter_str, pp, 1) != 1) { + return(NULL); + } + } /* * The spec says: * * The SSID in the Destination Address field of all packets is coded to specify * the APRS digipeater path. - * If the Destination Address SSID is –0, the packet follows the standard AX.25 - * digipeater (“VIA”) path contained in the Digipeater Addresses field of the + * If the Destination Address SSID is -0, the packet follows the standard AX.25 + * digipeater ("VIA") path contained in the Digipeater Addresses field of the * AX.25 frame. * If the Destination Address SSID is non-zero, the packet follows one of 15 * generic APRS digipeater paths. @@ -267,11 +333,6 @@ static packet_t digipeat_match (packet_t pp, char *mycall_rec, char *mycall_xmit * Otherwise we don't want to modify the input because this could be called multiple times. */ - if (ax25_get_num_repeaters(pp) == 0 && (ssid = ax25_get_ssid(pp, AX25_DESTINATION)) > 0) { - ax25_set_addr(pp, AX25_REPEATER_1, dest_ssid_path[ssid]); - ax25_set_ssid(pp, AX25_DESTINATION, 0); - /* Continue with general case, below. */ - } /* * Find the first repeater station which doesn't have "has been repeated" set. @@ -281,7 +342,7 @@ static packet_t digipeat_match (packet_t pp, char *mycall_rec, char *mycall_xmit r = ax25_get_first_not_repeated(pp); if (r < AX25_REPEATER_1) { - return NULL; + return (NULL); } ax25_get_addr_with_ssid(pp, r, repeater); @@ -294,14 +355,21 @@ static packet_t digipeat_match (packet_t pp, char *mycall_rec, char *mycall_xmit /* - * First check for explicit use of my call. + * First check for explicit use of my call, including SSID. + * Someone might explicitly specify a particular path for testing purposes. + * This will bypass the usual checks for duplicates and my call in the source. + * * In this case, we don't check the history so it would be possible * to have a loop (of limited size) if someone constructed the digipeater paths - * correctly. + * correctly. I would expect it only for testing purposes. */ if (strcmp(repeater, mycall_rec) == 0) { + packet_t result; + result = ax25_dup (pp); + assert (result != NULL); + /* If using multiple radio channels, they */ /* could have different calls. */ ax25_set_addr (result, r, mycall_xmit); @@ -309,13 +377,24 @@ static packet_t digipeat_match (packet_t pp, char *mycall_rec, char *mycall_xmit return (result); } +/* + * Don't digipeat my own. Fixed in 1.4 dev H. + * Alternatively we might feed everything transmitted into + * dedupe_remember rather than only frames out of digipeater. + */ + ax25_get_addr_with_ssid(pp, AX25_SOURCE, source); + if (strcmp(source, mycall_rec) == 0) { + return (NULL); + } + + /* * Next try to avoid retransmitting redundant information. * Duplicates are detected by comparing only: * - source * - destination * - info part - * - but none of the digipeaters + * - but not the via path. (digipeater addresses) * A history is kept for some amount of time, typically 30 seconds. * For efficiency, only a checksum, rather than the complete fields * might be kept but the result is the same. @@ -324,26 +403,31 @@ static packet_t digipeat_match (packet_t pp, char *mycall_rec, char *mycall_xmit * */ - if (dedupe_check(pp, to_chan)) { //#if DEBUG /* Might be useful if people are wondering why */ - /* some are not repeated. Might cause confusion. */ + /* some are not repeated. Might also cause confusion. */ text_color_set(DW_COLOR_INFO); - dw_printf ("Digipeater: Drop redundant packet.\n"); + dw_printf ("Digipeater: Drop redundant packet to channel %d.\n", to_chan); //#endif - assert (result == NULL); return NULL; } /* * For the alias pattern, we unconditionally digipeat it once. - * i.e. Just replace it with MYCALL don't even look at the ssid. + * i.e. Just replace it with MYCALL. + * + * My call should be an implied member of this set. + * In this implementation, we already caught it further up. */ err = regexec(alias,repeater,0,NULL,0); if (err == 0) { + packet_t result; + result = ax25_dup (pp); + assert (result != NULL); + ax25_set_addr (result, r, mycall_xmit); ax25_set_h (result, r); return (result); @@ -357,9 +441,12 @@ static packet_t digipeat_match (packet_t pp, char *mycall_rec, char *mycall_xmit /* * If preemptive digipeating is enabled, try matching my call * and aliases against all remaining unused digipeaters. + * + * Bob says: "GENERIC XXXXn-N DIGIPEATING should not do preemptive digipeating." + * + * But consider this case: https://github.com/wb2osz/direwolf/issues/488 */ - if (preempt != PREEMPT_OFF) { int r2; @@ -373,20 +460,32 @@ static packet_t digipeat_match (packet_t pp, char *mycall_rec, char *mycall_xmit if (strcmp(repeater2, mycall_rec) == 0 || regexec(alias,repeater2,0,NULL,0) == 0) { + packet_t result; result = ax25_dup (pp); + assert (result != NULL); + ax25_set_addr (result, r2, mycall_xmit); ax25_set_h (result, r2); switch (preempt) { case PREEMPT_DROP: /* remove all prior */ + // TODO: deprecate this option. Result is misleading. + + text_color_set (DW_COLOR_ERROR); + dw_printf ("The digipeat DROP option will be removed in a future release. Use PREEMPT for preemptive digipeating.\n"); + while (r2 > AX25_REPEATER_1) { ax25_remove_addr (result, r2-1); r2--; } break; - case PREEMPT_MARK: + case PREEMPT_MARK: // TODO: deprecate this option. Result is misleading. + + text_color_set (DW_COLOR_ERROR); + dw_printf ("The digipeat MARK option will be removed in a future release. Use PREEMPT for preemptive digipeating.\n"); + r2--; while (r2 >= AX25_REPEATER_1 && ax25_get_h(result,r2) == 0) { ax25_set_h (result, r2); @@ -394,7 +493,12 @@ static packet_t digipeat_match (packet_t pp, char *mycall_rec, char *mycall_xmit } break; - case PREEMPT_TRACE: /* remove prior unused */ + case PREEMPT_TRACE: /* My enhancement - remove prior unused digis. */ + /* this provides an accurate path of where packet traveled. */ + + // Uh oh. It looks like sample config files went out + // with this option. Should it be renamed as + // PREEMPT which is more descriptive? default: while (r2 > AX25_REPEATER_1 && ax25_get_h(result,r2-1) == 0) { ax25_remove_addr (result, r2-1); @@ -403,6 +507,16 @@ static packet_t digipeat_match (packet_t pp, char *mycall_rec, char *mycall_xmit break; } +// Idea: Here is an interesting idea for a new option. REORDER? +// The preemptive digipeater could move its call after the (formerly) last used digi field +// and preserve all the unused fields after that. The list of used addresses would +// accurately record the journey taken by the packet. + +// https://groups.yahoo.com/neo/groups/aprsisce/conversations/topics/31935 + +// > I was wishing for a non-marking preemptive digipeat so that the original packet would be left intact +// > or maybe something like WIDE1-1,WIDE2-1,KJ4OVQ-9 becoming KJ4OVQ-9*,WIDE1-1,WIDE2-1. + return (result); } } @@ -415,6 +529,40 @@ static packet_t digipeat_match (packet_t pp, char *mycall_rec, char *mycall_xmit err = regexec(wide,repeater,0,NULL,0); if (err == 0) { +// Special hack added for ATGP to behave like some combination of options in some old TNC +// so the via path does not continue to grow and exceed the 8 available positions. +// The strange thing about this is that the used up digipeater is left there but +// removed by the next digipeater. + + if (strlen(atgp) > 0 && strncasecmp(repeater, atgp, strlen(atgp)) == 0) { + + if (ssid >= 1 && ssid <= 7) { + packet_t result; + + result = ax25_dup (pp); + assert (result != NULL); + + // First, remove any already used digipeaters. + + while (ax25_get_num_addr(result) >= 3 && ax25_get_h(result,AX25_REPEATER_1) == 1) { + ax25_remove_addr (result, AX25_REPEATER_1); + r--; + } + + ssid = ssid - 1; + ax25_set_ssid(result, r, ssid); // could be zero. + if (ssid == 0) { + ax25_set_h (result, r); + } + + // Insert own call at beginning and mark it used. + + ax25_insert_addr (result, AX25_REPEATER_1, mycall_xmit); + ax25_set_h (result, AX25_REPEATER_1); + return (result); + } + } + /* * If ssid == 1, we simply replace the repeater with my call and * mark it as being used. @@ -426,14 +574,22 @@ static packet_t digipeat_match (packet_t pp, char *mycall_rec, char *mycall_xmit */ if (ssid == 1) { + packet_t result; + result = ax25_dup (pp); + assert (result != NULL); + ax25_set_addr (result, r, mycall_xmit); ax25_set_h (result, r); return (result); } if (ssid >= 2 && ssid <= 7) { + packet_t result; + result = ax25_dup (pp); + assert (result != NULL); + ax25_set_ssid(result, r, ssid-1); // should be at least 1 if (ax25_get_num_repeaters(pp) < AX25_MAX_REPEATERS) { @@ -453,8 +609,8 @@ static packet_t digipeat_match (packet_t pp, char *mycall_rec, char *mycall_xmit /* * Don't repeat it if we get here. */ - assert (result == NULL); - return NULL; + + return (NULL); } @@ -472,6 +628,9 @@ static packet_t digipeat_match (packet_t pp, char *mycall_rec, char *mycall_xmit * Returns: None. * * Description: TODO... + * + * Initial reports were favorable. + * Should document what this is all about if there is still interest... * *------------------------------------------------------------------------------*/ @@ -482,10 +641,10 @@ void digi_regen (int from_chan, packet_t pp) // dw_printf ("digi_regen()\n"); - assert (from_chan >= 0 && from_chan < my_config.num_chans); + assert (from_chan >= 0 && from_chan < MAX_CHANS); - for (to_chan=0; to_chanregen[from_chan][to_chan]) { result = ax25_dup (pp); if (result != NULL) { // TODO: if AX.25 and has been digipeated, put in HI queue? @@ -497,20 +656,21 @@ void digi_regen (int from_chan, packet_t pp) } /* end dig_regen */ + /*------------------------------------------------------------------------- * * Name: main * - * Purpose: Standalone test case for this funtionality. + * Purpose: Standalone test case for this functionality. * * Usage: make -f Makefile. dtest * ./dtest * *------------------------------------------------------------------------*/ -#if TEST +#if DIGITEST -static char mycall[] = "WB2OSZ-9"; +static char mycall[12]; static regex_t alias_re; @@ -520,17 +680,20 @@ static int failed; static enum preempt_e preempt = PREEMPT_OFF; +static char config_atgp[AX25_MAX_ADDR_LEN] = "HOP"; + static void test (char *in, char *out) { packet_t pp, result; - //int should_repeat; char rec[256]; char xmit[256]; unsigned char *pinfo; int info_len; unsigned char frame[AX25_MAX_PACKET_LEN]; int frame_len; + alevel_t alevel; + dw_printf ("\n"); @@ -543,7 +706,8 @@ static void test (char *in, char *out) ax25_format_addrs (pp, rec); info_len = ax25_get_info (pp, &pinfo); - strcat (rec, (char*)pinfo); + (void)info_len; + strlcat (rec, (char*)pinfo, sizeof(rec)); if (strcmp(in, rec) != 0) { text_color_set(DW_COLOR_ERROR); @@ -558,10 +722,15 @@ static void test (char *in, char *out) frame_len = ax25_pack (pp, frame); ax25_delete (pp); - pp = ax25_from_frame (frame, frame_len, 50); + alevel.rec = 50; + alevel.mark = 50; + alevel.space = 50; + + pp = ax25_from_frame (frame, frame_len, alevel); + assert (pp != NULL); ax25_format_addrs (pp, rec); info_len = ax25_get_info (pp, &pinfo); - strcat (rec, (char*)pinfo); + strlcat (rec, (char*)pinfo, sizeof(rec)); if (strcmp(in, rec) != 0) { text_color_set(DW_COLOR_ERROR); @@ -575,18 +744,20 @@ static void test (char *in, char *out) text_color_set(DW_COLOR_REC); dw_printf ("Rec\t%s\n", rec); - result = digipeat_match (pp, mycall, mycall, &alias_re, &wide_re, 0, preempt); +//TODO: Add filtering to test. +// V + result = digipeat_match (0, pp, mycall, mycall, &alias_re, &wide_re, 0, preempt, config_atgp, NULL); if (result != NULL) { dedupe_remember (result, 0); ax25_format_addrs (result, xmit); info_len = ax25_get_info (result, &pinfo); - strcat (xmit, (char*)pinfo); + strlcat (xmit, (char*)pinfo, sizeof(xmit)); ax25_delete (result); } else { - strcpy (xmit, ""); + strlcpy (xmit, "", sizeof(xmit)); } text_color_set(DW_COLOR_XMIT); @@ -610,6 +781,7 @@ int main (int argc, char *argv[]) int e; failed = 0; char message[256]; + strlcpy(mycall, "WB2OSZ-9", sizeof(mycall)); dedupe_init (4); @@ -624,7 +796,7 @@ int main (int argc, char *argv[]) exit (1); } - e = regcomp (&wide_re, "^WIDE[1-7]-[1-7]$|^TRACE[1-7]-[1-7]$|^MA[1-7]-[1-7]$", REG_EXTENDED|REG_NOSUB); + e = regcomp (&wide_re, "^WIDE[1-7]-[1-7]$|^TRACE[1-7]-[1-7]$|^MA[1-7]-[1-7]$|^HOP[1-7]-[1-7]$", REG_EXTENDED|REG_NOSUB); if (e != 0) { regerror (e, &wide_re, message, sizeof(message)); text_color_set(DW_COLOR_ERROR); @@ -710,10 +882,11 @@ int main (int argc, char *argv[]) /* - * Change destination SSID to normal digipeater if none specified. + * Change destination SSID to normal digipeater if none specified. (Obsolete, removed.) */ + test ( "W1ABC>TEST-3:", - "W1ABC>TEST,WB2OSZ-9*,WIDE3-2:"); + ""); test ( "W1DEF>TEST-3,WIDE2-2:", "W1DEF>TEST-3,WB2OSZ-9*,WIDE2-1:"); @@ -721,17 +894,22 @@ int main (int argc, char *argv[]) /* * Drop duplicates within specified time interval. * Only the first 1 of 3 should be retransmitted. + * The 4th case might be controversial. */ - test ( "W1XYZ>TEST,R1*,WIDE3-2:info1", - "W1XYZ>TEST,R1,WB2OSZ-9*,WIDE3-1:info1"); + test ( "W1XYZ>TESTD,R1*,WIDE3-2:info1", + "W1XYZ>TESTD,R1,WB2OSZ-9*,WIDE3-1:info1"); - test ( "W1XYZ>TEST,R2*,WIDE3-2:info1", + test ( "W1XYZ>TESTD,R2*,WIDE3-2:info1", ""); - test ( "W1XYZ>TEST,R3*,WIDE3-2:info1", + test ( "W1XYZ>TESTD,R3*,WIDE3-2:info1", ""); + test ( "W1XYZ>TESTD,R1*,WB2OSZ-9:has explicit routing", + "W1XYZ>TESTD,R1,WB2OSZ-9*:has explicit routing"); + + /* * Allow same thing after adequate time. */ @@ -791,8 +969,71 @@ int main (int argc, char *argv[]) /* * Did I miss any cases? + * Yes. Don't retransmit my own. 1.4H */ + test ( "WB2OSZ-7>TEST14,WIDE1-1,WIDE1-1:stuff", + "WB2OSZ-7>TEST14,WB2OSZ-9*,WIDE1-1:stuff"); + + test ( "WB2OSZ-9>TEST14,WIDE1-1,WIDE1-1:from myself", + ""); + + test ( "WB2OSZ-9>TEST14,WIDE1-1*,WB2OSZ-9:from myself but explicit routing", + "WB2OSZ-9>TEST14,WIDE1-1,WB2OSZ-9*:from myself but explicit routing"); + + test ( "WB2OSZ-15>TEST14,WIDE1-1,WIDE1-1:stuff", + "WB2OSZ-15>TEST14,WB2OSZ-9*,WIDE1-1:stuff"); + +// New in 1.7 - ATGP Hack + + preempt = PREEMPT_OFF; // Shouldn't make a difference here. + + test ( "W1ABC>TEST51,HOP7-7,HOP7-7:stuff1", + "W1ABC>TEST51,WB2OSZ-9*,HOP7-6,HOP7-7:stuff1"); + + test ( "W1ABC>TEST52,ABCD*,HOP7-1,HOP7-7:stuff2", + "W1ABC>TEST52,WB2OSZ-9,HOP7*,HOP7-7:stuff2"); // Used up address remains. + + test ( "W1ABC>TEST53,HOP7*,HOP7-7:stuff3", + "W1ABC>TEST53,WB2OSZ-9*,HOP7-6:stuff3"); // But it gets removed here. + + test ( "W1ABC>TEST54,HOP7*,HOP7-1:stuff4", + "W1ABC>TEST54,WB2OSZ-9,HOP7*:stuff4"); // Remains again here. + + test ( "W1ABC>TEST55,HOP7,HOP7*:stuff5", + ""); + +// Examples given for desired result. + + strlcpy (mycall, "CLNGMN-1", sizeof(mycall)); + test ( "W1ABC>TEST60,HOP7-7,HOP7-7:", + "W1ABC>TEST60,CLNGMN-1*,HOP7-6,HOP7-7:"); + test ( "W1ABC>TEST61,ROAN-3*,HOP7-6,HOP7-7:", + "W1ABC>TEST61,CLNGMN-1*,HOP7-5,HOP7-7:"); + + strlcpy (mycall, "GDHILL-8", sizeof(mycall)); + test ( "W1ABC>TEST62,MDMTNS-7*,HOP7-1,HOP7-7:", + "W1ABC>TEST62,GDHILL-8,HOP7*,HOP7-7:"); + test ( "W1ABC>TEST63,CAMLBK-9*,HOP7-1,HOP7-7:", + "W1ABC>TEST63,GDHILL-8,HOP7*,HOP7-7:"); + + strlcpy (mycall, "MDMTNS-7", sizeof(mycall)); + test ( "W1ABC>TEST64,GDHILL-8*,HOP7*,HOP7-7:", + "W1ABC>TEST64,MDMTNS-7*,HOP7-6:"); + + strlcpy (mycall, "CAMLBK-9", sizeof(mycall)); + test ( "W1ABC>TEST65,GDHILL-8,HOP7*,HOP7-7:", + "W1ABC>TEST65,CAMLBK-9*,HOP7-6:"); + + strlcpy (mycall, "KATHDN-15", sizeof(mycall)); + test ( "W1ABC>TEST66,MTWASH-14*,HOP7-1:", + "W1ABC>TEST66,KATHDN-15,HOP7*:"); + + strlcpy (mycall, "SPRNGR-1", sizeof(mycall)); + test ( "W1ABC>TEST67,CLNGMN-1*,HOP7-1:", + "W1ABC>TEST67,SPRNGR-1,HOP7*:"); + + if (failed == 0) { dw_printf ("SUCCESS -- All digipeater tests passed.\n"); } @@ -805,6 +1046,6 @@ int main (int argc, char *argv[]) } /* end main */ -#endif /* if TEST */ +#endif /* if DIGITEST */ /* end digipeater.c */ diff --git a/digipeater.h b/src/digipeater.h similarity index 63% rename from digipeater.h rename to src/digipeater.h index 21602ed6..5c849769 100644 --- a/digipeater.h +++ b/src/digipeater.h @@ -1,5 +1,4 @@ - #ifndef DIGIPEATER_H #define DIGIPEATER_H 1 @@ -7,6 +6,8 @@ #include "direwolf.h" /* for MAX_CHANS */ #include "ax25_pad.h" /* for packet_t */ +#include "audio.h" /* for radio channel properties */ + /* * Information required for digipeating. @@ -18,11 +19,6 @@ struct digi_config_s { - int num_chans; - - char mycall[MAX_CHANS][AX25_MAX_ADDR_LEN]; /* Call associated */ - /* with each of the radio channels. */ - /* Could be the same or different. */ int dedupe_time; /* Don't digipeat duplicate packets */ /* within this number of seconds. */ @@ -41,6 +37,16 @@ struct digi_config_s { enum preempt_e { PREEMPT_OFF, PREEMPT_DROP, PREEMPT_MARK, PREEMPT_TRACE } preempt[MAX_CHANS][MAX_CHANS]; + // ATGP is an ugly hack for the specific need of ATGP which needs more that 8 digipeaters. + // DO NOT put this in the User Guide. On a need to know basis. + + char atgp[MAX_CHANS][MAX_CHANS][AX25_MAX_ADDR_LEN]; + + char *filter_str[MAX_CHANS+1][MAX_CHANS+1]; + // NULL or optional Packet Filter strings such as "t/m". + // Notice the size of arrays is one larger than normal. + // That extra position is for the IGate. + int regen[MAX_CHANS][MAX_CHANS]; // Regenerate packet. // Sort of like digipeating but passed along unchanged. }; @@ -49,7 +55,7 @@ struct digi_config_s { * Call once at application start up time. */ -extern void digipeater_init (struct digi_config_s *p_digi_config); +extern void digipeater_init (struct audio_s *p_audio_config, struct digi_config_s *p_digi_config); /* * Call this for each packet received. @@ -61,6 +67,11 @@ extern void digipeater (int from_chan, packet_t pp); void digi_regen (int from_chan, packet_t pp); +/* Make statistics available. */ + +int digipeater_get_count (int from_chan, int to_chan); + + #endif /* end digipeater.h */ diff --git a/src/direwolf.c b/src/direwolf.c new file mode 100644 index 00000000..e23aecb4 --- /dev/null +++ b/src/direwolf.c @@ -0,0 +1,1749 @@ +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// +// Copyright (C) 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2019, 2020, 2021, 2023 John Langner, WB2OSZ +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . +// + + +/*------------------------------------------------------------------ + * + * Module: direwolf.c + * + * Purpose: Main program for "Dire Wolf" which includes: + * + * Various DSP modems using the "sound card." + * AX.25 encoder/decoder. + * APRS data encoder / decoder. + * APRS digipeater. + * KISS TNC emulator. + * APRStt (touch tone input) gateway + * Internet Gateway (IGate) + * Ham Radio of Things - IoT with Ham Radio + * FX.25 Forward Error Correction. + * IL2P Forward Error Correction. + * Emergency Alert System (EAS) Specific Area Message Encoding (SAME) receiver. + * AIS receiver for tracking ships. + * + *---------------------------------------------------------------*/ + + +#define DIREWOLF_C 1 + +#include "direwolf.h" + + + +#include +#include +#include +#include +#include +#include +#include +#include + +#if __ARM__ +//#include +//#include // Doesn't seem to be there. + // We have libc 2.13. Looks like we might need 2.17 & gcc 4.8 +#endif + +#if __WIN32__ +#include +#include +#else +#include +#include +#include +#include +#if USE_SNDIO || __APPLE__ +// no need to include +#else +#include +#endif +#include +#include +#include +#endif + +#if USE_HAMLIB +#include +#endif + + + +#include "version.h" +#include "audio.h" +#include "config.h" +#include "multi_modem.h" +#include "demod.h" +#include "hdlc_rec.h" +#include "hdlc_rec2.h" +#include "ax25_pad.h" +#include "xid.h" +#include "decode_aprs.h" +#include "encode_aprs.h" +#include "textcolor.h" +#include "server.h" +#include "kiss.h" +#include "kissnet.h" +#include "kissserial.h" +#include "kiss_frame.h" +#include "waypoint.h" +#include "gen_tone.h" +#include "digipeater.h" +#include "cdigipeater.h" +#include "tq.h" +#include "xmit.h" +#include "ptt.h" +#include "beacon.h" +#include "dtmf.h" +#include "aprs_tt.h" +#include "tt_user.h" +#include "igate.h" +#include "pfilter.h" +#include "symbols.h" +#include "dwgps.h" +#include "waypoint.h" +#include "log.h" +#include "recv.h" +#include "morse.h" +#include "mheard.h" +#include "ax25_link.h" +#include "dtime_now.h" +#include "fx25.h" +#include "il2p.h" +#include "dwsock.h" +#include "dns_sd_dw.h" +#include "dlq.h" // for fec_type_t definition. + + +//static int idx_decoded = 0; + +#if __WIN32__ +static BOOL cleanup_win (int); +#else +static void cleanup_linux (int); +#endif + +static void usage (); + +#if defined(__SSE__) && !defined(__APPLE__) + +static void __cpuid(int cpuinfo[4], int infotype){ + __asm__ __volatile__ ( + "cpuid": + "=a" (cpuinfo[0]), + "=b" (cpuinfo[1]), + "=c" (cpuinfo[2]), + "=d" (cpuinfo[3]): + "a" (infotype) + ); +} + +#endif + + +/*------------------------------------------------------------------- + * + * Name: main + * + * Purpose: Main program for packet radio virtual TNC. + * + * Inputs: Command line arguments. + * See usage message for details. + * + * Outputs: Decoded information is written to stdout. + * + * A socket and pseudo terminal are created for + * for communication with other applications. + * + *--------------------------------------------------------------------*/ + +static struct audio_s audio_config; +static struct tt_config_s tt_config; +static struct misc_config_s misc_config; + + +static const int audio_amplitude = 100; /* % of audio sample range. */ + /* This translates to +-32k for 16 bit samples. */ + /* Currently no option to change this. */ + +static int d_u_opt = 0; /* "-d u" command line option to print UTF-8 also in hexadecimal. */ +static int d_p_opt = 0; /* "-d p" option for dumping packets over radio. */ + +static int q_h_opt = 0; /* "-q h" Quiet, suppress the "heard" line with audio level. */ +static int q_d_opt = 0; /* "-q d" Quiet, suppress the printing of decoded of APRS packets. */ + +static int A_opt_ais_to_obj = 0; /* "-A" Convert received AIS to APRS "Object Report." */ + + +int main (int argc, char *argv[]) +{ + int err; + //int eof; + int j; + char config_file[100]; + int enable_pseudo_terminal = 0; + struct digi_config_s digi_config; + struct cdigi_config_s cdigi_config; + struct igate_config_s igate_config; + int r_opt = 0, n_opt = 0, b_opt = 0, B_opt = 0, D_opt = 0, U_opt = 0; /* Command line options. */ + char P_opt[16]; + char l_opt_logdir[80]; + char L_opt_logfile[80]; + char input_file[80]; + char T_opt_timestamp[40]; + + int t_opt = 1; /* Text color option. */ + int a_opt = 0; /* "-a n" interval, in seconds, for audio statistics report. 0 for none. */ + int g_opt = 0; /* G3RUH mode, ignoring default for speed. */ + int j_opt = 0; /* 2400 bps PSK compatible with direwolf <= 1.5 */ + int J_opt = 0; /* 2400 bps PSK compatible MFJ-2400 and maybe others. */ + + int d_k_opt = 0; /* "-d k" option for serial port KISS. Can be repeated for more detail. */ + int d_n_opt = 0; /* "-d n" option for Network KISS. Can be repeated for more detail. */ + int d_t_opt = 0; /* "-d t" option for Tracker. Can be repeated for more detail. */ + int d_g_opt = 0; /* "-d g" option for GPS. Can be repeated for more detail. */ + int d_o_opt = 0; /* "-d o" option for output control such as PTT and DCD. */ + int d_i_opt = 0; /* "-d i" option for IGate. Repeat for more detail */ + int d_m_opt = 0; /* "-d m" option for mheard list. */ + int d_f_opt = 0; /* "-d f" option for filtering. Repeat for more detail. */ +#if USE_HAMLIB + int d_h_opt = 0; /* "-d h" option for hamlib debugging. Repeat for more detail */ +#endif + int d_x_opt = 1; /* "-d x" option for FX.25. Default minimal. Repeat for more detail. -qx to silence. */ + int d_2_opt = 0; /* "-d 2" option for IL2P. Default minimal. Repeat for more detail. */ + + int aprstt_debug = 0; /* "-d d" option for APRStt (think Dtmf) debug. */ + + int E_tx_opt = 0; /* "-E n" Error rate % for clobbering transmit frames. */ + int E_rx_opt = 0; /* "-E Rn" Error rate % for clobbering receive frames. */ + + float e_recv_ber = 0.0; /* Receive Bit Error Rate (BER). */ + int X_fx25_xmit_enable = 0; /* FX.25 transmit enable. */ + + int I_opt = -1; /* IL2P transmit, normal polarity, arg is max_fec. */ + int i_opt = -1; /* IL2P transmit, inverted polarity, arg is max_fec. */ + + char x_opt_mode = ' '; /* "-x N" option for transmitting calibration tones. */ + int x_opt_chan = 0; /* Split into 2 parts. Mode e.g. m, a, and optional channel. */ + + strlcpy(l_opt_logdir, "", sizeof(l_opt_logdir)); + strlcpy(L_opt_logfile, "", sizeof(L_opt_logfile)); + strlcpy(P_opt, "", sizeof(P_opt)); + strlcpy(T_opt_timestamp, "", sizeof(T_opt_timestamp)); + +#if __WIN32__ + +// Select UTF-8 code page for console output. +// http://msdn.microsoft.com/en-us/library/windows/desktop/ms686036(v=vs.85).aspx +// This is the default I see for windows terminal: +// >chcp +// Active code page: 437 + + //Restore on exit? oldcp = GetConsoleOutputCP(); + SetConsoleOutputCP(CP_UTF8); + +#else + +/* + * Default on Raspian & Ubuntu Linux is fine. Don't know about others. + * + * Should we look at LANG environment variable and issue a warning + * if it doesn't look something like en_US.UTF-8 ? + */ + +#endif + +/* + * Pre-scan the command line options for the text color option. + * We need to set this before any text output. + * Default will be no colors if stdout is not a terminal (i.e. piped into + * something else such as "tee") but command line can override this. + */ + +#if __WIN32__ + t_opt = _isatty(_fileno(stdout)) > 0; +#else + t_opt = isatty(fileno(stdout)); +#endif + /* 1 = normal, 0 = no text colors. */ + /* 2, 3, ... alternate escape sequences for different terminals. */ + +// FIXME: consider case of no space between t and number. + + for (j=1; j= 1) { + __cpuid (cpuinfo, 1); + //dw_printf ("debug: cpuinfo = %x, %x, %x, %x\n", cpuinfo[0], cpuinfo[1], cpuinfo[2], cpuinfo[3]); + // https://en.wikipedia.org/wiki/CPUID + if ( ! ( cpuinfo[3] & (1 << 25))) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("------------------------------------------------------------------\n"); + dw_printf ("This version requires a minimum of a Pentium 3 or equivalent.\n"); + dw_printf ("If you are seeing this message, you are probably using a computer\n"); + dw_printf ("from the previous Century. See instructions in User Guide for\n"); + dw_printf ("information on how you can compile it for use with your antique.\n"); + dw_printf ("------------------------------------------------------------------\n"); + } + } + text_color_set(DW_COLOR_INFO); +#endif + +// I've seen many references to people running this as root. +// There is no reason to do that. +// Ordinary users can access audio, gpio, etc. if they are in the correct groups. +// Giving an applications permission to do things it does not need to do +// is a huge security risk. + +#ifndef __WIN32__ + if (getuid() == 0 || geteuid() == 0) { + text_color_set(DW_COLOR_ERROR); + for (int n=0; n<15; n++) { + dw_printf ("\n"); + dw_printf ("Dire Wolf requires only privileges available to ordinary users.\n"); + dw_printf ("Running this as root is an unnecessary security risk.\n"); + //SLEEP_SEC(1); + } + } +#endif + +/* + * Default location of configuration file is current directory. + * Can be overridden by -c command line option. + * TODO: Automatically search other places. + */ + + strlcpy (config_file, "direwolf.conf", sizeof(config_file)); + +/* + * Look at command line options. + * So far, the only one is the configuration file location. + */ + + strlcpy (input_file, "", sizeof(input_file)); + while (1) { + //int this_option_optind = optind ? optind : 1; + int option_index = 0; + int c; + char *p; + static struct option long_options[] = { + {"future1", 1, 0, 0}, + {"future2", 0, 0, 0}, + {"future3", 1, 0, 'c'}, + {0, 0, 0, 0} + }; + + /* ':' following option character means arg is required. */ + + c = getopt_long(argc, argv, "hP:B:gjJD:U:c:px:r:b:n:d:q:t:ul:L:Sa:E:T:e:X:AI:i:", + long_options, &option_index); + if (c == -1) + break; + + switch (c) { + + case 0: /* possible future use */ + text_color_set(DW_COLOR_DEBUG); + dw_printf("option %s", long_options[option_index].name); + if (optarg) { + dw_printf(" with arg %s", optarg); + } + dw_printf("\n"); + break; + + case 'a': /* -a for audio statistics interval */ + + a_opt = atoi(optarg); + if (a_opt < 0) a_opt = 0; + if (a_opt < 10) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Setting such a small audio statistics interval will produce inaccurate sample rate display.\n"); + } + break; + + case 'c': /* -c for configuration file name */ + + strlcpy (config_file, optarg, sizeof(config_file)); + break; + +#if __WIN32__ +#else + case 'p': /* -p enable pseudo terminal */ + + /* We want this to be off by default because it hangs */ + /* eventually when nothing is reading from other side. */ + + enable_pseudo_terminal = 1; + break; +#endif + + case 'B': /* -B baud rate and modem properties. */ + /* Also implies modem type based on speed. */ + /* Special case "AIS" rather than number. */ + if (strcasecmp(optarg, "AIS") == 0) { + B_opt = 12345; // See special case below. + } + else if (strcasecmp(optarg, "EAS") == 0) { + B_opt = 23456; // See special case below. + } + else { + B_opt = atoi(optarg); + } + if (B_opt < MIN_BAUD || B_opt > MAX_BAUD) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Use a more reasonable data baud rate in range of %d - %d.\n", MIN_BAUD, MAX_BAUD); + exit (EXIT_FAILURE); + } + break; + + case 'g': /* -g G3RUH modem, overriding default mode for speed. */ + + g_opt = 1; + break; + + case 'j': /* -j V.26 compatible with earlier direwolf. */ + + j_opt = 1; + break; + + case 'J': /* -J V.26 compatible with MFJ-2400. */ + + J_opt = 1; + break; + + case 'P': /* -P for modem profile. */ + + //debug: dw_printf ("Demodulator profile set to \"%s\"\n", optarg); + strlcpy (P_opt, optarg, sizeof(P_opt)); + break; + + case 'D': /* -D divide AFSK demodulator sample rate */ + + D_opt = atoi(optarg); + if (D_opt < 1 || D_opt > 8) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Crazy value for -D. \n"); + exit (EXIT_FAILURE); + } + break; + + case 'U': /* -U multiply G3RUH demodulator sample rate (upsample) */ + + U_opt = atoi(optarg); + if (U_opt < 1 || U_opt > 4) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Crazy value for -U. \n"); + exit (EXIT_FAILURE); + } + break; + + case 'x': /* -x N for transmit calibration tones. */ + /* N is composed of a channel number and/or one letter */ + /* for the mode: mark, space, alternate, ptt-only. */ + + for (char *p = optarg; *p != '\0'; p++ ) { + switch (*p) { + case '0': + case '1': + case '2': + case '3': + case '4': + case '5': + case '6': + case '7': + case '8': + case '9': + x_opt_chan = x_opt_chan * 10 + *p - '0'; + if (x_opt_mode == ' ') x_opt_mode = 'a'; + break; + case 'a': x_opt_mode = *p; break; // Alternating tones + case 'm': x_opt_mode = *p; break; // Mark tone + case 's': x_opt_mode = *p; break; // Space tone + case 'p': x_opt_mode = *p; break; // Set PTT only + default: + text_color_set(DW_COLOR_ERROR); + dw_printf ("Invalid option '%c' for -x. Must be a, m, s, or p.\n", *p); + text_color_set(DW_COLOR_INFO); + exit (EXIT_FAILURE); + break; + } + } + if (x_opt_chan < 0 || x_opt_chan >= MAX_CHANS) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Invalid channel %d for -x. \n", x_opt_chan); + text_color_set(DW_COLOR_INFO); + exit (EXIT_FAILURE); + } + break; + + case 'r': /* -r audio samples/sec. e.g. 44100 */ + + r_opt = atoi(optarg); + if (r_opt < MIN_SAMPLES_PER_SEC || r_opt > MAX_SAMPLES_PER_SEC) + { + text_color_set(DW_COLOR_ERROR); + dw_printf("-r option, audio samples/sec, is out of range.\n"); + r_opt = 0; + } + break; + + case 'n': /* -n number of audio channels for first audio device. 1 or 2. */ + + n_opt = atoi(optarg); + if (n_opt < 1 || n_opt > 2) + { + text_color_set(DW_COLOR_ERROR); + dw_printf("-n option, number of audio channels, is out of range.\n"); + n_opt = 0; + } + break; + + case 'b': /* -b bits per sample. 8 or 16. */ + + b_opt = atoi(optarg); + if (b_opt != 8 && b_opt != 16) + { + text_color_set(DW_COLOR_ERROR); + dw_printf("-b option, bits per sample, must be 8 or 16.\n"); + b_opt = 0; + } + break; + + case 'h': // -h for help + case '?': + + /* For '?' unknown option message was already printed. */ + usage (); + break; + + case 'd': /* Set debug option. */ + + /* New in 1.1. Can combine multiple such as "-d pkk" */ + + for (p=optarg; *p!='\0'; p++) { + switch (*p) { + + case 'a': server_set_debug(1); break; + + case 'k': d_k_opt++; kissserial_set_debug (d_k_opt); kisspt_set_debug (d_k_opt); break; + case 'n': d_n_opt++; kiss_net_set_debug (d_n_opt); break; + + case 'u': d_u_opt = 1; break; + + // separate out gps & waypoints. + + case 'g': d_g_opt++; break; + case 'w': waypoint_set_debug (1); break; // not documented yet. + case 't': d_t_opt++; beacon_tracker_set_debug (d_t_opt); break; + + case 'p': d_p_opt = 1; break; // TODO: packet dump for xmit side. + case 'o': d_o_opt++; ptt_set_debug(d_o_opt); break; + case 'i': d_i_opt++; break; + case 'm': d_m_opt++; break; + case 'f': d_f_opt++; break; +#if AX25MEMDEBUG + case 'l': ax25memdebug_set(); break; // Track down memory Leak. Not documented. +#endif // Previously 'm' but that is now used for mheard. +#if USE_HAMLIB + case 'h': d_h_opt++; break; // Hamlib verbose level. +#endif + case 'x': d_x_opt++; break; // FX.25 + case '2': d_2_opt++; break; // IL2P + case 'd': aprstt_debug++; break; // APRStt (mnemonic Dtmf) + default: break; + } + } + break; + + case 'q': /* Set quiet option. */ + + /* New in 1.2. Quiet option to suppress some types of printing. */ + /* Can combine multiple such as "-q hd" */ + + for (p=optarg; *p!='\0'; p++) { + switch (*p) { + case 'h': q_h_opt = 1; break; + case 'd': q_d_opt = 1; break; + case 'x': d_x_opt = 0; break; // Defaults to minimal info. This silences. + default: break; + } + } + break; + + case 't': /* Was handled earlier. */ + break; + + + case 'u': /* Print UTF-8 test and exit. */ + + dw_printf ("\n UTF-8 test string: ma%c%cana %c%c F%c%c%c%ce\n\n", + 0xc3, 0xb1, + 0xc2, 0xb0, + 0xc3, 0xbc, 0xc3, 0x9f); + + exit (0); + break; + + case 'l': /* -l for log directory with daily files */ + + strlcpy (l_opt_logdir, optarg, sizeof(l_opt_logdir)); + break; + + case 'L': /* -L for log file name with full path */ + + strlcpy (L_opt_logfile, optarg, sizeof(L_opt_logfile)); + break; + + + case 'S': /* Print symbol tables and exit. */ + + symbols_init (); + symbols_list (); + exit (0); + break; + + case 'E': /* -E Error rate (%) for corrupting frames. */ + /* Just a number is transmit. Precede by R for receive. */ + + if (*optarg == 'r' || *optarg == 'R') { + E_rx_opt = atoi(optarg+1); + if (E_rx_opt < 1 || E_rx_opt > 99) { + text_color_set(DW_COLOR_ERROR); + dw_printf("-ER must be in range of 1 to 99.\n"); + E_rx_opt = 10; + } + } + else { + E_tx_opt = atoi(optarg); + if (E_tx_opt < 1 || E_tx_opt > 99) { + text_color_set(DW_COLOR_ERROR); + dw_printf("-E must be in range of 1 to 99.\n"); + E_tx_opt = 10; + } + } + break; + + case 'T': /* -T for receive timestamp. */ + strlcpy (T_opt_timestamp, optarg, sizeof(T_opt_timestamp)); + break; + + case 'e': /* -e Receive Bit Error Rate (BER). */ + + e_recv_ber = atof(optarg); + break; + + case 'X': + + X_fx25_xmit_enable = atoi(optarg); + break; + + case 'I': // IL2P, normal polarity + + I_opt = atoi(optarg); + break; + + case 'i': // IL2P, inverted polarity + + i_opt = atoi(optarg); + break; + + case 'A': // -A convert AIS to APRS object + + A_opt_ais_to_obj = 1; + break; + + default: + + /* Should not be here. */ + text_color_set(DW_COLOR_DEBUG); + dw_printf("?? getopt returned character code 0%o ??\n", c); + usage (); + } + } /* end while(1) for options */ + + if (optind < argc) + { + + if (optind < argc - 1) + { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Warning: File(s) beyond the first are ignored.\n"); + } + + strlcpy (input_file, argv[optind], sizeof(input_file)); + + } + +/* + * Get all types of configuration settings from configuration file. + * + * Possibly override some by command line options. + */ + +#if USE_HAMLIB + rig_set_debug(d_h_opt); +#endif + + symbols_init (); + + (void)dwsock_init(); + + config_init (config_file, &audio_config, &digi_config, &cdigi_config, &tt_config, &igate_config, &misc_config); + + if (r_opt != 0) { + audio_config.adev[0].samples_per_sec = r_opt; + } + + if (n_opt != 0) { + audio_config.adev[0].num_channels = n_opt; + if (n_opt == 2) { + audio_config.chan_medium[1] = MEDIUM_RADIO; + } + } + + if (b_opt != 0) { + audio_config.adev[0].bits_per_sample = b_opt; + } + + if (B_opt != 0) { + audio_config.achan[0].baud = B_opt; + + /* We have similar logic in direwolf.c, config.c, gen_packets.c, and atest.c, */ + /* that need to be kept in sync. Maybe it could be a common function someday. */ + + if (audio_config.achan[0].baud < 600) { + audio_config.achan[0].modem_type = MODEM_AFSK; + audio_config.achan[0].mark_freq = 1600; // Typical for HF SSB. + audio_config.achan[0].space_freq = 1800; + audio_config.achan[0].decimate = 3; // Reduce CPU load. + } + else if (audio_config.achan[0].baud < 1800) { + audio_config.achan[0].modem_type = MODEM_AFSK; + audio_config.achan[0].mark_freq = DEFAULT_MARK_FREQ; + audio_config.achan[0].space_freq = DEFAULT_SPACE_FREQ; + } + else if (audio_config.achan[0].baud < 3600) { + audio_config.achan[0].modem_type = MODEM_QPSK; + audio_config.achan[0].mark_freq = 0; + audio_config.achan[0].space_freq = 0; + if (audio_config.achan[0].baud != 2400) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Bit rate should be standard 2400 rather than specified %d.\n", audio_config.achan[0].baud); + } + } + else if (audio_config.achan[0].baud < 7200) { + audio_config.achan[0].modem_type = MODEM_8PSK; + audio_config.achan[0].mark_freq = 0; + audio_config.achan[0].space_freq = 0; + if (audio_config.achan[0].baud != 4800) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Bit rate should be standard 4800 rather than specified %d.\n", audio_config.achan[0].baud); + } + } + else if (audio_config.achan[0].baud == 12345) { + audio_config.achan[0].modem_type = MODEM_AIS; + audio_config.achan[0].baud = 9600; + audio_config.achan[0].mark_freq = 0; + audio_config.achan[0].space_freq = 0; + } + else if (audio_config.achan[0].baud == 23456) { + audio_config.achan[0].modem_type = MODEM_EAS; + audio_config.achan[0].baud = 521; // Actually 520.83 but we have an integer field here. + // Will make more precise in afsk demod init. + audio_config.achan[0].mark_freq = 2083; // Actually 2083.3 - logic 1. + audio_config.achan[0].space_freq = 1563; // Actually 1562.5 - logic 0. + strlcpy (audio_config.achan[0].profiles, "A", sizeof(audio_config.achan[0].profiles)); + } + else { + audio_config.achan[0].modem_type = MODEM_SCRAMBLE; + audio_config.achan[0].mark_freq = 0; + audio_config.achan[0].space_freq = 0; + } + } + + if (g_opt) { + + // Force G3RUH mode, overriding default for speed. + // Example: -B 2400 -g + + audio_config.achan[0].modem_type = MODEM_SCRAMBLE; + audio_config.achan[0].mark_freq = 0; + audio_config.achan[0].space_freq = 0; + } + + if (j_opt) { + + // V.26 compatible with earlier versions of direwolf. + // Example: -B 2400 -j or simply -j + + audio_config.achan[0].v26_alternative = V26_A; + audio_config.achan[0].modem_type = MODEM_QPSK; + audio_config.achan[0].mark_freq = 0; + audio_config.achan[0].space_freq = 0; + audio_config.achan[0].baud = 2400; + } + if (J_opt) { + + // V.26 compatible with MFJ and maybe others. + // Example: -B 2400 -J or simply -J + + audio_config.achan[0].v26_alternative = V26_B; + audio_config.achan[0].modem_type = MODEM_QPSK; + audio_config.achan[0].mark_freq = 0; + audio_config.achan[0].space_freq = 0; + audio_config.achan[0].baud = 2400; + } + + + audio_config.statistics_interval = a_opt; + + if (strlen(P_opt) > 0) { + /* -P for modem profile. */ + strlcpy (audio_config.achan[0].profiles, P_opt, sizeof(audio_config.achan[0].profiles)); + } + + if (D_opt != 0) { + // Reduce audio sampling rate to reduce CPU requirements. + audio_config.achan[0].decimate = D_opt; + } + + if (U_opt != 0) { + // Increase G3RUH audio sampling rate to improve performance. + // The value is normally determined automatically based on audio + // sample rate and baud. This allows override for experimentation. + audio_config.achan[0].upsample = U_opt; + } + + strlcpy(audio_config.timestamp_format, T_opt_timestamp, sizeof(audio_config.timestamp_format)); + + // temp - only xmit errors. + + audio_config.xmit_error_rate = E_tx_opt; + audio_config.recv_error_rate = E_rx_opt; + + + if (strlen(l_opt_logdir) > 0 && strlen(L_opt_logfile) > 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Logging options -l and -L can't be used together. Pick one or the other.\n"); + exit(1); + } + + if (strlen(L_opt_logfile) > 0) { + misc_config.log_daily_names = 0; + strlcpy (misc_config.log_path, L_opt_logfile, sizeof(misc_config.log_path)); + } + else if (strlen(l_opt_logdir) > 0) { + misc_config.log_daily_names = 1; + strlcpy (misc_config.log_path, l_opt_logdir, sizeof(misc_config.log_path)); + } + + misc_config.enable_kiss_pt = enable_pseudo_terminal; + + if (strlen(input_file) > 0) { + + strlcpy (audio_config.adev[0].adevice_in, input_file, sizeof(audio_config.adev[0].adevice_in)); + + } + + audio_config.recv_ber = e_recv_ber; + + if (X_fx25_xmit_enable > 0) { + if (I_opt != -1 || i_opt != -1) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Can't mix -X with -I or -i.\n"); + exit (EXIT_FAILURE); + } + audio_config.achan[0].fx25_strength = X_fx25_xmit_enable; + audio_config.achan[0].layer2_xmit = LAYER2_FX25; + } + + if (I_opt != -1 && i_opt != -1) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Can't use both -I and -i at the same time.\n"); + exit (EXIT_FAILURE); + } + + if (I_opt >= 0) { + audio_config.achan[0].layer2_xmit = LAYER2_IL2P; + audio_config.achan[0].il2p_max_fec = (I_opt > 0); + if (audio_config.achan[0].il2p_max_fec == 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("It is highly recommended that 1, rather than 0, is used with -I for best results.\n"); + } + audio_config.achan[0].il2p_invert_polarity = 0; // normal + } + + if (i_opt >= 0) { + audio_config.achan[0].layer2_xmit = LAYER2_IL2P; + audio_config.achan[0].il2p_max_fec = (i_opt > 0); + if (audio_config.achan[0].il2p_max_fec == 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("It is highly recommended that 1, rather than 0, is used with -i for best results.\n"); + } + audio_config.achan[0].il2p_invert_polarity = 1; // invert for transmit + if (audio_config.achan[0].baud == 1200) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Using -i with 1200 bps is a bad idea. Use -I instead.\n"); + } + } + + +/* + * Open the audio source + * - soundcard + * - stdin + * - UDP + * Files not supported at this time. + * Can always "cat" the file and pipe it into stdin. + */ + + err = audio_open (&audio_config); + if (err < 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Pointless to continue without audio device.\n"); + SLEEP_SEC(5); + usage (); + exit (1); + } + +/* + * Initialize the demodulator(s) and layer 2 decoder (HDLC, IL2P). + */ + multi_modem_init (&audio_config); + fx25_init (d_x_opt); + il2p_init (d_2_opt); + +/* + * Initialize the touch tone decoder & APRStt gateway. + */ + dtmf_init (&audio_config, audio_amplitude); + aprs_tt_init (&tt_config, aprstt_debug); + tt_user_init (&audio_config, &tt_config); + +/* + * Should there be an option for audio output level? + * Note: This is not the same as a volume control you would see on the screen. + * It is the range of the digital sound representation. +*/ + gen_tone_init (&audio_config, audio_amplitude, 0); + morse_init (&audio_config, audio_amplitude); + + assert (audio_config.adev[0].bits_per_sample == 8 || audio_config.adev[0].bits_per_sample == 16); + assert (audio_config.adev[0].num_channels == 1 || audio_config.adev[0].num_channels == 2); + assert (audio_config.adev[0].samples_per_sec >= MIN_SAMPLES_PER_SEC && audio_config.adev[0].samples_per_sec <= MAX_SAMPLES_PER_SEC); + +/* + * Initialize the transmit queue. + */ + + xmit_init (&audio_config, d_p_opt); + +/* + * If -x N option specified, transmit calibration tones for transmitter + * audio level adjustment, up to 1 minute then quit. + * a: Alternating mark/space tones + * m: Mark tone (e.g. 1200Hz) + * s: Space tone (e.g. 2200Hz) + * p: Set PTT only. + * A leading or trailing number is the channel. + */ + + if (x_opt_mode != ' ') { + if (audio_config.chan_medium[x_opt_chan] == MEDIUM_RADIO) { + if (audio_config.achan[x_opt_chan].mark_freq + && audio_config.achan[x_opt_chan].space_freq) { + int max_duration = 60; + int n = audio_config.achan[x_opt_chan].baud * max_duration; + + text_color_set(DW_COLOR_INFO); + ptt_set(OCTYPE_PTT, x_opt_chan, 1); + + switch (x_opt_mode) { + default: + case 'a': // Alternating tones: -x a + dw_printf("\nSending alternating mark/space calibration tones (%d/%dHz) on channel %d.\nPress control-C to terminate.\n", + audio_config.achan[x_opt_chan].mark_freq, + audio_config.achan[x_opt_chan].space_freq, + x_opt_chan); + while (n-- > 0) { + tone_gen_put_bit(x_opt_chan, n & 1); + } + break; + case 'm': // "Mark" tone: -x m + dw_printf("\nSending mark calibration tone (%dHz) on channel %d.\nPress control-C to terminate.\n", + audio_config.achan[x_opt_chan].mark_freq, + x_opt_chan); + while (n-- > 0) { + tone_gen_put_bit(x_opt_chan, 1); + } + break; + case 's': // "Space" tone: -x s + dw_printf("\nSending space calibration tone (%dHz) on channel %d.\nPress control-C to terminate.\n", + audio_config.achan[x_opt_chan].space_freq, + x_opt_chan); + while (n-- > 0) { + tone_gen_put_bit(x_opt_chan, 0); + } + break; + case 'p': // Silence - set PTT only: -x p + dw_printf("\nSending silence (Set PTT only) on channel %d.\nPress control-C to terminate.\n", x_opt_chan); + SLEEP_SEC(max_duration); + break; + } + + ptt_set(OCTYPE_PTT, x_opt_chan, 0); + text_color_set(DW_COLOR_INFO); + exit(EXIT_SUCCESS); + + } else { + text_color_set(DW_COLOR_ERROR); + dw_printf("\nMark/Space frequencies not defined for channel %d. Cannot calibrate using this modem type.\n", x_opt_chan); + text_color_set(DW_COLOR_INFO); + exit(EXIT_FAILURE); + } + } else { + text_color_set(DW_COLOR_ERROR); + dw_printf("\nChannel %d is not configured as a radio channel.\n", x_opt_chan); + text_color_set(DW_COLOR_INFO); + exit(EXIT_FAILURE); + } + } + + +/* + * Initialize the digipeater and IGate functions. + */ + digipeater_init (&audio_config, &digi_config); + igate_init (&audio_config, &igate_config, &digi_config, d_i_opt); + cdigipeater_init (&audio_config, &cdigi_config); + pfilter_init (&igate_config, d_f_opt); + ax25_link_init (&misc_config); + +/* + * Provide the AGW & KISS socket interfaces for use by a client application. + */ + server_init (&audio_config, &misc_config); + kissnet_init (&misc_config); + +#if (USE_AVAHI_CLIENT|USE_MACOS_DNSSD) + if (misc_config.kiss_port > 0 && misc_config.dns_sd_enabled) + dns_sd_announce(&misc_config); +#endif + +/* + * Create a pseudo terminal and KISS TNC emulator. + */ + kisspt_init (&misc_config); + kissserial_init (&misc_config); + kiss_frame_init (&audio_config); + +/* + * Open port for communication with GPS. + */ + dwgps_init (&misc_config, d_g_opt); + + waypoint_init (&misc_config); + +/* + * Enable beaconing. + * Open log file first because "-dttt" (along with -l...) will + * log the tracker beacon transmissions with fake channel 999. + */ + + log_init(misc_config.log_daily_names, misc_config.log_path); + mheard_init (d_m_opt); + beacon_init (&audio_config, &misc_config, &igate_config); + + +/* + * Get sound samples and decode them. + * Use hot attribute for all functions called for every audio sample. + */ + + recv_init (&audio_config); + recv_process (); + + exit (EXIT_SUCCESS); +} + + +/*------------------------------------------------------------------- + * + * Name: app_process_rec_frame + * + * Purpose: This is called when we receive a frame with a valid + * FCS and acceptable size. + * + * Inputs: chan - Audio channel number, 0 or 1. + * subchan - Which modem caught it. + * Special case -1 for DTMF decoder. + * slice - Slicer which caught it. + * pp - Packet handle. + * alevel - Audio level, range of 0 - 100. + * (Special case, use negative to skip + * display of audio level line. + * Use -2 to indicate DTMF message.) + * retries - Level of bit correction used. + * spectrum - Display of how well multiple decoders did. + * + * + * Description: Print decoded packet. + * Optionally send to another application. + * + *--------------------------------------------------------------------*/ + +// TODO: Use only one printf per line so output doesn't get jumbled up with stuff from other threads. + +void app_process_rec_packet (int chan, int subchan, int slice, packet_t pp, alevel_t alevel, fec_type_t fec_type, retry_t retries, char *spectrum) +{ + + char stemp[500]; + unsigned char *pinfo; + int info_len; + char heard[AX25_MAX_ADDR_LEN]; + //int j; + int h; + char display_retries[32]; // Extra stuff before slice indicators. + // Can indicate FX.25/IL2P or fix_bits. + + assert (chan >= 0 && chan < MAX_TOTAL_CHANS); // TOTAL for virtual channels + assert (subchan >= -2 && subchan < MAX_SUBCHANS); + assert (slice >= 0 && slice < MAX_SLICERS); + assert (pp != NULL); // 1.1J+ + + strlcpy (display_retries, "", sizeof(display_retries)); + + switch (fec_type) { + case fec_type_fx25: + strlcpy (display_retries, " FX.25 ", sizeof(display_retries)); + break; + case fec_type_il2p: + strlcpy (display_retries, " IL2P ", sizeof(display_retries)); + break; + case fec_type_none: + default: + // Possible fix_bits indication. + if (audio_config.achan[chan].fix_bits != RETRY_NONE || audio_config.achan[chan].passall) { + assert (retries >= RETRY_NONE && retries <= RETRY_MAX); + snprintf (display_retries, sizeof(display_retries), " [%s] ", retry_text[(int)retries]); + } + break; + } + + ax25_format_addrs (pp, stemp); + + info_len = ax25_get_info (pp, &pinfo); + + /* Print so we can see what is going on. */ + + /* Display audio input level. */ + /* Who are we hearing? Original station or digipeater. */ + + if (ax25_get_num_addr(pp) == 0) { + /* Not AX.25. No station to display below. */ + h = -1; + strlcpy (heard, "", sizeof(heard)); + } + else { + h = ax25_get_heard(pp); + ax25_get_addr_with_ssid(pp, h, heard); + } + + text_color_set(DW_COLOR_DEBUG); + dw_printf ("\n"); + +// The HEARD line. + + if (( ! q_h_opt ) && alevel.rec >= 0) { /* suppress if "-q h" option */ +// FIXME: rather than checking for ichannel, how about checking medium==radio + if (chan != audio_config.igate_vchannel) { // suppress if from ICHANNEL + if (h != -1 && h != AX25_SOURCE) { + dw_printf ("Digipeater "); + } + + char alevel_text[AX25_ALEVEL_TO_TEXT_SIZE]; + + ax25_alevel_to_text (alevel, alevel_text); + +// Experiment: try displaying the DC bias. +// Should be 0 for soundcard but could show mistuning with SDR. + +#if 0 + char bias[16]; + snprintf (bias, sizeof(bias), " DC%+d", multi_modem_get_dc_average (chan)); + strlcat (alevel_text, bias, sizeof(alevel_text)); +#endif + + /* As suggested by KJ4ERJ, if we are receiving from */ + /* WIDEn-0, it is quite likely (but not guaranteed), that */ + /* we are actually hearing the preceding station in the path. */ + + if (h >= AX25_REPEATER_2 && + strncmp(heard, "WIDE", 4) == 0 && + isdigit(heard[4]) && + heard[5] == '\0') { + + char probably_really[AX25_MAX_ADDR_LEN]; + + + ax25_get_addr_with_ssid(pp, h-1, probably_really); + + dw_printf ("%s (probably %s) audio level = %s %s %s\n", heard, probably_really, alevel_text, display_retries, spectrum); + + } + else if (strcmp(heard, "DTMF") == 0) { + + dw_printf ("%s audio level = %s tt\n", heard, alevel_text); + } + else { + + dw_printf ("%s audio level = %s %s %s\n", heard, alevel_text, display_retries, spectrum); + } + } + } + + /* Version 1.2: Cranking the input level way up produces 199. */ + /* Keeping it under 100 gives us plenty of headroom to avoid saturation. */ + + // TODO: suppress this message if not using soundcard input. + // i.e. we have no control over the situation when using SDR. + + if (alevel.rec > 110) { + + text_color_set(DW_COLOR_ERROR); + dw_printf ("Audio input level is too high. Reduce so most stations are around 50.\n"); + } +// FIXME: rather than checking for ichannel, how about checking medium==radio + else if (alevel.rec < 5 && chan != audio_config.igate_vchannel) { + + text_color_set(DW_COLOR_ERROR); + dw_printf ("Audio input level is too low. Increase so most stations are around 50.\n"); + } + + +// Display non-APRS packets in a different color. + +// Display subchannel only when multiple modems configured for channel. + +// -1 for APRStt DTMF decoder. + + char ts[100]; // optional time stamp + + if (strlen(audio_config.timestamp_format) > 0) { + char tstmp[100]; + timestamp_user_format (tstmp, sizeof(tstmp), audio_config.timestamp_format); + strlcpy (ts, " ", sizeof(ts)); // space after channel. + strlcat (ts, tstmp, sizeof(ts)); + } + else { + strlcpy (ts, "", sizeof(ts)); + } + + if (subchan == -1) { + text_color_set(DW_COLOR_REC); + dw_printf ("[%d.dtmf%s] ", chan, ts); + } + else if (subchan == -2) { + text_color_set(DW_COLOR_REC); + dw_printf ("[%d.is%s] ", chan, ts); + } + else { + if (ax25_is_aprs(pp)) { + text_color_set(DW_COLOR_REC); + } + else { + text_color_set(DW_COLOR_DECODED); + } + + if (audio_config.achan[chan].num_subchan > 1 && audio_config.achan[chan].num_slicers == 1) { + dw_printf ("[%d.%d%s] ", chan, subchan, ts); + } + else if (audio_config.achan[chan].num_subchan == 1 && audio_config.achan[chan].num_slicers > 1) { + dw_printf ("[%d.%d%s] ", chan, slice, ts); + } + else if (audio_config.achan[chan].num_subchan > 1 && audio_config.achan[chan].num_slicers > 1) { + dw_printf ("[%d.%d.%d%s] ", chan, subchan, slice, ts); + } + else { + dw_printf ("[%d%s] ", chan, ts); + } + } + + dw_printf ("%s", stemp); /* stations followed by : */ + +/* Demystify non-APRS. Use same format for transmitted frames in xmit.c. */ + + if ( ! ax25_is_aprs(pp)) { + ax25_frame_type_t ftype; + cmdres_t cr; + char desc[80]; + int pf; + int nr; + int ns; + + ftype = ax25_frame_type (pp, &cr, desc, &pf, &nr, &ns); + + /* Could change by 1, since earlier call, if we guess at modulo 128. */ + info_len = ax25_get_info (pp, &pinfo); + + dw_printf ("(%s)", desc); + if (ftype == frame_type_U_XID) { + struct xid_param_s param; + char info2text[150]; + + xid_parse (pinfo, info_len, ¶m, info2text, sizeof(info2text)); + dw_printf (" %s\n", info2text); + } + else { + ax25_safe_print ((char *)pinfo, info_len, ( ! ax25_is_aprs(pp)) && ( ! d_u_opt) ); + dw_printf ("\n"); + } + } + else { + + // for APRS we generally want to display non-ASCII to see UTF-8. + // for other, probably want to restrict to ASCII only because we are + // more likely to have compressed data than UTF-8 text. + + // TODO: Might want to use d_u_opt for transmitted frames too. + + ax25_safe_print ((char *)pinfo, info_len, ( ! ax25_is_aprs(pp)) && ( ! d_u_opt) ); + dw_printf ("\n"); + } + + +// Also display in pure ASCII if non-ASCII characters and "-d u" option specified. + + if (d_u_opt) { + + unsigned char *p; + int n = 0; + + for (p = pinfo; *p != '\0'; p++) { + if (*p >= 0x80) n++; + } + + if (n > 0) { + text_color_set(DW_COLOR_DEBUG); + ax25_safe_print ((char *)pinfo, info_len, 1); + dw_printf ("\n"); + } + } + +/* Optional hex dump of packet. */ + + if (d_p_opt) { + + text_color_set(DW_COLOR_DEBUG); + dw_printf ("------\n"); + ax25_hex_dump (pp); + dw_printf ("------\n"); + } + + +/* + * Decode the contents of UI frames and display in human-readable form. + * Could be APRS or anything random for old fashioned packet beacons. + * + * Suppress printed decoding if "-q d" option used. + */ + char ais_obj_packet[300]; + strcpy (ais_obj_packet, ""); + + if (ax25_is_aprs(pp)) { + + decode_aprs_t A; + + // we still want to decode it for logging and other processing. + // Just be quiet about errors if "-qd" is set. + + decode_aprs (&A, pp, q_d_opt, NULL); + + if ( ! q_d_opt ) { + + // Print it all out in human readable format unless "-q d" option used. + + decode_aprs_print (&A); + } + + /* + * Perform validity check on each address. + * This should print an error message if any issues. + */ + (void)ax25_check_addresses(pp); + + // Send to log file. + + log_write (chan, &A, pp, alevel, retries); + + // temp experiment. + //log_rr_bits (&A, pp); + + // Add to list of stations heard over the radio. + + mheard_save_rf (chan, &A, pp, alevel, retries); + +// For AIS, we have an option to convert the NMEA format, in User Defined data, +// into an APRS "Object Report" and send that to the clients as well. + +// FIXME: partial implementation. + + static const char user_def_da[4] = { '{', USER_DEF_USER_ID, USER_DEF_TYPE_AIS, '\0' }; + + if (strncmp((char*)pinfo, user_def_da, 3) == 0) { + + waypoint_send_ais((char*)pinfo + 3); + + if (A_opt_ais_to_obj && A.g_lat != G_UNKNOWN && A.g_lon != G_UNKNOWN) { + + char ais_obj_info[256]; + (void)encode_object (A.g_name, 0, time(NULL), + A.g_lat, A.g_lon, 0, // no ambiguity + A.g_symbol_table, A.g_symbol_code, + 0, 0, 0, "", // power, height, gain, direction. + // Unknown not handled properly. + // Should encode_object take floating point here? + (int)(A.g_course+0.5), (int)(DW_MPH_TO_KNOTS(A.g_speed_mph)+0.5), + 0, 0, 0, A.g_comment, // freq, tone, offset + ais_obj_info, sizeof(ais_obj_info)); + + snprintf (ais_obj_packet, sizeof(ais_obj_packet), "%s>%s%1d%1d:%s", A.g_src, APP_TOCALL, MAJOR_VERSION, MINOR_VERSION, ais_obj_info); + + dw_printf ("[%d.AIS] %s\n", chan, ais_obj_packet); + + // This will be sent to client apps after the User Defined Data representation. + } + } + + // Convert to NMEA waypoint sentence if we have a location. + + if (A.g_lat != G_UNKNOWN && A.g_lon != G_UNKNOWN) { + waypoint_send_sentence (strlen(A.g_name) > 0 ? A.g_name : A.g_src, + A.g_lat, A.g_lon, A.g_symbol_table, A.g_symbol_code, + DW_FEET_TO_METERS(A.g_altitude_ft), A.g_course, DW_MPH_TO_KNOTS(A.g_speed_mph), + A.g_comment); + } + } + + +/* Send to another application if connected. */ +// TODO: Put a wrapper around this so we only call one function to send by all methods. +// We see the same sequence in tt_user.c. + + int flen; + unsigned char fbuf[AX25_MAX_PACKET_LEN]; + + flen = ax25_pack(pp, fbuf); + + server_send_rec_packet (chan, pp, fbuf, flen); // AGW net protocol + kissnet_send_rec_packet (chan, KISS_CMD_DATA_FRAME, fbuf, flen, NULL, -1); // KISS TCP + kissserial_send_rec_packet (chan, KISS_CMD_DATA_FRAME, fbuf, flen, NULL, -1); // KISS serial port + kisspt_send_rec_packet (chan, KISS_CMD_DATA_FRAME, fbuf, flen, NULL, -1); // KISS pseudo terminal + + if (A_opt_ais_to_obj && strlen(ais_obj_packet) != 0) { + packet_t ao_pp = ax25_from_text (ais_obj_packet, 1); + if (ao_pp != NULL) { + unsigned char ao_fbuf[AX25_MAX_PACKET_LEN]; + int ao_flen = ax25_pack(ao_pp, ao_fbuf); + + server_send_rec_packet (chan, ao_pp, ao_fbuf, ao_flen); + kissnet_send_rec_packet (chan, KISS_CMD_DATA_FRAME, ao_fbuf, ao_flen, NULL, -1); + kissserial_send_rec_packet (chan, KISS_CMD_DATA_FRAME, ao_fbuf, ao_flen, NULL, -1); + kisspt_send_rec_packet (chan, KISS_CMD_DATA_FRAME, ao_fbuf, ao_flen, NULL, -1); + ax25_delete (ao_pp); + } + } + +/* + * If it is from the ICHANNEL, we are done. + * Don't digipeat. Don't IGate. + * Don't do anything with it after printing and sending to client apps. + */ + + if (chan == audio_config.igate_vchannel) { + return; + } + +/* + * If it came from DTMF decoder (subchan == -1), send it to APRStt gateway. + * Otherwise, it is a candidate for IGate and digipeater. + * + * It is also useful to have some way to simulate touch tone + * sequences with BEACON sendto=R0 for testing. + */ + + if (subchan == -1) { // from DTMF decoder + if (tt_config.gateway_enabled && info_len >= 2) { + aprs_tt_sequence (chan, (char*)(pinfo+1)); + } + } + else if (*pinfo == 't' && info_len >= 2 && tt_config.gateway_enabled) { + // For testing. + // Would be nice to verify it was generated locally, + // not received over the air. + aprs_tt_sequence (chan, (char*)(pinfo+1)); + } + else { + +/* + * Send to the IGate processing. + * Use only those with correct CRC; We don't want to spread corrupted data! + * Our earlier "fix bits" hack could allow corrupted information to get thru. + * However, if it used FEC mode (FX.25. IL2P), we have much higher level of + * confidence that it is correct. + */ + if (ax25_is_aprs(pp) && ( retries == RETRY_NONE || fec_type == fec_type_fx25 || fec_type == fec_type_il2p) ) { + + igate_send_rec_packet (chan, pp); + } + + +/* Send out a regenerated copy. Applies to all types, not just APRS. */ +/* This was an experimental feature never documented in the User Guide. */ +/* Initial feedback was positive but it fell by the wayside. */ +/* Should follow up with testers and either document this or clean out the clutter. */ + + digi_regen (chan, pp); + + +/* + * Send to APRS digipeater. + * Use only those with correct CRC; We don't want to spread corrupted data! + * Our earlier "fix bits" hack could allow corrupted information to get thru. + * However, if it used FEC mode (FX.25. IL2P), we have much higher level of + * confidence that it is correct. + */ + if (ax25_is_aprs(pp) && ( retries == RETRY_NONE || fec_type == fec_type_fx25 || fec_type == fec_type_il2p) ) { + + digipeater (chan, pp); + } + +/* + * Connected mode digipeater. + * Use only those with correct CRC (or using FEC.) + */ + + if (retries == RETRY_NONE || fec_type == fec_type_fx25 || fec_type == fec_type_il2p) { + + cdigipeater (chan, pp); + } + } + +} /* end app_process_rec_packet */ + + + +/* Process control C and window close events. */ + +#if __WIN32__ + +static BOOL cleanup_win (int ctrltype) +{ + if (ctrltype == CTRL_C_EVENT || ctrltype == CTRL_CLOSE_EVENT) { + text_color_set(DW_COLOR_INFO); + dw_printf ("\nQRT\n"); + log_term (); + ptt_term (); + waypoint_term (); + dwgps_term (); + SLEEP_SEC(1); + ExitProcess (0); + } + return (TRUE); +} + + +#else + +static void cleanup_linux (int x) +{ + text_color_set(DW_COLOR_INFO); + dw_printf ("\nQRT\n"); + log_term (); + ptt_term (); + dwgps_term (); + SLEEP_SEC(1); + exit(0); +} + +#endif + + + +static void usage (char **argv) +{ + text_color_set(DW_COLOR_ERROR); + + dw_printf ("\n"); + dw_printf ("Dire Wolf version %d.%d\n", MAJOR_VERSION, MINOR_VERSION); + dw_printf ("\n"); + dw_printf ("Usage: direwolf [options] [ - | stdin | UDP:nnnn ]\n"); + dw_printf ("Options:\n"); + dw_printf (" -c fname Configuration file name.\n"); + dw_printf (" -l logdir Directory name for log files. Use . for current.\n"); + dw_printf (" -r n Audio sample rate, per sec.\n"); + dw_printf (" -n n Number of audio channels, 1 or 2.\n"); + dw_printf (" -b n Bits per audio sample, 8 or 16.\n"); + dw_printf (" -B n Data rate in bits/sec for channel 0. Standard values are 300, 1200, 2400, 4800, 9600.\n"); + dw_printf (" 300 bps defaults to AFSK tones of 1600 & 1800.\n"); + dw_printf (" 1200 bps uses AFSK tones of 1200 & 2200.\n"); + dw_printf (" 2400 bps uses QPSK based on V.26 standard.\n"); + dw_printf (" 4800 bps uses 8PSK based on V.27 standard.\n"); + dw_printf (" 9600 bps and up uses K9NG/G3RUH standard.\n"); + dw_printf (" AIS for ship Automatic Identification System.\n"); + dw_printf (" EAS for Emergency Alert System (EAS) Specific Area Message Encoding (SAME).\n"); + dw_printf (" -g Force G3RUH modem regardless of speed.\n"); + dw_printf (" -j 2400 bps QPSK compatible with direwolf <= 1.5.\n"); + dw_printf (" -J 2400 bps QPSK compatible with MFJ-2400.\n"); + dw_printf (" -P xxx Modem Profiles.\n"); + dw_printf (" -A Convert AIS positions to APRS Object Reports.\n"); + dw_printf (" -D n Divide audio sample rate by n for channel 0.\n"); + dw_printf (" -X n 1 to enable FX.25 transmit. 16, 32, 64 for specific number of check bytes.\n"); + dw_printf (" -I n Enable IL2P transmit. n=1 is recommended. 0 uses weaker FEC.\n"); + dw_printf (" -i n Enable IL2P transmit, inverted polarity. n=1 is recommended. 0 uses weaker FEC.\n"); + dw_printf (" -d Debug options:\n"); + dw_printf (" a a = AGWPE network protocol client.\n"); + dw_printf (" k k = KISS serial port or pseudo terminal client.\n"); + dw_printf (" n n = KISS network client.\n"); + dw_printf (" u u = Display non-ASCII text in hexadecimal.\n"); + dw_printf (" p p = dump Packets in hexadecimal.\n"); + dw_printf (" g g = GPS interface.\n"); + dw_printf (" w w = Waypoints for Position or Object Reports.\n"); + dw_printf (" t t = Tracker beacon.\n"); + dw_printf (" o o = output controls such as PTT and DCD.\n"); + dw_printf (" i i = IGate.\n"); + dw_printf (" m m = Monitor heard station list.\n"); + dw_printf (" f f = packet Filtering.\n"); +#if USE_HAMLIB + dw_printf (" h h = hamlib increase verbose level.\n"); +#endif + dw_printf (" x x = FX.25 increase verbose level.\n"); + dw_printf (" 2 2 = IL2P.\n"); + dw_printf (" d d = APRStt (DTMF to APRS object translation).\n"); + dw_printf (" -q Quiet (suppress output) options:\n"); + dw_printf (" h h = Heard line with the audio level.\n"); + dw_printf (" d d = Decoding of APRS packets.\n"); + dw_printf (" x x = Silence FX.25 information.\n"); + dw_printf (" -t n Text colors. 0=disabled. 1=default. 2,3,4,... alternatives.\n"); + dw_printf (" Use 9 to test compatibility with your terminal.\n"); + dw_printf (" -a n Audio statistics interval in seconds. 0 to disable.\n"); +#if __WIN32__ +#else + dw_printf (" -p Enable pseudo terminal for KISS protocol.\n"); +#endif + dw_printf (" -x Send Xmit level calibration tones.\n"); + dw_printf (" a a = Alternating mark/space tones.\n"); + dw_printf (" m m = Steady mark tone (e.g. 1200Hz).\n"); + dw_printf (" s s = Steady space tone (e.g. 2200Hz).\n"); + dw_printf (" p p = Silence (Set PTT only).\n"); + dw_printf (" chan Optionally add a number to specify radio channel.\n"); + dw_printf (" -u Print UTF-8 test string and exit.\n"); + dw_printf (" -S Print symbol tables and exit.\n"); + dw_printf (" -T fmt Time stamp format for sent and received frames.\n"); + dw_printf (" -e ber Receive Bit Error Rate (BER), e.g. 1e-5\n"); + dw_printf ("\n"); + + dw_printf ("After any options, there can be a single command line argument for the source of\n"); + dw_printf ("received audio. This can override the audio input specified in the configuration file.\n"); + dw_printf ("\n"); + +#if __WIN32__ + dw_printf ("Documentation can be found in the 'doc' folder\n"); +#else + // TODO: Could vary by platform and build options. + dw_printf ("Documentation can be found in /usr/local/share/doc/direwolf\n"); +#endif + dw_printf ("or online at https://github.com/wb2osz/direwolf/tree/master/doc\n"); + dw_printf ("additional topics: https://github.com/wb2osz/direwolf-doc\n"); + text_color_set(DW_COLOR_INFO); + exit (EXIT_FAILURE); +} + + +/* end direwolf.c */ diff --git a/src/direwolf.h b/src/direwolf.h new file mode 100644 index 00000000..69b09529 --- /dev/null +++ b/src/direwolf.h @@ -0,0 +1,355 @@ + +/* direwolf.h - Common stuff used many places. */ + +// TODO: include this file first before anything else in each .c file. + + +#ifdef NDEBUG +#undef NDEBUG // Because it would disable assert(). +#endif + + +#ifndef DIREWOLF_H +#define DIREWOLF_H 1 + +/* + * Support Windows XP and later. + * + * We need this before "#include ". + * + * Don't know what other impact it might have on others. + */ + +#if __WIN32__ + +#ifdef _WIN32_WINNT +#error Include "direwolf.h" before any windows system files. +#endif +#ifdef WINVER +#error Include "direwolf.h" before any windows system files. +#endif + +#define _WIN32_WINNT 0x0501 /* Minimum OS version is XP. */ +#define WINVER 0x0501 /* Minimum OS version is XP. */ + +#include +#include + +#endif + +/* + * Maximum number of audio devices. + * Three is probably adequate for standard version. + * Larger reasonable numbers should also be fine. + * + * For example, if you wanted to use 4 audio devices at once, change this to 4. + */ + +#define MAX_ADEVS 3 + + +/* + * Maximum number of radio channels. + * Note that there could be gaps. + * Suppose audio device 0 was in mono mode and audio device 1 was stereo. + * The channels available would be: + * + * ADevice 0: channel 0 + * ADevice 1: left = 2, right = 3 + * + * TODO1.2: Look for any places that have + * for (ch=0; ch>1) +#define ADEVFIRSTCHAN(n) ((n) * 2) + +/* + * Maximum number of modems per channel. + * I called them "subchannels" (in the code) because + * it is short and unambiguous. + * Nothing magic about the number. Could be larger + * but CPU demands might be overwhelming. + */ + +#define MAX_SUBCHANS 9 + +/* + * Each one of these can have multiple slicers, at + * different levels, to compensate for different + * amplitudes of the AFSK tones. + * Initially used same number as subchannels but + * we could probably trim this down a little + * without impacting performance. + */ + +#define MAX_SLICERS 9 + + +#if __WIN32__ +#define SLEEP_SEC(n) Sleep((n)*1000) +#define SLEEP_MS(n) Sleep(n) +#else +#define SLEEP_SEC(n) sleep(n) +#define SLEEP_MS(n) usleep((n)*1000) +#endif + +#if __WIN32__ + +#define PTW32_STATIC_LIB +//#include "pthreads/pthread.h" + +// This enables definitions of localtime_r and gmtime_r in system time.h. +//#define _POSIX_THREAD_SAFE_FUNCTIONS 1 +#define _POSIX_C_SOURCE 1 + +#else + #include +#endif + + +#ifdef __APPLE__ + +// https://groups.yahoo.com/neo/groups/direwolf_packet/conversations/messages/2072 + +// The original suggestion was to add this to only ptt.c. +// I thought it would make sense to put it here, so it will apply to all files, +// consistently, rather than only one file ptt.c. + +// The placement of this is critical. Putting it earlier was a problem. +// https://github.com/wb2osz/direwolf/issues/113 + +// It needs to be after the include pthread.h because +// pthread.h pulls in , which redefines __DARWIN_C_LEVEL back to ansi, +// which breaks things. +// Maybe it should just go in ptt.c as originally suggested. + +// #define __DARWIN_C_LEVEL __DARWIN_C_FULL + +// There is a more involved patch here: +// https://groups.yahoo.com/neo/groups/direwolf_packet/conversations/messages/2458 + +#ifndef _DARWIN_C_SOURCE +#define _DARWIN_C_SOURCE +#endif + +// Defining _DARWIN_C_SOURCE ensures that the definition for the cfmakeraw function (or similar) +// are pulled in through the include file . + +#ifdef __DARWIN_C_LEVEL +#undef __DARWIN_C_LEVEL +#endif + +#define __DARWIN_C_LEVEL __DARWIN_C_FULL + +#endif + + +/* Not sure where to put these. */ + +/* Prefix with DW_ because /usr/include/gps.h uses a couple of these names. */ + +#ifndef G_UNKNOWN +#include "latlong.h" +#endif + + +#define DW_METERS_TO_FEET(x) ((x) == G_UNKNOWN ? G_UNKNOWN : (x) * 3.2808399) +#define DW_FEET_TO_METERS(x) ((x) == G_UNKNOWN ? G_UNKNOWN : (x) * 0.3048) +#define DW_KM_TO_MILES(x) ((x) == G_UNKNOWN ? G_UNKNOWN : (x) * 0.621371192) +#define DW_MILES_TO_KM(x) ((x) == G_UNKNOWN ? G_UNKNOWN : (x) * 1.609344) + +#define DW_KNOTS_TO_MPH(x) ((x) == G_UNKNOWN ? G_UNKNOWN : (x) * 1.15077945) +#define DW_KNOTS_TO_METERS_PER_SEC(x) ((x) == G_UNKNOWN ? G_UNKNOWN : (x) * 0.51444444444) +#define DW_MPH_TO_KNOTS(x) ((x) == G_UNKNOWN ? G_UNKNOWN : (x) * 0.868976) +#define DW_MPH_TO_METERS_PER_SEC(x) ((x) == G_UNKNOWN ? G_UNKNOWN : (x) * 0.44704) + +#define DW_MBAR_TO_INHG(x) ((x) == G_UNKNOWN ? G_UNKNOWN : (x) * 0.0295333727) + + + + +#if __WIN32__ + +typedef CRITICAL_SECTION dw_mutex_t; + +#define dw_mutex_init(x) \ + InitializeCriticalSection (x) + +/* This one waits for lock. */ + +#define dw_mutex_lock(x) \ + EnterCriticalSection (x) + +/* Returns non-zero if lock was obtained. */ + +#define dw_mutex_try_lock(x) \ + TryEnterCriticalSection (x) + +#define dw_mutex_unlock(x) \ + LeaveCriticalSection (x) + + +#else + +typedef pthread_mutex_t dw_mutex_t; + +#define dw_mutex_init(x) pthread_mutex_init (x, NULL) + +/* this one will wait. */ + +#define dw_mutex_lock(x) \ + { \ + int err; \ + err = pthread_mutex_lock (x); \ + if (err != 0) { \ + text_color_set(DW_COLOR_ERROR); \ + dw_printf ("INTERNAL ERROR %s %d pthread_mutex_lock returned %d", __FILE__, __LINE__, err); \ + exit (1); \ + } \ + } + +/* This one returns true if lock successful, false if not. */ +/* pthread_mutex_trylock returns 0 for success. */ + +#define dw_mutex_try_lock(x) \ + ({ \ + int err; \ + err = pthread_mutex_trylock (x); \ + if (err != 0 && err != EBUSY) { \ + text_color_set(DW_COLOR_ERROR); \ + dw_printf ("INTERNAL ERROR %s %d pthread_mutex_trylock returned %d", __FILE__, __LINE__, err); \ + exit (1); \ + } ; \ + ! err; \ + }) + +#define dw_mutex_unlock(x) \ + { \ + int err; \ + err = pthread_mutex_unlock (x); \ + if (err != 0) { \ + text_color_set(DW_COLOR_ERROR); \ + dw_printf ("INTERNAL ERROR %s %d pthread_mutex_unlock returned %d", __FILE__, __LINE__, err); \ + exit (1); \ + } \ + } + +#endif + + + +// Formerly used write/read on Linux, for some forgotten reason, +// but always using send/recv makes more sense. +// Need option to prevent a SIGPIPE signal on Linux. (added for 1.5 beta 2) + +#if __WIN32__ || __APPLE__ +#define SOCK_SEND(s,data,size) send(s,data,size,0) +#else +#define SOCK_SEND(s,data,size) send(s,data,size, MSG_NOSIGNAL) +#endif +#define SOCK_RECV(s,data,size) recv(s,data,size,0) + + +/* Platform differences for string functions. */ + + +// Windows is missing a few which are available on Unix/Linux platforms. +// We provide our own copies when building on Windows. + +#if __WIN32__ +char *strsep(char **stringp, const char *delim); +char *strtok_r(char *str, const char *delim, char **saveptr); +#endif + +// Don't recall why I added this for everyone rather than only for Windows. +// Potential problem if some C library declares it a little differently. +char *strcasestr(const char *S, const char *FIND); + + +// cmake tries to determine whether strlcpy and strlcat are provided by the C runtime library. +// +// ../CMakeLists.txt:check_symbol_exists(strlcpy string.h HAVE_STRLCPY) +// +// It sets HAVE_STRLCPY and HAVE_STRLCAT if the corresponding functions are declared. +// Unfortunately this does not work right for glibc 2.38 which declares the functions +// like this: +// +// extern __typeof (strlcpy) __strlcpy; +// libc_hidden_proto (__strlcpy) +// extern __typeof (strlcat) __strlcat; +// libc_hidden_proto (__strlcat) +// +// Rather than the normal way found in earlier versions: +// +// extern char *strcpy (char *__restrict __dest, const char *__restrict __src) +// +// Perhaps a later version of cmake will recognize this form but the version I'm +// using does not. +// So, our work around is to assume these functions are available for glibc >= 2.38. +// +// In theory, cmake should be able to find the version of the C runtime library, +// but I could not get it to work. So we have the test here. We will still build +// own library with the strl... functions but this does not cause a problem +// because they have special debug names which will not cause a conflict. + +#ifdef __GLIBC__ +#if (__GLIBC__ > 2) || ((__GLIBC__ == 2) && (__GLIBC_MINOR__ >= 38)) +// These functions first added in 2.38. +//#warning "DEBUG - glibc >= 2.38" +#define HAVE_STRLCPY 1 +#define HAVE_STRLCAT 1 +#else +//#warning "DEBUG - glibc < 2.38" +#endif +#endif + +#define DEBUG_STRL 1 // Extra Debug version when using our own strlcpy, strlcat. + // Should be ignored if not supplying our own. + +#ifndef HAVE_STRLCPY // Need to supply our own. +#if DEBUG_STRL +#define strlcpy(dst,src,siz) strlcpy_debug(dst,src,siz,__FILE__,__func__,__LINE__) +size_t strlcpy_debug(char *__restrict__ dst, const char *__restrict__ src, size_t siz, const char *file, const char *func, int line); +#else +#define strlcpy(dst,src,siz) strlcpy_debug(dst,src,siz) +size_t strlcpy_debug(char *__restrict__ dst, const char *__restrict__ src, size_t siz); +#endif /* DEBUG_STRL */ +#endif + +#ifndef HAVE_STRLCAT // Need to supply our own. +#if DEBUG_STRL +#define strlcat(dst,src,siz) strlcat_debug(dst,src,siz,__FILE__,__func__,__LINE__) +size_t strlcat_debug(char *__restrict__ dst, const char *__restrict__ src, size_t siz, const char *file, const char *func, int line); +#else +#define strlcat(dst,src,siz) strlcat_debug(dst,src,siz) +size_t strlcat_debug(char *__restrict__ dst, const char *__restrict__ src, size_t siz); +#endif /* DEBUG_STRL */ +#endif + + +#endif /* ifndef DIREWOLF_H */ diff --git a/src/dlq.c b/src/dlq.c new file mode 100644 index 00000000..f56b8649 --- /dev/null +++ b/src/dlq.c @@ -0,0 +1,1332 @@ +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// +// Copyright (C) 2014, 2015, 2016, 2018 John Langner, WB2OSZ +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . +// + + +/*------------------------------------------------------------------ + * + * Module: dlq.c + * + * Purpose: Received frame queue. + * + * Description: In earlier versions, the main thread read from the + * audio device and performed the receive demodulation/decoding. + * + * Since version 1.2 we have a separate receive thread + * for each audio device. This queue is used to collect + * received frames from all channels and process them + * serially. + * + * In version 1.4, other types of events also go into this + * queue and we use it to drive the data link state machine. + * + *---------------------------------------------------------------*/ + +#include "direwolf.h" + +#include +#include +#include +#include +#include +#if __WIN32__ +#else +#include +#endif + +#include "ax25_pad.h" +#include "textcolor.h" +#include "audio.h" +#include "dlq.h" +#include "dedupe.h" +#include "dtime_now.h" + + +/* The queue is a linked list of these. */ + +static struct dlq_item_s *queue_head = NULL; /* Head of linked list for queue. */ + +#if __WIN32__ + +// TODO1.2: use dw_mutex_t + +static CRITICAL_SECTION dlq_cs; /* Critical section for updating queues. */ + +static HANDLE wake_up_event; /* Notify received packet processing thread when queue not empty. */ + +#else + +static pthread_mutex_t dlq_mutex; /* Critical section for updating queues. */ + +static pthread_cond_t wake_up_cond; /* Notify received packet processing thread when queue not empty. */ + +static pthread_mutex_t wake_up_mutex; /* Required by cond_wait. */ + +static volatile int recv_thread_is_waiting = 0; + +#endif + +static int was_init = 0; /* was initialization performed? */ + +static void append_to_queue (struct dlq_item_s *pnew); + +static volatile int s_new_count = 0; /* To detect memory leak for queue items. */ +static volatile int s_delete_count = 0; // TODO: need to test. + + +static volatile int s_cdata_new_count = 0; /* To detect memory leak for connected mode data. */ +static volatile int s_cdata_delete_count = 0; // TODO: need to test. + + + +/*------------------------------------------------------------------- + * + * Name: dlq_init + * + * Purpose: Initialize the queue. + * + * Inputs: None. + * + * Outputs: + * + * Description: Initialize the queue to be empty and set up other + * mechanisms for sharing it between different threads. + * + *--------------------------------------------------------------------*/ + + +void dlq_init (void) +{ +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("dlq_init ( )\n"); +#endif + + queue_head = NULL; + + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("dlq_init: pthread_mutex_init...\n"); +#endif + +#if __WIN32__ + InitializeCriticalSection (&dlq_cs); +#else + int err; + err = pthread_mutex_init (&wake_up_mutex, NULL); + if (err != 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("dlq_init: pthread_mutex_init err=%d", err); + perror (""); + exit (EXIT_FAILURE); + } + err = pthread_mutex_init (&dlq_mutex, NULL); + if (err != 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("dlq_init: pthread_mutex_init err=%d", err); + perror (""); + exit (EXIT_FAILURE); + } +#endif + + + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("dlq_init: pthread_cond_init...\n"); +#endif + +#if __WIN32__ + + wake_up_event = CreateEvent (NULL, 0, 0, NULL); + + if (wake_up_event == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("dlq_init: pthread_cond_init: can't create receive wake up event"); + exit (1); + } + +#else + err = pthread_cond_init (&wake_up_cond, NULL); + + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("dlq_init: pthread_cond_init returns %d\n", err); +#endif + + + if (err != 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("dlq_init: pthread_cond_init err=%d", err); + perror (""); + exit (1); + } + + recv_thread_is_waiting = 0; +#endif + + was_init = 1; + +} /* end dlq_init */ + + + +/*------------------------------------------------------------------- + * + * Name: dlq_rec_frame + * + * Purpose: Add a received packet to the end of the queue. + * Normally this was received over the radio but we can create + * our own from APRStt or beaconing. + * + * This would correspond to PH-DATA Indication in the AX.25 protocol spec. + * + * Inputs: chan - Channel, 0 is first. + * + * subchan - Which modem caught it. + * Special case -1 for APRStt gateway. + * + * slice - Which slice we picked. + * + * pp - Address of packet object. + * Caller should NOT make any references to + * it after this point because it could + * be deleted at any time. + * + * alevel - Audio level, range of 0 - 100. + * (Special case, use negative to skip + * display of audio level line. + * Use -2 to indicate DTMF message.) + * + * fec_type - Was it from FX.25 or IL2P? Need to know because + * meaning of retries is different. + * + * retries - Level of correction used. + * + * spectrum - Display of how well multiple decoders did. + * + * + * IMPORTANT! Don't make an further references to the packet object after + * giving it to dlq_append. + * + *--------------------------------------------------------------------*/ + +void dlq_rec_frame (int chan, int subchan, int slice, packet_t pp, alevel_t alevel, fec_type_t fec_type, retry_t retries, char *spectrum) +{ + + struct dlq_item_s *pnew; + + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("dlq_rec_frame (chan=%d, pp=%p, ...)\n", chan, pp); +#endif + + assert (chan >= 0 && chan < MAX_TOTAL_CHANS); // TOTAL to include virtual channels. + + if (pp == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("INTERNAL ERROR: dlq_rec_frame NULL packet pointer. Please report this!\n"); + return; + } + +#if AX25MEMDEBUG + + if (ax25memdebug_get()) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("dlq_rec_frame (chan=%d.%d, seq=%d, ...)\n", chan, subchan, ax25memdebug_seq(pp)); + } +#endif + + +/* Allocate a new queue item. */ + + pnew = (struct dlq_item_s *) calloc (sizeof(struct dlq_item_s), 1); + if (pnew == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("FATAL ERROR: Out of memory.\n"); + exit (EXIT_FAILURE); + } + s_new_count++; + + if (s_new_count > s_delete_count + 50) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("INTERNAL ERROR: DLQ memory leak, new=%d, delete=%d\n", s_new_count, s_delete_count); + } + + pnew->nextp = NULL; + pnew->type = DLQ_REC_FRAME; + pnew->chan = chan; + pnew->slice = slice; + pnew->subchan = subchan; + pnew->pp = pp; + pnew->alevel = alevel; + pnew->fec_type = fec_type; + pnew->retries = retries; + if (spectrum == NULL) + strlcpy(pnew->spectrum, "", sizeof(pnew->spectrum)); + else + strlcpy(pnew->spectrum, spectrum, sizeof(pnew->spectrum)); + +/* Put it into queue. */ + + append_to_queue (pnew); + +} /* end dlq_rec_frame */ + + + +/*------------------------------------------------------------------- + * + * Name: append_to_queue + * + * Purpose: Append some type of event to queue. + * This includes frames received over the radio, + * requests from client applications, and notifications + * from the frame transmission process. + * + * + * Inputs: pnew - Pointer to queue element structure. + * + * Outputs: Information is appended to queue. + * + * Description: Add item to end of linked list. + * Signal the receive processing thread if the queue was formerly empty. + * + *--------------------------------------------------------------------*/ + +static void append_to_queue (struct dlq_item_s *pnew) +{ + struct dlq_item_s *plast; + int queue_length = 0; + + if ( ! was_init) { + dlq_init (); + } + + pnew->nextp = NULL; + +#if DEBUG1 + text_color_set(DW_COLOR_DEBUG); + dw_printf ("dlq append_to_queue: enter critical section\n"); +#endif +#if __WIN32__ + EnterCriticalSection (&dlq_cs); +#else + int err; + err = pthread_mutex_lock (&dlq_mutex); + if (err != 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("dlq append_to_queue: pthread_mutex_lock err=%d", err); + perror (""); + exit (1); + } +#endif + + if (queue_head == NULL) { + queue_head = pnew; + queue_length = 1; + } + else { + queue_length = 2; /* head + new one */ + plast = queue_head; + while (plast->nextp != NULL) { + plast = plast->nextp; + queue_length++; + } + plast->nextp = pnew; + } + + +#if __WIN32__ + LeaveCriticalSection (&dlq_cs); +#else + err = pthread_mutex_unlock (&dlq_mutex); + if (err != 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("dlq append_to_queue: pthread_mutex_unlock err=%d", err); + perror (""); + exit (1); + } +#endif +#if DEBUG1 + text_color_set(DW_COLOR_DEBUG); + dw_printf ("dlq append_to_queue: left critical section\n"); + dw_printf ("dlq append_to_queue (): about to wake up recv processing thread.\n"); +#endif + + +/* + * Bug: June 2015, version 1.2 + * + * It has long been known that we will eventually block trying to write to a + * pseudo terminal if nothing is reading from the other end. There is even + * a warning at start up time: + * + * Virtual KISS TNC is available on /dev/pts/2 + * WARNING - Dire Wolf will hang eventually if nothing is reading from it. + * Created symlink /tmp/kisstnc -> /dev/pts/2 + * + * In earlier versions, where the audio input and demodulation was in the main + * thread, that would stop and it was pretty obvious something was wrong. + * In version 1.2, the audio in / demodulating was moved to a device specific + * thread. Packet objects are appended to this queue. + * + * The main thread should wake up and process them which includes printing and + * forwarding to clients over multiple protocols and transport methods. + * Just before the 1.2 release someone reported a memory leak which only showed + * up after about 20 hours. It happened to be on a Cubie Board 2, which shouldn't + * make a difference unless there was some operating system difference. + * (cubieez 2.0 is based on Debian wheezy, just like Raspian.) + * + * The debug output revealed: + * + * It was using AX.25 for Linux (not APRS). + * The pseudo terminal KISS interface was being used. + * Transmitting was continuing fine. (So something must be writing to the other end.) + * Frames were being received and appended to this queue. + * They were not coming out of the queue. + * + * My theory is that writing to the the pseudo terminal is blocking so the + * main thread is stopped. It's not taking anything from this queue and we detect + * it as a memory leak. + * + * Add a new check here and complain if the queue is growing too large. + * That will get us a step closer to the root cause. + * This has been documented in the User Guide and the CHANGES.txt file which is + * a minimal version of Release Notes. + * The proper fix will be somehow avoiding or detecting the pseudo terminal filling up + * and blocking on a write. + */ + + if (queue_length > 10) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Received frame queue is out of control. Length=%d.\n", queue_length); + dw_printf ("Reader thread is probably frozen.\n"); + dw_printf ("This can be caused by using a pseudo terminal (direwolf -p) where another\n"); + dw_printf ("application is not reading the frames from the other side.\n"); + } + + + +#if __WIN32__ + SetEvent (wake_up_event); +#else + if (recv_thread_is_waiting) { + + err = pthread_mutex_lock (&wake_up_mutex); + if (err != 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("dlq append_to_queue: pthread_mutex_lock wu err=%d", err); + perror (""); + exit (1); + } + + err = pthread_cond_signal (&wake_up_cond); + if (err != 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("dlq append_to_queue: pthread_cond_signal err=%d", err); + perror (""); + exit (1); + } + + err = pthread_mutex_unlock (&wake_up_mutex); + if (err != 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("dlq append_to_queue: pthread_mutex_unlock wu err=%d", err); + perror (""); + exit (1); + } + } +#endif + +} /* end append_to_queue */ + + +/*------------------------------------------------------------------- + * + * Name: dlq_connect_request + * + * Purpose: Client application has requested connection to another station. + * + * Inputs: addrs - Source (owncall), destination (peercall), + * and possibly digipeaters. + * + * num_addr - Number of addresses. 2 to 10. + * + * chan - Channel, 0 is first. + * + * client - Client application instance. We could have multiple + * applications, all on the same channel, connecting + * to different stations. We need to know which one + * should get the results. + * + * pid - Protocol ID for data. Normally 0xf0 but the API + * allows the client app to use something non-standard + * for special situations. + * TODO: remove this. PID is only for I and UI frames. + * + * Outputs: Request is appended to queue for processing by + * the data link state machine. + * + *--------------------------------------------------------------------*/ + +void dlq_connect_request (char addrs[AX25_MAX_ADDRS][AX25_MAX_ADDR_LEN], int num_addr, int chan, int client, int pid) +{ + struct dlq_item_s *pnew; + + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("dlq_connect_request (...)\n"); +#endif + + assert (chan >= 0 && chan < MAX_CHANS); + +/* Allocate a new queue item. */ + + pnew = (struct dlq_item_s *) calloc (sizeof(struct dlq_item_s), 1); + if (pnew == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("FATAL ERROR: Out of memory.\n"); + exit (EXIT_FAILURE); + } + s_new_count++; + + pnew->type = DLQ_CONNECT_REQUEST; + pnew->chan = chan; + memcpy (pnew->addrs, addrs, sizeof(pnew->addrs)); + pnew->num_addr = num_addr; + pnew->client = client; + +/* Put it into queue. */ + + append_to_queue (pnew); + +} /* end dlq_connect_request */ + + + +/*------------------------------------------------------------------- + * + * Name: dlq_disconnect_request + * + * Purpose: Client application has requested to disconnect. + * + * Inputs: addrs - Source (owncall), destination (peercall), + * and possibly digipeaters. + * + * num_addr - Number of addresses. 2 to 10. + * Only first two matter in this case. + * + * chan - Channel, 0 is first. + * + * client - Client application instance. We could have multiple + * applications, all on the same channel, connecting + * to different stations. We need to know which one + * should get the results. + * + * Outputs: Request is appended to queue for processing by + * the data link state machine. + * + *--------------------------------------------------------------------*/ + +void dlq_disconnect_request (char addrs[AX25_MAX_ADDRS][AX25_MAX_ADDR_LEN], int num_addr, int chan, int client) +{ + struct dlq_item_s *pnew; +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("dlq_disconnect_request (...)\n"); +#endif + + assert (chan >= 0 && chan < MAX_CHANS); + +/* Allocate a new queue item. */ + + pnew = (struct dlq_item_s *) calloc (sizeof(struct dlq_item_s), 1); + if (pnew == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("FATAL ERROR: Out of memory.\n"); + exit (EXIT_FAILURE); + } + s_new_count++; + + pnew->type = DLQ_DISCONNECT_REQUEST; + pnew->chan = chan; + memcpy (pnew->addrs, addrs, sizeof(pnew->addrs)); + pnew->num_addr = num_addr; + pnew->client = client; + +/* Put it into queue. */ + + append_to_queue (pnew); + +} /* end dlq_disconnect_request */ + + + +/*------------------------------------------------------------------- + * + * Name: dlq_outstanding_frames_request + * + * Purpose: Client application wants to know number of outstanding information + * frames supplied, supplied by the client, that have not yet been + * delivered to the remote station. + * + * Inputs: addrs - Source (owncall), destination (peercall) + * + * num_addr - Number of addresses. Should be 2. + * If more they will be ignored. + * + * chan - Channel, 0 is first. + * + * client - Client application instance. We could have multiple + * applications, all on the same channel, connecting + * to different stations. We need to know which one + * should get the results. + * + * Outputs: Request is appended to queue for processing by + * the data link state machine. + * + * Description: The data link state machine will count up all information frames + * for the given source(mycall) / destination(remote) / channel link. + * A 'Y' response will be sent back to the client application. + * + *--------------------------------------------------------------------*/ + +void dlq_outstanding_frames_request (char addrs[AX25_MAX_ADDRS][AX25_MAX_ADDR_LEN], int num_addr, int chan, int client) +{ + struct dlq_item_s *pnew; +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("dlq_outstanding_frames_request (...)\n"); +#endif + + assert (chan >= 0 && chan < MAX_CHANS); + +/* Allocate a new queue item. */ + + pnew = (struct dlq_item_s *) calloc (sizeof(struct dlq_item_s), 1); + if (pnew == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("FATAL ERROR: Out of memory.\n"); + exit (EXIT_FAILURE); + } + s_new_count++; + + pnew->type = DLQ_OUTSTANDING_FRAMES_REQUEST; + pnew->chan = chan; + memcpy (pnew->addrs, addrs, sizeof(pnew->addrs)); + pnew->num_addr = num_addr; + pnew->client = client; + +/* Put it into queue. */ + + append_to_queue (pnew); + +} /* end dlq_outstanding_frames_request */ + + + + + + +/*------------------------------------------------------------------- + * + * Name: dlq_xmit_data_request + * + * Purpose: Client application has requested transmission of connected + * data over an established link. + * + * Inputs: addrs - Source (owncall), destination (peercall), + * and possibly digipeaters. + * + * num_addr - Number of addresses. 2 to 10. + * First two are used to uniquely identify link. + * Any digipeaters involved are remembered + * from when the link was established. + * + * chan - Channel, 0 is first. + * + * client - Client application instance. + * + * pid - Protocol ID for data. Normally 0xf0 but the API + * allows the client app to use something non-standard + * for special situations. + * + * xdata_ptr - Pointer to block of data. + * + * xdata_len - Length of data in bytes. + * + * Outputs: Request is appended to queue for processing by + * the data link state machine. + * + *--------------------------------------------------------------------*/ + + +void dlq_xmit_data_request (char addrs[AX25_MAX_ADDRS][AX25_MAX_ADDR_LEN], int num_addr, int chan, int client, int pid, char *xdata_ptr, int xdata_len) +{ + struct dlq_item_s *pnew; + + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("dlq_xmit_data_request (...)\n"); +#endif + + assert (chan >= 0 && chan < MAX_CHANS); + +/* Allocate a new queue item. */ + + pnew = (struct dlq_item_s *) calloc (sizeof(struct dlq_item_s), 1); + if (pnew == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("FATAL ERROR: Out of memory.\n"); + exit (EXIT_FAILURE); + } + s_new_count++; + + pnew->type = DLQ_XMIT_DATA_REQUEST; + pnew->chan = chan; + memcpy (pnew->addrs, addrs, sizeof(pnew->addrs)); + pnew->num_addr = num_addr; + pnew->client = client; + +/* Attach the transmit data. */ + + pnew->txdata = cdata_new(pid,xdata_ptr,xdata_len); + +/* Put it into queue. */ + + append_to_queue (pnew); + +} /* end dlq_xmit_data_request */ + + + +/*------------------------------------------------------------------- + * + * Name: dlq_register_callsign + * dlq_unregister_callsign + * + * Purpose: Register callsigns that we will recognize for incoming connection requests. + * + * Inputs: addr - Callsign to [un]register. + * + * chan - Channel, 0 is first. + * + * client - Client application instance. + * + * Outputs: Request is appended to queue for processing by + * the data link state machine. + * + * Description: The data link state machine does not use MYCALL from the APRS configuration. + * For outgoing frames, the client supplies the source callsign. + * For incoming connection requests, we need to know what address(es) to respond to. + * + * Note that one client application can register multiple callsigns for + * multiple channels. + * Different clients can register different different addresses on the same channel. + * + *--------------------------------------------------------------------*/ + + +void dlq_register_callsign (char *addr, int chan, int client) +{ + struct dlq_item_s *pnew; + + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("dlq_register_callsign (%s, chan=%d, client=%d)\n", addr, chan, client); +#endif + + assert (chan >= 0 && chan < MAX_CHANS); + +/* Allocate a new queue item. */ + + pnew = (struct dlq_item_s *) calloc (sizeof(struct dlq_item_s), 1); + if (pnew == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("FATAL ERROR: Out of memory.\n"); + exit (EXIT_FAILURE); + } + s_new_count++; + + pnew->type = DLQ_REGISTER_CALLSIGN; + pnew->chan = chan; + strlcpy (pnew->addrs[0], addr, sizeof(pnew->addrs[0])); + pnew->num_addr = 1; + pnew->client = client; + +/* Put it into queue. */ + + append_to_queue (pnew); + +} /* end dlq_register_callsign */ + + +void dlq_unregister_callsign (char *addr, int chan, int client) +{ + struct dlq_item_s *pnew; + + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("dlq_unregister_callsign (%s, chan=%d, client=%d)\n", addr, chan, client); +#endif + + assert (chan >= 0 && chan < MAX_CHANS); + +/* Allocate a new queue item. */ + + pnew = (struct dlq_item_s *) calloc (sizeof(struct dlq_item_s), 1); + if (pnew == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("FATAL ERROR: Out of memory.\n"); + exit (EXIT_FAILURE); + } + s_new_count++; + + pnew->type = DLQ_UNREGISTER_CALLSIGN; + pnew->chan = chan; + strlcpy (pnew->addrs[0], addr, sizeof(pnew->addrs[0])); + pnew->num_addr = 1; + pnew->client = client; + +/* Put it into queue. */ + + append_to_queue (pnew); + +} /* end dlq_unregister_callsign */ + + + +/*------------------------------------------------------------------- + * + * Name: dlq_channel_busy + * + * Purpose: Inform data link state machine about activity on the radio channel. + * + * Inputs: chan - Radio channel number. + * + * activity - OCTYPE_PTT or OCTYPE_DCD, as defined in audio.h. + * Other values will be discarded. + * + * status - 1 for active or 0 for quiet. + * + * Outputs: Request is appended to queue for processing by + * the data link state machine. + * + * Description: Notify the link state machine about changes in carrier detect + * and our transmitter. + * This is needed for pausing some of our timers. For example, + * if we transmit a frame and expect a response in 3 seconds, that + * might be delayed because someone else is using the channel. + * + *--------------------------------------------------------------------*/ + +void dlq_channel_busy (int chan, int activity, int status) +{ + struct dlq_item_s *pnew; + + if (activity == OCTYPE_PTT || activity == OCTYPE_DCD) { +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("dlq_channel_busy (...)\n"); +#endif + + +/* Allocate a new queue item. */ + + pnew = (struct dlq_item_s *) calloc (sizeof(struct dlq_item_s), 1); + if (pnew == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("FATAL ERROR: Out of memory.\n"); + exit (EXIT_FAILURE); + } + s_new_count++; + + pnew->type = DLQ_CHANNEL_BUSY; + pnew->chan = chan; + pnew->activity = activity; + pnew->status = status; + +/* Put it into queue. */ + + append_to_queue (pnew); + } + +} /* end dlq_channel_busy */ + + + + + +/*------------------------------------------------------------------- + * + * Name: dlq_seize_confirm + * + * Purpose: Inform data link state machine that the transmitter is on. + * This is in response to lm_seize_request. + * + * Inputs: chan - Radio channel number. + * + * Outputs: Request is appended to queue for processing by + * the data link state machine. + * + * Description: When removed from the data link state machine queue, this + * becomes lm_seize_confirm. + * + *--------------------------------------------------------------------*/ + +void dlq_seize_confirm (int chan) +{ + struct dlq_item_s *pnew; + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("dlq_seize_confirm (chan=%d)\n", chan); +#endif + + +/* Allocate a new queue item. */ + + pnew = (struct dlq_item_s *) calloc (sizeof(struct dlq_item_s), 1); + if (pnew == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("FATAL ERROR: Out of memory.\n"); + exit (EXIT_FAILURE); + } + s_new_count++; + + pnew->type = DLQ_SEIZE_CONFIRM; + pnew->chan = chan; + +/* Put it into queue. */ + + append_to_queue (pnew); + + +} /* end dlq_seize_confirm */ + + + + +/*------------------------------------------------------------------- + * + * Name: dlq_client_cleanup + * + * Purpose: Client application has disappeared. + * i.e. The TCP connection has been broken. + * + * Inputs: client - Client application instance. + * + * Outputs: Request is appended to queue for processing by + * the data link state machine. + * + * Description: Notify the link state machine that given client has gone away. + * Clean up all information related to that client application. + * + *--------------------------------------------------------------------*/ + +void dlq_client_cleanup (int client) +{ + struct dlq_item_s *pnew; +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("dlq_client_cleanup (...)\n"); +#endif + + // assert (client >= 0 && client < MAX_NET_CLIENTS); + +/* Allocate a new queue item. */ + + pnew = (struct dlq_item_s *) calloc (sizeof(struct dlq_item_s), 1); + if (pnew == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("FATAL ERROR: Out of memory.\n"); + exit (EXIT_FAILURE); + } + s_new_count++; + + // All we care about is the client number. + + pnew->type = DLQ_CLIENT_CLEANUP; + pnew->client = client; + +/* Put it into queue. */ + + append_to_queue (pnew); + +} /* end dlq_client_cleanup */ + + + +/*------------------------------------------------------------------- + * + * Name: dlq_wait_while_empty + * + * Purpose: Sleep while the received data queue is empty rather than + * polling periodically. + * + * Inputs: timeout - Return at this time even if queue is empty. + * Zero for no timeout. + * + * Returns: True if timed out before any event arrived. + * + * Description: In version 1.4, we add timeout option so we can continue after + * some amount of time even if no events are in the queue. + * + *--------------------------------------------------------------------*/ + + +int dlq_wait_while_empty (double timeout) +{ + int timed_out_result = 0; + +#if DEBUG1 + text_color_set(DW_COLOR_DEBUG); + dw_printf ("dlq_wait_while_empty (%.3f)\n", timeout); +#endif + + if ( ! was_init) { + dlq_init (); + } + + + if (queue_head == NULL) { + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("dlq_wait_while_empty (): prepare to SLEEP...\n"); +#endif + + +#if __WIN32__ + + if (timeout != 0.0) { + + DWORD ms = (timeout - dtime_now()) * 1000; + if (ms <= 0) ms = 1; +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("WaitForSingleObject: timeout after %d ms\n", ms); +#endif + if (WaitForSingleObject (wake_up_event, ms) == WAIT_TIMEOUT) { + timed_out_result = 1; + } + } + else { + WaitForSingleObject (wake_up_event, INFINITE); + } + +#else + int err; + + err = pthread_mutex_lock (&wake_up_mutex); + if (err != 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("dlq_wait_while_empty: pthread_mutex_lock wu err=%d", err); + perror (""); + exit (1); + } + + recv_thread_is_waiting = 1; + if (timeout != 0.0) { + struct timespec abstime; + + abstime.tv_sec = (time_t)(long)timeout; + abstime.tv_nsec = (long)((timeout - (long)abstime.tv_sec) * 1000000000.0); + + err = pthread_cond_timedwait (&wake_up_cond, &wake_up_mutex, &abstime); + if (err == ETIMEDOUT) { + timed_out_result = 1; + } + } + else { + err = pthread_cond_wait (&wake_up_cond, &wake_up_mutex); + } + recv_thread_is_waiting = 0; + + err = pthread_mutex_unlock (&wake_up_mutex); + if (err != 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("dlq_wait_while_empty: pthread_mutex_unlock wu err=%d", err); + perror (""); + exit (1); + } +#endif + } + + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("dlq_wait_while_empty () returns timedout=%d\n", timed_out_result); +#endif + return (timed_out_result); + +} /* end dlq_wait_while_empty */ + + + +/*------------------------------------------------------------------- + * + * Name: dlq_remove + * + * Purpose: Remove an item from the head of the queue. + * + * Inputs: None. + * + * Returns: Pointer to a queue item. Caller is responsible for deleting it. + * NULL if queue is empty. + * + *--------------------------------------------------------------------*/ + + +struct dlq_item_s *dlq_remove (void) +{ + + struct dlq_item_s *result = NULL; + //int err; + +#if DEBUG1 + text_color_set(DW_COLOR_DEBUG); + dw_printf ("dlq_remove() enter critical section\n"); +#endif + + if ( ! was_init) { + dlq_init (); + } + +#if __WIN32__ + EnterCriticalSection (&dlq_cs); +#else + int err; + + err = pthread_mutex_lock (&dlq_mutex); + if (err != 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("dlq_remove: pthread_mutex_lock err=%d", err); + perror (""); + exit (1); + } +#endif + + if (queue_head != NULL) { + result = queue_head; + queue_head = queue_head->nextp; + } + +#if __WIN32__ + LeaveCriticalSection (&dlq_cs); +#else + err = pthread_mutex_unlock (&dlq_mutex); + if (err != 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("dlq_remove: pthread_mutex_unlock err=%d", err); + perror (""); + exit (1); + } +#endif + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("dlq_remove() returns \n"); +#endif + +#if AX25MEMDEBUG + + if (ax25memdebug_get() && result != NULL) { + text_color_set(DW_COLOR_DEBUG); + if (result->pp != NULL) { +// TODO: mnemonics for type. + dw_printf ("dlq_remove (type=%d, chan=%d.%d, seq=%d, ...)\n", result->type, result->chan, result->subchan, ax25memdebug_seq(result->pp)); + } + else { + dw_printf ("dlq_remove (type=%d, chan=%d, ...)\n", result->type, result->chan); + } + } +#endif + + return (result); +} + + +/*------------------------------------------------------------------- + * + * Name: dlq_delete + * + * Purpose: Release storage used by a queue item. + * + * Inputs: pitem - Pointer to a queue item. + * + *--------------------------------------------------------------------*/ + + +void dlq_delete (struct dlq_item_s *pitem) +{ + if (pitem == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("INTERNAL ERROR: dlq_delete() given NULL pointer.\n"); + return; + } + + s_delete_count++; + + if (pitem->pp != NULL) { + ax25_delete (pitem->pp); + pitem->pp = NULL; + } + + if (pitem->txdata != NULL) { + cdata_delete (pitem->txdata); + pitem->txdata = NULL; + } + + free (pitem); + +} /* end dlq_delete */ + + + + +/*------------------------------------------------------------------- + * + * Name: cdata_new + * + * Purpose: Allocate blocks of data for sending and receiving connected data. + * + * Inputs: pid - protocol id. + * data - pointer to data. Can be NULL for segment reassembler. + * len - length of data. + * + * Returns: Structure with a copy of the data. + * + * Description: The flow goes like this: + * + * Client application extablishes a connection with another station. + * Client application calls "dlq_xmit_data_request." + * A copy of the data is made with this function and attached to the queue item. + * The txdata block is attached to the appropriate link state machine. + * At the proper time, it is transmitted in an I frame. + * It needs to be kept around in case it needs to be retransmitted. + * When no longer needed, it is freed with cdata_delete. + * + *--------------------------------------------------------------------*/ + + +cdata_t *cdata_new (int pid, char *data, int len) +{ + int size; + cdata_t *cdata; + + s_cdata_new_count++; + + /* Round up the size to the next 128 bytes. */ + /* The theory is that a smaller number of unique sizes might be */ + /* beneficial for memory fragmentation and garbage collection. */ + + size = ( len + 127 ) & ~0x7f; + + cdata = malloc ( sizeof(cdata_t) + size ); + if (cdata == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("FATAL ERROR: Out of memory.\n"); + exit (EXIT_FAILURE); + } + + cdata->magic = TXDATA_MAGIC; + cdata->next = NULL; + cdata->pid = pid; + cdata->size = size; + cdata->len = len; + + assert (len >= 0 && len <= size); + if (data == NULL) { + memset (cdata->data, '?', size); + } + else { + memcpy (cdata->data, data, len); + } + return (cdata); + +} /* end cdata_new */ + + + +/*------------------------------------------------------------------- + * + * Name: cdata_delete + * + * Purpose: Release storage used by a connected data block. + * + * Inputs: cdata - Pointer to a data block. + * + *--------------------------------------------------------------------*/ + + +void cdata_delete (cdata_t *cdata) +{ + if (cdata == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("INTERNAL ERROR: cdata_delete() given NULL pointer.\n"); + return; + } + + if (cdata->magic != TXDATA_MAGIC) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("INTERNAL ERROR: cdata_delete() given corrupted data.\n"); + return; + } + + s_cdata_delete_count++; + + cdata->magic = 0; + + free (cdata); + +} /* end cdata_delete */ + + +/*------------------------------------------------------------------- + * + * Name: cdata_check_leak + * + * Purpose: Check for memory leak of cdata items. + * + * Description: This is called when we expect no outstanding allocations. + * + *--------------------------------------------------------------------*/ + + +void cdata_check_leak (void) +{ + if (s_cdata_delete_count != s_cdata_new_count) { + + text_color_set(DW_COLOR_ERROR); + dw_printf ("Internal Error, %s, new=%d, delete=%d\n", __func__, s_cdata_new_count, s_cdata_delete_count); + } + +} /* end cdata_check_leak */ + + + +/* end dlq.c */ diff --git a/src/dlq.h b/src/dlq.h new file mode 100644 index 00000000..fdac1c0c --- /dev/null +++ b/src/dlq.h @@ -0,0 +1,151 @@ + +/*------------------------------------------------------------------ + * + * Module: dlq.h + * + *---------------------------------------------------------------*/ + +#ifndef DLQ_H +#define DLQ_H 1 + +#include "ax25_pad.h" +#include "audio.h" + + +/* A transmit or receive data block for connected mode. */ + +typedef struct cdata_s { + int magic; /* For integrity checking. */ + +#define TXDATA_MAGIC 0x09110911 + + struct cdata_s *next; /* Pointer to next when part of a list. */ + + int pid; /* Protocol id. */ + + int size; /* Number of bytes allocated. */ + + int len; /* Number of bytes actually used. */ + + char data[]; /* Variable length data. */ + +} cdata_t; + + + + +/* Types of things that can be in queue. */ + +typedef enum dlq_type_e {DLQ_REC_FRAME, DLQ_CONNECT_REQUEST, DLQ_DISCONNECT_REQUEST, DLQ_XMIT_DATA_REQUEST, DLQ_REGISTER_CALLSIGN, DLQ_UNREGISTER_CALLSIGN, DLQ_OUTSTANDING_FRAMES_REQUEST, DLQ_CHANNEL_BUSY, DLQ_SEIZE_CONFIRM, DLQ_CLIENT_CLEANUP} dlq_type_t; + +typedef enum fec_type_e {fec_type_none=0, fec_type_fx25=1, fec_type_il2p=2} fec_type_t; + + +/* A queue item. */ + +// TODO: call this event rather than item. +// TODO: should add fences. + +typedef struct dlq_item_s { + + struct dlq_item_s *nextp; /* Next item in queue. */ + + dlq_type_t type; /* Type of item. */ + /* See enum definition above. */ + + int chan; /* Radio channel of origin. */ + +// I'm not worried about amount of memory used but this might be a +// little clearer if a union was used for the different event types. + +// Used for received frame. + + int subchan; /* Winning "subchannel" when using multiple */ + /* decoders on one channel. */ + /* Special case, -1 means DTMF decoder. */ + /* Maybe we should have a different type in this case? */ + + int slice; /* Winning slicer. */ + + packet_t pp; /* Pointer to frame structure. */ + + alevel_t alevel; /* Audio level. */ + + fec_type_t fec_type; // Type of FEC for received signal: none, FX.25, or IL2P. + + retry_t retries; /* Effort expended to get a valid CRC. */ + /* Bits changed for regular AX.25. */ + /* Number of bytes fixed for FX.25. */ + + char spectrum[MAX_SUBCHANS*MAX_SLICERS+1]; /* "Spectrum" display for multi-decoders. */ + +// Used by requests from a client application, connect, etc. + + char addrs[AX25_MAX_ADDRS][AX25_MAX_ADDR_LEN]; + + int num_addr; /* Range 2 .. 10. */ + + int client; + + +// Used only by client request to transmit connected data. + + cdata_t *txdata; + +// Used for channel activity change. +// It is useful to know when the channel is busy either for carrier detect +// or when we are transmitting. + + int activity; /* OCTYPE_PTT for my transmission start/end. */ + /* OCTYPE_DCD if we hear someone else. */ + + int status; /* 1 for active or 0 for quiet. */ + +} dlq_item_t; + + + +void dlq_init (void); + + + +void dlq_rec_frame (int chan, int subchan, int slice, packet_t pp, alevel_t alevel, fec_type_t fec_type, retry_t retries, char *spectrum); + +void dlq_connect_request (char addrs[AX25_MAX_ADDRS][AX25_MAX_ADDR_LEN], int num_addr, int chan, int client, int pid); + +void dlq_disconnect_request (char addrs[AX25_MAX_ADDRS][AX25_MAX_ADDR_LEN], int num_addr, int chan, int client); + +void dlq_outstanding_frames_request (char addrs[AX25_MAX_ADDRS][AX25_MAX_ADDR_LEN], int num_addr, int chan, int client); + +void dlq_xmit_data_request (char addrs[AX25_MAX_ADDRS][AX25_MAX_ADDR_LEN], int num_addr, int chan, int client, int pid, char *xdata_ptr, int xdata_len); + +void dlq_register_callsign (char *addr, int chan, int client); + +void dlq_unregister_callsign (char *addr, int chan, int client); + +void dlq_channel_busy (int chan, int activity, int status); + +void dlq_seize_confirm (int chan); + +void dlq_client_cleanup (int client); + + + +int dlq_wait_while_empty (double timeout_val); + +struct dlq_item_s *dlq_remove (void); + +void dlq_delete (struct dlq_item_s *pitem); + + + +cdata_t *cdata_new (int pid, char *data, int len); + +void cdata_delete (cdata_t *txdata); + +void cdata_check_leak (void); + + +#endif + +/* end dlq.h */ diff --git a/src/dns_sd_avahi.c b/src/dns_sd_avahi.c new file mode 100644 index 00000000..63ce0b66 --- /dev/null +++ b/src/dns_sd_avahi.c @@ -0,0 +1,260 @@ +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// +// Copyright (C) 2020 Heikki Hannikainen, OH7LZB +// +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . + +/*------------------------------------------------------------------ + * + * Module: dns_sd_avahi.c + * + * Purpose: Announce the KISS over TCP service using DNS-SD via Avahi + * + * Description: + * + * Most people have typed in enough IP addresses and ports by now, and + * would rather just select an available TNC that is automatically + * discovered on the local network. Even more so on a mobile device + * such an Android or iOS phone or tablet. + * + * On Linux, the announcement can be made through Avahi, the mDNS + * framework commonly deployed on Linux systems. + * + * This is largely based on the publishing example of the Avahi library. + */ + +#ifdef USE_AVAHI_CLIENT + +#include +#include +#include + +#include +#include +#include +#include +#include +#include + +#include "dns_sd_dw.h" +#include "dns_sd_common.h" +#include "textcolor.h" + +static AvahiEntryGroup *group = NULL; +static AvahiSimplePoll *simple_poll = NULL; +static AvahiClient *client = NULL; +static char *name = NULL; +static int kiss_port = 0; + +pthread_t avahi_thread; + +static void create_services(AvahiClient *c); + +#define PRINT_PREFIX "DNS-SD: Avahi: " + +static void entry_group_callback(AvahiEntryGroup *g, AvahiEntryGroupState state, AVAHI_GCC_UNUSED void *userdata) +{ + assert(g == group || group == NULL); + group = g; + + /* Called whenever the entry group state changes */ + switch (state) { + case AVAHI_ENTRY_GROUP_ESTABLISHED : + /* The entry group has been established successfully */ + text_color_set(DW_COLOR_INFO); + dw_printf(PRINT_PREFIX "Service '%s' successfully registered.\n", name); + break; + case AVAHI_ENTRY_GROUP_COLLISION: { + char *n; + /* A service name collision with a remote service + * happened. Let's pick a new name. */ + n = avahi_alternative_service_name(name); + avahi_free(name); + name = n; + text_color_set(DW_COLOR_INFO); + dw_printf(PRINT_PREFIX "Service name collision, renaming service to '%s'\n", name); + /* And recreate the services */ + create_services(avahi_entry_group_get_client(g)); + break; + } + case AVAHI_ENTRY_GROUP_FAILURE: + text_color_set(DW_COLOR_ERROR); + dw_printf(PRINT_PREFIX "Entry group failure: %s\n", avahi_strerror(avahi_client_errno(avahi_entry_group_get_client(g)))); + /* Some kind of failure happened while we were registering our services */ + avahi_simple_poll_quit(simple_poll); + break; + case AVAHI_ENTRY_GROUP_UNCOMMITED: + case AVAHI_ENTRY_GROUP_REGISTERING: + ; + } +} + +static void create_services(AvahiClient *c) +{ + char *n; + int ret; + assert(c); + /* If this is the first time we're called, let's create a new + * entry group if necessary */ + if (!group) { + if (!(group = avahi_entry_group_new(c, entry_group_callback, NULL))) { + text_color_set(DW_COLOR_ERROR); + dw_printf(PRINT_PREFIX "avahi_entry_group_new() failed: %s\n", avahi_strerror(avahi_client_errno(c))); + goto fail; + } + } else { + avahi_entry_group_reset(group); + } + + /* If the group is empty (either because it was just created, or + * because it was reset previously, add our entries. */ + if (avahi_entry_group_is_empty(group)) { + text_color_set(DW_COLOR_INFO); + dw_printf(PRINT_PREFIX "Announcing KISS TCP on port %d as '%s'\n", kiss_port, name); + + /* Announce with AVAHI_PROTO_INET instead of AVAHI_PROTO_UNSPEC, since Dire Wolf currently + * only listens on IPv4. + */ + + if ((ret = avahi_entry_group_add_service(group, AVAHI_IF_UNSPEC, AVAHI_PROTO_INET, 0, name, DNS_SD_SERVICE, NULL, NULL, kiss_port, NULL)) < 0) { + if (ret == AVAHI_ERR_COLLISION) + goto collision; + text_color_set(DW_COLOR_ERROR); + dw_printf(PRINT_PREFIX "Failed to add _kiss-tnc._tcp service: %s\n", avahi_strerror(ret)); + goto fail; + } + + /* Tell the server to register the service */ + if ((ret = avahi_entry_group_commit(group)) < 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf(PRINT_PREFIX "Failed to commit entry group: %s\n", avahi_strerror(ret)); + goto fail; + } + } + return; + +collision: + /* A service name collision with a local service happened. Let's + * pick a new name */ + n = avahi_alternative_service_name(name); + avahi_free(name); + name = n; + text_color_set(DW_COLOR_INFO); + dw_printf(PRINT_PREFIX "Service name collision, renaming service to '%s'\n", name); + avahi_entry_group_reset(group); + create_services(c); + return; + +fail: + avahi_simple_poll_quit(simple_poll); +} + +static void client_callback(AvahiClient *c, AvahiClientState state, AVAHI_GCC_UNUSED void * userdata) +{ + assert(c); + /* Called whenever the client or server state changes */ + switch (state) { + case AVAHI_CLIENT_S_RUNNING: + /* The server has startup successfully and registered its host + * name on the network, so it's time to create our services */ + create_services(c); + break; + case AVAHI_CLIENT_FAILURE: + text_color_set(DW_COLOR_ERROR); + dw_printf(PRINT_PREFIX "Client failure: %s\n", avahi_strerror(avahi_client_errno(c))); + avahi_simple_poll_quit(simple_poll); + break; + case AVAHI_CLIENT_S_COLLISION: + /* Let's drop our registered services. When the server is back + * in AVAHI_SERVER_RUNNING state we will register them + * again with the new host name. */ + case AVAHI_CLIENT_S_REGISTERING: + /* The server records are now being established. This + * might be caused by a host name change. We need to wait + * for our own records to register until the host name is + * properly esatblished. */ + if (group) + avahi_entry_group_reset(group); + break; + case AVAHI_CLIENT_CONNECTING: + ; + } +} + +static void cleanup(void) +{ + /* Cleanup things */ + if (client) + avahi_client_free(client); + + if (simple_poll) + avahi_simple_poll_free(simple_poll); + + avahi_free(name); +} + + +static void *avahi_mainloop(void *arg) +{ + /* Run the main loop */ + avahi_simple_poll_loop(simple_poll); + + cleanup(); + + return NULL; +} + +void dns_sd_announce (struct misc_config_s *mc) +{ + text_color_set(DW_COLOR_DEBUG); + //kiss_port = mc->kiss_port; // now an array. + kiss_port = mc->kiss_port[0]; // FIXME: Quick hack until I can handle multiple TCP ports properly. + + int error; + + /* Allocate main loop object */ + if (!(simple_poll = avahi_simple_poll_new())) { + text_color_set(DW_COLOR_ERROR); + dw_printf(PRINT_PREFIX "Failed to create Avahi simple poll object.\n"); + goto fail; + } + + if (mc->dns_sd_name[0]) { + name = avahi_strdup(mc->dns_sd_name); + } else { + name = dns_sd_default_service_name(); + } + + /* Allocate a new client */ + client = avahi_client_new(avahi_simple_poll_get(simple_poll), 0, client_callback, NULL, &error); + + /* Check whether creating the client object succeeded */ + if (!client) { + text_color_set(DW_COLOR_ERROR); + dw_printf(PRINT_PREFIX "Failed to create Avahi client: %s\n", avahi_strerror(error)); + goto fail; + } + + pthread_create(&avahi_thread, NULL, &avahi_mainloop, NULL); + + return; + +fail: + cleanup(); +} + +#endif // USE_AVAHI_CLIENT + diff --git a/src/dns_sd_common.c b/src/dns_sd_common.c new file mode 100644 index 00000000..65a1cbf7 --- /dev/null +++ b/src/dns_sd_common.c @@ -0,0 +1,65 @@ +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// +// Copyright (C) 2020 Heikki Hannikainen, OH7LZB +// +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . + +/*------------------------------------------------------------------ + * + * Module: dns_sd_common.c + * + * Purpose: Announce the KISS over TCP service using DNS-SD, common functions + * + * Description: + * + * Most people have typed in enough IP addresses and ports by now, and + * would rather just select an available TNC that is automatically + * discovered on the local network. Even more so on a mobile device + * such an Android or iOS phone or tablet. + * + * This module contains common functions needed on Linux and MacOS. + */ + + +#include +#include +#include + +/* Get a default service name to publish. By default, + * "Dire Wolf on ", or just "Dire Wolf" if hostname cannot + * be obtained. + */ +char *dns_sd_default_service_name(void) +{ + char hostname[51]; + char sname[64]; + + int i = gethostname(hostname, sizeof(hostname)); + if (i == 0) { + hostname[sizeof(hostname)-1] = 0; + + // on some systems, an FQDN is returned; remove domain part + char *dot = strchr(hostname, '.'); + if (dot) + *dot = 0; + + snprintf(sname, sizeof(sname), "Dire Wolf on %s", hostname); + return strdup(sname); + } + + return strdup("Dire Wolf"); +} + diff --git a/src/dns_sd_common.h b/src/dns_sd_common.h new file mode 100644 index 00000000..f104bf83 --- /dev/null +++ b/src/dns_sd_common.h @@ -0,0 +1,7 @@ + +#if (USE_AVAHI_CLIENT|USE_MACOS_DNSSD) + +char *dns_sd_default_service_name(void); + +#endif + diff --git a/src/dns_sd_dw.h b/src/dns_sd_dw.h new file mode 100644 index 00000000..79f4b868 --- /dev/null +++ b/src/dns_sd_dw.h @@ -0,0 +1,10 @@ + +#if (USE_AVAHI_CLIENT|USE_MACOS_DNSSD) + +#include "config.h" + +#define DNS_SD_SERVICE "_kiss-tnc._tcp" + +void dns_sd_announce (struct misc_config_s *mc); + +#endif // USE_AVAHI_CLIENT diff --git a/src/dns_sd_macos.c b/src/dns_sd_macos.c new file mode 100644 index 00000000..d733a412 --- /dev/null +++ b/src/dns_sd_macos.c @@ -0,0 +1,89 @@ +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// +// Copyright (C) 2020 Heikki Hannikainen, OH7LZB +// +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . + +/*------------------------------------------------------------------ + * + * Module: dns_sd_macos.c + * + * Purpose: Announce the KISS over TCP service using MacOS dns-sd + * + * Description: + * + * Most people have typed in enough IP addresses and ports by now, and + * would rather just select an available TNC that is automatically + * discovered on the local network. Even more so on a mobile device + * such an Android or iOS phone or tablet. + * + * On MacOs, the announcement can be made through dns-sd. + */ + +#ifdef USE_MACOS_DNSSD + +#include +#include +#include + +#include "dns_sd_dw.h" +#include "dns_sd_common.h" +#include "textcolor.h" + +static char *name = NULL; + +static void registerServiceCallBack(DNSServiceRef sdRef, DNSServiceFlags flags, DNSServiceErrorType errorCode, + const char* name, const char* regType, const char* domain, void* context) +{ + if (errorCode == kDNSServiceErr_NoError) { + text_color_set(DW_COLOR_INFO); + dw_printf("DNS-SD: Successfully registered '%s'\n", name); + } else { + text_color_set(DW_COLOR_ERROR); + dw_printf("DNS-SD: Failed to register '%s': %d\n", name, errorCode); + } +} + +void dns_sd_announce (struct misc_config_s *mc) +{ + //int kiss_port = mc->kiss_port; // now an array. + int kiss_port = mc->kiss_port[0]; // FIXME: Quick hack until I can handle multiple TCP ports properly. + + if (mc->dns_sd_name[0]) { + name = strdup(mc->dns_sd_name); + } else { + name = dns_sd_default_service_name(); + } + + uint16_t port_nw = htons(kiss_port); + + DNSServiceRef registerRef; + DNSServiceErrorType err = DNSServiceRegister( + ®isterRef, 0, 0, name, DNS_SD_SERVICE, NULL, NULL, + port_nw, 0, NULL, registerServiceCallBack, NULL); + + if (err == kDNSServiceErr_NoError) { + text_color_set(DW_COLOR_INFO); + dw_printf("DNS-SD: Announcing KISS TCP on port %d as '%s'\n", kiss_port, name); + } else { + text_color_set(DW_COLOR_ERROR); + dw_printf("DNS-SD: Failed to announce '%s': %d\n", name, err); + } +} + +#endif // USE_MACOS_DNSSD + + diff --git a/dsp.c b/src/dsp.c similarity index 56% rename from dsp.c rename to src/dsp.c index 07f1688b..4a5f4a88 100644 --- a/dsp.c +++ b/src/dsp.c @@ -1,7 +1,7 @@ // // This file is part of Dire Wolf, an amateur radio packet TNC. // -// Copyright (C) 2011,2012,2013 John Langner, WB2OSZ +// Copyright (C) 2011, 2012, 2013, 2015, 2019 John Langner, WB2OSZ // // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by @@ -18,8 +18,6 @@ // - - /*------------------------------------------------------------------ * * Name: dsp.c @@ -28,6 +26,8 @@ * *----------------------------------------------------------------*/ +#include "direwolf.h" + #include #include #include @@ -36,7 +36,6 @@ #include #include -#include "direwolf.h" #include "audio.h" #include "fsk_demod_state.h" #include "fsk_gen_filter.h" @@ -44,7 +43,6 @@ #include "dsp.h" -//#include "fsk_demod_agc.h" /* for M_FILTER_SIZE, etc. */ #define MIN(a,b) ((a)<(b)?(a):(b)) #define MAX(a,b) ((a)>(b)?(a):(b)) @@ -52,8 +50,8 @@ // Don't remove this. It serves as a reminder that an experiment is underway. -#if defined(TUNE_MS_FILTER_SIZE) || defined(TUNE_AGC_FAST) || defined(TUNE_LPF_BAUD) || defined(TUNE_PLL_LOCKED) || defined(TUNE_PROFILE) -#define DEBUG1 1 +#if defined(TUNE_MS_FILTER_SIZE) || defined(TUNE_MS2_FILTER_SIZE) || defined(TUNE_AGC_FAST) || defined(TUNE_LPF_BAUD) || defined(TUNE_PLL_LOCKED) || defined(TUNE_PROFILE) +#define DEBUG1 1 // Don't remove this. #endif @@ -119,9 +117,12 @@ float window (bp_window_t type, int size, int j) * Inputs: fc - Cutoff frequency as fraction of sampling frequency. * filter_size - Number of filter taps. * wtype - Window type, BP_WINDOW_HAMMING, etc. + * lp_delay_fract - Fudge factor for the delay value. * * Outputs: lp_filter * + * Returns: Signal delay thru the filter in number of audio samples. + * *----------------------------------------------------------------*/ @@ -163,7 +164,7 @@ void gen_lowpass (float fc, float *lp_filter, int filter_size, bp_window_t wtype } /* - * Normalize lowpass for unity gain. + * Normalize lowpass for unity gain at DC. */ G = 0; for (j=0; j= 3 && filter_size <= MAX_FILTER_SIZE); for (j=0; j -0.001 && t < 0.001) { + sinc = 1; + } + else { + sinc = sinf(M_PI * t) / (M_PI * t); + } + + if (fabsf(a * t) > 0.499 && fabsf(a * t) < 0.501) { + window = M_PI / 4; + } + else { + window = cos(M_PI * a * t) / ( 1 - powf(2 * a * t, 2)); + // This made nicer looking waveforms for generating signal. + //window = cos(M_PI * a * t); + // Do we want to let it go negative? + // I think this would happen when a > 0.5 / (filter width in symbol times) + if (window < 0) { + //printf ("'a' is too large for range of 't'.\n"); + //window = 0; + } + } + + result = sinc * window; + +#if DEBUGRRC + // t should vary from - to + half of filter size in symbols. + // Result should be 1 at t=0 and 0 at all other integer values of t. + + printf ("%.3f, %.3f, %.3f, %.3f\n", t, sinc, window, result); +#endif + return (result); +} + +// The Root Raised Cosine (RRC) low pass filter is suppposed to minimize Intersymbol Interference (ISI). + +void gen_rrc_lowpass (float *pfilter, int filter_taps, float rolloff, float samples_per_symbol) +{ + int k; + float t; + + for (k = 0; k < filter_taps; k++) { + t = (k - ((filter_taps - 1.0) / 2.0)) / samples_per_symbol; + pfilter[k] = rrc (t, rolloff); + } + + // Scale it for unity gain. + + t = 0; + for (k = 0; k < filter_taps; k++) { + t += pfilter[k]; + } + for (k = 0; k < filter_taps; k++) { + pfilter[k] = pfilter[k] / t; + } } -/* end dsp.c */ \ No newline at end of file +/* end dsp.c */ diff --git a/src/dsp.h b/src/dsp.h new file mode 100644 index 00000000..e0dbd248 --- /dev/null +++ b/src/dsp.h @@ -0,0 +1,17 @@ + +/* dsp.h */ + +// TODO: put prefixes on these names. + +float window (bp_window_t type, int size, int j); + +void gen_lowpass (float fc, float *lp_filter, int filter_size, bp_window_t wtype); + +void gen_bandpass (float f1, float f2, float *bp_filter, int filter_size, bp_window_t wtype); + +void gen_ms (int fc, int samples_per_sec, float *sin_table, float *cos_table, int filter_size, int wtype); + + +__attribute__((const)) float rrc (float t, float a); + +void gen_rrc_lowpass (float *pfilter, int filter_taps, float rolloff, float samples_per_symbol); diff --git a/src/dtime_now.c b/src/dtime_now.c new file mode 100644 index 00000000..e5b40c6c --- /dev/null +++ b/src/dtime_now.c @@ -0,0 +1,304 @@ + +#include "direwolf.h" + +#include + +#include "textcolor.h" +#include "dtime_now.h" + + +/* Current time in seconds but more resolution than time(). */ + +/* We don't care what date a 0 value represents because we */ +/* only use this to calculate elapsed real time. */ + + + +#include + +#ifdef __APPLE__ +#include +#endif + +#include // needed for Mac. + + +/*------------------------------------------------------------------ + * + * Name: dtime_realtime + * + * Purpose: Return current wall clock time as double precision. + * + * Input: none + * + * Returns: Unix time, as double precision, so we can get resolution + * finer than one second. + * + * Description: Normal unix time is in seconds since 1/1/1970 00:00:00 UTC. + * Sometimes we want resolution finer than a second. + * Rather than having a separate variable for the fractional + * part of a second, and having extra calculations everywhere, + * simply use double precision floating point to make usage + * easier. + * + * NOTE: This is not a good way to calculate elapsed time because + * it can jump forward or backware via NTP or other manual setting. + * + * Use the monotonic version for measuring elapsed time. + * + * History: Originally I called this dtime_now. We ran into issues where + * we really cared about elapsed time, rather than wall clock time. + * The wall clock time could be wrong at start up time if there + * is no realtime clock or Internet access. It can then jump + * when GPS time or Internet access becomes available. + * All instances of dtime_now should be replaced by dtime_realtime + * if we want wall clock time, or dtime_monotonic if it is to be + * used for measuring elapsed time, such as between becons. + * + *---------------------------------------------------------------*/ + +double dtime_realtime (void) +{ + double result; + +#if __WIN32__ + /* 64 bit integer is number of 100 nanosecond intervals from Jan 1, 1601. */ + + FILETIME ft; + + GetSystemTimeAsFileTime (&ft); + + result = ((( (double)ft.dwHighDateTime * (256. * 256. * 256. * 256.) + + (double)ft.dwLowDateTime ) / 10000000.) - 11644473600.); +#else + /* tv_sec is seconds from Jan 1, 1970. */ + + struct timespec ts; + +#ifdef __APPLE__ + +// Why didn't I use clock_gettime? +// Not available before Max OSX 10.12? https://github.com/gambit/gambit/issues/293 + + struct timeval tp; + gettimeofday(&tp, NULL); + ts.tv_nsec = tp.tv_usec * 1000; + ts.tv_sec = tp.tv_sec; +#else + clock_gettime (CLOCK_REALTIME, &ts); +#endif + + result = ((double)(ts.tv_sec) + (double)(ts.tv_nsec) * 0.000000001); + +#endif + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("dtime_realtime() returns %.3f\n", result ); +#endif + + return (result); +} + + +/*------------------------------------------------------------------ + * + * Name: dtime_monotonic + * + * Purpose: Return montonically increasing time, which is not influenced + * by the wall clock changing. e.g. leap seconds, NTP adjustments. + * + * Input: none + * + * Returns: Time as double precision, so we can get resolution + * finer than one second. + * + * Description: Use this when calculating elapsed time. + * + *---------------------------------------------------------------*/ + +double dtime_monotonic (void) +{ + double result; + +#if __WIN32__ + +// FIXME: +// This is still returning wall clock time. +// https://docs.microsoft.com/en-us/windows/win32/api/sysinfoapi/nf-sysinfoapi-gettickcount64 +// GetTickCount64 would be ideal but it requires Vista or Server 2008. +// As far as I know, the current version of direwolf still works on XP. +// +// As a work-around, GetTickCount could be used if we add extra code to deal +// with the wrap around after about 49.7 days. +// Resolution is only about 10 or 16 milliseconds. Is that good enough? + + /* 64 bit integer is number of 100 nanosecond intervals from Jan 1, 1601. */ + + FILETIME ft; + + GetSystemTimeAsFileTime (&ft); + + result = ((( (double)ft.dwHighDateTime * (256. * 256. * 256. * 256.) + + (double)ft.dwLowDateTime ) / 10000000.) - 11644473600.); +#else + /* tv_sec is seconds from Jan 1, 1970. */ + + struct timespec ts; + +#ifdef __APPLE__ + +// FIXME: Does MacOS have a monotonically increasing time? +// https://stackoverflow.com/questions/41509505/clock-gettime-on-macos + + struct timeval tp; + gettimeofday(&tp, NULL); + ts.tv_nsec = tp.tv_usec * 1000; + ts.tv_sec = tp.tv_sec; +#else + +// This is the only case handled properly. +// Probably the only one that matters. +// It is common to have a Raspberry Pi, without Internet, +// starting up direwolf before GPS/NTP adjusts the time. + + clock_gettime (CLOCK_MONOTONIC, &ts); +#endif + + result = ((double)(ts.tv_sec) + (double)(ts.tv_nsec) * 0.000000001); + +#endif + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("dtime_now() returns %.3f\n", result ); +#endif + + return (result); +} + + + +/*------------------------------------------------------------------ + * + * Name: timestamp_now + * + * Purpose: Convert local time to one of these formats for debug output. + * + * HH:MM:SS + * HH:MM:SS.mmm + * + * Input: result_size - Size of result location. + * Should be at least 9 or 13. + * + * show_ms - True to display milliseconds. + * + * Output: result - Result is placed here. + * + *---------------------------------------------------------------*/ + +void timestamp_now (char *result, int result_size, int show_ms) +{ + double now = dtime_realtime(); + time_t t = (int)now; + struct tm tm; + + localtime_r (&t, &tm); + strftime (result, result_size, "%H:%M:%S", &tm); + + if (show_ms) { + int ms = (now - (int)t) * 1000; + char strms[16]; + + if (ms == 1000) ms = 999; + sprintf (strms, ".%03d", ms); + strlcat (result, strms, result_size); + } + +} /* end timestamp_now */ + + + +/*------------------------------------------------------------------ + * + * Name: timestamp_user_format + * + * Purpose: Convert local time user-specified format. e.g. + * + * HH:MM:SS + * mm/dd/YYYY HH:MM:SS + * dd/mm/YYYY HH:MM:SS + * + * Input: result_size - Size of result location. + * + * user_format - See strftime documentation. + * + * https://linux.die.net/man/3/strftime + * https://msdn.microsoft.com/en-us/library/aa272978(v=vs.60).aspx + * + * Note that Windows does not support all of the Linux formats. + * For example, Linux has %T which is equivalent to %H:%M:%S + * + * Output: result - Result is placed here. + * + *---------------------------------------------------------------*/ + +void timestamp_user_format (char *result, int result_size, char *user_format) +{ + double now = dtime_realtime(); + time_t t = (int)now; + struct tm tm; + + localtime_r (&t, &tm); + strftime (result, result_size, user_format, &tm); + +} /* end timestamp_user_format */ + + +/*------------------------------------------------------------------ + * + * Name: timestamp_filename + * + * Purpose: Generate unique file name based on the current time. + * The format will be: + * + * YYYYMMDD-HHMMSS-mmm + * + * Input: result_size - Size of result location. + * Should be at least 20. + * + * Output: result - Result is placed here. + * + * Description: This is for the kissutil "-r" option which places + * each received frame in a new file. It is possible to + * have two packets arrive in less than a second so we + * need more than one second resolution. + * + * What if someone wants UTC, rather than local time? + * You can simply set an environment variable like this: + * + * TZ=UTC direwolf + * + * so it's probably not worth the effort to add another + * option. + * + *---------------------------------------------------------------*/ + +void timestamp_filename (char *result, int result_size) +{ + double now = dtime_realtime(); + time_t t = (int)now; + struct tm tm; + + localtime_r (&t, &tm); + strftime (result, result_size, "%Y%m%d-%H%M%S", &tm); + + int ms = (now - (int)t) * 1000; + char strms[16]; + + if (ms == 1000) ms = 999; + sprintf (strms, "-%03d", ms); + strlcat (result, strms, result_size); + +} /* end timestamp_filename */ + diff --git a/src/dtime_now.h b/src/dtime_now.h new file mode 100644 index 00000000..411534bf --- /dev/null +++ b/src/dtime_now.h @@ -0,0 +1,18 @@ + + +extern double dtime_realtime (void); + +extern double dtime_monotonic (void); + + +void timestamp_now (char *result, int result_size, int show_ms); + +void timestamp_user_format (char *result, int result_size, char *user_format); + +void timestamp_filename (char *result, int result_size); + + +// FIXME: remove temp workaround. +// Needs many scattered updates. + +#define dtime_now dtime_realtime diff --git a/src/dtmf.c b/src/dtmf.c new file mode 100644 index 00000000..953b0f70 --- /dev/null +++ b/src/dtmf.c @@ -0,0 +1,594 @@ + +//#define DEBUG 1 + + +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// +// Copyright (C) 2013, 2014, 2015, 2016 John Langner, WB2OSZ +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . +// + +/*------------------------------------------------------------------ + * + * Module: dtmf.c + * + * Purpose: Decoder for DTMF, commonly known as "touch tones." + * + * Description: This uses the Goertzel Algorithm for tone detection. + * + * References: http://eetimes.com/design/embedded/4024443/The-Goertzel-Algorithm + * http://www.ti.com/ww/cn/uprogram/share/ppt/c5000/17dtmf_v13.ppt + * + * Revisions: 1.4 - Added transmit capability. + * + *---------------------------------------------------------------*/ + +#include "direwolf.h" + +#include +#include +#include +#include +#include + +#include "dtmf.h" +#include "hdlc_rec.h" // for dcd_change +#include "textcolor.h" +#include "gen_tone.h" + + + +#if DTMF_TEST +#define TIMEOUT_SEC 1 /* short for unit test below. */ +#define DEBUG 1 // Don't remove this. We want more output for test. +#else +#define TIMEOUT_SEC 5 /* for normal operation. */ +#endif + + +#define NUM_TONES 8 +static int const dtmf_tones[NUM_TONES] = { 697, 770, 852, 941, 1209, 1336, 1477, 1633 }; + +/* + * Current state of the DTMF decoding. + */ + +static struct dd_s { /* Separate for each audio channel. */ + + int sample_rate; /* Samples per sec. Typ. 44100, 8000, etc. */ + int block_size; /* Number of samples to process in one block. */ + float coef[NUM_TONES]; + + int n; /* Samples processed in this block. */ + float Q1[NUM_TONES]; + float Q2[NUM_TONES]; + char prev_dec; + char debounced; + char prev_debounced; + int timeout; + +} dd[MAX_CHANS]; + + +static int s_amplitude = 100; // range of 0 .. 100 + + +static void push_button (int chan, char button, int ms); + + +/*------------------------------------------------------------------ + * + * Name: dtmf_init + * + * Purpose: Initialize the DTMF decoder. + * This should be called once at application start up time. + * + * Inputs: p_audio_config - Configuration for audio interfaces. + * + * All we care about is: + * + * samples_per_sec - Audio sample frequency, typically + * 44100, 22050, 8000, etc. + * + * This is a associated with the soundcard. + * In version 1.2, we can have multiple soundcards + * with potentially different sample rates. + * + * amp - Signal amplitude, for transmit, on scale of 0 .. 100. + * + * 100 will produce maximum amplitude of +-32k samples. + * + * Returns: None. + * + *----------------------------------------------------------------*/ + + +void dtmf_init (struct audio_s *p_audio_config, int amp) +{ + int j; /* Loop over all tones frequencies. */ + int c; /* Loop over all audio channels. */ + + + s_amplitude = amp; + +/* + * Pick a suitable processing block size. + * Larger = narrower bandwidth, slower response. + */ + + for (c=0; csample_rate = p_audio_config->adev[a].samples_per_sec; + + if (p_audio_config->achan[c].dtmf_decode != DTMF_DECODE_OFF) { + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("channel %d:\n", c); +#endif + D->block_size = (205 * D->sample_rate) / 8000; + +#if DEBUG + dw_printf (" freq k coef \n"); +#endif + for (j=0; jblock_size * (float)(dtmf_tones[j]) / (float)(D->sample_rate); + + D->coef[j] = 2.0f * cosf(2.0f * (float)M_PI * (float)k / (float)(D->block_size)); + + assert (D->coef[j] > 0.0f && D->coef[j] < 2.0f); +#if DEBUG + dw_printf ("%8d %5.1f %8.5f \n", dtmf_tones[j], k, D->coef[j]); +#endif + } + } + } + + for (c=0; cn = 0; + for (j=0; jQ1[j] = 0; + D->Q2[j] = 0; + } + D->prev_dec = ' '; + D->debounced = ' '; + D->prev_debounced = ' '; + D->timeout = 0; + } + +} + +/*------------------------------------------------------------------ + * + * Name: dtmf_sample + * + * Purpose: Process one audio sample from the sound input source. + * + * Inputs: c - Audio channel number. + * This can process multiple channels in parallel. + * input - Audio sample. + * + * Returns: 0123456789ABCD*# for a button push. + * . for nothing happening during sample interval. + * $ after several seconds of inactivity. + * space between sample intervals. + * + * + *----------------------------------------------------------------*/ + +__attribute__((hot)) +char dtmf_sample (int c, float input) +{ + int i; + float Q0; + float output[NUM_TONES]; + char decoded; + char ret; + struct dd_s *D; + static const char rc2char[16] = { '1', '2', '3', 'A', + '4', '5', '6', 'B', + '7', '8', '9', 'C', + '*', '0', '#', 'D' }; + + D = &(dd[c]); + + for (i=0; iQ1[i] * D->coef[i] - D->Q2[i]; + D->Q2[i] = D->Q1[i]; + D->Q1[i] = Q0; + } + +/* + * Is it time to process the block? + */ + D->n++; + if (D->n == D->block_size) { + int row, col; + + for (i=0; iQ1[i] * D->Q1[i] + D->Q2[i] * D->Q2[i] - D->Q1[i] * D->Q2[i] * D->coef[i]); + D->Q1[i] = 0; + D->Q2[i] = 0; + } + D->n = 0; + + +/* + * The input signal can vary over a couple orders of + * magnitude so we can't set some absolute threshold. + * + * See if one tone is stronger than the sum of the + * others in the same group multiplied by some factor. + * + * For perfect synthetic signals this needs to be in + * the range of about 1.33 (very sensitive) to 2.15 (very fussy). + * + * Too low will cause false triggers on random noise. + * Too high will won't decode less than perfect signals. + * + * Use the mid point 1.74 as our initial guess. + * It might need some fine tuning for imperfect real world signals. + */ + + +#define THRESHOLD 1.74f + + if (output[0] > THRESHOLD * ( output[1] + output[2] + output[3])) row = 0; + else if (output[1] > THRESHOLD * (output[0] + output[2] + output[3])) row = 1; + else if (output[2] > THRESHOLD * (output[0] + output[1] + output[3])) row = 2; + else if (output[3] > THRESHOLD * (output[0] + output[1] + output[2] )) row = 3; + else row = -1; + + if (output[4] > THRESHOLD * ( output[5] + output[6] + output[7])) col = 0; + else if (output[5] > THRESHOLD * (output[4] + output[6] + output[7])) col = 1; + else if (output[6] > THRESHOLD * (output[4] + output[5] + output[7])) col = 2; + else if (output[7] > THRESHOLD * (output[4] + output[5] + output[6] )) col = 3; + else col = -1; + + for (i=0; i= 0 && col >= 0) { + decoded = rc2char[row*4+col]; + } + else { + decoded = ' '; + } + +// Consider valid only if we get same twice in a row. + + if (decoded == D->prev_dec) { + D->debounced = decoded; + + // Update Data Carrier Detect Indicator. + +#ifndef DTMF_TEST + dcd_change (c, MAX_SUBCHANS, 0, decoded != ' '); +#endif + + /* Reset timeout timer. */ + if (decoded != ' ') { + D->timeout = ((TIMEOUT_SEC) * D->sample_rate) / D->block_size; + } + } + D->prev_dec = decoded; + +// Return only new button pushes. +// Also report timeout after period of inactivity. + + ret = '.'; + if (D->debounced != D->prev_debounced) { + if (D->debounced != ' ') { + ret = D->debounced; + } + } + if (ret == '.') { + if (D->timeout > 0) { + D->timeout--; + if (D->timeout == 0) { + ret = '$'; + } + } + } + D->prev_debounced = D->debounced; + +#if DEBUG + dw_printf (" dec=%c, deb=%c, ret=%c, to=%d \n", + decoded, D->debounced, ret, D->timeout); +#endif + return (ret); + } + + return (' '); +} + + + +/*------------------------------------------------------------------- + * + * Name: dtmf_send + * + * Purpose: Generate DTMF tones from text string. + * + * Inputs: chan - Radio channel number. + * str - Character string to send. 0-9, A-D, *, # + * speed - Number of tones per second. Range 1 to 10. + * txdelay - Delay (ms) from PTT to start. + * txtail - Delay (ms) from end to PTT off. + * + * Returns: Total number of milliseconds to activate PTT. + * This includes delays before the first tone + * and after the last to avoid chopping off part of it. + * + * Description: xmit_thread calls this instead of the usual hdlc_send + * when we have a special packet that means send DTMF. + * + *--------------------------------------------------------------------*/ + +int dtmf_send (int chan, char *str, int speed, int txdelay, int txtail) +{ + char *p; + int len_ms; // Length of tone or gap between. + + len_ms = (int) ( ( 500.0f / (float)speed ) + 0.5f); + + push_button (chan, ' ', txdelay); + + for (p = str; *p != '\0'; p++) { + + push_button (chan, *p, len_ms); + push_button (chan, ' ', len_ms); + } + + push_button (chan, ' ', txtail); + +#ifndef DTMF_TEST + audio_flush(ACHAN2ADEV(chan)); +#endif + return (txdelay + + (int) (1000.0f * (float)strlen(str) / (float)speed + 0.5f) + + txtail); + +} /* end dtmf_send */ + + + +/*------------------------------------------------------------------ + * + * Name: push_button + * + * Purpose: Generate DTMF tone for a button push. + * + * Inputs: chan - Radio channel number. + * + * button - One of 0-9, A-D, *, #. Others result in silence. + * '?' is a special case used only for unit testing. + * + * ms - Duration in milliseconds. + * Use 50 ms for tone and 50 ms of silence for max rate of 10 per second. + * + * Outputs: Audio is sent to radio. + * + *----------------------------------------------------------------*/ + +static void push_button (int chan, char button, int ms) +{ + float phasea = 0; + float phaseb = 0; + float fa = 0; + float fb = 0; + int i; + float dtmf; // Audio. Sum of two sine waves. +#if DTMF_TEST + char x; + static char result[100]; + static int result_len = 0; +#endif + + switch (button) { + case '1': fa = dtmf_tones[0]; fb = dtmf_tones[4]; break; + case '2': fa = dtmf_tones[0]; fb = dtmf_tones[5]; break; + case '3': fa = dtmf_tones[0]; fb = dtmf_tones[6]; break; + case 'a': + case 'A': fa = dtmf_tones[0]; fb = dtmf_tones[7]; break; + + case '4': fa = dtmf_tones[1]; fb = dtmf_tones[4]; break; + case '5': fa = dtmf_tones[1]; fb = dtmf_tones[5]; break; + case '6': fa = dtmf_tones[1]; fb = dtmf_tones[6]; break; + case 'b': + case 'B': fa = dtmf_tones[1]; fb = dtmf_tones[7]; break; + + case '7': fa = dtmf_tones[2]; fb = dtmf_tones[4]; break; + case '8': fa = dtmf_tones[2]; fb = dtmf_tones[5]; break; + case '9': fa = dtmf_tones[2]; fb = dtmf_tones[6]; break; + case 'c': + case 'C': fa = dtmf_tones[2]; fb = dtmf_tones[7]; break; + + case '*': fa = dtmf_tones[3]; fb = dtmf_tones[4]; break; + case '0': fa = dtmf_tones[3]; fb = dtmf_tones[5]; break; + case '#': fa = dtmf_tones[3]; fb = dtmf_tones[6]; break; + case 'd': + case 'D': fa = dtmf_tones[3]; fb = dtmf_tones[7]; break; + +#if DTMF_TEST + + case '?': /* check result */ + + if (strcmp(result, "123A456B789C*0#D123$789$") == 0) { + text_color_set(DW_COLOR_REC); + dw_printf ("\nSuccess!\n"); + } + else if (strcmp(result, "123A456B789C*0#D123789") == 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("\n * Time-out failed, otherwise OK *\n"); + dw_printf ("\"%s\"\n", result); + exit (EXIT_FAILURE); + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("\n *** TEST FAILED ***\n"); + dw_printf ("\"%s\"\n", result); + exit (EXIT_FAILURE); + } + break; +#endif + } + + //dw_printf ("push_button (%d, '%c', %d), fa=%.0f, fb=%.0f. %d samples\n", chan, button, ms, fa, fb, (ms*dd[chan].sample_rate)/1000); + + for (i = 0; i < (ms*dd[chan].sample_rate)/1000; i++) { + + // This could be more efficient with a precomputed sine wave table + // but I'm not that worried about it. + // With a Raspberry Pi, model 2, default 1200 receiving takes about 14% of one CPU core. + // When transmitting tones, it briefly shoots up to about 33%. + + if (fa > 0 && fb > 0) { + dtmf = sinf(phasea) + sinf(phaseb); + phasea += 2.0f * (float)M_PI * fa / dd[chan].sample_rate; + phaseb += 2.0f * (float)M_PI * fb / dd[chan].sample_rate; + } + else { + dtmf = 0; + } + +#if DTMF_TEST + + /* Make sure it is insensitive to signal amplitude. */ + /* (Uncomment each of below when testing.) */ + + x = dtmf_sample (0, dtmf); + //x = dtmf_sample (0, dtmf * 1000); + //x = dtmf_sample (0, dtmf * 0.001); + + if (x != ' ' && x != '.') { + result[result_len] = x; + result_len++; + result[result_len] = '\0'; + } +#else + + // 'dtmf' can be in range of +-2.0 because it is sum of two sine waves. + // Amplitude of 100 would use full +-32k range. + + int sam = (int)(dtmf * 16383.0f * (float)s_amplitude / 100.0f); + gen_tone_put_sample (chan, ACHAN2ADEV(chan), sam); + +#endif + } +} + + +/*------------------------------------------------------------------ + * + * Name: main + * + * Purpose: Unit test for functions above. + * + * Usage: rm a.exe ; gcc -DDTMF_TEST dtmf.c textcolor.c ; ./a.exe + * or + * make dtmftest + * + *----------------------------------------------------------------*/ + +#if DTMF_TEST + +static struct audio_s my_audio_config; + + +int main () +{ + int c = 0; // radio channel. + + memset (&my_audio_config, 0, sizeof(my_audio_config)); + my_audio_config.adev[ACHAN2ADEV(c)].defined = 1; + my_audio_config.adev[ACHAN2ADEV(c)].samples_per_sec = 44100; + my_audio_config.chan_medium[c] = MEDIUM_RADIO; + my_audio_config.achan[c].dtmf_decode = DTMF_DECODE_ON; + + dtmf_init(&my_audio_config, 50); + + text_color_set(DW_COLOR_INFO); + dw_printf ("\nFirst, check all button tone pairs. \n\n"); + /* Max auto dialing rate is 10 per second. */ + + push_button (c, '1', 50); push_button (c, ' ', 50); + push_button (c, '2', 50); push_button (c, ' ', 50); + push_button (c, '3', 50); push_button (c, ' ', 50); + push_button (c, 'A', 50); push_button (c, ' ', 50); + + push_button (c, '4', 50); push_button (c, ' ', 50); + push_button (c, '5', 50); push_button (c, ' ', 50); + push_button (c, '6', 50); push_button (c, ' ', 50); + push_button (c, 'B', 50); push_button (c, ' ', 50); + + push_button (c, '7', 50); push_button (c, ' ', 50); + push_button (c, '8', 50); push_button (c, ' ', 50); + push_button (c, '9', 50); push_button (c, ' ', 50); + push_button (c, 'C', 50); push_button (c, ' ', 50); + + push_button (c, '*', 50); push_button (c, ' ', 50); + push_button (c, '0', 50); push_button (c, ' ', 50); + push_button (c, '#', 50); push_button (c, ' ', 50); + push_button (c, 'D', 50); push_button (c, ' ', 50); + + text_color_set(DW_COLOR_INFO); + dw_printf ("\nShould reject very short pulses.\n\n"); + + push_button (c, '1', 20); push_button (c, ' ', 50); + push_button (c, '1', 20); push_button (c, ' ', 50); + push_button (c, '1', 20); push_button (c, ' ', 50); + push_button (c, '1', 20); push_button (c, ' ', 50); + push_button (c, '1', 20); push_button (c, ' ', 50); + + text_color_set(DW_COLOR_INFO); + dw_printf ("\nTest timeout after inactivity.\n\n"); + /* For this test we use 1 second. */ + /* In practice, it will probably more like 5. */ + + push_button (c, '1', 250); push_button (c, ' ', 500); + push_button (c, '2', 250); push_button (c, ' ', 500); + push_button (c, '3', 250); push_button (c, ' ', 1200); + + push_button (c, '7', 250); push_button (c, ' ', 500); + push_button (c, '8', 250); push_button (c, ' ', 500); + push_button (c, '9', 250); push_button (c, ' ', 1200); + + /* Check for expected results. */ + + push_button (c, '?', 0); + + exit (EXIT_SUCCESS); + +} /* end main */ + +#endif + +/* end dtmf.c */ + diff --git a/src/dtmf.h b/src/dtmf.h new file mode 100644 index 00000000..c1b52b91 --- /dev/null +++ b/src/dtmf.h @@ -0,0 +1,14 @@ +/* dtmf.h */ + + +#include "audio.h" + +void dtmf_init (struct audio_s *p_audio_config, int amp); + +char dtmf_sample (int c, float input); + +int dtmf_send (int chan, char *str, int speed, int txdelay, int txtail); + + +/* end dtmf.h */ + diff --git a/src/dwgps.c b/src/dwgps.c new file mode 100644 index 00000000..ccf24b0b --- /dev/null +++ b/src/dwgps.c @@ -0,0 +1,269 @@ +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// +// Copyright (C) 2015 John Langner, WB2OSZ +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . +// + + +/*------------------------------------------------------------------ + * + * Module: dwgps.c + * + * Purpose: Interface for obtaining location from GPS. + * + * Description: This is a wrapper for two different implementations: + * + * (1) Read NMEA sentences from a serial port (or USB + * that looks line one). Available for all platforms. + * + * (2) Read from gpsd. Not available for Windows. + * Including this is optional because it depends + * on another external software component. + * + * + * API: dwgps_init Connect to data stream at start up time. + * + * dwgps_read Return most recent location to application. + * + * dwgps_print Print contents of structure for debugging. + * + * dwgps_term Shutdown on exit. + * + * + * from below: dwgps_set_data Called from other two implementations to + * save data until it is needed. + * + *---------------------------------------------------------------*/ + +#include "direwolf.h" + +#include +#include +#include +#include +#include + +#include "textcolor.h" +#include "dwgps.h" +#include "dwgpsnmea.h" +#include "dwgpsd.h" + + +static int s_dwgps_debug = 0; /* Enable debug output. */ + /* >= 2 show updates from GPS. */ + /* >= 1 show results from dwgps_read. */ + +/* + * The GPS reader threads deposit current data here when it becomes available. + * dwgps_read returns it to the requesting application. + * + * A critical region to avoid inconsistency between fields. + */ + +static dwgps_info_t s_dwgps_info = { + .timestamp = 0, + .fix = DWFIX_NOT_INIT, /* to detect read without init. */ + .dlat = G_UNKNOWN, + .dlon = G_UNKNOWN, + .speed_knots = G_UNKNOWN, + .track = G_UNKNOWN, + .altitude = G_UNKNOWN +}; + +static dw_mutex_t s_gps_mutex; + + +/*------------------------------------------------------------------- + * + * Name: dwgps_init + * + * Purpose: Initialize the GPS interface. + * + * Inputs: pconfig Configuration settings. This might include + * serial port name for direct connect and host + * name or address for network connection. + * + * debug - If >= 1, print results when dwgps_read is called. + * (In this file.) + * + * If >= 2, location updates are also printed. + * (In other two related files.) + * + * Returns: none + * + * Description: Call corresponding functions for implementations. + * Normally we would expect someone to use either GPSNMEA or + * GPSD but there is nothing to prevent use of both at the + * same time. + * + *--------------------------------------------------------------------*/ + + +void dwgps_init (struct misc_config_s *pconfig, int debug) +{ + + s_dwgps_debug = debug; + + dw_mutex_init (&s_gps_mutex); + + dwgpsnmea_init (pconfig, debug); + +#if ENABLE_GPSD + + dwgpsd_init (pconfig, debug); + +#endif + + SLEEP_MS(500); /* So receive thread(s) can clear the */ + /* not init status before it gets checked. */ + +} /* end dwgps_init */ + + +/*------------------------------------------------------------------- + * + * Name: dwgps_clear + * + * Purpose: Clear the gps info structure. + * + *--------------------------------------------------------------------*/ + +void dwgps_clear (dwgps_info_t *gpsinfo) +{ + gpsinfo->timestamp = 0; + gpsinfo->fix = DWFIX_NOT_SEEN; + gpsinfo->dlat = G_UNKNOWN; + gpsinfo->dlon = G_UNKNOWN; + gpsinfo->speed_knots = G_UNKNOWN; + gpsinfo->track = G_UNKNOWN; + gpsinfo->altitude = G_UNKNOWN; +} + + +/*------------------------------------------------------------------- + * + * Name: dwgps_read + * + * Purpose: Return most recent location data available. + * + * Outputs: gpsinfo - Structure with latitude, longitude, etc. + * + * Returns: Position fix quality. Same as in structure. + * + * + *--------------------------------------------------------------------*/ + +dwfix_t dwgps_read (dwgps_info_t *gpsinfo) +{ + + dw_mutex_lock (&s_gps_mutex); + + memcpy (gpsinfo, &s_dwgps_info, sizeof(*gpsinfo)); + + dw_mutex_unlock (&s_gps_mutex); + + if (s_dwgps_debug >= 1) { + text_color_set (DW_COLOR_DEBUG); + dwgps_print ("gps_read: ", gpsinfo); + } + + // TODO: Should we check timestamp and complain if very stale? + // or should we leave that up to the caller? + + return (s_dwgps_info.fix); +} + + +/*------------------------------------------------------------------- + * + * Name: dwgps_print + * + * Purpose: Print gps information for debugging. + * + * Inputs: msg - Message for prefix on line. + * gpsinfo - Structure with latitude, longitude, etc. + * + * Description: Caller is responsible for setting text color. + * + *--------------------------------------------------------------------*/ + +void dwgps_print (char *msg, dwgps_info_t *gpsinfo) +{ + + dw_printf ("%stime=%d fix=%d lat=%.6f lon=%.6f trk=%.0f spd=%.1f alt=%.0f\n", + msg, + (int)gpsinfo->timestamp, (int)gpsinfo->fix, + gpsinfo->dlat, gpsinfo->dlon, + gpsinfo->track, gpsinfo->speed_knots, + gpsinfo->altitude); + +} /* end dwgps_set_data */ + + +/*------------------------------------------------------------------- + * + * Name: dwgps_term + * + * Purpose: Shut down GPS interface before exiting from application. + * + * Inputs: none. + * + * Returns: none. + * + *--------------------------------------------------------------------*/ + +void dwgps_term (void) { + + dwgpsnmea_term (); + +#if ENABLE_GPSD + dwgpsd_term (); +#endif + +} /* end dwgps_term */ + + + + +/*------------------------------------------------------------------- + * + * Name: dwgps_set_data + * + * Purpose: Called by the GPS interfaces when new data is available. + * + * Inputs: gpsinfo - Structure with latitude, longitude, etc. + * + *--------------------------------------------------------------------*/ + +void dwgps_set_data (dwgps_info_t *gpsinfo) +{ + + /* Debug print is handled by the two callers so */ + /* we can distinguish the source. */ + + dw_mutex_lock (&s_gps_mutex); + + memcpy (&s_dwgps_info, gpsinfo, sizeof(s_dwgps_info)); + + dw_mutex_unlock (&s_gps_mutex); + +} /* end dwgps_set_data */ + + +/* end dwgps.c */ + + + diff --git a/src/dwgps.h b/src/dwgps.h new file mode 100644 index 00000000..78f821f7 --- /dev/null +++ b/src/dwgps.h @@ -0,0 +1,61 @@ + +/* dwgps.h */ + +#ifndef DWGPS_H +#define DWGPS_H 1 + + +#include +#include "config.h" /* for struct misc_config_s */ + + +/* + * Values for fix, equivalent to values from libgps. + * -2 = not initialized. + * -1 = error communicating with GPS receiver. + * 0 = nothing heard yet. + * 1 = had signal but lost it. + * 2 = 2D. + * 3 = 3D. + * + * Undefined float & double values are set to G_UNKNOWN. + * + */ + +enum dwfix_e { DWFIX_NOT_INIT= -2, DWFIX_ERROR= -1, DWFIX_NOT_SEEN=0, DWFIX_NO_FIX=1, DWFIX_2D=2, DWFIX_3D=3 }; + +typedef enum dwfix_e dwfix_t; + +typedef struct dwgps_info_s { + time_t timestamp; /* When last updated. System time. */ + dwfix_t fix; /* Quality of position fix. */ + double dlat; /* Latitude. Valid if fix >= 2. */ + double dlon; /* Longitude. Valid if fix >= 2. */ + float speed_knots; /* libgps uses meters/sec but we use GPS usual knots. */ + float track; /* What is difference between track and course? */ + float altitude; /* meters above mean sea level. Valid if fix == 3. */ +} dwgps_info_t; + + + + + +void dwgps_init (struct misc_config_s *pconfig, int debug); + +void dwgps_clear (dwgps_info_t *gpsinfo); + +dwfix_t dwgps_read (dwgps_info_t *gpsinfo); + +void dwgps_print (char *msg, dwgps_info_t *gpsinfo); + +void dwgps_term (void); + +void dwgps_set_data (dwgps_info_t *gpsinfo); + + +#endif /* DWGPS_H 1 */ + +/* end dwgps.h */ + + + diff --git a/src/dwgpsd.c b/src/dwgpsd.c new file mode 100644 index 00000000..1bc9d47a --- /dev/null +++ b/src/dwgpsd.c @@ -0,0 +1,574 @@ +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// +// Copyright (C) 2013, 2014, 2015, 2020, 2022 John Langner, WB2OSZ +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . +// + + +/*------------------------------------------------------------------ + * + * Module: dwgpsd.c + * + * Purpose: Interface to location data, i.e. GPS receiver. + * + * Description: For Linux, we would normally want to use gpsd and libgps. + * This allows multiple applications to access the GPS data, + * without fighting over the same serial port, and has the + * extra benefit that the system clock can be set from the GPS signal. + * + * Reference: http://www.catb.org/gpsd/ + * + *---------------------------------------------------------------*/ + + +#include "direwolf.h" + + +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#if __WIN32__ +#error Not for Windows +#endif + +#if ENABLE_GPSD + +#include + + + +// An API incompatibility was introduced with API version 7. +// and again with 9. +// and again with 10. +// We deal with it by using a bunch of conditional code such as: +// #if GPSD_API_MAJOR_VERSION >= 9 + + +// release lib version API Raspberry Pi OS Testing status +// 3.22 28 11 bullseye OK. +// 3.23 29 12 OK. +// 3.25 30 14 OK, Jan. 2023 + + +// Previously the compilation would fail if the API version was later +// than the last one tested. Now it is just a warning because it changes so +// often but more recent versions have not broken backward compatibility. + +#define MAX_TESTED_VERSION 14 + +#if (GPSD_API_MAJOR_VERSION < 5) || (GPSD_API_MAJOR_VERSION > MAX_TESTED_VERSION) +#pragma message "Your version of gpsd might be incompatible with this application." +#pragma message "The libgps application program interface (API) often" +#pragma message "changes to be incompatible with earlier versions." +// I could not figure out how to do value substitution here. +#pragma message "You have libgpsd API version GPSD_API_MAJOR_VERSION." +#pragma message "The last that has been tested is MAX_TESTED_VERSION." +#pragma message "Even if this builds successfully, it might not run properly." +#endif + + +/* + * Information for interface to gpsd daemon. + */ + +static struct gps_data_t gpsdata; + +#endif /* ENABLE_GPSD */ + + +#include "textcolor.h" +#include "dwgps.h" +#include "dwgpsd.h" + + +#if ENABLE_GPSD + +static int s_debug = 0; /* Enable debug output. */ + /* >= 1 show results from dwgps_read. */ + /* >= 2 show updates from GPS. */ + +static void * read_gpsd_thread (void *arg); + +#endif + + + +/*------------------------------------------------------------------- + * + * Name: dwgpsd_init + * + * Purpose: Initialize the GPS interface. + * + * Inputs: pconfig Configuration settings. This includes + * host name or address for network connection. + * + * debug - If >= 1, print results when dwgps_read is called. + * (In different file.) + * + * If >= 2, location updates are also printed. + * (In this file.) + * + * Returns: 1 = success + * 0 = nothing to do (no host specified in config) + * -1 = failure + * + * Description: - Establish socket connection with gpsd. + * - Start up thread to process incoming data. + * It reads from the daemon and deposits into + * shared region via dwgps_put_data. + * + * The application calls dwgps_read to get the most + * recent information. + * + *--------------------------------------------------------------------*/ + +/* + * Historical notes: + * + * Originally, I wanted to use the shared memory interface to gpsd + * because it is simpler and more efficient. Just access it when we + * actually need the data and we don't have a lot of extra unnecessary + * busy work going on constantly polling it when we don't need the information. + * + * The current version of gpsd, supplied with Raspian (Wheezy), is 3.6 from back in + * May 2012, is missing support for the shared memory interface. + * + * I tried to download a newer source and build with shared memory support + * but ran into a couple other issues. + * + * sudo apt-get install libncurses5-dev + * sudo apt-get install scons + * cd ~ + * wget http://download-mirror.savannah.gnu.org/releases/gpsd/gpsd-3.11.tar.gz + * tar xfz gpsd-3.11.tar.gz + * cd gpsd-3.11 + * scons prefix=/usr libdir=lib/arm-linux-gnueabihf shm_export=True python=False + * sudo scons udev-install + * + * For now, we will use the socket interface. Maybe get back to this again someday. + * + * Update: January 2016. + * + * I'm told that the shared memory interface might work in Raspian, Jessie version. + * Haven't tried it yet. + * + * June 2020: This is how to build the most recent. + * + * Based on https://www.satsignal.eu/raspberry-pi/UpdatingGPSD.html + * + * git clone https://gitlab.com/gpsd/gpsd.git gpsd-gitlab + * cd gpsd-gitlab + * scons --config=force + * scons + * sudo scons install + * + * The problem we have here is that the library is put in /usr/local/lib and direwolf + * can't find it there. Solution is to define environment variable: + * + * export LD_LIBRARY_PATH=/use/local/lib + * + * January 2023: Now using 64 bit Raspberry Pi OS, bullseye. + * See https://gitlab.com/gpsd/gpsd/-/blob/master/build.adoc + * Try to install in proper library place so we don't have to mess with LD_LIBRARY_PATH. + * + * (Remove any existing gpsd first so we are not mixing mismatched pieces.) + * + * sudo apt-get install libncurses5-dev + * sudo apt-get install gtk+-3.0 + * + * git clone https://gitlab.com/gpsd/gpsd.git gpsd-gitlab + * cd gpsd-gitlab + * scons prefix=/usr libdir=lib/aarch64-linux-gnu + * [ scons check ] + * sudo scons udev-install + * + */ + + + +int dwgpsd_init (struct misc_config_s *pconfig, int debug) +{ + +#if ENABLE_GPSD + + pthread_t read_gps_tid; + int e; + int err; + int arg = 0; + char sport[12]; + + s_debug = debug; + + if (s_debug >= 2) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("dwgpsd_init()\n"); + } + +/* + * Socket interface to gpsd. + */ + + if (strlen(pconfig->gpsd_host) == 0) { + + /* Nothing to do. Leave initial fix value of error. */ + return (0); + } + + snprintf (sport, sizeof(sport), "%d", pconfig->gpsd_port); + err = gps_open (pconfig->gpsd_host, sport, &gpsdata); + if (err != 0) { + + text_color_set(DW_COLOR_ERROR); + dw_printf ("Unable to connect to GPSD stream at %s:%s.\n", pconfig->gpsd_host, sport); + dw_printf ("%s\n", gps_errstr(errno)); + + return (-1); + } + + gps_stream(&gpsdata, WATCH_ENABLE | WATCH_JSON, NULL); + + e = pthread_create (&read_gps_tid, NULL, read_gpsd_thread, (void *)(ptrdiff_t)arg); + if (e != 0) { + text_color_set(DW_COLOR_ERROR); + perror("Could not create GPS reader thread"); + return (-1); + } + +/* success */ + + return (1); + + +#else /* end ENABLE_GPSD */ + + // Shouldn't be here. + + text_color_set(DW_COLOR_ERROR); + dw_printf ("GPSD interface not enabled in this version.\n"); + dw_printf ("See documentation on how to rebuild with ENABLE_GPSD.\n"); + + return (-1); + +#endif + +} /* end dwgps_init */ + + +/*------------------------------------------------------------------- + * + * Name: read_gpsd_thread + * + * Purpose: Read information from GPSD, as it becomes available, and + * store in memory shared with dwgps_read. + * + * Inputs: arg - not used + * + *--------------------------------------------------------------------*/ + +#define TIMEOUT 15 + +#if ENABLE_GPSD + +static void * read_gpsd_thread (void *arg) +{ + dwgps_info_t info; + + if (s_debug >= 1) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("starting read_gpsd_thread (%d)\n", (int)(long)arg); + } + + dwgps_clear (&info); + info.fix = DWFIX_NOT_SEEN; /* clear not init state. */ + if (s_debug >= 2) { + text_color_set(DW_COLOR_DEBUG); + dwgps_print ("GPSD: ", &info); + } + dwgps_set_data (&info); + + while (1) { + +// Example code found here: +// https://lists.nongnu.org/archive/html/gpsd-dev/2017-11/msg00001.html + + if ( ! gps_waiting(&gpsdata, TIMEOUT * 1000000)) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("------------------------------------------\n"); + dw_printf ("dwgpsd: Timeout waiting for GPS data.\n"); + dw_printf ("Is GPSD daemon running?\n"); + dw_printf ("Troubleshooting tip: Try running cgps or xgps.\n"); + dw_printf ("------------------------------------------\n"); + info.fix = DWFIX_ERROR; + SLEEP_MS(5000); + continue; + } + +// https://github.com/wb2osz/direwolf/issues/196 +// https://bugzilla.redhat.com/show_bug.cgi?id=1674812 + +// gps_read has two new parameters in API version 7. +// It looks like this could be used to obtain the JSON message from the daemon. +// Specify NULL, instead of message buffer space, if this is not desired. +// Why couldn't they add a new function instead of introducing incompatibility? + +#if GPSD_API_MAJOR_VERSION >= 7 + if (gps_read (&gpsdata, NULL, 0) == -1) { +#else + if (gps_read (&gpsdata) == -1) { +#endif + text_color_set(DW_COLOR_ERROR); + + dw_printf ("------------------------------------------\n"); + dw_printf ("GPSD: Lost communication with gpsd server.\n"); + dw_printf ("------------------------------------------\n"); + + info.fix = DWFIX_ERROR; + if (s_debug >= 2) { + text_color_set(DW_COLOR_DEBUG); + dwgps_print ("GPSD: ", &info); + } + dwgps_set_data (&info); + + break; // Jump out of loop and terminate thread. + } + +#if GPSD_API_MAJOR_VERSION >= 9 + +// The gps.h revision history says: +// * mark altitude in gps_fix_t as deprecated and undefined +// This seems really stupid to me. +// If it is deprecated and undefined then take it out. Someone trying to use +// it would get a compile error and know that something needs to be done. +// Instead we all just go merrily on our way using a field that is [allegedly] undefined. +// Why not simply add more variables with different definitions of altitude +// and keep the original variable working as it always did? +// If it is truly undefined, as the comment would have us believe, numerous +// people will WASTE VAST AMOUNTS OF TIME pondering why altitude is now broken in +// their applications. + +#define stupid_altitude altMSL +#else +#define stupid_altitude altitude +#endif + +#if GPSD_API_MAJOR_VERSION >= 10 + +// They did it again. Whimsical incompatibilities that cause +// pain and aggravation for everyone trying to use this library. +// +// error: ‘struct gps_data_t’ has no member named ‘status’ +// +// Yes, I can understand that it is a more logical place but it breaks +// all existing code that uses this. +// I'm really getting annoyed about wasting so much time on keeping up with all +// of these incompatibilities that are completely unnecessary. + +#define stupid_status fix.status +#else +#define stupid_status status +#endif + + + if (s_debug >= 3) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("gpsdata: status=%d, mode=%d, lat=%.6f, lon=%.6f, track=%.1f, speed=%.1f, alt=%.0f\n", + gpsdata.stupid_status, gpsdata.fix.mode, + gpsdata.fix.latitude, gpsdata.fix.longitude, + gpsdata.fix.track, gpsdata.fix.speed, gpsdata.fix.stupid_altitude); + } + + // Inform user about change in fix status. + + switch (gpsdata.fix.mode) { + default: + case MODE_NOT_SEEN: + case MODE_NO_FIX: + if (info.fix <= DWFIX_NOT_SEEN) { + text_color_set(DW_COLOR_INFO); + dw_printf ("GPSD: No location fix.\n"); + } + if (info.fix >= DWFIX_2D) { + text_color_set(DW_COLOR_INFO); + dw_printf ("GPSD: Lost location fix.\n"); + } + info.fix = DWFIX_NO_FIX; + break; + + case MODE_2D: + if (info.fix != DWFIX_2D) { + text_color_set(DW_COLOR_INFO); + dw_printf ("GPSD: Location fix is now 2D.\n"); + } + info.fix = DWFIX_2D; + break; + + case MODE_3D: + if (info.fix != DWFIX_3D) { + text_color_set(DW_COLOR_INFO); + dw_printf ("GPSD: Location fix is now 3D.\n"); + } + info.fix = DWFIX_3D; + break; + } + + +// Oct. 2020 - 'status' is always zero for latest version of libgps so we can't use that anymore. + + if (/*gpsdata.stupid_status >= STATUS_FIX &&*/ gpsdata.fix.mode >= MODE_2D) { + +#define GOOD(x) (isfinite(x) && ! isnan(x)) + + info.dlat = GOOD(gpsdata.fix.latitude) ? gpsdata.fix.latitude : G_UNKNOWN; + info.dlon = GOOD(gpsdata.fix.longitude) ? gpsdata.fix.longitude : G_UNKNOWN; + // When stationary, track is NaN which is not finite. + info.track = GOOD(gpsdata.fix.track) ? gpsdata.fix.track : G_UNKNOWN; + info.speed_knots = GOOD(gpsdata.fix.speed) ? (MPS_TO_KNOTS * gpsdata.fix.speed) : G_UNKNOWN; + if (gpsdata.fix.mode >= MODE_3D) { + info.altitude = GOOD(gpsdata.fix.stupid_altitude) ? gpsdata.fix.stupid_altitude : G_UNKNOWN; + } + // Otherwise keep last known altitude when we downgrade from 3D to 2D fix. + // Caller knows altitude is outdated if info.fix == DWFIX_2D. + } + // Otherwise keep the last known location which is better than totally lost. + // Caller knows location is outdated if info.fix == DWFIX_NO_FIX. + + + info.timestamp = time(NULL); + if (s_debug >= 2) { + text_color_set(DW_COLOR_DEBUG); + dwgps_print ("GPSD: ", &info); + } + dwgps_set_data (&info); + } + + return(0); // Terminate thread on serious error. + +} /* end read_gpsd_thread */ + +#endif + + +/*------------------------------------------------------------------- + * + * Name: dwgpsd_term + * + * Purpose: Shut down GPS interface before exiting from application. + * + * Inputs: none. + * + * Returns: none. + * + *--------------------------------------------------------------------*/ + + +void dwgpsd_term (void) { + +#if ENABLE_GPSD + + gps_stream (&gpsdata, WATCH_DISABLE, NULL); + gps_close (&gpsdata); + +#endif + +} /* end dwgpsd_term */ + + + + +/*------------------------------------------------------------------- + * + * Name: main + * + * Purpose: Simple unit test for other functions in this file. + * + * Description: Compile with -DGPSTEST option. + * + * gcc -DGPSTEST -DENABLE_GPSD dwgpsd.c dwgps.c textcolor.o latlong.o misc.a -lm -lpthread -lgps + * ./a.out + * + *--------------------------------------------------------------------*/ + +#if GPSTEST + + +int dwgpsnmea_init (struct misc_config_s *pconfig, int debug) +{ + return (0); +} +void dwgpsnmea_term (void) +{ + return; +} + + +int main (int argc, char *argv[]) +{ + struct misc_config_s config; + dwgps_info_t info; + + + memset (&config, 0, sizeof(config)); + strlcpy (config.gpsd_host, "localhost", sizeof(config.gpsd_host)); + config.gpsd_port = atoi(DEFAULT_GPSD_PORT); + + dwgps_init (&config, 3); + + while (1) { + dwfix_t fix; + + fix = dwgps_read (&info) ; + text_color_set (DW_COLOR_INFO); + switch (fix) { + case DWFIX_2D: + case DWFIX_3D: + dw_printf ("%.6f %.6f", info.dlat, info.dlon); + dw_printf (" %.1f knots %.0f degrees", info.speed_knots, info.track); + if (fix==3) dw_printf (" altitude = %.1f meters", info.altitude); + dw_printf ("\n"); + break; + case DWFIX_NOT_SEEN: + case DWFIX_NO_FIX: + dw_printf ("Location currently not available.\n"); + break; + case DWFIX_NOT_INIT: + dw_printf ("GPS Init failed.\n"); + exit (1); + case DWFIX_ERROR: + default: + dw_printf ("ERROR getting GPS information.\n"); + break; + } + SLEEP_SEC (3); + } + +} /* end main */ + + +#endif + + + +/* end dwgpsd.c */ + + + diff --git a/src/dwgpsd.h b/src/dwgpsd.h new file mode 100644 index 00000000..4c0e0fd1 --- /dev/null +++ b/src/dwgpsd.h @@ -0,0 +1,22 @@ + +/* dwgpsd.h - For communicating with daemon */ + + + +#ifndef DWGPSD_H +#define DWGPSD_H 1 + +#include "config.h" + + +int dwgpsd_init (struct misc_config_s *pconfig, int debug); + +void dwgpsd_term (void); + +#endif + + +/* end dwgpsd.h */ + + + diff --git a/src/dwgpsnmea.c b/src/dwgpsnmea.c new file mode 100644 index 00000000..14cda77e --- /dev/null +++ b/src/dwgpsnmea.c @@ -0,0 +1,817 @@ +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// +// Copyright (C) 2013, 2014, 2015 John Langner, WB2OSZ +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . +// + + +/*------------------------------------------------------------------ + * + * Module: dwgpsnmea.c + * + * Purpose: process NMEA sentences from a GPS receiver. + * + * Description: This version is available for all operating systems. + * + * + * TODO: GPS is no longer the only game in town. + * "GNSS" is often seen as a more general term to include + * other similar systems. Some receivers will receive + * multiple types at the same time and combine them + * for greater accuracy and reliability. + * + * We can now see NMEA sentences with other "Talker IDs." + * + * $GPxxx = GPS + * $GLxxx = GLONASS + * $GAxxx = Galileo + * $GBxxx = BeiDou + * $GNxxx = Any combination + * + *---------------------------------------------------------------*/ + + +#include "direwolf.h" + + +#include +#include +#include +#include +#include +#include +#include +#include + + +#include "textcolor.h" +#include "dwgps.h" +#include "dwgpsnmea.h" +#include "serial_port.h" + + +static int s_debug = 0; /* Enable debug output. */ + /* See dwgpsnmea_init description for values. */ + +static struct misc_config_s *s_save_configp; + + + +#if __WIN32__ +static unsigned __stdcall read_gpsnmea_thread (void *arg); +#else +static void * read_gpsnmea_thread (void *arg); +#endif + +/*------------------------------------------------------------------- + * + * Name: dwgpsnmea_init + * + * Purpose: Open serial port for the GPS receiver. + * + * Inputs: pconfig Configuration settings. This includes + * serial port name for direct connect. + * + * debug - If >= 1, print results when dwgps_read is called. + * (In different file.) + * + * If >= 2, location updates are also printed. + * (In this file.) + * Why not do it in dwgps_set_data() ? + * Here, we can prefix it with GPSNMEA to + * distinguish it from GPSD. + * + * If >= 3, Also the NMEA sentences. + * (In this file.) + * + * Returns: 1 = success + * 0 = nothing to do (no serial port specified in config) + * -1 = failure + * + * Description: When talking directly to GPS receiver (any operating system): + * + * - Open the appropriate serial port. + * - Start up thread to process incoming data. + * It reads from the serial port and deposits into + * dwgps_info, above. + * + * The application calls dwgps_read to get the most recent information. + * + *--------------------------------------------------------------------*/ + +/* Make this static and available to all functions so term function can access it. */ + +static MYFDTYPE s_gpsnmea_port_fd = MYFDERROR; /* Handle for serial port. */ + + +int dwgpsnmea_init (struct misc_config_s *pconfig, int debug) +{ + //dwgps_info_t info; +#if __WIN32__ + HANDLE read_gps_th; +#else + pthread_t read_gps_tid; + //int e; +#endif + + s_debug = debug; + s_save_configp = pconfig; + + + if (s_debug >= 2) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("dwgpsnmea_init()\n"); + } + + if (strlen(pconfig->gpsnmea_port) == 0) { + + /* Nothing to do. Leave initial fix value for not init. */ + return (0); + } + +/* + * Open serial port connection. + */ + + s_gpsnmea_port_fd = serial_port_open (pconfig->gpsnmea_port, pconfig->gpsnmea_speed); + + if (s_gpsnmea_port_fd != MYFDERROR) { +#if __WIN32__ + read_gps_th = (HANDLE)_beginthreadex (NULL, 0, read_gpsnmea_thread, (void*)(ptrdiff_t)s_gpsnmea_port_fd, 0, NULL); + if (read_gps_th == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Could not create GPS NMEA listening thread.\n"); + return (-1); + } +#else + int e; + e = pthread_create (&read_gps_tid, NULL, read_gpsnmea_thread, (void*)(ptrdiff_t)s_gpsnmea_port_fd); + if (e != 0) { + text_color_set(DW_COLOR_ERROR); + perror("Could not create GPS NMEA listening thread."); + return (-1); + } +#endif + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Could not open serial port %s for GPS receiver.\n", pconfig->gpsnmea_port); + return (-1); + } + +/* success */ + + return (1); + +} /* end dwgpsnmea_init */ + + +/* Return fd to share if waypoint wants same device. */ + +MYFDTYPE dwgpsnmea_get_fd(char *wp_port_name, int speed) +{ + if (strcmp(s_save_configp->gpsnmea_port, wp_port_name) == 0 && speed == s_save_configp->gpsnmea_speed) { + return (s_gpsnmea_port_fd); + } + return (MYFDERROR); +} + + +/*------------------------------------------------------------------- + * + * Name: read_gpsnmea_thread + * + * Purpose: Read information from GPS, as it becomes available, and + * store it for later retrieval by dwgps_read. + * + * Inputs: fd - File descriptor for serial port. + * + * Description: This version reads from serial port and parses the + * NMEA sentences. + * + *--------------------------------------------------------------------*/ + +#define TIMEOUT 5 + + +#if __WIN32__ +static unsigned __stdcall read_gpsnmea_thread (void *arg) +#else +static void * read_gpsnmea_thread (void *arg) +#endif +{ + MYFDTYPE fd = (MYFDTYPE)(ptrdiff_t)arg; + +// Maximum length of message from GPS receiver is 82 according to some people. +// Make buffer considerably larger to be safe. + +#define NMEA_MAX_LEN 160 + + char gps_msg[NMEA_MAX_LEN]; + int gps_msg_len = 0; + dwgps_info_t info; + + + if (s_debug >= 2) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("read_gpsnmea_thread (%d)\n", (int)(ptrdiff_t)arg); + } + + dwgps_clear (&info); + info.fix = DWFIX_NOT_SEEN; /* clear not init state. */ + if (s_debug >= 2) { + text_color_set(DW_COLOR_DEBUG); + dwgps_print ("GPSNMEA: ", &info); + } + dwgps_set_data (&info); + + + while (1) { + int ch; + + ch = serial_port_get1(fd); + + if (ch < 0) { + + /* This might happen if a USB device is unplugged. */ + /* I can't imagine anything that would cause it with */ + /* a normal serial port. */ + + text_color_set(DW_COLOR_ERROR); + dw_printf ("----------------------------------------------\n"); + dw_printf ("GPSNMEA: Lost communication with GPS receiver.\n"); + dw_printf ("----------------------------------------------\n"); + + info.fix = DWFIX_ERROR; + if (s_debug >= 2) { + text_color_set(DW_COLOR_DEBUG); + dwgps_print ("GPSNMEA: ", &info); + } + dwgps_set_data (&info); + + serial_port_close(s_gpsnmea_port_fd); + s_gpsnmea_port_fd = MYFDERROR; + + // TODO: If the open() was in this thread, we could wait a while and + // try to open again. That would allow recovery if the USB GPS device + // is unplugged and plugged in again. + break; /* terminate thread. */ + } + + if (ch == '$') { + // Start of new sentence. + gps_msg_len = 0; + gps_msg[gps_msg_len++] = ch; + gps_msg[gps_msg_len] = '\0'; + } + else if (ch == '\r' || ch == '\n') { + if (gps_msg_len >= 6 && gps_msg[0] == '$') { + + dwfix_t f; + + if (s_debug >= 3) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("%s\n", gps_msg); + } + +/* Process sentence. */ +// TODO: More general: Ignore the second letter rather than recognizing only GP... and GN... + + if (strncmp(gps_msg, "$GPRMC", 6) == 0 || + strncmp(gps_msg, "$GNRMC", 6) == 0) { + + // Here we just tuck away the course and speed. + // Fix and location will be updated by GxGGA. + + double ignore_dlat; + double ignore_dlon; + + f = dwgpsnmea_gprmc (gps_msg, 0, &ignore_dlat, &ignore_dlon, &info.speed_knots, &info.track); + + if (f == DWFIX_ERROR) { + /* Parse error. Shouldn't happen. Better luck next time. */ + text_color_set(DW_COLOR_ERROR); + dw_printf ("GPSNMEA: Error parsing $GPRMC sentence.\n"); + dw_printf ("%s\n", gps_msg); + } + } + + else if (strncmp(gps_msg, "$GPGGA", 6) == 0 || + strncmp(gps_msg, "$GNGGA", 6) == 0) { + int nsat; + + f = dwgpsnmea_gpgga (gps_msg, 0, &info.dlat, &info.dlon, &info.altitude, &nsat); + + if (f == DWFIX_ERROR) { + /* Parse error. Shouldn't happen. Better luck next time. */ + text_color_set(DW_COLOR_ERROR); + dw_printf ("GPSNMEA: Error parsing $GPGGA sentence.\n"); + dw_printf ("%s\n", gps_msg); + } + else { + if (f != info.fix) { // Print change in location fix. + text_color_set(DW_COLOR_INFO); + if (f == DWFIX_NO_FIX) dw_printf ("GPSNMEA: Location fix has been lost.\n"); + if (f == DWFIX_2D) dw_printf ("GPSNMEA: Location fix is now 2D.\n"); + if (f == DWFIX_3D) dw_printf ("GPSNMEA: Location fix is now 3D.\n"); + info.fix = f; + } + info.timestamp = time(NULL); + if (s_debug >= 2) { + text_color_set(DW_COLOR_DEBUG); + dwgps_print ("GPSNMEA: ", &info); + } + dwgps_set_data (&info); + } + } + } + + gps_msg_len = 0; + gps_msg[gps_msg_len] = '\0'; + } + else { + if (gps_msg_len < NMEA_MAX_LEN-1) { + gps_msg[gps_msg_len++] = ch; + gps_msg[gps_msg_len] = '\0'; + } + } + } /* while (1) */ + +#if __WIN32__ + return (0); +#else + return (NULL); +#endif + +} /* end read_gpsnmea_thread */ + + + + +/*------------------------------------------------------------------- + * + * Name: remove_checksum + * + * Purpose: Validate checksum and remove before further processing. + * + * Inputs: sentence + * quiet suppress printing of error messages. + * + * Outputs: sentence modified in place. + * + * Returns: 0 = good checksum. + * -1 = error. missing or wrong. + * + *--------------------------------------------------------------------*/ + + +static int remove_checksum (char *sent, int quiet) +{ + char *p; + unsigned char cs; + + +// Do we have valid checksum? + + cs = 0; + for (p = sent+1; *p != '*' && *p != '\0'; p++) { + cs ^= *p; + } + + p = strchr (sent, '*'); + if (p == NULL) { + if ( ! quiet) { + text_color_set (DW_COLOR_INFO); + dw_printf("Missing GPS checksum.\n"); + } + return (-1); + } + if (cs != strtoul(p+1, NULL, 16)) { + if ( ! quiet) { + text_color_set (DW_COLOR_ERROR); + dw_printf("GPS checksum error. Expected %02x but found %s.\n", cs, p+1); + } + return (-1); + } + *p = '\0'; // Remove the checksum. + return (0); +} + + +/*------------------------------------------------------------------- + * + * Name: dwgpsnmea_gprmc + * + * Purpose: Parse $GPRMC sentence and extract interesting parts. + * + * Inputs: sentence NMEA sentence. + * + * quiet suppress printing of error messages. + * + * Outputs: odlat latitude + * odlon longitude + * oknots speed + * ocourse direction of travel. + * + * Left undefined if not valid. + * + * Note: RMC does not contain altitude. + * + * Returns: DWFIX_ERROR Parse error. + * DWFIX_NO_FIX GPS is there but Position unknown. Could be temporary. + * DWFIX_2D Valid position. We don't know if it is really 2D or 3D. + * + * Examples: $GPRMC,001431.00,V,,,,,,,121015,,,N*7C + * $GPRMC,212404.000,V,4237.1505,N,07120.8602,W,,,150614,,*0B + * $GPRMC,000029.020,V,,,,,,,080810,,,N*45 + * $GPRMC,003413.710,A,4237.1240,N,07120.8333,W,5.07,291.42,160614,,,A*7F + * + *--------------------------------------------------------------------*/ + +dwfix_t dwgpsnmea_gprmc (char *sentence, int quiet, double *odlat, double *odlon, float *oknots, float *ocourse) +{ + char stemp[NMEA_MAX_LEN]; /* Make copy because parsing is destructive. */ + + char *next; + + char *ptype; /* Should be $GPRMC */ + char *ptime; /* Time, hhmmss[.sss] */ + char *pstatus; /* Status, A=Active (valid position), V=Void */ + char *plat; /* Latitude */ + char *pns; /* North/South */ + char *plon; /* Longitude */ + char *pew; /* East/West */ + char *pknots; /* Speed over ground, knots. */ + char *pcourse; /* True course, degrees. */ + char *pdate; /* Date, ddmmyy */ + /* Magnetic variation */ + /* In version 3.00, mode is added: A D E N (see below) */ + /* Checksum */ + + strlcpy (stemp, sentence, sizeof(stemp)); + + if (remove_checksum (stemp, quiet) < 0) { + return (DWFIX_ERROR); + } + + next = stemp; + ptype = strsep(&next, ","); + ptime = strsep(&next, ","); + pstatus = strsep(&next, ","); + plat = strsep(&next, ","); + pns = strsep(&next, ","); + plon = strsep(&next, ","); + pew = strsep(&next, ","); + pknots = strsep(&next, ","); + pcourse = strsep(&next, ","); + pdate = strsep(&next, ","); + + /* Suppress the 'set but not used' warnings. */ + /* Alternatively, we might use __attribute__((unused)) */ + + (void)(ptype); + (void)(ptime); + (void)(pdate); + + if (pstatus != NULL && strlen(pstatus) == 1) { + if (*pstatus != 'A') { + return (DWFIX_NO_FIX); /* Not "Active." Don't parse. */ + } + } + else { + if ( ! quiet) { + text_color_set (DW_COLOR_ERROR); + dw_printf("No status in GPRMC sentence.\n"); + } + return (DWFIX_ERROR); + } + + + if (plat != NULL && strlen(plat) > 0 && pns != NULL && strlen(pns) > 0) { + *odlat = latitude_from_nmea(plat, pns); + } + else { + if ( ! quiet) { + text_color_set (DW_COLOR_ERROR); + dw_printf("Can't get latitude from GPRMC sentence.\n"); + } + return (DWFIX_ERROR); + } + + + if (plon != NULL && strlen(plon) > 0 && pew != NULL && strlen(pew) > 0) { + *odlon = longitude_from_nmea(plon, pew); + } + else { + if ( ! quiet) { + text_color_set (DW_COLOR_ERROR); + dw_printf("Can't get longitude from GPRMC sentence.\n"); + } + return (DWFIX_ERROR); + } + + + if (pknots != NULL && strlen(pknots) > 0) { + *oknots = atof(pknots); + } + else { + if ( ! quiet) { + text_color_set (DW_COLOR_ERROR); + dw_printf("Can't get speed from GPRMC sentence.\n"); + } + return (DWFIX_ERROR); + } + + + if (pcourse != NULL) { + if (strlen(pcourse) > 0) { + *ocourse = atof(pcourse); + } + else { + /* When stationary, this field might be empty. */ + *ocourse = G_UNKNOWN; + } + } + else { + if ( ! quiet) { + + text_color_set (DW_COLOR_ERROR); + dw_printf("Can't get course from GPRMC sentence.\n"); + } + return (DWFIX_ERROR); + } + + //text_color_set (DW_COLOR_INFO); + //dw_printf("%.6f %.6f %.1f %.0f\n", *odlat, *odlon, *oknots, *ocourse); + + return (DWFIX_2D); + +} /* end dwgpsnmea_gprmc */ + + +/*------------------------------------------------------------------- + * + * Name: dwgpsnmea_gpgga + * + * Purpose: Parse $GPGGA sentence and extract interesting parts. + * + * Inputs: sentence NMEA sentence. + * + * quiet suppress printing of error messages. + * + * Outputs: odlat latitude + * odlon longitude + * oalt altitude in meters + * onsat number of satellites. + * + * Left undefined if not valid. + * + * Note: GGA has altitude but not course and speed so we need to use both. + * + * Returns: DWFIX_ERROR Parse error. + * DWFIX_NO_FIX GPS is there but Position unknown. Could be temporary. + * DWFIX_2D Valid position. We don't know if it is really 2D or 3D. + * Take more cautious value so we don't try using altitude. + * DWFIX_3D Valid 3D position. + * + * Examples: $GPGGA,001429.00,,,,,0,00,99.99,,,,,,*68 + * $GPGGA,212407.000,4237.1505,N,07120.8602,W,0,00,,,M,,M,,*58 + * $GPGGA,000409.392,,,,,0,00,,,M,0.0,M,,0000*53 + * $GPGGA,003518.710,4237.1250,N,07120.8327,W,1,03,5.9,33.5,M,-33.5,M,,0000*5B + * + *--------------------------------------------------------------------*/ + +dwfix_t dwgpsnmea_gpgga (char *sentence, int quiet, double *odlat, double *odlon, float *oalt, int *onsat) +{ + char stemp[NMEA_MAX_LEN]; /* Make copy because parsing is destructive. */ + + char *next; + + char *ptype; /* Should be $GPGGA */ + char *ptime; /* Time, hhmmss[.sss] */ + char *plat; /* Latitude */ + char *pns; /* North/South */ + char *plon; /* Longitude */ + char *pew; /* East/West */ + char *pfix; /* 0=invalid, 1=GPS fix, 2=DGPS fix */ + char *pnum_sat; /* Number of satellites */ + char *phdop; /* Horiz. Dilution fo Precision */ + char *paltitude; /* Altitude, above mean sea level */ + char *palt_u; /* Units for Altitude, typically M for meters. */ + char *pheight; /* Height above ellipsoid */ + char *pheight_u; /* Units for height, typically M for meters. */ + char *psince; /* Time since last DGPS update. */ + char *pdsta; /* DGPS reference station id. */ + + + strlcpy (stemp, sentence, sizeof(stemp)); + + if (remove_checksum (stemp, quiet) < 0) { + return (DWFIX_ERROR); + } + + next = stemp; + ptype = strsep(&next, ","); + ptime = strsep(&next, ","); + plat = strsep(&next, ","); + pns = strsep(&next, ","); + plon = strsep(&next, ","); + pew = strsep(&next, ","); + pfix = strsep(&next, ","); + pnum_sat = strsep(&next, ","); + phdop = strsep(&next, ","); + paltitude = strsep(&next, ","); + palt_u = strsep(&next, ","); + pheight = strsep(&next, ","); + pheight_u = strsep(&next, ","); + psince = strsep(&next, ","); + pdsta = strsep(&next, ","); + + /* Suppress the 'set but not used' warnings. */ + /* Alternatively, we might use __attribute__((unused)) */ + + (void)(ptype); + (void)(ptime); + (void)(pnum_sat); + (void)(phdop); + (void)(palt_u); + (void)(pheight); + (void)(pheight_u); + (void)(psince); + (void)(pdsta); + + if (pfix != NULL && strlen(pfix) == 1) { + if (*pfix == '0') { + return (DWFIX_NO_FIX); /* No Fix. Don't parse the rest. */ + } + } + else { + if ( ! quiet) { + text_color_set (DW_COLOR_ERROR); + dw_printf("No fix in GPGGA sentence.\n"); + } + return (DWFIX_ERROR); + } + + + if (plat != NULL && strlen(plat) > 0 && pns != NULL && strlen(pns) > 0) { + *odlat = latitude_from_nmea(plat, pns); + } + else { + if ( ! quiet) { + text_color_set (DW_COLOR_ERROR); + dw_printf("Can't get latitude from GPGGA sentence.\n"); + } + return (DWFIX_ERROR); + } + + + if (plon != NULL && strlen(plon) > 0 && pew != NULL && strlen(pew) > 0) { + *odlon = longitude_from_nmea(plon, pew); + } + else { + if ( ! quiet) { + text_color_set (DW_COLOR_ERROR); + dw_printf("Can't get longitude from GPGGA sentence.\n"); + } + return (DWFIX_ERROR); + } + + // TODO: num sat... Why would we care? + +/* + * We can distinguish between 2D & 3D fix by presence + * of altitude or an empty field. + */ + + if (paltitude != NULL) { + + if (strlen(paltitude) > 0) { + *oalt = atof(paltitude); + return (DWFIX_3D); + } + else { + return (DWFIX_2D); + } + } + else { + if ( ! quiet) { + text_color_set (DW_COLOR_ERROR); + dw_printf("Can't get altitude from GPGGA sentence.\n"); + } + return (DWFIX_ERROR); + } + +} /* end dwgpsnmea_gpgga */ + + + +/*------------------------------------------------------------------- + * + * Name: dwgpsnmea_term + * + * Purpose: Shut down GPS interface before exiting from application. + * + * Inputs: none. + * + * Returns: none. + * + *--------------------------------------------------------------------*/ + + +void dwgpsnmea_term (void) { + + // Should probably kill reader thread before closing device to avoid + // message about read error. + + // serial_port_close (s_gpsnmea_port_fd); + +} /* end dwgps_term */ + + + + +/*------------------------------------------------------------------- + * + * Name: main + * + * Purpose: Simple unit test for other functions in this file. + * + * Description: Compile with -DGPSTEST option. + * + * Windows: + * gcc -DGPSTEST -Iregex dwgpsnmea.c dwgps.c textcolor.o serial_port.o latlong.o misc.a + * a.exe + * + * Linux: + * gcc -DGPSTEST dwgpsnmea.c dwgps.c textcolor.o serial_port.o latlong.o misc.a -lm -lpthread + * ./a.out + * + *--------------------------------------------------------------------*/ + +#if GPSTEST + +int main (int argc, char *argv[]) +{ + + struct misc_config_s config; + dwgps_info_t info; + + + memset (&config, 0, sizeof(config)); + strlcpy (config.gpsnmea_port, "COM22", sizeof(config.gpsnmea_port)); + + dwgps_init (&config, 3); + + while (1) { + dwfix_t fix; + + fix = dwgps_read (&info) ; + text_color_set (DW_COLOR_INFO); + switch (fix) { + case DWFIX_2D: + case DWFIX_3D: + dw_printf ("%.6f %.6f", info.dlat, info.dlon); + dw_printf (" %.1f knots %.0f degrees", info.speed_knots, info.track); + if (fix==3) dw_printf (" altitude = %.1f meters", info.altitude); + dw_printf ("\n"); + break; + case DWFIX_NOT_SEEN: + case DWFIX_NO_FIX: + dw_printf ("Location currently not available.\n"); + break; + case DWFIX_NOT_INIT: + dw_printf ("GPS Init failed.\n"); + exit (1); + case DWFIX_ERROR: + default: + dw_printf ("ERROR getting GPS information.\n"); + break; + } + SLEEP_SEC (3); + } + +} /* end main */ + + +#endif + + + +/* end dwgpsnmea.c */ + + + diff --git a/src/dwgpsnmea.h b/src/dwgpsnmea.h new file mode 100644 index 00000000..ffe5a12b --- /dev/null +++ b/src/dwgpsnmea.h @@ -0,0 +1,32 @@ + +/* dwgpsnmea.h - For reading NMEA sentences over serial port */ + + + +#ifndef DWGPSNMEA_H +#define DWGPSNMEA_H 1 + +#include "dwgps.h" /* for dwfix_t */ +#include "config.h" +#include "serial_port.h" /* for MYFDTYPE */ + + +int dwgpsnmea_init (struct misc_config_s *pconfig, int debug); + +MYFDTYPE dwgpsnmea_get_fd(char *wp_port_name, int speed); + +void dwgpsnmea_term (void); + + +dwfix_t dwgpsnmea_gprmc (char *sentence, int quiet, double *odlat, double *odlon, float *oknots, float *ocourse); + +dwfix_t dwgpsnmea_gpgga (char *sentence, int quiet, double *odlat, double *odlon, float *oalt, int *onsat); + + +#endif + + +/* end dwgpsnmea.h */ + + + diff --git a/src/dwsock.c b/src/dwsock.c new file mode 100644 index 00000000..6324a2fc --- /dev/null +++ b/src/dwsock.c @@ -0,0 +1,451 @@ + +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// +// Copyright (C) 2017 John Langner, WB2OSZ +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . +// + + +/*------------------------------------------------------------------ + * + * Module: dwsock.c + * + * Purpose: Functions for TCP sockets. + * + * Description: These are used for connecting between different applications, + * possibly on different hosts. + * + * New in version 1.5: + * Duplicate code already exists in multiple places and I was about + * to add another one. Instead, we will gather the common code here + * instead of having yet another copy. + * + *---------------------------------------------------------------*/ + +#include "direwolf.h" // Sets _WIN32_WINNT for XP API level needed by ws2tcpip.h + +#if __WIN32__ + +#include +#include // _WIN32_WINNT must be set to 0x0501 before including this + +#else + +#include +#include +#include +#include +#include +#include +#include +#include +#include +//#include +#include + +#endif + +#include +#include +#include +#include +#include +#include + +#include "textcolor.h" +#include "dwsock.h" + +static void shuffle (struct addrinfo *host[], int nhosts); + + +/*------------------------------------------------------------------- + * + * Name: dwsock_init + * + * Purpose: Preparation before using socket interface. + * + * Inputs: none + * + * Returns: 0 for success, -1 for error. + * + * Errors: Message is printed. I've never seen it fail. + * + * Description: Doesn't do anything for Linux. + * + * TODO: Use this instead of own copy in aclients.c + * TODO: Use this instead of own copy in appserver.c + * TODO: Use this instead of own copy in audio_win.c + * TODO: Use this instead of own copy in igate.c + * TODO: Use this instead of own copy in kissnet.c + * TODO: Use this instead of own copy in kissutil.c + * TODO: Use this instead of own copy in server.c + * TODO: Use this instead of own copy in tnctest.c + * TODO: Use this instead of own copy in ttcalc.c + * + *--------------------------------------------------------------------*/ + +int dwsock_init(void) +{ +#if __WIN32__ + WSADATA wsadata; + int err; + + err = WSAStartup (MAKEWORD(2,2), &wsadata); + if (err != 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf("WSAStartup failed, error: %d\n", err); + return (-1); + } + + if (LOBYTE(wsadata.wVersion) != 2 || HIBYTE(wsadata.wVersion) != 2) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Could not find a usable version of Winsock.dll\n"); + WSACleanup(); + return (-1); + } +#endif + return (0); + +} /* end dwsock_init */ + + + +/*------------------------------------------------------------------- + * + * Name: sock_connect + * + * Purpose: Connect to given host / port. + * + * Inputs: hostname - Host name or IP address. + * + * port - TCP port as text string. + * + * description - Description of the remote server to be used in error message. + * e.g. "APRS-IS (Igate) Server" or "TCP KISS TNC". + * + * allow_ipv6 - True to allow IPv6. Otherwise only IPv4. + * + * debug - Print debugging information. + * + * Outputs: ipaddr_str - The IP address, in text form, is placed here in case + * the caller wants it. Should be DWSOCK_IPADDR_LEN bytes. + * + * Returns: Socket Handle / file descriptor or -1 for error. + * + * Errors: (1) Can't find address for given host name. + * + * Print error and return -1. + * + * (2) Can't connect to one of the address(es). + * + * Silently try the next one. + * + * (3) Can't connect to any of the address(es). + * + * Nothing is printed for success. The caller might do that + * to provide confirmation on what is happening. + * + *--------------------------------------------------------------------*/ + +int dwsock_connect (char *hostname, char *port, char *description, int allow_ipv6, int debug, char ipaddr_str[DWSOCK_IPADDR_LEN]) +{ +#define MAX_HOSTS 50 + + struct addrinfo hints; + struct addrinfo *ai_head = NULL; + struct addrinfo *ai; + struct addrinfo *hosts[MAX_HOSTS]; + int num_hosts, n; + int err; + int server_sock = -1; + + strlcpy (ipaddr_str, "???", DWSOCK_IPADDR_LEN); + memset (&hints, 0, sizeof(hints)); + + hints.ai_family = AF_UNSPEC; /* Allow either IPv4 or IPv6. */ + if ( ! allow_ipv6) { + hints.ai_family = AF_INET; /* IPv4 only. */ + } + hints.ai_socktype = SOCK_STREAM; + hints.ai_protocol = IPPROTO_TCP; + +/* + * First, we need to look up the DNS name to get IP address. + * It is possible to have multiple addresses. + */ + + ai_head = NULL; + err = getaddrinfo(hostname, port, &hints, &ai_head); + if (err != 0) { + text_color_set(DW_COLOR_ERROR); +#if __WIN32__ + dw_printf ("Can't get address for %s, %s, err=%d\n", + description, hostname, WSAGetLastError()); +#else + dw_printf ("Can't get address for %s, %s, %s\n", + description, hostname, gai_strerror(err)); +#endif + freeaddrinfo(ai_head); + return (-1); + } + + if (debug) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("getaddrinfo returns:\n"); + } + + num_hosts = 0; + for (ai = ai_head; ai != NULL; ai = ai->ai_next) { + + if (debug) { + text_color_set(DW_COLOR_DEBUG); + dwsock_ia_to_text (ai->ai_family, ai->ai_addr, ipaddr_str, DWSOCK_IPADDR_LEN); + dw_printf (" %s\n", ipaddr_str); + } + + hosts[num_hosts] = ai; + if (num_hosts < MAX_HOSTS) num_hosts++; + } + + shuffle (hosts, num_hosts); + + if (debug) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("addresses for hostname:\n"); + for (n=0; nai_family, hosts[n]->ai_addr, ipaddr_str, DWSOCK_IPADDR_LEN); + dw_printf (" %s\n", ipaddr_str); + } + } + +/* + * Try each address until we find one that is successful. + */ + for (n = 0; n < num_hosts; n++) { +#if __WIN32__ + SOCKET is; +#else + int is; +#endif + ai = hosts[n]; + + dwsock_ia_to_text (ai->ai_family, ai->ai_addr, ipaddr_str, DWSOCK_IPADDR_LEN); + is = socket(ai->ai_family, ai->ai_socktype, ai->ai_protocol); +#if __WIN32__ + if (is == INVALID_SOCKET) { + printf ("Socket creation failed, err=%d", WSAGetLastError()); + WSACleanup(); + is = -1; + continue; + } +#else + if (err != 0) { + printf ("Socket creation failed, err=%s", gai_strerror(err)); + (void) close (is); + is = -1; + continue; + } +#endif + +#ifndef DEBUG_DNS + err = connect(is, ai->ai_addr, (int)ai->ai_addrlen); +#if __WIN32__ + if (err == SOCKET_ERROR) { +#if DEBUGx + printf("Connect to %s on %s (%s), port %s failed.\n", + description, hostname, ipaddr_str, port); +#endif + closesocket (is); + is = -1; + continue; + } +#else + if (err != 0) { +#if DEBUGx + printf("Connect to %s on %s (%s), port %s failed.\n", + description, hostname, ipaddr_str, port); +#endif + (void) close (is); + is = -1; + continue; + } + + /* IGate documentation says to use no delay. */ + /* Does it really make a difference? */ + int flag = 1; + err = setsockopt (is, IPPROTO_TCP, TCP_NODELAY, (void*)(long)(&flag), (socklen_t)sizeof(flag)); + if (err < 0) { + printf("setsockopt TCP_NODELAY failed.\n"); + } +#endif + +/* Success. */ + + + server_sock = is; +#endif + break; + } + + freeaddrinfo(ai_head); + +// no, caller should handle this. +// function should be generally be silent unless debug option. + + if (server_sock == -1) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Unable to connect to %s at %s (%s), port %s\n", + description, hostname, ipaddr_str, port ); + } + + return (server_sock); + +} /* end dwsock_connect */ + + + +/*------------------------------------------------------------------- + * + * Name: dwsock_bind + * + * Purpose: We also have a bunch of duplicate code for the server side. + * + * Inputs: + * + * TODO: Use this instead of own copy in audio.c + * TODO: Use this instead of own copy in audio_portaudio.c + * TODO: Use this instead of own copy in audio_win.c + * TODO: Use this instead of own copy in kissnet.c + * TODO: Use this instead of own copy in server.c + * + *--------------------------------------------------------------------*/ + +// Not implemented yet. + + +/* + * Addresses don't get mixed up very well. + * IPv6 always shows up last so we'd probably never + * end up using any of them for APRS-IS server. + * Add our own shuffle. + */ + +static void shuffle (struct addrinfo *host[], int nhosts) +{ + int j, k; + + assert (RAND_MAX >= nhosts); /* for % to work right */ + + if (nhosts < 2) return; + + srand (time(NULL)); + + for (j=0; j=0 && ksin_addr.S_un.S_un_b.s_b1, + sa4->sin_addr.S_un.S_un_b.s_b2, + sa4->sin_addr.S_un.S_un_b.s_b3, + sa4->sin_addr.S_un.S_un_b.s_b4); +#else + inet_ntop (AF_INET, &(sa4->sin_addr), pStringBuf, StringBufSize); +#endif + break; + + case AF_INET6: + sa6 = (struct sockaddr_in6 *)pAddr; +#if __WIN32__ + snprintf (pStringBuf, StringBufSize, "%x:%x:%x:%x:%x:%x:%x:%x", + ntohs(((unsigned short *)(&(sa6->sin6_addr)))[0]), + ntohs(((unsigned short *)(&(sa6->sin6_addr)))[1]), + ntohs(((unsigned short *)(&(sa6->sin6_addr)))[2]), + ntohs(((unsigned short *)(&(sa6->sin6_addr)))[3]), + ntohs(((unsigned short *)(&(sa6->sin6_addr)))[4]), + ntohs(((unsigned short *)(&(sa6->sin6_addr)))[5]), + ntohs(((unsigned short *)(&(sa6->sin6_addr)))[6]), + ntohs(((unsigned short *)(&(sa6->sin6_addr)))[7])); +#else + inet_ntop (AF_INET6, &(sa6->sin6_addr), pStringBuf, StringBufSize); +#endif + break; + + default: + snprintf (pStringBuf, StringBufSize, "Invalid address family!"); + } + return pStringBuf; + +} /* end dwsock_ia_to_text */ + + +void dwsock_close (int fd) +{ +#if __WIN32__ + closesocket (fd); +#else + close (fd); +#endif +} + + + + +/* end dwsock.c */ diff --git a/src/dwsock.h b/src/dwsock.h new file mode 100644 index 00000000..986f6a29 --- /dev/null +++ b/src/dwsock.h @@ -0,0 +1,21 @@ + +/* dwsock.h - Socket helper functions. */ + +#ifndef DWSOCK_H +#define DWSOCK_H 1 + +#define DWSOCK_IPADDR_LEN 48 // Size of string to hold IPv4 or IPv6 address. + // I think 40 would be adequate but we'll make + // it a little larger just to be safe. + // Use INET6_ADDRSTRLEN (from netinet/in.h) instead? + +int dwsock_init (void); + +int dwsock_connect (char *hostname, char *port, char *description, int allow_ipv6, int debug, char ipaddr_str[DWSOCK_IPADDR_LEN]); + /* ipaddr_str needs to be at least SOCK_IPADDR_LEN bytes */ + +char *dwsock_ia_to_text (int Family, void * pAddr, char * pStringBuf, size_t StringBufSize); + +void dwsock_close (int fd); + +#endif \ No newline at end of file diff --git a/encode_aprs.c b/src/encode_aprs.c similarity index 60% rename from encode_aprs.c rename to src/encode_aprs.c index fe39f0f3..20992bf7 100644 --- a/encode_aprs.c +++ b/src/encode_aprs.c @@ -1,3 +1,4 @@ + // // This file is part of Dire Wolf, an amateur radio packet TNC. // @@ -32,6 +33,8 @@ * *---------------------------------------------------------------*/ +#include "direwolf.h" + #include #include #include @@ -41,7 +44,6 @@ #include #include -#include "direwolf.h" #include "encode_aprs.h" #include "latlong.h" #include "textcolor.h" @@ -59,6 +61,7 @@ * symbol - Symbol id. * dlat - Latitude. * dlong - Longitude. + * ambiguity - Blank out least significant digits. * * Outputs: presult - Stored here. * @@ -76,10 +79,16 @@ typedef struct position_s { } position_t; -static int set_norm_position (char symtab, char symbol, double dlat, double dlong, position_t *presult) +static int set_norm_position (char symtab, char symbol, double dlat, double dlong, int ambiguity, position_t *presult) { + // An over zealous compiler might complain about l*itude_to_str writing + // N characters plus nul to an N character field so we stick it into a + // larger temp then copy the desired number of bytes. (Issue 296) - latitude_to_str (dlat, 0, presult->lat); + char stemp[16]; + + latitude_to_str (dlat, ambiguity, stemp); + memcpy (presult->lat, stemp, sizeof(presult->lat)); if (symtab != '/' && symtab != '\\' && ! isdigit(symtab) && ! isupper(symtab)) { text_color_set(DW_COLOR_ERROR); @@ -87,7 +96,8 @@ static int set_norm_position (char symtab, char symbol, double dlat, double dlon } presult->sym_table_id = symtab; - longitude_to_str (dlong, 0, presult->lon); + longitude_to_str (dlong, ambiguity, stemp); + memcpy (presult->lon, stemp, sizeof(presult->lon)); if (symbol < '!' || symbol > '~') { text_color_set(DW_COLOR_ERROR); @@ -115,7 +125,8 @@ static int set_norm_position (char symtab, char symbol, double dlat, double dlon * height - Feet. * gain - dBi. * - * course - Degress, 1 - 360. 0 means none or unknown. + * course - Degrees, 0 - 360 (360 equiv. to 0). + * Use G_UNKNOWN for none or unknown. * speed - knots. * * @@ -129,6 +140,9 @@ static int set_norm_position (char symtab, char symbol, double dlat, double dlon * radio range - calculated from PHG * altitude - not implemented yet. * + * Some conversion must be performed for course from + * the API definition to what is sent over the air. + * *----------------------------------------------------------------*/ /* Compressed position & symbol fields common to several message formats. */ @@ -197,13 +211,18 @@ static int set_comp_position (char symtab, char symbol, double dlat, double dlon * When c is '{', s is range ... */ - if (course || speed) { + if (speed > 0) { int c; int s; - - c = (course + 1) / 4; - if (c < 0) c += 90; - if (c >= 90) c -= 90; + + if (course != G_UNKNOWN) { + c = (course + 2) / 4; + if (c < 0) c += 90; + if (c >= 90) c -= 90; + } + else { + c = 0; + } presult->c = c + '!'; s = (int)round(log(speed+1.0) / log(1.08)); @@ -250,7 +269,10 @@ static int set_comp_position (char symtab, char symbol, double dlat, double dlon * * Inputs: power - Watts. * height - Feet. - * gain - dB. Not clear if it is dBi or dBd. + * gain - dB. Protocol spec doesn't mention whether it is dBi or dBd. + * This says dBi: + * http://www.tapr.org/pipermail/aprssig/2008-September/027034.html + * dir - Directivity: N, NE, etc., omni. * * Outputs: presult - Stored here. @@ -259,6 +281,11 @@ static int set_comp_position (char symtab, char symbol, double dlat, double dlon * *----------------------------------------------------------------*/ +// TODO (bug): Doesn't check for G_UNKNOWN. +// could have a case where some, but not all, values were specified. +// Callers originally checked for any not zero. +// now they check for any > 0. + typedef struct phg_s { char P; @@ -316,13 +343,19 @@ static int phg_data_extension (int power, int height, int gain, char *dir, char * * Purpose: Fill in parts of the course & speed data extension. * - * Inputs: course - Degress, 1 - 360. + * Inputs: course - Degrees, 0 - 360 (360 equiv. to 0). + * Use G_UNKNOWN for none or unknown. + * * speed - knots. * * Outputs: presult - Stored here. * * Returns: Number of characters in result. * + * Description: Over the air we use: + * 0 for unknown or not relevant. + * 1 - 360 for valid course. (360 for north) + * *----------------------------------------------------------------*/ @@ -339,18 +372,25 @@ static int cse_spd_data_extension (int course, int speed, char *presult) char stemp[8]; int x; - x = course; - if (x < 0) x = 0; - if (x > 360) x = 360; - sprintf (stemp, "%03d", x); + if (course != G_UNKNOWN) { + x = course; + while (x < 1) x += 360; + while (x > 360) x -= 360; + // Should now be in range of 1 - 360. */ + // Original value of 0 for north is transmitted as 360. */ + } + else { + x = 0; + } + snprintf (stemp, sizeof(stemp), "%03d", x); memcpy (r->cse, stemp, 3); r->slash = '/'; x = speed; - if (x < 0) x = 0; + if (x < 0) x = 0; // would include G_UNKNOWN if (x > 999) x = 999; - sprintf (stemp, "%03d", x); + snprintf (stemp, sizeof(stemp), "%03d", x); memcpy (r->spd, stemp, 3); return (sizeof(cs_t)); @@ -379,61 +419,57 @@ static int cse_spd_data_extension (int course, int speed, char *presult) * * Offset must always be preceded by tone. * + * Resulting formats are all fixed width and have a trailing space: + * + * "999.999MHz " + * "T999 " + * "+999 " (10 kHz units) + * + * Reference: http://www.aprs.org/info/freqspec.txt + * *----------------------------------------------------------------*/ -typedef struct freq_s { - char f[7]; /* format 999.999 */ - char mhz[3]; - char space; - } freq_t; - -typedef struct to_s { - char T; - char ttt[3]; /* format 999 (drop fraction) or 'off'. */ - char space1; - char oooo[4]; /* leading sign, 3 digits, tens of KHz. */ - char space2; - } to_t; - - static int frequency_spec (float freq, float tone, float offset, char *presult) { - int result_len = 0; + int result_size = 24; // TODO: add as parameter. + + *presult = '\0'; - if (freq != 0) { - freq_t *f = (freq_t*)presult; - char stemp[12]; + if (freq > 0) { + char stemp[16]; + + /* TODO: Should use letters for > 999.999. */ + /* For now, just be sure we have proper field width. */ + + if (freq > 999.999) freq = 999.999; + + snprintf (stemp, sizeof(stemp), "%07.3fMHz ", freq); - /* Should use letters for > 999.999. */ - sprintf (stemp, "%07.3f", freq); - memcpy (f->f, stemp, 7); - memcpy (f->mhz, "MHz", 3); - f->space = ' '; - result_len = sizeof (freq_t); + strlcpy (presult, stemp, result_size); } - - if (tone != 0 || offset != 0) { - to_t *to = (to_t*)(presult + result_len); + + if (tone != G_UNKNOWN) { char stemp[12]; - to->T = 'T'; if (tone == 0) { - memcpy(to->ttt, "off", 3); + strlcpy (stemp, "Toff ", sizeof (stemp)); } else { - sprintf (stemp, "%03d", (int)tone); - memcpy (to->ttt, stemp, 3); + snprintf (stemp, sizeof(stemp), "T%03d ", (int)tone); } - to->space1 = ' '; - sprintf (stemp, "%+04d", (int)round(offset * 100)); - memcpy (to->oooo, stemp, 4); - to->space2 = ' '; - result_len += sizeof (to_t); + strlcat (presult, stemp, result_size); } - return (result_len); + if (offset != G_UNKNOWN) { + char stemp[12]; + + snprintf (stemp, sizeof(stemp), "%+04d ", (int)round(offset * 100)); + strlcat (presult, stemp, result_size); + } + + return (strlen(presult)); } @@ -448,6 +484,7 @@ static int frequency_spec (float freq, float tone, float offset, char *presult) * compressed - Send in compressed form? * lat - Latitude. * lon - Longitude. + * ambiguity - Number of digits to omit from location. * alt_ft - Altitude in feet. * symtab - Symbol table id or overlay. * symbol - Symbol id. @@ -457,8 +494,9 @@ static int frequency_spec (float freq, float tone, float offset, char *presult) * gain - dB. Not clear if it is dBi or dBd. * dir - Directivity: N, NE, etc., omni. * - * course - Degress, 1 - 360. 0 means none or unknown. - * speed - knots. + * course - Degrees, 0 - 360 (360 equiv. to 0). + * Use G_UNKNOWN for none or unknown. + * speed - knots. // TODO: should distinguish unknown(not revevant) vs. known zero. * * freq - MHz. * tone - Hz. @@ -466,8 +504,12 @@ static int frequency_spec (float freq, float tone, float offset, char *presult) * * comment - Additional comment text. * + * result_size - Amount of space for result, provided by + * caller, to avoid buffer overflow. * * Outputs: presult - Stored here. Should be at least ??? bytes. + * Could get into hundreds of characters + * because it includes the comment. * * Returns: Number of characters in result. * @@ -477,10 +519,11 @@ static int frequency_spec (float freq, float tone, float offset, char *presult) * Power/height/gain/directivity or * Course/speed. * - * Afer that, + * After that, * *----------------------------------------------------------------*/ + typedef struct aprs_ll_pos_s { char dti; /* ! or = */ position_t pos; @@ -497,17 +540,26 @@ typedef struct aprs_compressed_pos_s { } aprs_compressed_pos_t; -int encode_position (int messaging, int compressed, double lat, double lon, int alt_ft, +int encode_position (int messaging, int compressed, double lat, double lon, int ambiguity, int alt_ft, char symtab, char symbol, int power, int height, int gain, char *dir, int course, int speed, float freq, float tone, float offset, char *comment, - char *presult) + char *presult, size_t result_size) { int result_len = 0; if (compressed) { + +// Thought: +// https://groups.io/g/direwolf/topic/92718535#6886 +// When speed is zero, we could put the altitude in the compressed +// position rather than having /A=999999. +// However, the resolution would be decreased and that could be important +// when hiking in hilly terrain. It would also be confusing to +// flip back and forth between two different representations. + aprs_compressed_pos_t *p = (aprs_compressed_pos_t *)presult; p->dti = messaging ? '=' : '!'; @@ -521,16 +573,16 @@ int encode_position (int messaging, int compressed, double lat, double lon, int aprs_ll_pos_t *p = (aprs_ll_pos_t *)presult; p->dti = messaging ? '=' : '!'; - set_norm_position (symtab, symbol, lat, lon, &(p->pos)); + set_norm_position (symtab, symbol, lat, lon, ambiguity, &(p->pos)); result_len = 1 + sizeof (p->pos); /* Optional data extension. (singular) */ /* Can't have both course/speed and PHG. Former gets priority. */ - if (course || speed) { + if (course != G_UNKNOWN || speed > 0) { result_len += cse_spd_data_extension (course, speed, presult + result_len); } - else if (power || height || gain) { + else if (power > 0 || height > 0 || gain > 0) { result_len += phg_data_extension (power, height, gain, dir, presult + result_len); } } @@ -551,18 +603,23 @@ int encode_position (int messaging, int compressed, double lat, double lon, int /* Be sure it will be converted to 6 digits. */ if (alt_ft < 0) alt_ft = 0; if (alt_ft > 999999) alt_ft = 999999; - sprintf (salt, "/A=%06d", alt_ft); - strcat (presult, salt); + snprintf (salt, sizeof(salt), "/A=%06d", alt_ft); + strlcat (presult, salt, result_size); result_len += strlen(salt); } /* Finally, comment text. */ if (comment != NULL) { - strcat (presult, comment); + strlcat (presult, comment, result_size); result_len += strlen(comment); } + if (result_len >= (int)result_size) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("encode_position result of %d characters won't fit into space provided.\n", result_len); + } + return (result_len); } /* end encode_position */ @@ -579,6 +636,7 @@ int encode_position (int messaging, int compressed, double lat, double lon, int * thyme - Time stamp or 0 for none. * lat - Latitude. * lon - Longitude. + * ambiguity - Number of digits to omit from location. * symtab - Symbol table id or overlay. * symbol - Symbol id. * @@ -587,7 +645,8 @@ int encode_position (int messaging, int compressed, double lat, double lon, int * gain - dB. Not clear if it is dBi or dBd. * dir - Direction: N, NE, etc., omni. * - * course - Degress, 1 - 360. 0 means none or unknown. + * course - Degrees, 0 - 360 (360 equiv. to 0). + * Use G_UNKNOWN for none or unknown. * speed - knots. * * freq - MHz. @@ -596,7 +655,14 @@ int encode_position (int messaging, int compressed, double lat, double lon, int * * comment - Additional comment text. * + * result_size - Amount of space for result, provided by + * caller, to avoid buffer overflow. + * * Outputs: presult - Stored here. Should be at least ??? bytes. + * 36 for fixed part, + * 7 for optional extended data, + * ~20 for freq, etc., + * comment could be very long... * * Returns: Number of characters in result. * @@ -617,12 +683,12 @@ typedef struct aprs_object_s { } u; } aprs_object_t; -int encode_object (char *name, int compressed, time_t thyme, double lat, double lon, +int encode_object (char *name, int compressed, time_t thyme, double lat, double lon, int ambiguity, char symtab, char symbol, int power, int height, int gain, char *dir, int course, int speed, float freq, float tone, float offset, char *comment, - char *presult) + char *presult, size_t result_size) { aprs_object_t *p = (aprs_object_t *) presult; int result_len = 0; @@ -633,7 +699,7 @@ int encode_object (char *name, int compressed, time_t thyme, double lat, double memset (p->o.name, ' ', sizeof(p->o.name)); n = strlen(name); - if (n > sizeof(p->o.name)) n = sizeof(p->o.name); + if (n > (int)(sizeof(p->o.name))) n = sizeof(p->o.name); memcpy (p->o.name, name, n); p->o.live_killed = '*'; @@ -643,7 +709,7 @@ int encode_object (char *name, int compressed, time_t thyme, double lat, double #define XMIT_UTC 1 #if XMIT_UTC - gmtime_r (&thyme, &tm); + (void)gmtime_r (&thyme, &tm); #else /* Using local time, for this application, would make more sense to me. */ /* On Windows, localtime_r produces UTC. */ @@ -651,7 +717,7 @@ int encode_object (char *name, int compressed, time_t thyme, double lat, double localtime_r (thyme, &tm); #endif - sprintf (p->o.time_stamp, "%02d%02d%02d", tm.tm_mday, tm.tm_hour, tm.tm_min); + snprintf (p->o.time_stamp, sizeof(p->o.time_stamp), "%02d%02d%02d", tm.tm_mday, tm.tm_hour, tm.tm_min); #if XMIT_UTC p->o.time_stamp[6] = 'z'; #else @@ -670,16 +736,16 @@ int encode_object (char *name, int compressed, time_t thyme, double lat, double result_len = sizeof(p->o) + sizeof (p->u.cpos); } else { - set_norm_position (symtab, symbol, lat, lon, &(p->u.pos)); + set_norm_position (symtab, symbol, lat, lon, ambiguity, &(p->u.pos)); result_len = sizeof(p->o) + sizeof (p->u.pos); /* Optional data extension. (singular) */ /* Can't have both course/speed and PHG. Former gets priority. */ - if (course || speed) { + if (course != G_UNKNOWN || speed > 0) { result_len += cse_spd_data_extension (course, speed, presult + result_len); } - else if (power || height || gain) { + else if (power > 0 || height > 0 || gain > 0) { result_len += phg_data_extension (power, height, gain, dir, presult + result_len); } } @@ -695,15 +761,77 @@ int encode_object (char *name, int compressed, time_t thyme, double lat, double /* Finally, comment text. */ if (comment != NULL) { - strcat (presult, comment); + strlcat (presult, comment, result_size); result_len += strlen(comment); } + if (result_len >= (int)result_size) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("encode_object result of %d characters won't fit into space provided.\n", result_len); + } + return (result_len); } /* end encode_object */ + +/*------------------------------------------------------------------ + * + * Name: encode_message + * + * Purpose: Construct info part for APRS "message" format. + * + * Inputs: addressee - Addressed to, up to 9 characters. + * text - Text part of the message. + * id - Identifier, 0 to 5 characters. + * result_size - Amount of space for result, provided by + * caller, to avoid buffer overflow. + * + * Outputs: presult - Stored here. + * + * Returns: Number of characters in result. + * + * Description: + * + *----------------------------------------------------------------*/ + + +typedef struct aprs_message_s { + char dti; /* : Data Type Indicator */ + char addressee[9]; /* Fixed width 9 characters. */ + char sep; /* : separator */ + char text; + } aprs_message_t; + +int encode_message (char *addressee, char *text, char *id, char *presult, size_t result_size) +{ + aprs_message_t *p = (aprs_message_t *) presult; + int n; + + p->dti = ':'; + + memset (p->addressee, ' ', sizeof(p->addressee)); + n = strlen(addressee); + if (n > (int)(sizeof(p->addressee))) n = sizeof(p->addressee); + memcpy (p->addressee, addressee, n); + + p->sep = ':'; + p->text = '\0'; + + strlcat (presult, text, result_size); + if (strlen(id) > 0) { + strlcat (presult, "{", result_size); + strlcat (presult, id, result_size); + } + + return (strlen(presult)); + +} /* end encode_message */ + + + + /*------------------------------------------------------------------ * * Name: main @@ -712,7 +840,7 @@ int encode_object (char *name, int compressed, time_t thyme, double lat, double * * Description: Just a smattering, not an organized test. * - * $ rm a.exe ; gcc -DEN_MAIN encode_aprs.c latlong.c textcolor.c ; ./a.exe + * $ rm a.exe ; gcc -DEN_MAIN encode_aprs.c latlong.c textcolor.c misc.a ; ./a.exe * *----------------------------------------------------------------*/ @@ -723,93 +851,138 @@ int encode_object (char *name, int compressed, time_t thyme, double lat, double int main (int argc, char *argv[]) { char result[100]; - + int errors = 0; /*********** Position ***********/ - encode_position (0, 42+34.61/60, -(71+26.47/60), G_UNKNOWN, 'D', '&', - 0, 0, 0, NULL, 0, 0, 0, 0, 0, NULL, result); + encode_position (0, 0, 42+34.61/60, -(71+26.47/60), 0, G_UNKNOWN, 'D', '&', + 0, 0, 0, NULL, G_UNKNOWN, 0, 0, 0, 0, NULL, result, sizeof(result)); dw_printf ("%s\n", result); - if (strcmp(result, "!4234.61ND07126.47W&") != 0) dw_printf ("ERROR! line %d\n", __LINE__); + if (strcmp(result, "!4234.61ND07126.47W&") != 0) { dw_printf ("ERROR! line %d\n", __LINE__); errors++; } /* with PHG. */ +// TODO: Need to test specifying some but not all. - encode_position (0, 42+34.61/60, -(71+26.47/60), G_UNKNOWN, 'D', '&', - 50, 100, 6, "N", 0, 0, 0, 0, 0, NULL, result); + encode_position (0, 0, 42+34.61/60, -(71+26.47/60), 0, G_UNKNOWN, 'D', '&', + 50, 100, 6, "N", G_UNKNOWN, 0, 0, 0, 0, NULL, result, sizeof(result)); dw_printf ("%s\n", result); - if (strcmp(result, "!4234.61ND07126.47W&PHG7368") != 0) dw_printf ("ERROR! line %d\n", __LINE__); + if (strcmp(result, "!4234.61ND07126.47W&PHG7368") != 0) { dw_printf ("ERROR! line %d\n", __LINE__); errors++; } -/* with freq. */ +/* with freq & tone. minus offset, no offset, explicit simplex. */ - encode_position (0, 42+34.61/60, -(71+26.47/60), G_UNKNOWN, 'D', '&', - 0, 0, 0, NULL, 0, 0, 146.955, 74.4, -0.6, NULL, result); + encode_position (0, 0, 42+34.61/60, -(71+26.47/60), 0, G_UNKNOWN, 'D', '&', + 0, 0, 0, NULL, G_UNKNOWN, 0, 146.955, 74.4, -0.6, NULL, result, sizeof(result)); dw_printf ("%s\n", result); - if (strcmp(result, "!4234.61ND07126.47W&146.955MHz T074 -060 ") != 0) dw_printf ("ERROR! line %d\n", __LINE__); + if (strcmp(result, "!4234.61ND07126.47W&146.955MHz T074 -060 ") != 0) { dw_printf ("ERROR! line %d\n", __LINE__); errors++; } + + encode_position (0, 0, 42+34.61/60, -(71+26.47/60), 0, G_UNKNOWN, 'D', '&', + 0, 0, 0, NULL, G_UNKNOWN, 0, 146.955, 74.4, G_UNKNOWN, NULL, result, sizeof(result)); + dw_printf ("%s\n", result); + if (strcmp(result, "!4234.61ND07126.47W&146.955MHz T074 ") != 0) { dw_printf ("ERROR! line %d\n", __LINE__); errors++; } + + encode_position (0, 0, 42+34.61/60, -(71+26.47/60), 0, G_UNKNOWN, 'D', '&', + 0, 0, 0, NULL, G_UNKNOWN, 0, 146.955, 74.4, 0, NULL, result, sizeof(result)); + dw_printf ("%s\n", result); + if (strcmp(result, "!4234.61ND07126.47W&146.955MHz T074 +000 ") != 0) { dw_printf ("ERROR! line %d\n", __LINE__); errors++; } /* with course/speed, freq, and comment! */ - encode_position (0, 42+34.61/60, -(71+26.47/60), G_UNKNOWN, 'D', '&', - 0, 0, 0, NULL, 180, 55, 146.955, 74.4, -0.6, "River flooding", result); + encode_position (0, 0, 42+34.61/60, -(71+26.47/60), 0, G_UNKNOWN, 'D', '&', + 0, 0, 0, NULL, 180, 55, 146.955, 74.4, -0.6, "River flooding", result, sizeof(result)); dw_printf ("%s\n", result); - if (strcmp(result, "!4234.61ND07126.47W&180/055146.955MHz T074 -060 River flooding") != 0) dw_printf ("ERROR! line %d\n", __LINE__); + if (strcmp(result, "!4234.61ND07126.47W&180/055146.955MHz T074 -060 River flooding") != 0) { dw_printf ("ERROR! line %d\n", __LINE__); errors++; } /* Course speed, no tone, + offset */ - encode_position (0, 42+34.61/60, -(71+26.47/60), G_UNKNOWN, 'D', '&', - 0, 0, 0, NULL, 180, 55, 146.955, 0, 0.6, "River flooding", result); + encode_position (0, 0, 42+34.61/60, -(71+26.47/60), 0, G_UNKNOWN, 'D', '&', + 0, 0, 0, NULL, 180, 55, 146.955, G_UNKNOWN, 0.6, "River flooding", result, sizeof(result)); dw_printf ("%s\n", result); - if (strcmp(result, "!4234.61ND07126.47W&180/055146.955MHz Toff +060 River flooding") != 0) dw_printf ("ERROR! line %d\n", __LINE__); + if (strcmp(result, "!4234.61ND07126.47W&180/055146.955MHz +060 River flooding") != 0) { dw_printf ("ERROR! line %d\n", __LINE__); errors++; } /* Course speed, no tone, + offset + altitude */ - encode_position (0, 42+34.61/60, -(71+26.47/60), 12345, 'D', '&', - 0, 0, 0, NULL, 180, 55, 146.955, 0, 0.6, "River flooding", result); + encode_position (0, 0, 42+34.61/60, -(71+26.47/60), 0, 12345, 'D', '&', + 0, 0, 0, NULL, 180, 55, 146.955, G_UNKNOWN, 0.6, "River flooding", result, sizeof(result)); dw_printf ("%s\n", result); - if (strcmp(result, "!4234.61ND07126.47W&180/055146.955MHz Toff +060 /A=012345River flooding") != 0) dw_printf ("ERROR! line %d\n", __LINE__); + if (strcmp(result, "!4234.61ND07126.47W&180/055146.955MHz +060 /A=012345River flooding") != 0) { dw_printf ("ERROR! line %d\n", __LINE__); errors++; } + encode_position (0, 0, 42+34.61/60, -(71+26.47/60), 0, 12345, 'D', '&', + 0, 0, 0, NULL, 180, 55, 146.955, 0, 0.6, "River flooding", result, sizeof(result)); + dw_printf ("%s\n", result); + if (strcmp(result, "!4234.61ND07126.47W&180/055146.955MHz Toff +060 /A=012345River flooding") != 0) { dw_printf ("ERROR! line %d\n", __LINE__); errors++; } + +// TODO: try boundary conditions of course = 0, 359, 360 /*********** Compressed position. ***********/ - encode_position (1, 42+34.61/60, -(71+26.47/60), G_UNKNOWN, 'D', '&', - 0, 0, 0, NULL, 0, 0, 0, 0, 0, NULL, result); + encode_position (0, 1, 42+34.61/60, -(71+26.47/60), 0, G_UNKNOWN, 'D', '&', + 0, 0, 0, NULL, G_UNKNOWN, 0, 0, 0, 0, NULL, result, sizeof(result)); dw_printf ("%s\n", result); - if (strcmp(result, "!D8yKCB:!D8yKCB:!D8yKC 0) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("Encode APRS test FAILED with %d errors.\n", errors); + exit (EXIT_FAILURE); + } + + +/*********** Message. ***********/ + + + encode_message ("N2GH", "some stuff", "", result, sizeof(result)); + dw_printf ("%s\n", result); + if (strcmp(result, ":N2GH :some stuff") != 0) { dw_printf ("ERROR! line %d\n", __LINE__); errors++; } + + + encode_message ("N2GH", "other stuff", "12345", result, sizeof(result)); + dw_printf ("%s\n", result); + if (strcmp(result, ":N2GH :other stuff{12345") != 0) { dw_printf ("ERROR! line %d\n", __LINE__); errors++; } + + + encode_message ("WB2OSZ-123", "other stuff", "12345", result, sizeof(result)); + dw_printf ("%s\n", result); + if (strcmp(result, ":WB2OSZ-12:other stuff{12345") != 0) { dw_printf ("ERROR! line %d\n", __LINE__); errors++; } + + + if (errors != 0) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("Encode APRS test FAILED with %d errors.\n", errors); + exit (EXIT_FAILURE); + } + + text_color_set (DW_COLOR_REC); + dw_printf ("Encode APRS test PASSED with no errors.\n"); + exit (EXIT_SUCCESS); + } /* end main */ diff --git a/encode_aprs.h b/src/encode_aprs.h similarity index 56% rename from encode_aprs.h rename to src/encode_aprs.h index d27bb4b5..dc7b8bdf 100644 --- a/encode_aprs.h +++ b/src/encode_aprs.h @@ -1,16 +1,17 @@ -int encode_position (int messaging, int compressed, double lat, double lon, int alt_ft, +int encode_position (int messaging, int compressed, double lat, double lon, int ambiguity, int alt_ft, char symtab, char symbol, int power, int height, int gain, char *dir, - int course, int speed, + int course, int speed_knots, float freq, float tone, float offset, char *comment, - char *presult); + char *presult, size_t result_size); -int encode_object (char *name, int compressed, time_t thyme, double lat, double lon, +int encode_object (char *name, int compressed, time_t thyme, double lat, double lon, int ambiguity, char symtab, char symbol, int power, int height, int gain, char *dir, - int course, int speed, + int course, int speed_knots, float freq, float tone, float offset, char *comment, - char *presult); + char *presult, size_t result_size); +int encode_message (char *addressee, char *text, char *id, char *presult, size_t result_size); diff --git a/fcs_calc.c b/src/fcs_calc.c similarity index 84% rename from fcs_calc.c rename to src/fcs_calc.c index eff88d3a..f49a2f55 100644 --- a/fcs_calc.c +++ b/src/fcs_calc.c @@ -18,6 +18,8 @@ // +#include "direwolf.h" + #include /* @@ -85,6 +87,22 @@ unsigned short fcs_calc (unsigned char *data, int len) } +/* + * CRC is also used for duplicate checking for the digipeater and IGate. + * A packet is considered a duplicate if the source, destination, and + * information parts match. In other words, we ignore the via path + * which changes along the way. + * Rather than keeping a variable length string we just keep a 16 bit + * CRC which takes less memory and processing to compare. + * + * This can result in occasional false matches. If we had a random + * 16 bit number, there is a 1/65536 ( = 0.0015 % ) chance that it will + * match and we will drop something that should be passed along. + * + * Looking at it another way, there is a 0.9999847412109375 (out of 1) + * probability of doing the right thing. + */ + /* * This can be used when we want to calculate a single CRC over disjoint data. * diff --git a/fcs_calc.h b/src/fcs_calc.h similarity index 100% rename from fcs_calc.h rename to src/fcs_calc.h diff --git a/src/fsk_demod_state.h b/src/fsk_demod_state.h new file mode 100644 index 00000000..c9b26c23 --- /dev/null +++ b/src/fsk_demod_state.h @@ -0,0 +1,558 @@ +/* fsk_demod_state.h */ + +#ifndef FSK_DEMOD_STATE_H + +#include // int64_t + +#include "rpack.h" + +#include "audio.h" // for enum modem_t + +/* + * Demodulator state. + * The name of the file is from we only had FSK. Now we have other techniques. + * Different copy is required for each channel & subchannel being processed concurrently. + */ + +// TODO1.2: change prefix from BP_ to DSP_ + +typedef enum bp_window_e { BP_WINDOW_TRUNCATED, + BP_WINDOW_COSINE, + BP_WINDOW_HAMMING, + BP_WINDOW_BLACKMAN, + BP_WINDOW_FLATTOP } bp_window_t; + +// Experimental low pass filter to detect DC bias or low frequency changes. +// IIR behaves like an analog R-C filter. +// Intuitively, it seems like FIR would be better because it is based on a finite history. +// However, it would require MANY taps and a LOT of computation for a low frequency. +// We can use a little trick here to keep a running average. +// This would be equivalent to convolving with an array of all 1 values. +// That would eliminate the need to multiply. +// We can also eliminate the need to add them all up each time by keeping a running total. +// Add a sample to the total when putting it in our array of recent samples. +// Subtract it from the total when it gets pushed off the end. +// We can also eliminate the need to shift them all down by using a circular buffer. + +#define CIC_LEN_MAX 4000 + +typedef struct cic_s { + int len; // Number of elements used. + // Might want to dynamically allocate. + short in[CIC_LEN_MAX]; // Samples coming in. + int sum; // Running sum. + int inext; // Next position to fill. +} cic_t; + + +#define MAX_FILTER_SIZE 480 /* 401 is needed for profile A, 300 baud & 44100. Revisit someday. */ + // Size comes out to 417 for 1200 bps with 48000 sample rate + // v1.7 - Was 404. Bump up to 480. + +struct demodulator_state_s +{ +/* + * These are set once during initialization. + */ + enum modem_t modem_type; // MODEM_AFSK, MODEM_8PSK, etc. + +// enum v26_e v26_alt; // Which alternative when V.26. + + char profile; // 'A', 'B', etc. Upper case. + // Only needed to see if we are using 'F' to take fast path. + +#define TICKS_PER_PLL_CYCLE ( 256.0 * 256.0 * 256.0 * 256.0 ) + + int pll_step_per_sample; // PLL is advanced by this much each audio sample. + // Data is sampled when it overflows. + + +/* + * Window type for the various filters. + */ + + bp_window_t lp_window; + +/* + * Alternate Low pass filters. + * First is arbitrary number for quick IIR. + * Second is frequency as ratio to baud rate for FIR. + */ + int lpf_use_fir; /* 0 for IIR, 1 for FIR. */ + + float lpf_iir; /* Only if using IIR. */ + + float lpf_baud; /* Cutoff frequency as fraction of baud. */ + /* Intuitively we'd expect this to be somewhere */ + /* in the range of 0.5 to 1. */ + /* In practice, it turned out a little larger */ + /* for profiles B, C, D. */ + + float lp_filter_width_sym; /* Length in number of symbol times. */ + +#define lp_filter_len_bits lp_filter_width_sym // FIXME: temp hack + + int lp_filter_taps; /* Size of Low Pass filter, in audio samples. */ + +#define lp_filter_size lp_filter_taps // FIXME: temp hack + + +/* + * Automatic gain control. Fast attack and slow decay factors. + */ + float agc_fast_attack; + float agc_slow_decay; + +/* + * Use a longer term view for reporting signal levels. + */ + float quick_attack; + float sluggish_decay; + +/* + * Hysteresis before final demodulator 0 / 1 decision. + */ + float hysteresis; + int num_slicers; /* >1 for multiple slicers. */ + +/* + * Phase Locked Loop (PLL) inertia. + * Larger number means less influence by signal transitions. + * It is more resistant to change when locked on to a signal. + */ + float pll_locked_inertia; + float pll_searching_inertia; + + +/* + * Optional band pass pre-filter before mark/space detector. + */ + int use_prefilter; /* True to enable it. */ + + float prefilter_baud; /* Cutoff frequencies, as fraction of */ + /* baud rate, beyond tones used. */ + /* Example, if we used 1600/1800 tones at */ + /* 300 baud, and this was 0.5, the cutoff */ + /* frequencies would be: */ + /* lower = min(1600,1800) - 0.5 * 300 = 1450 */ + /* upper = max(1600,1800) + 0.5 * 300 = 1950 */ + + float pre_filter_len_sym; // Length in number of symbol times. +#define pre_filter_len_bits pre_filter_len_sym // temp until all references changed. + + bp_window_t pre_window; // Window type for filter shaping. + + int pre_filter_taps; // Calculated number of filter taps. +#define pre_filter_size pre_filter_taps // temp until all references changed. + + float pre_filter[MAX_FILTER_SIZE] __attribute__((aligned(16))); + + float raw_cb[MAX_FILTER_SIZE] __attribute__((aligned(16))); // audio in, need better name. + +/* + * The rest are continuously updated. + */ + + unsigned int lo_phase; /* Local oscillator for PSK. */ + + +/* + * Use half of the AGC code to get a measure of input audio amplitude. + * These use "quick" attack and "sluggish" decay while the + * AGC uses "fast" attack and "slow" decay. + */ + + float alevel_rec_peak; + float alevel_rec_valley; + float alevel_mark_peak; + float alevel_space_peak; + +/* + * Outputs from the mark and space amplitude detection, + * used as inputs to the FIR lowpass filters. + * Kernel for the lowpass filters. + */ + + float lp_filter[MAX_FILTER_SIZE] __attribute__((aligned(16))); + + float m_peak, s_peak; + float m_valley, s_valley; + float m_amp_prev, s_amp_prev; + + +/* + * For the PLL and data bit timing. + * starting in version 1.2 we can have multiple slicers for one demodulator. + * Each slicer has its own PLL and HDLC decoder. + */ + +/* + * Version 1.3: Clean up subchan vs. slicer. + * + * Originally some number of CHANNELS (originally 2, later 6) + * which can have multiple parallel demodulators called SUB-CHANNELS. + * This was originally for staggered frequencies for HF SSB. + * It can also be used for multiple demodulators with the same + * frequency but other differing parameters. + * Each subchannel has its own demodulator and HDLC decoder. + * + * In version 1.2 we added multiple SLICERS. + * The data structure, here, has multiple slicers per + * demodulator (subchannel). Due to fuzzy thinking or + * expediency, the multiple slicers got mapped into subchannels. + * This means we can't use both multiple decoders and + * multiple slicers at the same time. + * + * Clean this up in 1.3 and keep the concepts separate. + * This means adding a third variable many places + * we are passing around the origin. + * + */ + struct { + + signed int data_clock_pll; // PLL for data clock recovery. + // It is incremented by pll_step_per_sample + // for each audio sample. + // Must be 32 bits!!! + // So far, this is the case for every compiler used. + + signed int prev_d_c_pll; // Previous value of above, before + // incrementing, to detect overflows. + + int pll_symbol_count; // Number symbols during time nudge_total is accumulated. + int64_t pll_nudge_total; // Sum of DPLL nudge amounts. + // Both of these are cleared at start of frame. + // At end of frame, we can see if incoming + // baud rate is a little off. + + int prev_demod_data; // Previous data bit detected. + // Used to look for transitions. + float prev_demod_out_f; + + /* This is used only for "9600" baud data. */ + + int lfsr; // Descrambler shift register. + + // This is for detecting phase lock to incoming signal. + + int good_flag; // Set if transition is near where expected, + // i.e. at a good time. + int bad_flag; // Set if transition is not where expected, + // i.e. at a bad time. + unsigned char good_hist; // History of good transitions for past octet. + unsigned char bad_hist; // History of bad transitions for past octet. + unsigned int score; // History of whether good triumphs over bad + // for past 32 symbols. + int data_detect; // True when locked on to signal. + + } slicer [MAX_SLICERS]; // Actual number in use is num_slicers. + // Should be in range 1 .. MAX_SLICERS, +/* + * Version 1.6: + * + * This has become quite disorganized and messy with different combinations of + * fields used for different demodulator types. Start to reorganize it into a common + * part (with things like the DPLL for clock recovery), and separate sections + * for each of the demodulator types. + * Still a lot to do here. + */ + + union { + +////////////////////////////////////////////////////////////////////////////////// +// // +// AFSK only - new method in 1.7 // +// // +////////////////////////////////////////////////////////////////////////////////// + + + struct afsk_only_s { + + unsigned int m_osc_phase; // Phase for Mark local oscillator. + unsigned int m_osc_delta; // How much to change for each audio sample. + + unsigned int s_osc_phase; // Phase for Space local oscillator. + unsigned int s_osc_delta; // How much to change for each audio sample. + + unsigned int c_osc_phase; // Phase for Center frequency local oscillator. + unsigned int c_osc_delta; // How much to change for each audio sample. + + // Need two mixers for profile "A". + + float m_I_raw[MAX_FILTER_SIZE] __attribute__((aligned(16))); + float m_Q_raw[MAX_FILTER_SIZE] __attribute__((aligned(16))); + + float s_I_raw[MAX_FILTER_SIZE] __attribute__((aligned(16))); + float s_Q_raw[MAX_FILTER_SIZE] __attribute__((aligned(16))); + + // Only need one mixer for profile "B". Reuse the same storage? + +//#define c_I_raw m_I_raw +//#define c_Q_raw m_Q_raw + float c_I_raw[MAX_FILTER_SIZE] __attribute__((aligned(16))); + float c_Q_raw[MAX_FILTER_SIZE] __attribute__((aligned(16))); + + int use_rrc; // Use RRC rather than generic low pass. + + float rrc_width_sym; /* Width of RRC filter in number of symbols. */ + + float rrc_rolloff; /* Rolloff factor for RRC. Between 0 and 1. */ + + float prev_phase; // To see phase shift between samples for FM demod. + + float normalize_rpsam; // Normalize to -1 to +1 for expected tones. + + } afsk; + +////////////////////////////////////////////////////////////////////////////////// +// // +// Baseband only, AKA G3RUH // +// // +////////////////////////////////////////////////////////////////////////////////// + +// TODO: Continue experiments with root raised cosine filter. +// Either switch to that or take out all the related stuff. + + struct bb_only_s { + + float rrc_width_sym; /* Width of RRC filter in number of symbols. */ + + float rrc_rolloff; /* Rolloff factor for RRC. Between 0 and 1. */ + + int rrc_filter_taps; // Number of elements used in the next two. + +// FIXME: TODO: reevaluate max size needed. + + float audio_in[MAX_FILTER_SIZE] __attribute__((aligned(16))); // Audio samples in. + + + float lp_filter[MAX_FILTER_SIZE] __attribute__((aligned(16))); // Low pass filter. + + // New in 1.7 - Polyphase filter to reduce CPU requirements. + + float lp_polyphase_1[MAX_FILTER_SIZE] __attribute__((aligned(16))); + float lp_polyphase_2[MAX_FILTER_SIZE] __attribute__((aligned(16))); + float lp_polyphase_3[MAX_FILTER_SIZE] __attribute__((aligned(16))); + float lp_polyphase_4[MAX_FILTER_SIZE] __attribute__((aligned(16))); + + float lp_1_iir_param; // very low pass filters to get DC offset. + float lp_1_out; + + float lp_2_iir_param; + float lp_2_out; + + float agc_1_fast_attack; // Signal envelope detection. + float agc_1_slow_decay; + float agc_1_peak; + float agc_1_valley; + + float agc_2_fast_attack; + float agc_2_slow_decay; + float agc_2_peak; + float agc_2_valley; + + float agc_3_fast_attack; + float agc_3_slow_decay; + float agc_3_peak; + float agc_3_valley; + + // CIC low pass filters to detect DC bias or low frequency changes. + // IIR behaves like an analog R-C filter. + // Intuitively, it seems like FIR would be better because it is based on a finite history. + // However, it would require MANY taps and a LOT of computation for a low frequency. + // We can use a little trick here to keep a running average. + // This would be equivalent to convolving with an array of all 1 values. + // That would eliminate the need to multiply. + // We can also eliminate the need to add them all up each time by keeping a running total. + // Add a sample to the total when putting it in our array of recent samples. + // Subtract it from the total when it gets pushed off the end. + // We can also eliminate the need to shift them all down by using a circular buffer. + // This only works with integers because float would have cumulated round off errors. + + cic_t cic_center1; + cic_t cic_above; + cic_t cic_below; + + } bb; + +////////////////////////////////////////////////////////////////////////////////// +// // +// PSK only. // +// // +////////////////////////////////////////////////////////////////////////////////// + + + struct psk_only_s { + + enum v26_e v26_alt; // Which alternative when V.26. + + float sin_table256[256]; // Precomputed sin table for speed. + + + // Optional band pass pre-filter before phase detector. + +// TODO? put back into common section? +// TODO? Why was I thinking that? + + int use_prefilter; // True to enable it. + + float prefilter_baud; // Cutoff frequencies, as fraction of baud rate, beyond tones used. + // In the case of PSK, we use only a single tone of 1800 Hz. + // If we were using 2400 bps (= 1200 baud), this would be + // the fraction of 1200 for the cutoff below and above 1800. + + + float pre_filter_width_sym; /* Length in number of symbol times. */ + + int pre_filter_taps; /* Size of pre filter, in audio samples. */ + + bp_window_t pre_window; + + float audio_in[MAX_FILTER_SIZE] __attribute__((aligned(16))); + float pre_filter[MAX_FILTER_SIZE] __attribute__((aligned(16))); + + // Use local oscillator or correlate with previous sample. + + int psk_use_lo; /* Use local oscillator rather than self correlation. */ + + unsigned int lo_step; /* How much to advance the local oscillator */ + /* phase for each audio sample. */ + + unsigned int lo_phase; /* Local oscillator phase accumulator for PSK. */ + + // After mixing with LO before low pass filter. + + float I_raw[MAX_FILTER_SIZE] __attribute__((aligned(16))); // signal * LO cos. + float Q_raw[MAX_FILTER_SIZE] __attribute__((aligned(16))); // signal * LO sin. + + // Number of delay line taps into previous symbol. + // They are one symbol period and + or - 45 degrees of the carrier frequency. + + int boffs; /* symbol length based on sample rate and baud. */ + int coffs; /* to get cos component of previous symbol. */ + int soffs; /* to get sin component of previous symbol. */ + + float delay_line_width_sym; + int delay_line_taps; // In audio samples. + + float delay_line[MAX_FILTER_SIZE] __attribute__((aligned(16))); + + // Low pass filter Second is frequency as ratio to baud rate for FIR. + +// TODO? put back into common section? +// TODO? What are the tradeoffs? + float lpf_baud; /* Cutoff frequency as fraction of baud. */ + /* Intuitively we'd expect this to be somewhere */ + /* in the range of 0.5 to 1. */ + + float lp_filter_width_sym; /* Length in number of symbol times. */ + + int lp_filter_taps; /* Size of Low Pass filter, in audio samples (i.e. filter taps). */ + + bp_window_t lp_window; + + float lp_filter[MAX_FILTER_SIZE] __attribute__((aligned(16))); + + } psk; + + } u; // end of union for different demodulator types. + +}; + + +/*------------------------------------------------------------------- + * + * Name: pll_dcd_signal_transition2 + * dcd_each_symbol2 + * + * Purpose: New DCD strategy for 1.6. + * + * Inputs: D Pointer to demodulator state. + * + * chan Radio channel: 0 to MAX_CHANS - 1 + * + * subchan Which of multiple demodulators: 0 to MAX_SUBCHANS - 1 + * + * slice Slicer number: 0 to MAX_SLICERS - 1. + * + * dpll_phase Signed 32 bit counter for DPLL phase. + * Wraparound is where data is sampled. + * Ideally transitions would occur close to 0. + * + * Output: D->slicer[slice].data_detect - true when PLL is locked to incoming signal. + * + * Description: From the beginning, DCD was based on finding several flag octets + * in a row and dropping when eight bits with no transitions. + * It was less than ideal but we limped along with it all these years. + * This fell apart when FX.25 came along and a couple of the + * correlation tags have eight "1" bits in a row. + * + * Our new strategy is to keep a running score of how well demodulator + * output transitions match to where expected. + * + *--------------------------------------------------------------------*/ + +#include "hdlc_rec.h" // for dcd_change + +// These are good for 1200 bps AFSK. +// Might want to override for other modems. + +#ifndef DCD_THRESH_ON +#define DCD_THRESH_ON 30 // Hysteresis: Can miss 2 out of 32 for detecting lock. + // 31 is best for TNC Test CD. 30 almost as good. + // 30 better for 1200 regression test. +#endif + +#ifndef DCD_THRESH_OFF +#define DCD_THRESH_OFF 6 // Might want a little more fine tuning. +#endif + +#ifndef DCD_GOOD_WIDTH +#define DCD_GOOD_WIDTH 512 // No more than 1024!!! +#endif + +__attribute__((always_inline)) +inline static void pll_dcd_signal_transition2 (struct demodulator_state_s *D, int slice, int dpll_phase) +{ + if (dpll_phase > - DCD_GOOD_WIDTH * 1024 * 1024 && dpll_phase < DCD_GOOD_WIDTH * 1024 * 1024) { + D->slicer[slice].good_flag = 1; + } + else { + D->slicer[slice].bad_flag = 1; + } +} + +__attribute__((always_inline)) +inline static void pll_dcd_each_symbol2 (struct demodulator_state_s *D, int chan, int subchan, int slice) +{ + D->slicer[slice].good_hist <<= 1; + D->slicer[slice].good_hist |= D->slicer[slice].good_flag; + D->slicer[slice].good_flag = 0; + + D->slicer[slice].bad_hist <<= 1; + D->slicer[slice].bad_hist |= D->slicer[slice].bad_flag; + D->slicer[slice].bad_flag = 0; + + D->slicer[slice].score <<= 1; + // 2 is to detect 'flag' patterns with 2 transitions per octet. + D->slicer[slice].score |= (signed)__builtin_popcount(D->slicer[slice].good_hist) + - (signed)__builtin_popcount(D->slicer[slice].bad_hist) >= 2; + + int s = __builtin_popcount(D->slicer[slice].score); + if (s >= DCD_THRESH_ON) { + if (D->slicer[slice].data_detect == 0) { + D->slicer[slice].data_detect = 1; + dcd_change (chan, subchan, slice, D->slicer[slice].data_detect); + } + } + else if (s <= DCD_THRESH_OFF) { + if (D->slicer[slice].data_detect != 0) { + D->slicer[slice].data_detect = 0; + dcd_change (chan, subchan, slice, D->slicer[slice].data_detect); + } + } +} + + +#define FSK_DEMOD_STATE_H 1 +#endif diff --git a/fsk_filters.h b/src/fsk_filters.h similarity index 100% rename from fsk_filters.h rename to src/fsk_filters.h diff --git a/fsk_gen_filter.h b/src/fsk_gen_filter.h similarity index 100% rename from fsk_gen_filter.h rename to src/fsk_gen_filter.h diff --git a/src/fx25.h b/src/fx25.h new file mode 100644 index 00000000..99e9d261 --- /dev/null +++ b/src/fx25.h @@ -0,0 +1,96 @@ +#ifndef FX25_H +#define FX25_H + +#include // for uint64_t + + +/* Reed-Solomon codec control block */ +struct rs { + unsigned int mm; /* Bits per symbol */ + unsigned int nn; /* Symbols per block (= (1<mm) +#define NN (rs->nn) +#define ALPHA_TO (rs->alpha_to) +#define INDEX_OF (rs->index_of) +#define GENPOLY (rs->genpoly) +#define NROOTS (rs->nroots) +#define FCR (rs->fcr) +#define PRIM (rs->prim) +#define IPRIM (rs->iprim) +#define A0 (NN) + + + +__attribute__((always_inline)) +static inline int modnn(struct rs *rs, int x){ + while (x >= rs->nn) { + x -= rs->nn; + x = (x >> rs->mm) + (x & rs->nn); + } + return x; +} + +#define MODNN(x) modnn(rs,x) + + +#define ENCODE_RS encode_rs_char +#define DECODE_RS decode_rs_char +#define INIT_RS init_rs_char +#define FREE_RS free_rs_char + +#define DTYPE unsigned char + +void ENCODE_RS(struct rs *rs, DTYPE *data, DTYPE *bb); + +int DECODE_RS(struct rs *rs, DTYPE *data, int *eras_pos, int no_eras); + +struct rs *INIT_RS(unsigned int symsize, unsigned int gfpoly, + unsigned int fcr, unsigned int prim, unsigned int nroots); + +void FREE_RS(struct rs *rs); + + + +// These 3 are the external interface. +// Maybe these should be in a different file, separated from the internal stuff. + +void fx25_init ( int debug_level ); +int fx25_send_frame (int chan, unsigned char *fbuf, int flen, int fx_mode); +void fx25_rec_bit (int chan, int subchan, int slice, int dbit); +int fx25_rec_busy (int chan); + + +// Other functions in fx25_init.c. + +struct rs *fx25_get_rs (int ctag_num); +uint64_t fx25_get_ctag_value (int ctag_num); +int fx25_get_k_data_radio (int ctag_num); +int fx25_get_k_data_rs (int ctag_num); +int fx25_get_nroots (int ctag_num); +int fx25_get_debug (void); +int fx25_tag_find_match (uint64_t t); +int fx25_pick_mode (int fx_mode, int dlen); + +void fx_hex_dump(unsigned char *x, int len); + + + +#define CTAG_MIN 0x01 +#define CTAG_MAX 0x0B + +// Maximum sizes of "data" and "check" parts. + +#define FX25_MAX_DATA 239 // i.e. RS(255,239) +#define FX25_MAX_CHECK 64 // e.g. RS(255, 191) +#define FX25_BLOCK_SIZE 255 // Block size always 255 for 8 bit symbols. + +#endif // FX25_H \ No newline at end of file diff --git a/src/fx25_auto.c b/src/fx25_auto.c new file mode 100644 index 00000000..c84ecefc --- /dev/null +++ b/src/fx25_auto.c @@ -0,0 +1 @@ +/* */ \ No newline at end of file diff --git a/src/fx25_encode.c b/src/fx25_encode.c new file mode 100644 index 00000000..02c20a84 --- /dev/null +++ b/src/fx25_encode.c @@ -0,0 +1,84 @@ +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// +// Copyright (C) 2019 John Langner, WB2OSZ +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . +// +// ----------------------------------------------------------------------- +// +// +// Most of this is based on: +// +// FX.25 Encoder +// Author: Jim McGuire KB3MPL +// Date: 23 October 2007 +// +// This program is a single-file implementation of the FX.25 encapsulation +// structure for use with AX.25 data packets. Details of the FX.25 +// specification are available at: +// http://www.stensat.org/Docs/Docs.htm +// +// This program implements a single RS(255,239) FEC structure. Future +// releases will incorporate more capabilities as accommodated in the FX.25 +// spec. +// +// The Reed Solomon encoding routines are based on work performed by +// Phil Karn. Phil was kind enough to release his code under the GPL, as +// noted below. Consequently, this FX.25 implementation is also released +// under the terms of the GPL. +// +// Phil Karn's original copyright notice: + /* Test the Reed-Solomon codecs + * for various block sizes and with random data and random error patterns + * + * Copyright 2002 Phil Karn, KA9Q + * May be used under the terms of the GNU General Public License (GPL) + * + */ + + +#include +#include +#include +#include + +#include "fx25.h" + + + +void ENCODE_RS(struct rs * restrict rs, DTYPE * restrict data, DTYPE * restrict bb) +{ + + int i, j; + DTYPE feedback; + + memset(bb,0,NROOTS*sizeof(DTYPE)); // clear out the FEC data area + + for(i=0;i. +// +// ----------------------------------------------------------------------- +// +// This is based on: +// +// +// FX25_extract.c +// Author: Jim McGuire KB3MPL +// Date: 23 October 2007 +// +// +// Accepts an FX.25 byte stream on STDIN, finds the correlation tag, stores 256 bytes, +// corrects errors with FEC, removes the bit-stuffing, and outputs the resultant AX.25 +// byte stream out STDOUT. +// +// stdout prints a bunch of status information about the packet being processed. +// +// +// Usage : FX25_extract < infile > outfile [2> logfile] +// +// +// +// This program is a single-file implementation of the FX.25 extraction/decode +// structure for use with FX.25 data frames. Details of the FX.25 +// specification are available at: +// http://www.stensat.org/Docs/Docs.htm +// +// This program implements a single RS(255,239) FEC structure. Future +// releases will incorporate more capabilities as accommodated in the FX.25 +// spec. +// +// The Reed Solomon encoding routines are based on work performed by +// Phil Karn. Phil was kind enough to release his code under the GPL, as +// noted below. Consequently, this FX.25 implementation is also released +// under the terms of the GPL. +// +// Phil Karn's original copyright notice: + /* Test the Reed-Solomon codecs + * for various block sizes and with random data and random error patterns + * + * Copyright 2002 Phil Karn, KA9Q + * May be used under the terms of the GNU General Public License (GPL) + * + */ + +#include +#include +#include + +#include "fx25.h" + + +//#define DEBUG 5 + +//----------------------------------------------------------------------- +// Revision History +//----------------------------------------------------------------------- +// 0.0.1 - initial release +// Modifications from Phil Karn's GPL source code. +// Initially added code to run with PC file +// I/O and use the (255,239) decoder exclusively. Confirmed that the +// code produces the correct results. +// +//----------------------------------------------------------------------- +// 0.0.2 - + + +#define min(a,b) ((a) < (b) ? (a) : (b)) + + + +int DECODE_RS(struct rs * restrict rs, DTYPE * restrict data, int *eras_pos, int no_eras) { + + int deg_lambda, el, deg_omega; + int i, j, r,k; + DTYPE u,q,tmp,num1,num2,den,discr_r; +// DTYPE lambda[NROOTS+1], s[NROOTS]; /* Err+Eras Locator poly and syndrome poly */ +// DTYPE b[NROOTS+1], t[NROOTS+1], omega[NROOTS+1]; +// DTYPE root[NROOTS], reg[NROOTS+1], loc[NROOTS]; + DTYPE lambda[FX25_MAX_CHECK+1], s[FX25_MAX_CHECK]; /* Err+Eras Locator poly and syndrome poly */ + DTYPE b[FX25_MAX_CHECK+1], t[FX25_MAX_CHECK+1], omega[FX25_MAX_CHECK+1]; + DTYPE root[FX25_MAX_CHECK], reg[FX25_MAX_CHECK+1], loc[FX25_MAX_CHECK]; + int syn_error, count; + + /* form the syndromes; i.e., evaluate data(x) at roots of g(x) */ + for(i=0;i 0) { + /* Init lambda to be the erasure locator polynomial */ + lambda[1] = ALPHA_TO[MODNN(PRIM*(NN-1-eras_pos[0]))]; + for (i = 1; i < no_eras; i++) { + u = MODNN(PRIM*(NN-1-eras_pos[i])); + for (j = i+1; j > 0; j--) { + tmp = INDEX_OF[lambda[j - 1]]; + if(tmp != A0) + lambda[j] ^= ALPHA_TO[MODNN(u + tmp)]; + } + } + +#if DEBUG >= 1 + /* Test code that verifies the erasure locator polynomial just constructed + Needed only for decoder debugging. */ + + /* find roots of the erasure location polynomial */ + for(i=1;i<=no_eras;i++) + reg[i] = INDEX_OF[lambda[i]]; + + count = 0; + for (i = 1,k=IPRIM-1; i <= NN; i++,k = MODNN(k+IPRIM)) { + q = 1; + for (j = 1; j <= no_eras; j++) + if (reg[j] != A0) { + reg[j] = MODNN(reg[j] + j); + q ^= ALPHA_TO[reg[j]]; + } + if (q != 0) + continue; + /* store root and error location number indices */ + root[count] = i; + loc[count] = k; + count++; + } + if (count != no_eras) { + fprintf(stderr,"count = %d no_eras = %d\n lambda(x) is WRONG\n",count,no_eras); + count = -1; + goto finish; + } +#if DEBUG >= 2 + fprintf(stderr,"\n Erasure positions as determined by roots of Eras Loc Poly:\n"); + for (i = 0; i < count; i++) + fprintf(stderr,"%d ", loc[i]); + fprintf(stderr,"\n"); +#endif +#endif + } + for(i=0;i 0; j--){ + if (reg[j] != A0) { + reg[j] = MODNN(reg[j] + j); + q ^= ALPHA_TO[reg[j]]; + } + } + if (q != 0) + continue; /* Not a root */ + /* store root (index-form) and error location number */ +#if DEBUG>=2 + fprintf(stderr,"count %d root %d loc %d\n",count,i,k); +#endif + root[count] = i; + loc[count] = k; + /* If we've already found max possible roots, + * abort the search to save time + */ + if(++count == deg_lambda) + break; + } + if (deg_lambda != count) { + /* + * deg(lambda) unequal to number of roots => uncorrectable + * error detected + */ + count = -1; + goto finish; + } + /* + * Compute err+eras evaluator poly omega(x) = s(x)*lambda(x) (modulo + * x**NROOTS). in index form. Also find deg(omega). + */ + deg_omega = 0; + for (i = 0; i < NROOTS;i++){ + tmp = 0; + j = (deg_lambda < i) ? deg_lambda : i; + for(;j >= 0; j--){ + if ((s[i - j] != A0) && (lambda[j] != A0)) + tmp ^= ALPHA_TO[MODNN(s[i - j] + lambda[j])]; + } + if(tmp != 0) + deg_omega = i; + omega[i] = INDEX_OF[tmp]; + } + omega[NROOTS] = A0; + + /* + * Compute error values in poly-form. num1 = omega(inv(X(l))), num2 = + * inv(X(l))**(FCR-1) and den = lambda_pr(inv(X(l))) all in poly-form + */ + for (j = count-1; j >=0; j--) { + num1 = 0; + for (i = deg_omega; i >= 0; i--) { + if (omega[i] != A0) + num1 ^= ALPHA_TO[MODNN(omega[i] + i * root[j])]; + } + num2 = ALPHA_TO[MODNN(root[j] * (FCR - 1) + NN)]; + den = 0; + + /* lambda[i+1] for i even is the formal derivative lambda_pr of lambda[i] */ + for (i = min(deg_lambda,NROOTS-1) & ~1; i >= 0; i -=2) { + if(lambda[i+1] != A0) + den ^= ALPHA_TO[MODNN(lambda[i+1] + i * root[j])]; + } + if (den == 0) { +#if DEBUG >= 1 + fprintf(stderr,"\n ERROR: denominator = 0\n"); +#endif + count = -1; + goto finish; + } + /* Apply error to data */ + if (num1 != 0) { + data[loc[j]] ^= ALPHA_TO[MODNN(INDEX_OF[num1] + INDEX_OF[num2] + NN - INDEX_OF[den])]; + } + } + finish: + if(eras_pos != NULL){ + for(i=0;i. +// +// ----------------------------------------------------------------------- +// +// +// Some of this is based on: +// +// FX.25 Encoder +// Author: Jim McGuire KB3MPL +// Date: 23 October 2007 +// +// This program is a single-file implementation of the FX.25 encapsulation +// structure for use with AX.25 data packets. Details of the FX.25 +// specification are available at: +// http://www.stensat.org/Docs/Docs.htm +// +// This program implements a single RS(255,239) FEC structure. Future +// releases will incorporate more capabilities as accommodated in the FX.25 +// spec. +// +// The Reed Solomon encoding routines are based on work performed by +// Phil Karn. Phil was kind enough to release his code under the GPL, as +// noted below. Consequently, this FX.25 implementation is also released +// under the terms of the GPL. +// +// Phil Karn's original copyright notice: + /* Test the Reed-Solomon codecs + * for various block sizes and with random data and random error patterns + * + * Copyright 2002 Phil Karn, KA9Q + * May be used under the terms of the GNU General Public License (GPL) + * + */ + +#include "direwolf.h" + +#include +#include +#include +#include +#include // uint64_t +#include // PRIx64 +#include + +#include "fx25.h" +#include "textcolor.h" + + +#define NTAB 3 + +static struct { + int symsize; // Symbol size, bits (1-8). Always 8 for this application. + int genpoly; // Field generator polynomial coefficients. + int fcs; // First root of RS code generator polynomial, index form. + int prim; // Primitive element to generate polynomial roots. + int nroots; // RS code generator polynomial degree (number of roots). + // Same as number of check bytes added. + struct rs *rs; // Pointer to RS codec control block. Filled in at init time. +} Tab[NTAB] = { + {8, 0x11d, 1, 1, 16, NULL }, // RS(255,239) + {8, 0x11d, 1, 1, 32, NULL }, // RS(255,223) + {8, 0x11d, 1, 1, 64, NULL }, // RS(255,191) +}; + +/* + * Reference: http://www.stensat.org/docs/FX-25_01_06.pdf + * FX.25 + * Forward Error Correction Extension to + * AX.25 Link Protocol For Amateur Packet Radio + * Version: 0.01 DRAFT + * Date: 01 September 2006 + */ + +struct correlation_tag_s { + uint64_t value; // 64 bit value, send LSB first. + int n_block_radio; // Size of transmitted block, all in bytes. + int k_data_radio; // Size of transmitted data part. + int n_block_rs; // Size of RS algorithm block. + int k_data_rs; // Size of RS algorithm data part. + int itab; // Index into Tab array. +}; + +static const struct correlation_tag_s tags[16] = { + /* Tag_00 */ { 0x566ED2717946107ELL, 0, 0, 0, 0, -1 }, // Reserved + + /* Tag_01 */ { 0xB74DB7DF8A532F3ELL, 255, 239, 255, 239, 0 }, // RS(255, 239) 16-byte check value, 239 information bytes + /* Tag_02 */ { 0x26FF60A600CC8FDELL, 144, 128, 255, 239, 0 }, // RS(144,128) - shortened RS(255, 239), 128 info bytes + /* Tag_03 */ { 0xC7DC0508F3D9B09ELL, 80, 64, 255, 239, 0 }, // RS(80,64) - shortened RS(255, 239), 64 info bytes + /* Tag_04 */ { 0x8F056EB4369660EELL, 48, 32, 255, 239, 0 }, // RS(48,32) - shortened RS(255, 239), 32 info bytes + + /* Tag_05 */ { 0x6E260B1AC5835FAELL, 255, 223, 255, 223, 1 }, // RS(255, 223) 32-byte check value, 223 information bytes + /* Tag_06 */ { 0xFF94DC634F1CFF4ELL, 160, 128, 255, 223, 1 }, // RS(160,128) - shortened RS(255, 223), 128 info bytes + /* Tag_07 */ { 0x1EB7B9CDBC09C00ELL, 96, 64, 255, 223, 1 }, // RS(96,64) - shortened RS(255, 223), 64 info bytes + /* Tag_08 */ { 0xDBF869BD2DBB1776LL, 64, 32, 255, 223, 1 }, // RS(64,32) - shortened RS(255, 223), 32 info bytes + + /* Tag_09 */ { 0x3ADB0C13DEAE2836LL, 255, 191, 255, 191, 2 }, // RS(255, 191) 64-byte check value, 191 information bytes + /* Tag_0A */ { 0xAB69DB6A543188D6LL, 192, 128, 255, 191, 2 }, // RS(192, 128) - shortened RS(255, 191), 128 info bytes + /* Tag_0B */ { 0x4A4ABEC4A724B796LL, 128, 64, 255, 191, 2 }, // RS(128, 64) - shortened RS(255, 191), 64 info bytes + + /* Tag_0C */ { 0x0293D578626B67E6LL, 0, 0, 0, 0, -1 }, // Undefined + /* Tag_0D */ { 0xE3B0B0D6917E58A6LL, 0, 0, 0, 0, -1 }, // Undefined + /* Tag_0E */ { 0x720267AF1BE1F846LL, 0, 0, 0, 0, -1 }, // Undefined + /* Tag_0F */ { 0x93210201E8F4C706LL, 0, 0, 0, 0, -1 } // Undefined +}; + + + +#define CLOSE_ENOUGH 8 // How many bits can be wrong in tag yet consider it a match? + // Needs to be large enough to match with significant errors + // but not so large to get frequent false matches. + // Probably don't want >= 16 because the hamming distance between + // any two pairs is 32. + // What is a good number? 8?? 12?? 15?? + // 12 got many false matches with random noise. + // Even 8 might be too high. We see 2 or 4 bit errors here + // at the point where decoding the block is very improbable. + // After 2 months of continuous operation as a digipeater/iGate, + // no false triggers were observed. So 8 doesn't seem to be too + // high for 1200 bps. No study has been done for 9600 bps. + +// Given a 64 bit correlation tag value, find acceptable match in table. +// Return index into table or -1 for no match. + +// Both gcc and clang have a built in function to count the number of '1' bits +// in an integer. This can result in a single machine instruction. You might need +// to supply your own popcount function if using a different compiler. + +int fx25_tag_find_match (uint64_t t) +{ + for (int c = CTAG_MIN; c <= CTAG_MAX; c++) { + if (__builtin_popcountll(t ^ tags[c].value) <= CLOSE_ENOUGH) { + //printf ("%016" PRIx64 " received\n", t); + //printf ("%016" PRIx64 " tag %d\n", tags[c].value, c); + //printf ("%016" PRIx64 " xor, popcount = %d\n", t ^ tags[c].value, __builtin_popcountll(t ^ tags[c].value)); + return (c); + } + } + return (-1); +} + + + +void free_rs_char(struct rs *rs){ + free(rs->alpha_to); + free(rs->index_of); + free(rs->genpoly); + free(rs); +} + + +/*------------------------------------------------------------- + * + * Name: fx25_init + * + * Purpose: This must be called once before any of the other fx25 functions. + * + * Inputs: debug_level - Controls level of informational / debug messages. + * + * 0 Only errors. + * 1 (default) Transmitting ctag. Currently no other way to know this. + * 2 Receive correlation tag detected. FEC decode complete. + * 3 Dump data going in and out. + * + * Use command line -dx to increase level or -qx for quiet. + * + * Description: Initialize 3 Reed-Solomon codecs, for 16, 32, and 64 check bytes. + * + *--------------------------------------------------------------*/ + +static int g_debug_level; + +void fx25_init ( int debug_level ) +{ + g_debug_level = debug_level; + + for (int i = 0 ; i < NTAB ; i++) { + Tab[i].rs = INIT_RS(Tab[i].symsize, Tab[i].genpoly, Tab[i].fcs, Tab[i].prim, Tab[i].nroots); + if (Tab[i].rs == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf("FX.25 internal error: init_rs_char failed!\n"); + exit(EXIT_FAILURE); + } + } + + // Verify integrity of tables and assumptions. + // This also does a quick check for the popcount function. + + for (int j = 0; j < 16 ; j++) { + for (int k = 0; k < 16; k++) { + if (j == k) { + assert (__builtin_popcountll(tags[j].value ^ tags[k].value) == 0); + } + else { + assert (__builtin_popcountll(tags[j].value ^ tags[k].value) == 32); + } + } + } + + for (int j = CTAG_MIN; j <= CTAG_MAX; j++) { + assert (tags[j].n_block_radio - tags[j].k_data_radio == Tab[tags[j].itab].nroots); + assert (tags[j].n_block_rs - tags[j].k_data_rs == Tab[tags[j].itab].nroots); + assert (tags[j].n_block_rs == FX25_BLOCK_SIZE); + } + + assert (fx25_pick_mode (100+1, 239) == 1); + assert (fx25_pick_mode (100+1, 240) == -1); + + assert (fx25_pick_mode (100+5, 223) == 5); + assert (fx25_pick_mode (100+5, 224) == -1); + + assert (fx25_pick_mode (100+9, 191) == 9); + assert (fx25_pick_mode (100+9, 192) == -1); + + assert (fx25_pick_mode (16, 32) == 4); + assert (fx25_pick_mode (16, 64) == 3); + assert (fx25_pick_mode (16, 128) == 2); + assert (fx25_pick_mode (16, 239) == 1); + assert (fx25_pick_mode (16, 240) == -1); + + assert (fx25_pick_mode (32, 32) == 8); + assert (fx25_pick_mode (32, 64) == 7); + assert (fx25_pick_mode (32, 128) == 6); + assert (fx25_pick_mode (32, 223) == 5); + assert (fx25_pick_mode (32, 234) == -1); + + assert (fx25_pick_mode (64, 64) == 11); + assert (fx25_pick_mode (64, 128) == 10); + assert (fx25_pick_mode (64, 191) == 9); + assert (fx25_pick_mode (64, 192) == -1); + + assert (fx25_pick_mode (1, 32) == 4); + assert (fx25_pick_mode (1, 33) == 3); + assert (fx25_pick_mode (1, 64) == 3); + assert (fx25_pick_mode (1, 65) == 6); + assert (fx25_pick_mode (1, 128) == 6); + assert (fx25_pick_mode (1, 191) == 9); + assert (fx25_pick_mode (1, 223) == 5); + assert (fx25_pick_mode (1, 239) == 1); + assert (fx25_pick_mode (1, 240) == -1); + +} // fx25_init + + +// Get properties of specified CTAG number. + +struct rs *fx25_get_rs (int ctag_num) +{ + assert (ctag_num >= CTAG_MIN && ctag_num <= CTAG_MAX); + assert (tags[ctag_num].itab >= 0 && tags[ctag_num].itab < NTAB); + assert (Tab[tags[ctag_num].itab].rs != NULL); + return (Tab[tags[ctag_num].itab].rs); +} + +uint64_t fx25_get_ctag_value (int ctag_num) +{ + assert (ctag_num >= CTAG_MIN && ctag_num <= CTAG_MAX); + return (tags[ctag_num].value); +} + +int fx25_get_k_data_radio (int ctag_num) +{ + assert (ctag_num >= CTAG_MIN && ctag_num <= CTAG_MAX); + return (tags[ctag_num].k_data_radio); +} + +int fx25_get_k_data_rs (int ctag_num) +{ + assert (ctag_num >= CTAG_MIN && ctag_num <= CTAG_MAX); + return (tags[ctag_num].k_data_rs); +} + +int fx25_get_nroots (int ctag_num) +{ + assert (ctag_num >= CTAG_MIN && ctag_num <= CTAG_MAX); + return (Tab[tags[ctag_num].itab].nroots); +} + +int fx25_get_debug (void) +{ + return (g_debug_level); +} + +/*------------------------------------------------------------- + * + * Name: fx25_pick_mode + * + * Purpose: Pick suitable transmission format based on user preference + * and size of data part required. + * + * Inputs: fx_mode - 0 = none. + * 1 = pick a tag automatically. + * 16, 32, 64 = use this many check bytes. + * 100 + n = use tag n. + * + * 0 and 1 would be the most common. + * Others are mostly for testing. + * + * dlen - Required size for transmitted "data" part, in bytes. + * This includes the AX.25 frame with bit stuffing and a flag + * pattern on each end. + * + * Returns: Correlation tag number in range of CTAG_MIN thru CTAG_MAX. + * -1 is returned for failure. + * The caller should fall back to using plain old AX.25. + * + *--------------------------------------------------------------*/ + +int fx25_pick_mode (int fx_mode, int dlen) +{ + if (fx_mode <= 0) return (-1); + +// Specify a specific tag by adding 100 to the number. +// Fails if data won't fit. + + if (fx_mode - 100 >= CTAG_MIN && fx_mode - 100 <= CTAG_MAX) { + if (dlen <= fx25_get_k_data_radio(fx_mode - 100)) { + return (fx_mode - 100); + } + else { + return (-1); // Assuming caller prints failure message. + } + } + +// Specify number of check bytes. +// Pick the shortest one that can handle the required data length. + + else if (fx_mode == 16 || fx_mode == 32 || fx_mode == 64) { + for (int k = CTAG_MAX; k >= CTAG_MIN; k--) { + if (fx_mode == fx25_get_nroots(k) && dlen <= fx25_get_k_data_radio(k)) { + return (k); + } + } + return (-1); + } + +// For any other number, [[ or if the preference was not possible, ?? ]] +// try to come up with something reasonable. For shorter frames, +// use smaller overhead. For longer frames, where an error is +// more probable, use more check bytes. When the data gets even +// larger, check bytes must be reduced to fit in block size. +// When all else fails, fall back to normal AX.25. +// Some of this is from observing UZ7HO Soundmodem behavior. +// +// Tag Data Check Max Num +// Number Bytes Bytes Repaired +// ------ ----- ----- ----- +// 0x04 32 16 8 +// 0x03 64 16 8 +// 0x06 128 32 16 +// 0x09 191 64 32 +// 0x05 223 32 16 +// 0x01 239 16 8 +// none larger +// +// The PRUG FX.25 TNC has additional modes that will handle larger frames +// by using multiple RS blocks. This is a future possibility but needs +// to be coordinated with other FX.25 developers so we maintain compatibility. +// See https://web.tapr.org/meetings/DCC_2020/JE1WAZ/DCC-2020-PRUG-FINAL.pptx + + static const int prefer[6] = { 0x04, 0x03, 0x06, 0x09, 0x05, 0x01 }; + for (int k = 0; k < 6; k++) { + int m = prefer[k]; + if (dlen <= fx25_get_k_data_radio(m)) { + return (m); + } + } + return (-1); + +// TODO: revisit error messages, produced by caller, when this returns -1. + +} + + +/* Initialize a Reed-Solomon codec + * symsize = symbol size, bits (1-8) - always 8 for this application. + * gfpoly = Field generator polynomial coefficients + * fcr = first root of RS code generator polynomial, index form + * prim = primitive element to generate polynomial roots + * nroots = RS code generator polynomial degree (number of roots) + */ + +struct rs *INIT_RS(unsigned int symsize,unsigned int gfpoly,unsigned fcr,unsigned prim, + unsigned int nroots){ + struct rs *rs; + int i, j, sr,root,iprim; + + if(symsize > 8*sizeof(DTYPE)) + return NULL; /* Need version with ints rather than chars */ + + if(fcr >= (1<= (1<= (1<mm = symsize; + rs->nn = (1<alpha_to = (DTYPE *)calloc((rs->nn+1),sizeof(DTYPE)); + if(rs->alpha_to == NULL){ + text_color_set(DW_COLOR_ERROR); + dw_printf ("FATAL ERROR: Out of memory.\n"); + exit (EXIT_FAILURE); + } + rs->index_of = (DTYPE *)calloc((rs->nn+1),sizeof(DTYPE)); + if(rs->index_of == NULL){ + text_color_set(DW_COLOR_ERROR); + dw_printf ("FATAL ERROR: Out of memory.\n"); + exit (EXIT_FAILURE); + } + + /* Generate Galois field lookup tables */ + rs->index_of[0] = A0; /* log(zero) = -inf */ + rs->alpha_to[A0] = 0; /* alpha**-inf = 0 */ + sr = 1; + for(i=0;inn;i++){ + rs->index_of[sr] = i; + rs->alpha_to[i] = sr; + sr <<= 1; + if(sr & (1<nn; + } + if(sr != 1){ + /* field generator polynomial is not primitive! */ + free(rs->alpha_to); + free(rs->index_of); + free(rs); + return NULL; + } + + /* Form RS code generator polynomial from its roots */ + rs->genpoly = (DTYPE *)calloc((nroots+1),sizeof(DTYPE)); + if(rs->genpoly == NULL){ + text_color_set(DW_COLOR_ERROR); + dw_printf ("FATAL ERROR: Out of memory.\n"); + exit (EXIT_FAILURE); + } + rs->fcr = fcr; + rs->prim = prim; + rs->nroots = nroots; + + /* Find prim-th root of 1, used in decoding */ + for(iprim=1;(iprim % prim) != 0;iprim += rs->nn) + ; + rs->iprim = iprim / prim; + + rs->genpoly[0] = 1; + for (i = 0,root=fcr*prim; i < nroots; i++,root += prim) { + rs->genpoly[i+1] = 1; + + /* Multiply rs->genpoly[] by @**(root + x) */ + for (j = i; j > 0; j--){ + if (rs->genpoly[j] != 0) + rs->genpoly[j] = rs->genpoly[j-1] ^ rs->alpha_to[modnn(rs,rs->index_of[rs->genpoly[j]] + root)]; + else + rs->genpoly[j] = rs->genpoly[j-1]; + } + /* rs->genpoly[0] can never be zero */ + rs->genpoly[0] = rs->alpha_to[modnn(rs,rs->index_of[rs->genpoly[0]] + root)]; + } + /* convert rs->genpoly[] to index form for quicker encoding */ + for (i = 0; i <= nroots; i++) { + rs->genpoly[i] = rs->index_of[rs->genpoly[i]]; + } + +// diagnostic prints +#if 0 + printf("Alpha To:\n\r"); + for (i=0; i < sizeof(DTYPE)*(rs->nn+1); i++) + printf("0x%2x,", rs->alpha_to[i]); + printf("\n\r"); + + printf("Index Of:\n\r"); + for (i=0; i < sizeof(DTYPE)*(rs->nn+1); i++) + printf("0x%2x,", rs->index_of[i]); + printf("\n\r"); + + printf("GenPoly:\n\r"); + for (i = 0; i <= nroots; i++) + printf("0x%2x,", rs->genpoly[i]); + printf("\n\r"); +#endif + return rs; +} + + +// TEMPORARY!!! +// FIXME: We already have multiple copies of this. +// Consolidate them into one somewhere. + +void fx_hex_dump (unsigned char *p, int len) +{ + int n, i, offset; + + offset = 0; + while (len > 0) { + n = len < 16 ? len : 16; + dw_printf (" %03x: ", offset); + for (i=0; i. +// + + + +/******************************************************************************** + * + * File: fx25_rec.c + * + * Purpose: Extract FX.25 codeblocks from a stream of bits and process them. + * + *******************************************************************************/ + +#include "direwolf.h" + +#include +#include +#include +#include +#include +//#if __WIN32__ +//#include +//#endif + +#include "fx25.h" + +#include "fcs_calc.h" +#include "textcolor.h" +#include "multi_modem.h" +#include "demod.h" + +struct fx_context_s { + + enum { FX_TAG=0, FX_DATA, FX_CHECK } state; + uint64_t accum; // Accumulate bits for matching to correlation tag. + int ctag_num; // Correlation tag number, CTAG_MIN to CTAG_MAX if approx. match found. + int k_data_radio; // Expected size of "data" sent over radio. + int coffs; // Starting offset of the check part. + int nroots; // Expected number of check bytes. + int dlen; // Accumulated length in "data" below. + int clen; // Accumulated length in "check" below. + unsigned char imask; // Mask for storing a bit. + unsigned char block[FX25_BLOCK_SIZE+1]; +}; + +static struct fx_context_s *fx_context[MAX_CHANS][MAX_SUBCHANS][MAX_SLICERS]; + +static void process_rs_block (int chan, int subchan, int slice, struct fx_context_s *F); + +static int my_unstuff (int chan, int subchan, int slice, unsigned char * restrict pin, int ilen, unsigned char * restrict frame_buf); + +//#define FXTEST 1 // Define for standalone test application. + // It expects to find files fx01.dat, fx02.dat, ..., fx0b.dat/ + +#if FXTEST +static int fx25_test_count = 0; + +int main () +{ + fx25_init(3); + + for (int i = CTAG_MIN; i <= CTAG_MAX; i++) { + + char fname[32]; + snprintf (fname, sizeof(fname), "fx%02x.dat", i); + FILE *fp = fopen(fname, "rb"); + if (fp == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("\n"); + dw_printf ("****** Could not open %s ******\n", fname); + dw_printf ("****** Did you generate the test files first? ******\n"); + exit (EXIT_FAILURE); + } + +//#if 0 // reminder for future if reading from stdin. +//#if __WIN32__ +// // So 0x1a byte does not signal EOF. +// _setmode(_fileno(stdin), _O_BINARY); +//#endif +// fp = stdin; +//#endif + unsigned char ch; + while (fread(&ch, 1, 1, fp) == 1) { + for (unsigned char imask = 0x01; imask != 0; imask <<=1) { + fx25_rec_bit (0, 0, 0, ch & imask); + } + } + fclose (fp); + } + + if (fx25_test_count == 11) { + text_color_set(DW_COLOR_REC); + dw_printf ("\n"); + dw_printf ("\n"); + dw_printf ("\n"); + dw_printf ("***** FX25 unit test Success - all tests passed. *****\n"); + exit (EXIT_SUCCESS); + } + text_color_set(DW_COLOR_ERROR); + dw_printf ("\n"); + dw_printf ("\n"); + dw_printf ("***** FX25 unit test FAILED. Only %d/11 tests passed. *****\n", fx25_test_count); + exit (EXIT_SUCCESS); + +} // end main + +#endif // FXTEST + + + +/*********************************************************************************** + * + * Name: fx25_rec_bit + * + * Purpose: Extract FX.25 codeblocks from a stream of bits. + * In a completely integrated AX.25 / FX.25 receive system, + * this would see the same bit stream as hdlc_rec_bit. + * + * Inputs: chan - Channel number. + * + * subchan - This allows multiple demodulators per channel. + * + * slice - Allows multiple slicers per demodulator (subchannel). + * + * dbit - Data bit after NRZI and any descrambling. + * Any non-zero value is logic '1'. + * + * Description: This is called once for each received bit. + * For each valid frame, process_rec_frame() is called for further processing. + * It can gather multiple candidates from different parallel demodulators + * ("subchannels") and slicers, then decide which one is the best. + * + ***********************************************************************************/ + +#define FENCE 0x55 // to detect buffer overflow. + +void fx25_rec_bit (int chan, int subchan, int slice, int dbit) +{ + +// Allocate context blocks only as needed. + + struct fx_context_s *F = fx_context[chan][subchan][slice]; + if (F == NULL) { + assert (chan >= 0 && chan < MAX_CHANS); + assert (subchan >= 0 && subchan < MAX_SUBCHANS); + assert (slice >= 0 && slice < MAX_SLICERS); + F = fx_context[chan][subchan][slice] = (struct fx_context_s *)malloc(sizeof (struct fx_context_s)); + assert (F != NULL); + memset (F, 0, sizeof(struct fx_context_s)); + } + +// State machine to identify correlation tag then gather appropriate number of data and check bytes. + + switch (F->state) { + case FX_TAG: + F->accum >>= 1; + if (dbit) F->accum |= 1LL << 63; + int c = fx25_tag_find_match (F->accum); + if (c >= CTAG_MIN && c <= CTAG_MAX) { + + F->ctag_num = c; + F->k_data_radio = fx25_get_k_data_radio (F->ctag_num); + F->nroots = fx25_get_nroots (F->ctag_num); + F->coffs = fx25_get_k_data_rs (F->ctag_num); + assert (F->coffs == FX25_BLOCK_SIZE - F->nroots); + + if (fx25_get_debug() >= 2) { + text_color_set(DW_COLOR_INFO); + dw_printf ("FX.25[%d.%d]: Matched correlation tag 0x%02x with %d bit errors. Expecting %d data & %d check bytes.\n", + chan, slice, // ideally subchan too only if applicable + c, + __builtin_popcountll(F->accum ^ fx25_get_ctag_value(c)), + F->k_data_radio, F->nroots); + } + + F->imask = 0x01; + F->dlen = 0; + F->clen = 0; + memset (F->block, 0, sizeof(F->block)); + F->block[FX25_BLOCK_SIZE] = FENCE; + F->state = FX_DATA; + } + break; + + case FX_DATA: + if (dbit) F->block[F->dlen] |= F->imask; + F->imask <<= 1; + if (F->imask == 0) { + F->imask = 0x01; + F->dlen++; + if (F->dlen >= F->k_data_radio) { + F->state = FX_CHECK; + } + } + break; + + case FX_CHECK: + if (dbit) F->block[F->coffs + F->clen] |= F->imask; + F->imask <<= 1; + if (F->imask == 0) { + F->imask = 0x01; + F->clen++; + if (F->clen >= F->nroots) { + + process_rs_block (chan, subchan, slice, F); // see below + + F->ctag_num = -1; + F->accum = 0; + F->state = FX_TAG; + } + } + break; + } +} + + + +/*********************************************************************************** + * + * Name: fx25_rec_busy + * + * Purpose: Is FX.25 reception currently in progress? + * + * Inputs: chan - Channel number. + * + * Returns: True if currently in progress for the specified channel. + * + * Description: This is required for duplicate removal. One channel and can have + * multiple demodulators (called subchannels) running in parallel. + * Each of them can have multiple slicers. Duplicates need to be + * removed. Normally a delay of a couple bits (or more accurately + * symbols) was fine because they all took about the same amount of time. + * Now, we can have an additional delay of up to 64 check bytes and + * some filler in the data portion. We can't simply wait that long. + * With normal AX.25 a couple frames can come and go during that time. + * We want to delay the duplicate removal while FX.25 block reception + * is going on. + * + ***********************************************************************************/ + +int fx25_rec_busy (int chan) +{ + assert (chan >= 0 && chan < MAX_CHANS); + + // This could be a little faster if we knew number of + // subchannels and slicers but it is probably insignificant. + + for (int i = 0; i < MAX_SUBCHANS; i++) { + for (int j = 0; j < MAX_SLICERS; j++) { + if (fx_context[chan][i][j] != NULL) { + if (fx_context[chan][i][j]->state != FX_TAG) { + return (1); + } + } + } + } + return (0); + +} // end fx25_rec_busy + + + +/*********************************************************************************** + * + * Name: process_rs_block + * + * Purpose: After the correlation tag was detected and the appropriate number + * of data and check bytes are accumulated, this performs the processing + * + * Inputs: chan, subchan, slice + * + * F->ctag_num - Correlation tag number (index into table) + * + * F->dlen - Number of "data" bytes. + * + * F->clen - Number of "check" bytes" + * + * F->block - Codeblock. Always 255 total bytes. + * Anything left over after data and check + * bytes is filled with zeros. + * + * <- - - - - - - - - - - 255 bytes total - - - - - - - - -> + * +-----------------------+---------------+---------------+ + * | dlen bytes "data" | zero fill | check bytes | + * +-----------------------+---------------+---------------+ + * + * Description: Use Reed-Solomon decoder to fix up any errors. + * Extract the AX.25 frame from the corrected data. + * + ***********************************************************************************/ + +static void process_rs_block (int chan, int subchan, int slice, struct fx_context_s *F) +{ + if (fx25_get_debug() >= 3) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("FX.25[%d.%d]: Received RS codeblock.\n", chan, slice); + fx_hex_dump (F->block, FX25_BLOCK_SIZE); + } + assert (F->block[FX25_BLOCK_SIZE] == FENCE); + + int derrlocs[FX25_MAX_CHECK]; // Half would probably be OK. + struct rs *rs = fx25_get_rs(F->ctag_num); + + int derrors = DECODE_RS(rs, F->block, derrlocs, 0); + + if (derrors >= 0) { // -1 for failure. >= 0 for success, number of bytes corrected. + + if (fx25_get_debug() >= 2) { + text_color_set(DW_COLOR_INFO); + if (derrors == 0) { + dw_printf ("FX.25[%d.%d]: FEC complete with no errors.\n", chan, slice); + } + else { + dw_printf ("FX.25[%d.%d]: FEC complete, fixed %2d errors in byte positions:", chan, slice, derrors); + for (int k = 0; k < derrors; k++) { + dw_printf (" %d", derrlocs[k]); + } + dw_printf ("\n"); + } + } + + unsigned char frame_buf[FX25_MAX_DATA+1]; // Out must be shorter than input. + int frame_len = my_unstuff (chan, subchan, slice, F->block, F->dlen, frame_buf); + + if (frame_len >= 14 + 1 + 2) { // Minimum length: Two addresses & control & FCS. + + unsigned short actual_fcs = frame_buf[frame_len-2] | (frame_buf[frame_len-1] << 8); + unsigned short expected_fcs = fcs_calc (frame_buf, frame_len - 2); + if (actual_fcs == expected_fcs) { + + if (fx25_get_debug() >= 3) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("FX.25[%d.%d]: Extracted AX.25 frame:\n", chan, slice); + fx_hex_dump (frame_buf, frame_len); + } + +#if FXTEST + fx25_test_count++; +#else + alevel_t alevel = demod_get_audio_level (chan, subchan); + + multi_modem_process_rec_frame (chan, subchan, slice, frame_buf, frame_len - 2, alevel, derrors, 1); /* len-2 to remove FCS. */ + +#endif + } else { + // Most likely cause is defective sender software. + text_color_set(DW_COLOR_ERROR); + dw_printf ("FX.25[%d.%d]: Bad FCS for AX.25 frame.\n", chan, slice); + fx_hex_dump (F->block, F->dlen); + fx_hex_dump (frame_buf, frame_len); + } + } + else { + // Most likely cause is defective sender software. + text_color_set(DW_COLOR_ERROR); + dw_printf ("FX.25[%d.%d]: AX.25 frame is shorter than minimum length.\n", chan, slice); + fx_hex_dump (F->block, F->dlen); + fx_hex_dump (frame_buf, frame_len); + } + } + else if (fx25_get_debug() >= 2) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("FX.25[%d.%d]: FEC failed. Too many errors.\n", chan, slice); + } + +} // process_rs_block + + +/*********************************************************************************** + * + * Name: my_unstuff + * + * Purpose: Remove HDLC it stuffing and surrounding flag delimiters. + * + * Inputs: chan, subchan, slice - For error messages. + * + * pin - "data" part of RS codeblock. + * First byte must be HDLC "flag". + * May be followed by additional flags. + * There must be terminating flag but it might not be byte aligned. + * + * ilen - Number of bytes in pin. + * + * Outputs: frame_buf - Frame contents including FCS. + * Bit stuffing is gone so it should be a whole number of bytes. + * + * Returns: Number of bytes in frame_buf, including 2 for FCS. + * This can never be larger than the max "data" size. + * 0 if any error. + * + * Errors: First byte is not not flag. + * Found seven '1' bits in a row. + * Result is not whole number of bytes after removing bit stuffing. + * Trailing flag not found. + * Most likely cause, for all of these, is defective sender software. + * + ***********************************************************************************/ + +static int my_unstuff (int chan, int subchan, int slice, unsigned char * restrict pin, int ilen, unsigned char * restrict frame_buf) +{ + unsigned char pat_det = 0; // Pattern detector. + unsigned char oacc = 0; // Accumulator for a byte out. + int olen = 0; // Number of good bits in oacc. + int frame_len = 0; // Number of bytes accumulated, including CRC. + + if (*pin != 0x7e) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("FX.25[%d.%d] error: Data section did not start with 0x7e.\n", chan, slice); + fx_hex_dump (pin, ilen); + return (0); + } + while (ilen > 0 && *pin == 0x7e) { + ilen--; + pin++; // Skip over leading flag byte(s). + } + + for (int i=0; i>= 1; // Shift the most recent eight bits thru the pattern detector. + pat_det |= dbit << 7; + + if (pat_det == 0xfe) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("FX.25[%d.%d]: Invalid AX.25 frame - Seven '1' bits in a row.\n", chan, slice); + fx_hex_dump (pin, ilen); + return 0; + } + + if (dbit) { + oacc >>= 1; + oacc |= 0x80; + } else { + if (pat_det == 0x7e) { // "flag" pattern - End of frame. + if (olen == 7) { + return (frame_len); // Whole number of bytes in result including CRC + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("FX.25[%d.%d]: Invalid AX.25 frame - Not a whole number of bytes.\n", chan, slice); + fx_hex_dump (pin, ilen); + return (0); + } + } else if ( (pat_det >> 2) == 0x1f ) { + continue; // Five '1' bits in a row, followed by '0'. Discard the '0'. + } + oacc >>= 1; + } + + olen++; + if (olen & 8) { + olen = 0; + frame_buf[frame_len++] = oacc; + } + } + } /* end of loop on all bits in block */ + + text_color_set(DW_COLOR_ERROR); + dw_printf ("FX.25[%d.%d]: Invalid AX.25 frame - Terminating flag not found.\n", chan, slice); + fx_hex_dump (pin, ilen); + + return (0); // Should never fall off the end. + +} // my_unstuff + +// end fx25_rec.c \ No newline at end of file diff --git a/src/fx25_send.c b/src/fx25_send.c new file mode 100644 index 00000000..7435be9f --- /dev/null +++ b/src/fx25_send.c @@ -0,0 +1,336 @@ +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// +// Copyright (C) 2019 John Langner, WB2OSZ +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . +// + +#include "direwolf.h" + +#include +#include +#include +#include + +#include "fx25.h" +#include "fcs_calc.h" +#include "textcolor.h" +#include "audio.h" +#include "gen_tone.h" + + +//#define FXTEST 1 // To build unit test application. + + +#ifndef FXTEST +static void send_bytes (int chan, unsigned char *b, int count); +static void send_bit (int chan, int b); +#endif +static int stuff_it (unsigned char *in, int ilen, unsigned char *out, int osize); + + +static int number_of_bits_sent[MAX_CHANS]; // Count number of bits sent by "fx25_send_frame" or "???" + + +#if FXTEST +static unsigned char preload[] = { + 'T'<<1, 'E'<<1, 'S'<<1, 'T'<<1, ' '<<1, ' '<<1, 0x60, + 'W'<<1, 'B'<<1, '2'<<1, 'O'<<1, 'S'<<1, 'Z'<<1, 0x63, + 0x03, 0xf0, + 'F', 'o', 'o', '?' , 'B', 'a', 'r', '?' , // '?' causes bit stuffing + 0, 0, 0 // Room for FCS + extra +}; + +int main () +{ + text_color_set(DW_COLOR_ERROR); + dw_printf("fxsend - FX.25 unit test.\n"); + dw_printf("This generates 11 files named fx01.dat, fx02.dat, ..., fx0b.dat\n"); + dw_printf("Run fxrec as second part of test.\n"); + + fx25_init (3); + for (int i = 100 + CTAG_MIN; i <= 100 + CTAG_MAX; i++) { + fx25_send_frame (0, preload, (int)sizeof(preload)-3, i); + } + exit(EXIT_SUCCESS); +} // end main +#endif + + +/*------------------------------------------------------------- + * + * Name: fx25_send_frame + * + * Purpose: Convert HDLC frames to a stream of bits. + * + * Inputs: chan - Audio channel number, 0 = first. + * + * fbuf - Frame buffer address. + * + * flen - Frame length, before bit-stuffing, not including the FCS. + * + * fx_mode - Normally, this would be 16, 32, or 64 for the desired number + * of check bytes. The shortest format, adequate for the + * required data length will be picked automatically. + * 0x01 thru 0x0b may also be specified for a specific format + * but this is expected to be mostly for testing, not normal + * operation. + * + * Outputs: Bits are shipped out by calling tone_gen_put_bit(). + * + * Returns: Number of bits sent including "flags" and the + * stuffing bits. + * The required time can be calculated by dividing this + * number by the transmit rate of bits/sec. + * -1 is returned for failure. + * + * Description: Generate an AX.25 frame in the usual way then wrap + * it inside of the FX.25 correlation tag and check bytes. + * + * Assumptions: It is assumed that the tone_gen module has been + * properly initialized so that bits sent with + * tone_gen_put_bit() are processed correctly. + * + * Errors: If something goes wrong, return -1 and the caller should + * fallback to sending normal AX.25. + * + * This could happen if the frame is too large. + * + *--------------------------------------------------------------*/ + +int fx25_send_frame (int chan, unsigned char *fbuf, int flen, int fx_mode) +{ + if (fx25_get_debug() >= 3) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("------\n"); + dw_printf ("FX.25[%d] send frame: FX.25 mode = %d\n", chan, fx_mode); + fx_hex_dump (fbuf, flen); + } + + number_of_bits_sent[chan] = 0; + + // Append the FCS. + + int fcs = fcs_calc (fbuf, flen); + fbuf[flen++] = fcs & 0xff; + fbuf[flen++] = (fcs >> 8) & 0xff; + + // Add bit-stuffing. + + unsigned char data[FX25_MAX_DATA+1]; + const unsigned char fence = 0xaa; + data[FX25_MAX_DATA] = fence; + + int dlen = stuff_it(fbuf, flen, data, FX25_MAX_DATA); + + assert (data[FX25_MAX_DATA] == fence); + if (dlen < 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("FX.25[%d]: Frame length of %d + overhead is too large to encode.\n", chan, flen); + return (-1); + } + + // Pick suitable correlation tag depending on + // user's preference, for number of check bytes, + // and the data size. + + int ctag_num = fx25_pick_mode (fx_mode, dlen); + + if (ctag_num < CTAG_MIN || ctag_num > CTAG_MAX) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("FX.25[%d]: Could not find suitable format for requested %d and data length %d.\n", chan, fx_mode, dlen); + return (-1); + } + + uint64_t ctag_value = fx25_get_ctag_value (ctag_num); + + // Zero out part of data which won't be transmitted. + // It should all be filled by extra HDLC "flag" patterns. + + int k_data_radio = fx25_get_k_data_radio (ctag_num); + int k_data_rs = fx25_get_k_data_rs (ctag_num); + int shorten_by = FX25_MAX_DATA - k_data_radio; + if (shorten_by > 0) { + memset (data + k_data_radio, 0, shorten_by); + } + + // Compute the check bytes. + + unsigned char check[FX25_MAX_CHECK+1]; + check[FX25_MAX_CHECK] = fence; + struct rs *rs = fx25_get_rs (ctag_num); + + assert (k_data_rs + NROOTS == NN); + + ENCODE_RS(rs, data, check); + assert (check[FX25_MAX_CHECK] == fence); + + if (fx25_get_debug() >= 3) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("FX.25[%d]: transmit %d data bytes, ctag number 0x%02x\n", chan, k_data_radio, ctag_num); + fx_hex_dump (data, k_data_radio); + dw_printf ("FX.25[%d]: transmit %d check bytes:\n", chan, NROOTS); + fx_hex_dump (check, NROOTS); + dw_printf ("------\n"); + } + +#if FXTEST + // Standalone text application. + + unsigned char flags[16] = { 0x7e ,0x7e ,0x7e ,0x7e ,0x7e ,0x7e ,0x7e ,0x7e ,0x7e ,0x7e ,0x7e ,0x7e ,0x7e ,0x7e ,0x7e ,0x7e }; + char fname[32]; + snprintf (fname, sizeof(fname), "fx%02x.dat", ctag_num); + FILE *fp = fopen(fname, "wb"); + fwrite (flags, sizeof(flags), 1, fp); + //fwrite ((unsigned char *)(&ctag_value), sizeof(ctag_value), 1, fp); // No - assumes little endian. + for (int k = 0; k < 8; k++) { + unsigned char b = (ctag_value >> (k * 8)) & 0xff; // Should be portable to big endian too. + fwrite (&b, 1, 1, fp); + } +#if 1 + for (int j = 8; j < 16; j++) { // Introduce errors. + data[j] = ~ data[j]; + } +#endif + fwrite (data, k_data_radio, 1, fp); + fwrite (check, NROOTS, 1, fp); + fwrite (flags, sizeof(flags), 1, fp); + fflush(fp); + fclose (fp); +#else + // Normal usage. Send bits to modulator. + +// Temp hack for testing. Corrupt first 8 bytes. +// for (int j = 0; j < 16; j++) { +// data[j] = ~ data[j]; +// } + + for (int k = 0; k < 8; k++) { + unsigned char b = (ctag_value >> (k * 8)) & 0xff; + send_bytes (chan, &b, 1); + } + send_bytes (chan, data, k_data_radio); + send_bytes (chan, check, NROOTS); +#endif + + return (number_of_bits_sent[chan]); +} + + +#ifndef FXTEST + +static void send_bytes (int chan, unsigned char *b, int count) +{ + for (int j = 0; j < count; j++) { + unsigned char x = b[j]; + for (int k = 0; k < 8; k++) { + send_bit (chan, x & 0x01); + x >>= 1; + } + } +} + +/* + * NRZI encoding. + * data 1 bit -> no change. + * data 0 bit -> invert signal. + */ +static void send_bit (int chan, int b) +{ + static int output[MAX_CHANS]; + + if (b == 0) { + output[chan] = ! output[chan]; + } + tone_gen_put_bit (chan, output[chan]); + number_of_bits_sent[chan]++; +} +#endif // FXTEST + + +/*------------------------------------------------------------- + * + * Name: stuff_it + * + * Purpose: Perform HDLC bit-stuffing and add "flag" octets in + * preparation for the RS encoding. + * + * Inputs: in - Frame, including FCS, in. + * + * ilen - Number of bytes in. + * + * osize - Size of out area. + * + * Outputs: out - Location to receive result. + * + * Returns: Number of bytes needed in output area including one trailing flag. + * -1 if it won't fit. + * + * Description: Convert to stream of bits including: + * start flag + * bit stuffed data, including FCS + * end flag + * Fill remainder with flag octets which might not be on byte boundaries. + * + *--------------------------------------------------------------*/ + +#define put_bit(value) { \ + if (olen >= osize) return(-1); \ + if (value) out[olen>>3] |= 1 << (olen & 0x7); \ + olen++; \ + } + +static int stuff_it (unsigned char *in, int ilen, unsigned char *out, int osize) +{ + const unsigned char flag = 0x7e; + int ret = -1; + memset (out, 0, osize); + out[0] = flag; + int olen = 8; // Number of bits in output. + osize *= 8; // Now in bits rather than bytes. + int ones = 0; + + for (int i = 0; i < ilen; i++) { + for (unsigned char imask = 1; imask != 0; imask <<= 1) { + int v = in[i] & imask; + put_bit(v); + if (v) { + ones++; + if (ones == 5) { + put_bit(0); + ones = 0; + } + } + else { + ones = 0; + } + } + } + for (unsigned char imask = 1; imask != 0; imask <<= 1) { + put_bit(flag & imask); + } + ret = (olen + 7) / 8; // Includes any partial byte. + + unsigned char imask = 1; + while (olen < osize) { + put_bit( flag & imask); + imask = (imask << 1) | (imask >> 7); // Rotate. + } + + return (ret); + +} // end stuff_it + +// end fx25_send.c \ No newline at end of file diff --git a/src/gen_packets.c b/src/gen_packets.c new file mode 100644 index 00000000..57b2741c --- /dev/null +++ b/src/gen_packets.c @@ -0,0 +1,1126 @@ +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// +// Copyright (C) 2011, 2013, 2014, 2015, 2016, 2019, 2021, 2023 John Langner, WB2OSZ +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . +// + + +/*------------------------------------------------------------------ + * + * Name: gen_packets.c + * + * Purpose: Test program for generating AX.25 frames. + * + * Description: Given messages are converted to audio and written + * to a .WAV type audio file. + * + * Bugs: Most options are implemented for only one audio channel. + * + * Examples: Different speeds: + * + * gen_packets -o z1.wav + * atest z1.wav + * + * gen_packets -B 300 -o z3.wav + * atest -B 300 z3.wav + * + * gen_packets -B 9600 -o z9.wav + * atest -B 300 z9.wav + * + * User-defined content: + * + * echo "WB2OSZ>APDW12:This is a test" | gen_packets -o z.wav - + * atest z.wav + * + * echo "WB2OSZ>APDW12:Test line 1" > z.txt + * echo "WB2OSZ>APDW12:Test line 2" >> z.txt + * echo "WB2OSZ>APDW12:Test line 3" >> z.txt + * gen_packets -o z.wav z.txt + * atest z.wav + * + * With artificial noise added: + * + * gen_packets -n 100 -o z2.wav + * atest z2.wav + * + * Variable speed. e.g. 95% to 105% of normal speed. + * Required parameter is max % below and above normal. + * Optionally specify step other than 0.1%. + * Used to test how tolerant TNCs are to senders not + * not using exactly the right baud rate. + * + * gen_packets -v 5 + * gen_packets -v 5,0.5 + * + *------------------------------------------------------------------*/ + + +#include "direwolf.h" + +#include +#include +#include +#include +#include +#include + +#include "audio.h" +#include "ax25_pad.h" +#include "hdlc_send.h" +#include "gen_tone.h" +#include "textcolor.h" +#include "morse.h" +#include "dtmf.h" +#include "fx25.h" +#include "il2p.h" + + +/* Own random number generator so we can get */ +/* same results on Windows and Linux. */ + +#define MY_RAND_MAX 0x7fffffff +static int seed = 1; + +static int my_rand (void) { + // Perform the calculation as unsigned to avoid signed overflow error. + seed = (int)(((unsigned)seed * 1103515245) + 12345) & MY_RAND_MAX; + return (seed); +} + +static void usage (char **argv); +static int audio_file_open (char *fname, struct audio_s *pa); +static int audio_file_close (void); + +static int g_add_noise = 0; +static float g_noise_level = 0; +static int g_morse_wpm = 0; /* Send morse code at this speed. */ + + + +static struct audio_s modem; + + +static void send_packet (char *str) +{ + packet_t pp; + unsigned char fbuf[AX25_MAX_PACKET_LEN+2]; + int flen; + int c = 0; // channel number. + + if (g_morse_wpm > 0) { + + // Why not use the destination field instead of command line option? + // For one thing, this is not in TNC-2 monitor format. + + morse_send (c, str, g_morse_wpm, 100, 100); + } + else if (modem.achan[0].modem_type == MODEM_EAS) { + +// Generate EAS SAME signal FOR RESEARCH AND TESTING ONLY!!! +// There could be legal consequences for sending unauhorized SAME +// over the radio so don't do it! + + // I'm expecting to see TNC 2 monitor format. + // The source and destination are ignored. + // The optional destination SSID is the number of times to repeat. + // The user defined data type indicator can optionally be used + // for compatibility with how it is received and presented to client apps. + // Examples: + // X>X-3:{DEZCZC-WXR-RWT-033019-033017-033015-033013-033011-025011-025017-033007-033005-033003-033001-025009-025027-033009+0015-1691525-KGYX/NWS- + // X>X:NNNN + + pp = ax25_from_text (str, 1); + if (pp == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("\"%s\" is not valid TNC2 monitoring format.\n", str); + return; + } + unsigned char *pinfo; + int info_len = ax25_get_info (pp, &pinfo); + if (info_len >= 3 && strncmp((char*)pinfo, "{DE", 3) == 0) { + pinfo += 3; + info_len -= 3; + } + + int repeat = ax25_get_ssid (pp, AX25_DESTINATION); + if (repeat == 0) repeat = 1; + + eas_send (c, pinfo, repeat, 500, 500); + ax25_delete (pp); + } + else { + pp = ax25_from_text (str, 1); + if (pp == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("\"%s\" is not valid TNC2 monitoring format.\n", str); + return; + } + flen = ax25_pack (pp, fbuf); + (void)flen; + + // If stereo, put same thing in each channel. + + for (c=0; c MAX_BAUD) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Use a more reasonable bit rate in range of %d - %d.\n", MIN_BAUD, MAX_BAUD); + exit (EXIT_FAILURE); + } + break; + + case 'B': /* -B for data Bit rate */ + /* 300 implies 1600/1800 AFSK. */ + /* 1200 implies 1200/2200 AFSK. */ + /* 9600 implies scrambled. */ + + /* If you want something else, specify -B first */ + /* then anything to override these defaults with -m, -s, or -g. */ + + // FIXME: options should not be order dependent. + + if (strcasecmp(optarg, "EAS") == 0) { + modem.achan[0].baud = 0xEA5EA5; // See special case below. + } + else { + modem.achan[0].baud = atoi(optarg); + } + + text_color_set(DW_COLOR_INFO); + dw_printf ("Data rate set to %d bits / second.\n", modem.achan[0].baud); + + /* We have similar logic in direwolf.c, config.c, gen_packets.c, and atest.c, */ + /* that need to be kept in sync. Maybe it could be a common function someday. */ + + if (modem.achan[0].baud == 100) { // What was this for? + modem.achan[0].modem_type = MODEM_AFSK; + modem.achan[0].mark_freq = 1615; + modem.achan[0].space_freq = 1785; + } + else if (modem.achan[0].baud == 0xEA5EA5) { + modem.achan[0].baud = 521; // Fine tuned later. 520.83333 + // Proper fix is to make this float. + modem.achan[0].modem_type = MODEM_EAS; + modem.achan[0].mark_freq = 2083.3333; // Ideally these should be floating point. + modem.achan[0].space_freq = 1562.5000 ; + } + else if (modem.achan[0].baud < 600) { + modem.achan[0].modem_type = MODEM_AFSK; + modem.achan[0].mark_freq = 1600; // Typical for HF SSB + modem.achan[0].space_freq = 1800; + } + else if (modem.achan[0].baud < 1800) { + modem.achan[0].modem_type = MODEM_AFSK; + modem.achan[0].mark_freq = DEFAULT_MARK_FREQ; + modem.achan[0].space_freq = DEFAULT_SPACE_FREQ; + } + else if (modem.achan[0].baud < 3600) { + modem.achan[0].modem_type = MODEM_QPSK; + modem.achan[0].mark_freq = 0; + modem.achan[0].space_freq = 0; + dw_printf ("Using V.26 QPSK rather than AFSK.\n"); + if (modem.achan[0].baud != 2400) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Bit rate should be standard 2400 rather than specified %d.\n", modem.achan[0].baud); + } + } + else if (modem.achan[0].baud < 7200) { + modem.achan[0].modem_type = MODEM_8PSK; + modem.achan[0].mark_freq = 0; + modem.achan[0].space_freq = 0; + dw_printf ("Using V.27 8PSK rather than AFSK.\n"); + if (modem.achan[0].baud != 4800) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Bit rate should be standard 4800 rather than specified %d.\n", modem.achan[0].baud); + } + } + else { + modem.achan[0].modem_type = MODEM_SCRAMBLE; + text_color_set(DW_COLOR_INFO); + dw_printf ("Using scrambled baseband signal rather than AFSK.\n"); + } + if (modem.achan[0].baud != 100 && (modem.achan[0].baud < MIN_BAUD || modem.achan[0].baud > MAX_BAUD)) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Use a more reasonable bit rate in range of %d - %d.\n", MIN_BAUD, MAX_BAUD); + exit (EXIT_FAILURE); + } + break; + + case 'g': /* -g for g3ruh scrambling */ + + g_opt = 1; + break; + + case 'j': /* -j V.26 compatible with earlier direwolf. */ + + j_opt = 1; + break; + + case 'J': /* -J V.26 compatible with MFJ-2400. */ + + J_opt = 1; + break; + + case 'm': /* -m for Mark freq */ + + modem.achan[0].mark_freq = atoi(optarg); + text_color_set(DW_COLOR_INFO); + dw_printf ("Mark frequency set to %d Hz.\n", modem.achan[0].mark_freq); + if (modem.achan[0].mark_freq < 300 || modem.achan[0].mark_freq > 3000) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Use a more reasonable value in range of 300 - 3000.\n"); + exit (EXIT_FAILURE); + } + break; + + case 's': /* -s for Space freq */ + + modem.achan[0].space_freq = atoi(optarg); + text_color_set(DW_COLOR_INFO); + dw_printf ("Space frequency set to %d Hz.\n", modem.achan[0].space_freq); + if (modem.achan[0].space_freq < 300 || modem.achan[0].space_freq > 3000) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Use a more reasonable value in range of 300 - 3000.\n"); + exit (EXIT_FAILURE); + } + break; + + case 'n': /* -n number of packets with increasing noise. */ + + packet_count = atoi(optarg); + g_add_noise = 1; + break; + + case 'N': /* -N number of packets. Don't add noise. */ + + packet_count = atoi(optarg); + g_add_noise = 0; + break; + + case 'a': /* -a for amplitude */ + + amplitude = atoi(optarg); + text_color_set(DW_COLOR_INFO); + dw_printf ("Amplitude set to %d%%.\n", amplitude); + if (amplitude < 0 || amplitude > 200) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Amplitude must be in range of 0 to 200.\n"); + exit (EXIT_FAILURE); + } + break; + + case 'r': /* -r for audio sample Rate */ + + modem.adev[0].samples_per_sec = atoi(optarg); + text_color_set(DW_COLOR_INFO); + dw_printf ("Audio sample rate set to %d samples / second.\n", modem.adev[0].samples_per_sec); + if (modem.adev[0].samples_per_sec < MIN_SAMPLES_PER_SEC || modem.adev[0].samples_per_sec > MAX_SAMPLES_PER_SEC) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Use a more reasonable audio sample rate in range of %d - %d.\n", + MIN_SAMPLES_PER_SEC, MAX_SAMPLES_PER_SEC); + exit (EXIT_FAILURE); + } + break; + + case 'z': /* -z leading zeros before frame flag */ + + leading_zeros = atoi(optarg); + text_color_set(DW_COLOR_INFO); + dw_printf ("Send %d zero bits before frame flag.\n", leading_zeros); + + /* The demodulator needs a few for the clock recovery PLL. */ + /* We don't want to be here all day either. */ + /* We can't translate to time yet because the data bit rate */ + /* could be changed later. */ + + if (leading_zeros < 8 || leading_zeros > 12000) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Use a more reasonable value.\n"); + exit (EXIT_FAILURE); + } + break; + + case '8': /* -8 for 8 bit samples */ + + modem.adev[0].bits_per_sample = 8; + text_color_set(DW_COLOR_INFO); + dw_printf("8 bits per audio sample rather than 16.\n"); + break; + + case '2': /* -2 for 2 channels of sound */ + + modem.adev[0].num_channels = 2; + modem.chan_medium[1] = MEDIUM_RADIO; + text_color_set(DW_COLOR_INFO); + dw_printf("2 channels of sound rather than 1.\n"); + break; + + case 'o': /* -o for Output file */ + + strlcpy (output_file, optarg, sizeof(output_file)); + text_color_set(DW_COLOR_INFO); + dw_printf ("Output file set to %s\n", output_file); + break; + + case 'M': /* -M for morse code speed */ + +//TODO: document this. +// Why not base it on the destination field instead? + + g_morse_wpm = atoi(optarg); + text_color_set(DW_COLOR_INFO); + dw_printf ("Morse code speed set to %d WPM.\n", g_morse_wpm); + if (g_morse_wpm < 5 || g_morse_wpm > 50) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Morse code speed must be in range of 5 to 50 WPM.\n"); + exit (EXIT_FAILURE); + } + break; + + case 'X': + + X_opt = atoi(optarg); + break; + + case 'I': // IL2P, normal polarity + + I_opt = atoi(optarg); + break; + + case 'i': // IL2P, inverted polarity + + i_opt = atoi(optarg); + break; + + case 'v': // Variable speed data + an - this percentage + // optional comma and increment. + + variable_speed_max_error = fabs(atof(optarg)); + char *q = strchr(optarg, ','); + if (q != NULL) { + variable_speed_increment = fabs(atof(q+1)); + } + break; + + case '?': + + /* Unknown option message was already printed. */ + usage (argv); + break; + + default: + + /* Should not be here. */ + text_color_set(DW_COLOR_ERROR); + dw_printf("?? getopt returned character code 0%o ??\n", (unsigned)c); + usage (argv); + } + } + +// These must be processed after -B option. + + if (g_opt) { /* -g for g3ruh scrambling */ + + modem.achan[0].modem_type = MODEM_SCRAMBLE; + text_color_set(DW_COLOR_INFO); + dw_printf ("Using G3RUH mode regardless of bit rate.\n"); + } + + if (j_opt) { /* -j V.26 compatible with earlier direwolf. */ + + modem.achan[0].v26_alternative = V26_A; + modem.achan[0].modem_type = MODEM_QPSK; + modem.achan[0].mark_freq = 0; + modem.achan[0].space_freq = 0; + modem.achan[0].baud = 2400; + } + + if (J_opt) { /* -J V.26 compatible with MFJ-2400. */ + + modem.achan[0].v26_alternative = V26_B; + modem.achan[0].modem_type = MODEM_QPSK; + modem.achan[0].mark_freq = 0; + modem.achan[0].space_freq = 0; + modem.achan[0].baud = 2400; + } + + if (modem.achan[0].modem_type == MODEM_QPSK && + modem.achan[0].v26_alternative == V26_UNSPECIFIED) { + + text_color_set(DW_COLOR_ERROR); + dw_printf ("ERROR: Either -j or -J must be specified when using 2400 bps QPSK.\n"); + usage (argv); + exit (1); + } + + if (X_opt > 0) { + if (I_opt != -1 || i_opt != -1) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Can't mix -X with -I or -i.\n"); + exit (EXIT_FAILURE); + } + modem.achan[0].fx25_strength = X_opt; + modem.achan[0].layer2_xmit = LAYER2_FX25; + } + + if (I_opt != -1 && i_opt != -1) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Can't use both -I and -i at the same time.\n"); + exit (EXIT_FAILURE); + } + + if (I_opt >= 0) { + text_color_set(DW_COLOR_INFO); + dw_printf ("Using IL2P normal polarity.\n"); + modem.achan[0].layer2_xmit = LAYER2_IL2P; + modem.achan[0].il2p_max_fec = (I_opt > 0); + modem.achan[0].il2p_invert_polarity = 0; // normal + } + + if (i_opt >= 0) { + text_color_set(DW_COLOR_INFO); + dw_printf ("Using IL2P inverted polarity.\n"); + modem.achan[0].layer2_xmit = LAYER2_IL2P; + modem.achan[0].il2p_max_fec = (i_opt > 0); + modem.achan[0].il2p_invert_polarity = 1; // invert for transmit + if (modem.achan[0].baud == 1200) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Using -i with 1200 bps is a bad idea. Use -I instead.\n"); + } + } + + +/* + * Open the output file. + */ + + if (strlen(output_file) == 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("ERROR: The -o output file option must be specified.\n"); + usage (argv); + exit (1); + } + + err = audio_file_open (output_file, &modem); + + + if (err < 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("ERROR - Can't open output file.\n"); + exit (1); + } + + + gen_tone_init (&modem, amplitude/2, 1); + morse_init (&modem, amplitude/2); + dtmf_init (&modem, amplitude/2); + + // We don't have -d or -q options here. + // Just use the default of minimal information. + + fx25_init (1); + il2p_init (0); // There are no "-d" options so far but it could be handy here. + + assert (modem.adev[0].bits_per_sample == 8 || modem.adev[0].bits_per_sample == 16); + assert (modem.adev[0].num_channels == 1 || modem.adev[0].num_channels == 2); + assert (modem.adev[0].samples_per_sec >= MIN_SAMPLES_PER_SEC && modem.adev[0].samples_per_sec <= MAX_SAMPLES_PER_SEC); + + +/* + * Get user packets(s) from file or stdin if specified. + * "-n" option is ignored in this case. + */ + + if (optind < argc) { + + char str[400]; + + // dw_printf("non-option ARGV-elements: "); + // while (optind < argc) + // dw_printf("%s ", argv[optind++]); + //dw_printf("\n"); + + if (optind < argc - 1) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Warning: File(s) beyond the first are ignored.\n"); + } + + if (strcmp(argv[optind], "-") == 0) { + text_color_set(DW_COLOR_INFO); + dw_printf ("Reading from stdin ...\n"); + input_fp = stdin; + } + else { + input_fp = fopen(argv[optind], "r"); + if (input_fp == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Can't open %s for read.\n", argv[optind]); + exit (EXIT_FAILURE); + } + text_color_set(DW_COLOR_INFO); + dw_printf ("Reading from %s ...\n", argv[optind]); + } + + while (fgets (str, sizeof(str), input_fp) != NULL) { + text_color_set(DW_COLOR_REC); + dw_printf ("%s", str); + send_packet (str); + } + + if (input_fp != stdin) { + fclose (input_fp); + } + + audio_file_close(); + return EXIT_SUCCESS; + } + +/* + * Otherwise, use the built in packets. + */ + text_color_set(DW_COLOR_INFO); + dw_printf ("built in message...\n"); + +// +// Generate packets with variable speed. +// This overrides any other number of packets or adding noise. +// + + + if (variable_speed_max_error != 0) { + + int normal_speed = modem.achan[0].baud; + + text_color_set(DW_COLOR_INFO); + dw_printf ("Variable speed.\n"); + + for (double speed_error = - variable_speed_max_error; + speed_error <= variable_speed_max_error + 0.001; + speed_error += variable_speed_increment) { + + // Baud is int so we get some roundoff. Make it real? + modem.achan[0].baud = (int)round(normal_speed * (1. + speed_error / 100.)); + gen_tone_init (&modem, amplitude/2, 1); + + char stemp[256]; + snprintf (stemp, sizeof(stemp), "WB2OSZ-15>TEST:, speed %+0.1f%% The quick brown fox jumps over the lazy dog!", speed_error); + send_packet (stemp); + } + } + + else if (packet_count > 0) { + +/* + * Generate packets with increasing noise level. + * Would probably be better to record real noise from a radio but + * for now just use a random number generator. + */ + for (i = 1; i <= packet_count; i++) { + + char stemp[88]; + + if (modem.achan[0].baud < 600) { + /* e.g. 300 bps AFSK - About 2/3 should be decoded properly. */ + g_noise_level = amplitude *.0048 * ((float)i / packet_count); + } + else if (modem.achan[0].baud < 1800) { + /* e.g. 1200 bps AFSK - About 2/3 should be decoded properly. */ + g_noise_level = amplitude *.0023 * ((float)i / packet_count); + } + else if (modem.achan[0].baud < 3600) { + /* e.g. 2400 bps QPSK - T.B.D. */ + g_noise_level = amplitude *.0015 * ((float)i / packet_count); + } + else if (modem.achan[0].baud < 7200) { + /* e.g. 4800 bps - T.B.D. */ + g_noise_level = amplitude *.0007 * ((float)i / packet_count); + } + else { + /* e.g. 9600 */ + g_noise_level = 0.33 * (amplitude / 200.0) * ((float)i / packet_count); + // temp test + //g_noise_level = 0.20 * (amplitude / 200.0) * ((float)i / packet_count); + } + + snprintf (stemp, sizeof(stemp), "WB2OSZ-15>TEST:,The quick brown fox jumps over the lazy dog! %04d of %04d", i, packet_count); + + send_packet (stemp); + + } + } + else { + + // This should send a total of 6. + // Note that sticking in the user defined type {DE is optional. + + if (modem.achan[0].modem_type == MODEM_EAS) { + send_packet ("X>X-3:{DEZCZC-WXR-RWT-033019-033017-033015-033013-033011-025011-025017-033007-033005-033003-033001-025009-025027-033009+0015-1691525-KGYX/NWS-"); + send_packet ("X>X-2:{DENNNN"); + send_packet ("X>X:NNNN"); + } + else { +/* + * Builtin default 4 packets. + */ + send_packet ("WB2OSZ-15>TEST:,The quick brown fox jumps over the lazy dog! 1 of 4"); + send_packet ("WB2OSZ-15>TEST:,The quick brown fox jumps over the lazy dog! 2 of 4"); + send_packet ("WB2OSZ-15>TEST:,The quick brown fox jumps over the lazy dog! 3 of 4"); + send_packet ("WB2OSZ-15>TEST:,The quick brown fox jumps over the lazy dog! 4 of 4"); + } + } + + audio_file_close(); + + return EXIT_SUCCESS; +} + + +static void usage (char **argv) +{ + + text_color_set(DW_COLOR_ERROR); + dw_printf ("\n"); + dw_printf ("Usage: gen_packets [options] [file]\n"); + dw_printf ("Options:\n"); + dw_printf (" -a Signal amplitude in range of 0 - 200%%. Default 50.\n"); + dw_printf (" -b Bits / second for data. Default is %d.\n", DEFAULT_BAUD); + dw_printf (" -B Bits / second for data. Proper modem selected for 300, 1200, 2400, 4800, 9600, EAS.\n"); + dw_printf (" -g Scrambled baseband rather than AFSK.\n"); + dw_printf (" -j 2400 bps QPSK compatible with direwolf <= 1.5.\n"); + dw_printf (" -J 2400 bps QPSK compatible with MFJ-2400.\n"); + dw_printf (" -X n 1 to enable FX.25 transmit. 16, 32, 64 for specific number of check bytes.\n"); + dw_printf (" -I n Enable IL2P transmit. n=1 is recommended. 0 uses weaker FEC.\n"); + dw_printf (" -i n Enable IL2P transmit, inverted polarity. n=1 is recommended. 0 uses weaker FEC.\n"); + dw_printf (" -m Mark frequency. Default is %d.\n", DEFAULT_MARK_FREQ); + dw_printf (" -s Space frequency. Default is %d.\n", DEFAULT_SPACE_FREQ); + dw_printf (" -r Audio sample Rate. Default is %d.\n", DEFAULT_SAMPLES_PER_SEC); + dw_printf (" -n Generate specified number of frames with increasing noise.\n"); + dw_printf (" -o Send output to .wav file.\n"); + dw_printf (" -8 8 bit audio rather than 16.\n"); + dw_printf (" -2 2 channels (stereo) audio rather than one channel.\n"); + dw_printf (" -v max[,incr] Variable speed with specified maximum error and increment.\n"); +// dw_printf (" -z Number of leading zero bits before frame.\n"); +// dw_printf (" Default is 12 which is .01 seconds at 1200 bits/sec.\n"); + + dw_printf ("\n"); + dw_printf ("An optional file may be specified to provide messages other than\n"); + dw_printf ("the default built-in message. The format should correspond to\n"); + dw_printf ("the standard packet monitoring representation such as,\n\n"); + dw_printf (" WB2OSZ-1>APDW12,WIDE2-2:!4237.14NS07120.83W#\n"); + dw_printf ("User defined content can't be used with -n option.\n"); + dw_printf ("\n"); + dw_printf ("Example: gen_packets -o x.wav \n"); + dw_printf ("\n"); + dw_printf (" With all defaults, a built-in test message is generated\n"); + dw_printf (" with standard Bell 202 tones used for packet radio on ordinary\n"); + dw_printf (" VHF FM transceivers.\n"); + dw_printf ("\n"); + dw_printf ("Example: gen_packets -o x.wav -g -b 9600\n"); + dw_printf ("Shortcut: gen_packets -o x.wav -B 9600\n"); + dw_printf ("\n"); + dw_printf (" 9600 baud mode.\n"); + dw_printf ("\n"); + dw_printf ("Example: gen_packets -o x.wav -m 1600 -s 1800 -b 300\n"); + dw_printf ("Shortcut: gen_packets -o x.wav -B 300\n"); + dw_printf ("\n"); + dw_printf (" 200 Hz shift, 300 baud, suitable for HF SSB transceiver.\n"); + dw_printf ("\n"); + dw_printf ("Example: echo -n \"WB2OSZ>WORLD:Hello, world!\" | gen_packets -a 25 -o x.wav -\n"); + dw_printf ("\n"); + dw_printf (" Read message from stdin and put quarter volume sound into the file x.wav.\n"); + + exit (EXIT_FAILURE); +} + + + +/*------------------------------------------------------------------ + * + * Name: audio_file_open + * + * Purpose: Open a .WAV format file for output. + * + * Inputs: fname - Name of .WAV file to create. + * + * pa - Address of structure of type audio_s. + * + * The fields that we care about are: + * num_channels + * samples_per_sec + * bits_per_sample + * If zero, reasonable defaults will be provided. + * + * Returns: 0 for success, -1 for failure. + * + *----------------------------------------------------------------*/ + +struct wav_header { /* .WAV file header. */ + char riff[4]; /* "RIFF" */ + int filesize; /* file length - 8 */ + char wave[4]; /* "WAVE" */ + char fmt[4]; /* "fmt " */ + int fmtsize; /* 16. */ + short wformattag; /* 1 for PCM. */ + short nchannels; /* 1 for mono, 2 for stereo. */ + int nsamplespersec; /* sampling freq, Hz. */ + int navgbytespersec; /* = nblockalign * nsamplespersec. */ + short nblockalign; /* = wbitspersample / 8 * nchannels. */ + short wbitspersample; /* 16 or 8. */ + char data[4]; /* "data" */ + int datasize; /* number of bytes following. */ +} ; + + /* 8 bit samples are unsigned bytes */ + /* in range of 0 .. 255. */ + + /* 16 bit samples are signed short */ + /* in range of -32768 .. +32767. */ + +static FILE *out_fp = NULL; + +static struct wav_header header; + +static int byte_count; /* Number of data bytes written to file. */ + /* Will be written to header when file is closed. */ + + +static int audio_file_open (char *fname, struct audio_s *pa) +{ + int n; + +/* + * Fill in defaults for any missing values. + */ + if (pa -> adev[0].num_channels == 0) + pa -> adev[0].num_channels = DEFAULT_NUM_CHANNELS; + + if (pa -> adev[0].samples_per_sec == 0) + pa -> adev[0].samples_per_sec = DEFAULT_SAMPLES_PER_SEC; + + if (pa -> adev[0].bits_per_sample == 0) + pa -> adev[0].bits_per_sample = DEFAULT_BITS_PER_SAMPLE; + + +/* + * Write the file header. Don't know length yet. + */ + out_fp = fopen (fname, "wb"); + + if (out_fp == NULL) { + text_color_set(DW_COLOR_ERROR); dw_printf ("Couldn't open file for write: %s\n", fname); + perror (""); + return (-1); + } + + memset (&header, 0, sizeof(header)); + + memcpy (header.riff, "RIFF", (size_t)4); + header.filesize = 0; + memcpy (header.wave, "WAVE", (size_t)4); + memcpy (header.fmt, "fmt ", (size_t)4); + header.fmtsize = 16; // Always 16. + header.wformattag = 1; // 1 for PCM. + + header.nchannels = pa -> adev[0].num_channels; + header.nsamplespersec = pa -> adev[0].samples_per_sec; + header.wbitspersample = pa -> adev[0].bits_per_sample; + + header.nblockalign = header.wbitspersample / 8 * header.nchannels; + header.navgbytespersec = header.nblockalign * header.nsamplespersec; + memcpy (header.data, "data", (size_t)4); + header.datasize = 0; + + assert (header.nchannels == 1 || header.nchannels == 2); + + n = fwrite (&header, sizeof(header), (size_t)1, out_fp); + + if (n != 1) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Couldn't write header to: %s\n", fname); + perror (""); + fclose (out_fp); + out_fp = NULL; + return (-1); + } + + +/* + * Number of bytes written will be filled in later. + */ + byte_count = 0; + + return (0); + +} /* end audio_open */ + + +/*------------------------------------------------------------------ + * + * Name: audio_put + * + * Purpose: Send one byte to the audio output file. + * + * Inputs: c - One byte in range of 0 - 255. + * + * Returns: Normally non-negative. + * -1 for any type of error. + * + * Description: The caller must deal with the details of mono/stereo + * and number of bytes per sample. + * + *----------------------------------------------------------------*/ + + +int audio_put (int a, int c) +{ + static short sample16; + int s; + + if (g_add_noise) { + + if ((byte_count & 1) == 0) { + sample16 = c & 0xff; /* save lower byte. */ + byte_count++; + return c; + } + else { + float r; + + sample16 |= (c << 8) & 0xff00; /* insert upper byte. */ + byte_count++; + s = sample16; // sign extend. + +/* Add random noise to the signal. */ +/* r should be in range of -1 .. +1. */ + +/* Use own function instead of rand() from the C library. */ +/* Windows and Linux have different results, messing up my self test procedure. */ +/* No idea what Mac OSX and BSD might do. */ + + + r = (my_rand() - MY_RAND_MAX/2.0) / (MY_RAND_MAX/2.0); + + s += 5 * r * g_noise_level * 32767; + + if (s > 32767) s = 32767; + if (s < -32767) s = -32767; + + putc(s & 0xff, out_fp); + return (putc((s >> 8) & 0xff, out_fp)); + } + } + else { + byte_count++; + return (putc(c, out_fp)); + } + +} /* end audio_put */ + + +int audio_flush (int a) +{ + return 0; +} + +/*------------------------------------------------------------------ + * + * Name: audio_file_close + * + * Purpose: Close the audio output file. + * + * Returns: Normally non-negative. + * -1 for any type of error. + * + * + * Description: Must go back to beginning of file and fill in the + * size of the data. + * + *----------------------------------------------------------------*/ + +static int audio_file_close (void) +{ + int n; + + //text_color_set(DW_COLOR_DEBUG); + //dw_printf ("audio_close()\n"); + +/* + * Go back and fix up lengths in header. + */ + header.filesize = byte_count + sizeof(header) - 8; + header.datasize = byte_count; + + if (out_fp == NULL) { + return (-1); + } + + fflush (out_fp); + + fseek (out_fp, 0L, SEEK_SET); + n = fwrite (&header, sizeof(header), (size_t)1, out_fp); + + if (n != 1) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Couldn't write header to audio file.\n"); + perror (""); // TODO: remove perror. + fclose (out_fp); + out_fp = NULL; + return (-1); + } + + fclose (out_fp); + out_fp = NULL; + + return (0); + +} /* end audio_close */ + + +// To keep dtmf.c happy. + +#include "hdlc_rec.h" // for dcd_change + +void dcd_change (int chan, int subchan, int slice, int state) +{ +} diff --git a/src/gen_tone.c b/src/gen_tone.c new file mode 100644 index 00000000..6a816556 --- /dev/null +++ b/src/gen_tone.c @@ -0,0 +1,764 @@ +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// +// Copyright (C) 2011, 2014, 2015, 2016, 2019, 2023 John Langner, WB2OSZ +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . +// + + +/*------------------------------------------------------------------ + * + * Module: gen_tone.c + * + * Purpose: Convert bits to AFSK for writing to .WAV sound file + * or a sound device. + * + * + *---------------------------------------------------------------*/ + +#include "direwolf.h" + + +#include +#include +#include +#include +#include +#include + + +#include "audio.h" +#include "gen_tone.h" +#include "textcolor.h" + +#include "fsk_demod_state.h" /* for MAX_FILTER_SIZE which might be overly generous for here. */ + /* but safe if we use same size as for receive. */ +#include "dsp.h" + + +// Properties of the digitized sound stream & modem. + +static struct audio_s *save_audio_config_p = NULL; + +/* + * 8 bit samples are unsigned bytes in range of 0 .. 255. + * + * 16 bit samples are signed short in range of -32768 .. +32767. + */ + + +/* Constants after initialization. */ + +#define TICKS_PER_CYCLE ( 256.0 * 256.0 * 256.0 * 256.0 ) + +static int ticks_per_sample[MAX_CHANS]; /* Same for both channels of same soundcard */ + /* because they have same sample rate */ + /* but less confusing to have for each channel. */ + +static int ticks_per_bit[MAX_CHANS]; +static int f1_change_per_sample[MAX_CHANS]; +static int f2_change_per_sample[MAX_CHANS]; +static float samples_per_symbol[MAX_CHANS]; + + +static short sine_table[256]; + + +/* Accumulators. */ + +static unsigned int tone_phase[MAX_CHANS]; // Phase accumulator for tone generation. + // Upper bits are used as index into sine table. + +#define PHASE_SHIFT_180 ( 128u << 24 ) +#define PHASE_SHIFT_90 ( 64u << 24 ) +#define PHASE_SHIFT_45 ( 32u << 24 ) + + +static int bit_len_acc[MAX_CHANS]; // To accumulate fractional samples per bit. + +static int lfsr[MAX_CHANS]; // Shift register for scrambler. + +static int bit_count[MAX_CHANS]; // Counter incremented for each bit transmitted + // on the channel. This is only used for QPSK. + // The LSB determines if we save the bit until + // next time, or send this one with the previously saved. + // The LSB+1 position determines if we add an + // extra 180 degrees to the phase to compensate + // for having 1.5 carrier cycles per symbol time. + + // For 8PSK, it has a different meaning. It is the + // number of bits in 'save_bit' so we can accumulate + // three for each symbol. +static int save_bit[MAX_CHANS]; + + +static int prev_dat[MAX_CHANS]; // Previous data bit. Used for G3RUH style. + + + + +/*------------------------------------------------------------------ + * + * Name: gen_tone_init + * + * Purpose: Initialize for AFSK tone generation which might + * be used for RTTY or amateur packet radio. + * + * Inputs: audio_config_p - Pointer to modem parameter structure, modem_s. + * + * The fields we care about are: + * + * samples_per_sec + * baud + * mark_freq + * space_freq + * samples_per_sec + * + * amp - Signal amplitude on scale of 0 .. 100. + * + * 100% uses the full 16 bit sample range of +-32k. + * + * gen_packets - True if being called from "gen_packets" utility + * rather than the "direwolf" application. + * + * Returns: 0 for success. + * -1 for failure. + * + * Description: Calculate various constants for use by the direct digital synthesis + * audio tone generation. + * + *----------------------------------------------------------------*/ + +static int amp16bit; /* for 9600 baud */ + + +int gen_tone_init (struct audio_s *audio_config_p, int amp, int gen_packets) +{ + int j; + int chan = 0; + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("gen_tone_init ( audio_config_p=%p, amp=%d, gen_packets=%d )\n", + audio_config_p, amp, gen_packets); +#endif + +/* + * Save away modem parameters for later use. + */ + + save_audio_config_p = audio_config_p; + + amp16bit = (int)((32767 * amp) / 100); + + for (chan = 0; chan < MAX_CHANS; chan++) { + + if (audio_config_p->chan_medium[chan] == MEDIUM_RADIO) { + + int a = ACHAN2ADEV(chan); + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("gen_tone_init: chan=%d, modem_type=%d, bps=%d, samples_per_sec=%d\n", + chan, + save_audio_config_p->achan[chan].modem_type, + audio_config_p->achan[chan].baud, + audio_config_p->adev[a].samples_per_sec); +#endif + + tone_phase[chan] = 0; + bit_len_acc[chan] = 0; + lfsr[chan] = 0; + + ticks_per_sample[chan] = (int) ((TICKS_PER_CYCLE / (double)audio_config_p->adev[a].samples_per_sec ) + 0.5); + + // The terminology is all wrong here. Didn't matter with 1200 and 9600. + // The config speed should be bits per second rather than baud. + // ticks_per_bit should be ticks_per_symbol. + + switch (save_audio_config_p->achan[chan].modem_type) { + + case MODEM_QPSK: + + audio_config_p->achan[chan].mark_freq = 1800; + audio_config_p->achan[chan].space_freq = audio_config_p->achan[chan].mark_freq; // Not Used. + + // symbol time is 1 / (half of bps) + ticks_per_bit[chan] = (int) ((TICKS_PER_CYCLE / ((double)audio_config_p->achan[chan].baud * 0.5)) + 0.5); + f1_change_per_sample[chan] = (int) (((double)audio_config_p->achan[chan].mark_freq * TICKS_PER_CYCLE / (double)audio_config_p->adev[a].samples_per_sec ) + 0.5); + f2_change_per_sample[chan] = f1_change_per_sample[chan]; // Not used. + samples_per_symbol[chan] = 2. * (float)audio_config_p->adev[a].samples_per_sec / (float)audio_config_p->achan[chan].baud; + + tone_phase[chan] = PHASE_SHIFT_45; // Just to mimic first attempt. + // ??? Why? We are only concerned with the difference + // from one symbol to the next. + break; + + case MODEM_8PSK: + + audio_config_p->achan[chan].mark_freq = 1800; + audio_config_p->achan[chan].space_freq = audio_config_p->achan[chan].mark_freq; // Not Used. + + // symbol time is 1 / (third of bps) + ticks_per_bit[chan] = (int) ((TICKS_PER_CYCLE / ((double)audio_config_p->achan[chan].baud / 3.)) + 0.5); + f1_change_per_sample[chan] = (int) (((double)audio_config_p->achan[chan].mark_freq * TICKS_PER_CYCLE / (double)audio_config_p->adev[a].samples_per_sec ) + 0.5); + f2_change_per_sample[chan] = f1_change_per_sample[chan]; // Not used. + samples_per_symbol[chan] = 3. * (float)audio_config_p->adev[a].samples_per_sec / (float)audio_config_p->achan[chan].baud; + break; + + case MODEM_BASEBAND: + case MODEM_SCRAMBLE: + case MODEM_AIS: + + // Tone is half baud. + ticks_per_bit[chan] = (int) ((TICKS_PER_CYCLE / (double)audio_config_p->achan[chan].baud ) + 0.5); + f1_change_per_sample[chan] = (int) (((double)audio_config_p->achan[chan].baud * 0.5 * TICKS_PER_CYCLE / (double)audio_config_p->adev[a].samples_per_sec ) + 0.5); + samples_per_symbol[chan] = (float)audio_config_p->adev[a].samples_per_sec / (float)audio_config_p->achan[chan].baud; + break; + + case MODEM_EAS: // EAS. + + // TODO: Proper fix would be to use float for baud, mark, space. + + ticks_per_bit[chan] = (int) ((TICKS_PER_CYCLE / 520.833333333333 ) + 0.5); + samples_per_symbol[chan] = (int)((audio_config_p->adev[a].samples_per_sec / 520.83333) + 0.5); + f1_change_per_sample[chan] = (int) ((2083.33333333333 * TICKS_PER_CYCLE / (double)audio_config_p->adev[a].samples_per_sec ) + 0.5); + f2_change_per_sample[chan] = (int) ((1562.5000000 * TICKS_PER_CYCLE / (double)audio_config_p->adev[a].samples_per_sec ) + 0.5); + break; + + default: // AFSK + + ticks_per_bit[chan] = (int) ((TICKS_PER_CYCLE / (double)audio_config_p->achan[chan].baud ) + 0.5); + samples_per_symbol[chan] = (float)audio_config_p->adev[a].samples_per_sec / (float)audio_config_p->achan[chan].baud; + f1_change_per_sample[chan] = (int) (((double)audio_config_p->achan[chan].mark_freq * TICKS_PER_CYCLE / (double)audio_config_p->adev[a].samples_per_sec ) + 0.5); + f2_change_per_sample[chan] = (int) (((double)audio_config_p->achan[chan].space_freq * TICKS_PER_CYCLE / (double)audio_config_p->adev[a].samples_per_sec ) + 0.5); + break; + } + } + } + + for (j=0; j<256; j++) { + double a; + int s; + + a = ((double)(j) / 256.0) * (2 * M_PI); + s = (int) (sin(a) * 32767 * amp / 100.0); + + /* 16 bit sound sample must fit in range of -32768 .. +32767. */ + + if (s < -32768) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("gen_tone_init: Excessive amplitude is being clipped.\n"); + s = -32768; + } + else if (s > 32767) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("gen_tone_init: Excessive amplitude is being clipped.\n"); + s = 32767; + } + sine_table[j] = s; + } + + return (0); + + } /* end gen_tone_init */ + + +/*------------------------------------------------------------------- + * + * Name: tone_gen_put_bit + * + * Purpose: Generate tone of proper duration for one data bit. + * + * Inputs: chan - Audio channel, 0 = first. + * + * dat - 0 for f1, 1 for f2. + * + * -1 inserts half bit to test data + * recovery PLL. + * + * Assumption: fp is open to a file for write. + * + * Version 1.4: Attempt to implement 2400 and 4800 bps PSK modes. + * + * Version 1.6: For G3RUH, rather than generating square wave and low + * pass filtering, generate the waveform directly. + * This avoids overshoot, ringing, and adding more jitter. + * Alternating bits come out has sine wave of baud/2 Hz. + * + * Version 1.6: MFJ-2400 compatibility for V.26. + * + *--------------------------------------------------------------------*/ + +// Interpolate between two values. +// My original approximation simply jumped between phases, producing a discontinuity, +// and increasing bandwidth. +// According to multiple sources, we should transition more gently. +// Below see see a rough approximation of: +// * A step function, immediately going to new value. +// * Linear interpoation. +// * Raised cosine. Square root of cosine is also mentioned. +// +// new - / -- +// | / / +// | / | +// | / / +// old ------- / -- +// step linear raised cosine +// +// Inputs are the old (previous value), new value, and a blending control +// 0 -> take old value +// 1 -> take new value. +// inbetween some sort of weighted average. + +static inline float interpol8 (float oldv, float newv, float bc) +{ + // Step function. + //return (newv); // 78 on 11/7 + + assert (bc >= 0); + assert (bc <= 1.1); + + if (bc < 0) return (oldv); + if (bc > 1) return (newv); + + // Linear interpolation, just for comparison. + //return (bc * newv + (1.0f - bc) * oldv); // 39 on 11/7 + + float rc = 0.5f * (cosf(bc * M_PI - M_PI) + 1.0f); + float rrc = bc >= 0.5f + ? 0.5f * (sqrtf(fabsf(cosf(bc * M_PI - M_PI))) + 1.0f) + : 0.5f * (-sqrtf(fabsf(cosf(bc * M_PI - M_PI))) + 1.0f); + + (void)rrc; + return (rc * newv + (1.0f - bc) * oldv); // 49 on 11/7 + //return (rrc * newv + (1.0f - bc) * oldv); // 55 on 11/7 +} + +static const int gray2phase_v26[4] = {0, 1, 3, 2}; +static const int gray2phase_v27[8] = {1, 0, 2, 3, 6, 7, 5, 4}; + +// #define PSKIQ 1 // not ready for prime time yet. +#if PSKIQ +static int xmit_octant[MAX_CHANS]; // absolute phase in 45 degree units. +static int xmit_prev_octant[MAX_CHANS]; // from previous symbol. + +// For PSK, we generate the final signal by combining fixed frequency cosine and +// sine by the following weights. +static const float ci[8] = { 1, .7071, 0, -.7071, -1, -.7071, 0, .7071 }; +static const float sq[8] = { 0, .7071, 1, .7071, 0, -.7071, -1, -.7071 }; +#endif + +void tone_gen_put_bit (int chan, int dat) +{ + int a = ACHAN2ADEV(chan); /* device for channel. */ + + assert (save_audio_config_p != NULL); + + if (save_audio_config_p->chan_medium[chan] != MEDIUM_RADIO) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Invalid channel %d for tone generation.\n", chan); + return; + } + + if (dat < 0) { + /* Hack to test receive PLL recovery. */ + bit_len_acc[chan] -= ticks_per_bit[chan]; + dat = 0; + } + +// TODO: change to switch instead of if if if + + if (save_audio_config_p->achan[chan].modem_type == MODEM_QPSK) { + + int dibit; + int symbol; + + dat &= 1; // Keep only LSB to be extra safe. + + if ( ! (bit_count[chan] & 1)) { + save_bit[chan] = dat; + bit_count[chan]++; + return; + } + + // All zero bits should give us steady 1800 Hz. + // All one bits should flip phase by 180 degrees each time. + // For V.26B, add another 45 degrees. + // This seems to work a little better. + + dibit = (save_bit[chan] << 1) | dat; + + symbol = gray2phase_v26[dibit]; // 0 .. 3 for QPSK. +#if PSKIQ + // One phase shift unit is 45 degrees. + // Remember what it was last time and calculate new. + // values 0 .. 7. + xmit_prev_octant[chan] = xmit_octant[chan]; + xmit_octant[chan] += symbol * 2; + if (save_audio_config_p->achan[chan].v26_alternative == V26_B) { + xmit_octant[chan] += 1; + } + xmit_octant[chan] &= 0x7; +#else + tone_phase[chan] += symbol * PHASE_SHIFT_90; + if (save_audio_config_p->achan[chan].v26_alternative == V26_B) { + tone_phase[chan] += PHASE_SHIFT_45; + } +#endif + bit_count[chan]++; + } + + if (save_audio_config_p->achan[chan].modem_type == MODEM_8PSK) { + + int tribit; + int symbol; + + dat &= 1; // Keep only LSB to be extra safe. + + if (bit_count[chan] < 2) { + save_bit[chan] = (save_bit[chan] << 1) | dat; + bit_count[chan]++; + return; + } + + // The bit pattern 001 should give us steady 1800 Hz. + // All one bits should flip phase by 180 degrees each time. + + tribit = (save_bit[chan] << 1) | dat; + + symbol = gray2phase_v27[tribit]; + tone_phase[chan] += symbol * PHASE_SHIFT_45; + + save_bit[chan] = 0; + bit_count[chan] = 0; + } + + // Would be logical to have MODEM_BASEBAND for IL2P rather than checking here. But... + // That would mean putting in at least 3 places and testing all rather than just one. + if (save_audio_config_p->achan[chan].modem_type == MODEM_SCRAMBLE && + save_audio_config_p->achan[chan].layer2_xmit != LAYER2_IL2P) { + int x; + + x = (dat ^ (lfsr[chan] >> 16) ^ (lfsr[chan] >> 11)) & 1; + lfsr[chan] = (lfsr[chan] << 1) | (x & 1); + dat = x; + } +#if PSKIQ + int blend = 1; +#endif + do { /* until enough audio samples for this symbol. */ + + int sam; + + switch (save_audio_config_p->achan[chan].modem_type) { + + case MODEM_AFSK: + +#if DEBUG2 + text_color_set(DW_COLOR_DEBUG); + dw_printf ("tone_gen_put_bit %d AFSK\n", __LINE__); +#endif + + // v1.7 reversed. + // Previously a data '1' selected the second (usually higher) tone. + // It never really mattered before because we were using NRZI. + // With the addition of IL2P, we need to be more careful. + // A data '1' should be the mark tone. + + tone_phase[chan] += dat ? f1_change_per_sample[chan] : f2_change_per_sample[chan]; + sam = sine_table[(tone_phase[chan] >> 24) & 0xff]; + gen_tone_put_sample (chan, a, sam); + break; + + case MODEM_EAS: + + tone_phase[chan] += dat ? f1_change_per_sample[chan] : f2_change_per_sample[chan]; + sam = sine_table[(tone_phase[chan] >> 24) & 0xff]; + gen_tone_put_sample (chan, a, sam); + break; + + case MODEM_QPSK: + +#if DEBUG2 + text_color_set(DW_COLOR_DEBUG); + dw_printf ("tone_gen_put_bit %d PSK\n", __LINE__); +#endif + tone_phase[chan] += f1_change_per_sample[chan]; +#if PSKIQ +#if 1 // blend JWL + // remove loop invariant + float old_i = ci[xmit_prev_octant[chan]]; + float old_q = sq[xmit_prev_octant[chan]]; + + float new_i = ci[xmit_octant[chan]]; + float new_q = sq[xmit_octant[chan]]; + + float b = blend / samples_per_symbol[chan]; // roughly 0 to 1 + blend++; + // b = (b - 0.5) * 20 + 0.5; + // if (b < 0) b = 0; + // if (b > 1) b = 1; + // b = b > 0.5; + //b = 1; // 78 decoded with this. + // only 39 without. + + + //float blended_i = new_i * b + old_i * (1.0f - b); + //float blended_q = new_q * b + old_q * (1.0f - b); + + float blended_i = interpol8 (old_i, new_i, b); + float blended_q = interpol8 (old_q, new_q, b); + + sam = blended_i * sine_table[((tone_phase[chan] - PHASE_SHIFT_90) >> 24) & 0xff] + + blended_q * sine_table[(tone_phase[chan] >> 24) & 0xff]; +#else // jump + sam = ci[xmit_octant[chan]] * sine_table[((tone_phase[chan] - PHASE_SHIFT_90) >> 24) & 0xff] + + sq[xmit_octant[chan]] * sine_table[(tone_phase[chan] >> 24) & 0xff]; +#endif +#else + sam = sine_table[(tone_phase[chan] >> 24) & 0xff]; +#endif + gen_tone_put_sample (chan, a, sam); + break; + + case MODEM_8PSK: +#if DEBUG2 + text_color_set(DW_COLOR_DEBUG); + dw_printf ("tone_gen_put_bit %d PSK\n", __LINE__); +#endif + tone_phase[chan] += f1_change_per_sample[chan]; + sam = sine_table[(tone_phase[chan] >> 24) & 0xff]; + gen_tone_put_sample (chan, a, sam); + break; + + case MODEM_BASEBAND: + case MODEM_SCRAMBLE: + case MODEM_AIS: + + if (dat != prev_dat[chan]) { + tone_phase[chan] += f1_change_per_sample[chan]; + } + else { + if (tone_phase[chan] & 0x80000000) + tone_phase[chan] = 0xc0000000; // 270 degrees. + else + tone_phase[chan] = 0x40000000; // 90 degrees. + } + sam = sine_table[(tone_phase[chan] >> 24) & 0xff]; + gen_tone_put_sample (chan, a, sam); + break; + + default: + text_color_set(DW_COLOR_ERROR); + dw_printf ("INTERNAL ERROR: %s %d achan[%d].modem_type = %d\n", + __FILE__, __LINE__, chan, save_audio_config_p->achan[chan].modem_type); + exit (EXIT_FAILURE); + } + + /* Enough for the bit time? */ + + bit_len_acc[chan] += ticks_per_sample[chan]; + + } while (bit_len_acc[chan] < ticks_per_bit[chan]); + + bit_len_acc[chan] -= ticks_per_bit[chan]; + + prev_dat[chan] = dat; // Only needed for G3RUH baseband/scrambled. + +} /* end tone_gen_put_bit */ + + +void gen_tone_put_sample (int chan, int a, int sam) { + + /* Ship out an audio sample. */ + /* 16 bit is signed, little endian, range -32768 .. +32767 */ + /* 8 bit is unsigned, range 0 .. 255 */ + + assert (save_audio_config_p != NULL); + + assert (save_audio_config_p->adev[a].num_channels == 1 || save_audio_config_p->adev[a].num_channels == 2); + + assert (save_audio_config_p->adev[a].bits_per_sample == 16 || save_audio_config_p->adev[a].bits_per_sample == 8); + + // Bad news if we are clipping and distorting the signal. + // We are using the full range. + // Too late to change now because everyone would need to recalibrate their + // transmit audio level. + + if (sam < -32767) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Warning: Audio sample %d clipped to -32767.\n", sam); + sam = -32767; + } + else if (sam > 32767) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Warning: Audio sample %d clipped to +32767.\n", sam); + sam = 32767; + } + + if (save_audio_config_p->adev[a].num_channels == 1) { + + /* Mono */ + + if (save_audio_config_p->adev[a].bits_per_sample == 8) { + audio_put (a, ((sam+32768) >> 8) & 0xff); + } + else { + audio_put (a, sam & 0xff); + audio_put (a, (sam >> 8) & 0xff); + } + } + else { + + if (chan == ADEVFIRSTCHAN(a)) { + + /* Stereo, left channel. */ + + if (save_audio_config_p->adev[a].bits_per_sample == 8) { + audio_put (a, ((sam+32768) >> 8) & 0xff); + audio_put (a, 0); + } + else { + audio_put (a, sam & 0xff); + audio_put (a, (sam >> 8) & 0xff); + + audio_put (a, 0); + audio_put (a, 0); + } + } + else { + + /* Stereo, right channel. */ + + if (save_audio_config_p->adev[a].bits_per_sample == 8) { + audio_put (a, 0); + audio_put (a, ((sam+32768) >> 8) & 0xff); + } + else { + audio_put (a, 0); + audio_put (a, 0); + + audio_put (a, sam & 0xff); + audio_put (a, (sam >> 8) & 0xff); + } + } + } +} + +void gen_tone_put_quiet_ms (int chan, int time_ms) { + + int a = ACHAN2ADEV(chan); /* device for channel. */ + int sam = 0; + + int nsamples = (int) ((time_ms * (float)save_audio_config_p->adev[a].samples_per_sec / 1000.) + 0.5); + + for (int j=0; j 30 OVERLAYED CAR + sym_car, // > 30 OVERLAID CAR sym_default, // ? 31 INFO Kiosk (Blue box with ?) - sym_default, // @ 32 HURICANE/Trop-Storm + sym_default, // @ 32 HURRICANE/Trop-Storm sym_default, // A 33 overlayBOX DTMF & RFID & XO sym_default, // B 34 Blwng Snow (& future codes) sym_coast_guard, // C 35 Coast Guard @@ -445,7 +445,7 @@ static const symbol_type_t grm_alternate_symtab[SYMTAB_SIZE] = { sym_default, // G 39 Snow Shwr (& future ovrlys) sym_default, // H 40 Haze (& Overlay Hazards) sym_default, // I 41 Rain Shower - sym_default, // J 42 Lightening (& future ovrlys) + sym_default, // J 42 Lightning (& future ovrlys) sym_rbcn, // K 43 Kenwood HT (W) sym_light, // L 44 Lighthouse sym_default, // M 45 MARS (A=Army,N=Navy,F=AF) @@ -488,12 +488,12 @@ static const symbol_type_t grm_alternate_symtab[SYMTAB_SIZE] = { sym_restrooms, // r 82 Restrooms sym_default, // s 83 OVERLAY SHIP/boat (top view) sym_default, // t 84 Tornado - sym_car, // u 85 OVERLAYED TRUCK - sym_car, // v 86 OVERLAYED Van + sym_car, // u 85 OVERLAID TRUCK + sym_car, // v 86 OVERLAID Van sym_default, // w 87 Flooding sym_wreck, // x 88 Wreck or Obstruction ->X<- sym_default, // y 89 Skywarn - sym_default, // z 90 OVERLAYED Shelter + sym_default, // z 90 OVERLAID Shelter sym_default, // { 91 Fog (& future ovrly codes) sym_default, // | 92 TNC Stream Switch sym_default, // } 93 diff --git a/src/hdlc_rec.c b/src/hdlc_rec.c new file mode 100644 index 00000000..d87a1b50 --- /dev/null +++ b/src/hdlc_rec.c @@ -0,0 +1,809 @@ +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// +// Copyright (C) 2011, 2012, 2013, 2014, 2015 John Langner, WB2OSZ +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . +// + + + +/******************************************************************************** + * + * File: hdlc_rec.c + * + * Purpose: Extract HDLC frames from a stream of bits. + * + *******************************************************************************/ + +#include "direwolf.h" + +#include +#include +#include +#include // uint64_t + +//#include "tune.h" +#include "demod.h" +#include "hdlc_rec.h" +#include "hdlc_rec2.h" +#include "fcs_calc.h" +#include "textcolor.h" +#include "ax25_pad.h" +#include "rrbb.h" +#include "multi_modem.h" +#include "demod_9600.h" /* for descramble() */ +#include "ptt.h" +#include "fx25.h" +#include "il2p.h" + + +//#define TEST 1 /* Define for unit testing. */ + +//#define DEBUG3 1 /* monitor the data detect signal. */ + + + +/* + * Minimum & maximum sizes of an AX.25 frame including the 2 octet FCS. + */ + +#define MIN_FRAME_LEN ((AX25_MIN_PACKET_LEN) + 2) + +#define MAX_FRAME_LEN ((AX25_MAX_PACKET_LEN) + 2) + +/* + * This is the current state of the HDLC decoder. + * + * It is possible to run multiple decoders concurrently by + * having a separate set of state variables for each. + * + * Should have a reset function instead of initializations here. + */ + +struct hdlc_state_s { + + + int prev_raw; /* Keep track of previous bit so */ + /* we can look for transitions. */ + /* Should be only 0 or 1. */ + + int lfsr; /* Descrambler shift register for 9600 baud. */ + + int prev_descram; /* Previous descrambled for 9600 baud. */ + + unsigned char pat_det; /* 8 bit pattern detector shift register. */ + /* See below for more details. */ + + unsigned int flag4_det; /* Last 32 raw bits to look for 4 */ + /* flag patterns in a row. */ + + unsigned char oacc; /* Accumulator for building up an octet. */ + + int olen; /* Number of bits in oacc. */ + /* When this reaches 8, oacc is copied */ + /* to the frame buffer and olen is zeroed. */ + /* The value of -1 is a special case meaning */ + /* bits should not be accumulated. */ + + unsigned char frame_buf[MAX_FRAME_LEN]; + /* One frame is kept here. */ + + int frame_len; /* Number of octets in frame_buf. */ + /* Should be in range of 0 .. MAX_FRAME_LEN. */ + + rrbb_t rrbb; /* Handle for bit array for raw received bits. */ + + uint64_t eas_acc; /* Accumulate most recent 64 bits received for EAS. */ + + int eas_gathering; /* Decoding in progress. */ + + int eas_plus_found; /* "+" seen, indicating end of geographical area list. */ + + int eas_fields_after_plus; /* Number of "-" characters after the "+". */ +}; + +static struct hdlc_state_s hdlc_state[MAX_CHANS][MAX_SUBCHANS][MAX_SLICERS]; + +static int num_subchan[MAX_CHANS]; //TODO1.2 use ptr rather than copy. + +static int composite_dcd[MAX_CHANS][MAX_SUBCHANS+1]; + + +/*********************************************************************************** + * + * Name: hdlc_rec_init + * + * Purpose: Call once at the beginning to initialize. + * + * Inputs: None. + * + ***********************************************************************************/ + +static int was_init = 0; + +static struct audio_s *g_audio_p; + + +void hdlc_rec_init (struct audio_s *pa) +{ + int ch, sub, slice; + struct hdlc_state_s *H; + + //text_color_set(DW_COLOR_DEBUG); + //dw_printf ("hdlc_rec_init (%p) \n", pa); + + assert (pa != NULL); + g_audio_p = pa; + + memset (composite_dcd, 0, sizeof(composite_dcd)); + + for (ch = 0; ch < MAX_CHANS; ch++) + { + + if (pa->chan_medium[ch] == MEDIUM_RADIO) { + + num_subchan[ch] = pa->achan[ch].num_subchan; + + assert (num_subchan[ch] >= 1 && num_subchan[ch] <= MAX_SUBCHANS); + + for (sub = 0; sub < num_subchan[ch]; sub++) + { + for (slice = 0; slice < MAX_SLICERS; slice++) { + + H = &hdlc_state[ch][sub][slice]; + + H->olen = -1; + + // TODO: FIX13 wasteful if not needed. + // Should loop on number of slicers, not max. + + H->rrbb = rrbb_new(ch, sub, slice, pa->achan[ch].modem_type == MODEM_SCRAMBLE, H->lfsr, H->prev_descram); + } + } + } + } + hdlc_rec2_init (pa); + was_init = 1; +} + +/* Own copy of random number generator so we can get */ +/* same predictable results on different operating systems. */ +/* TODO: Consolidate multiple copies somewhere. */ + +#define MY_RAND_MAX 0x7fffffff +static int seed = 1; + +static int my_rand (void) { + // Perform the calculation as unsigned to avoid signed overflow error. + seed = (int)(((unsigned)seed * 1103515245) + 12345) & MY_RAND_MAX; + return (seed); +} + + +/*********************************************************************************** + * + * Name: eas_rec_bit + * + * Purpose: Extract EAS trasmissions from a stream of bits. + * + * Inputs: chan - Channel number. + * + * subchan - This allows multiple demodulators per channel. + * + * slice - Allows multiple slicers per demodulator (subchannel). + * + * raw - One bit from the demodulator. + * should be 0 or 1. + * + * future_use - Not implemented yet. PSK already provides it. + * + * + * Description: This is called once for each received bit. + * For each valid transmission, process_rec_frame() + * is called for further processing. + * + ***********************************************************************************/ + +#define PREAMBLE 0xababababababababULL +#define PREAMBLE_ZCZC 0x435a435aababababULL +#define PREAMBLE_NNNN 0x4e4e4e4eababababULL +#define EAS_MAX_LEN 268 // Not including preamble. Up to 31 geographic areas. + + +static void eas_rec_bit (int chan, int subchan, int slice, int raw, int future_use) +{ + struct hdlc_state_s *H; + +/* + * Different state information for each channel / subchannel / slice. + */ + H = &hdlc_state[chan][subchan][slice]; + + //dw_printf ("slice %d = %d\n", slice, raw); + +// Accumulate most recent 64 bits. + + H->eas_acc >>= 1; + if (raw) { + H->eas_acc |= 0x8000000000000000ULL; + } + + int done = 0; + + if (H->eas_acc == PREAMBLE_ZCZC) { + //dw_printf ("ZCZC\n"); + H->olen = 0; + H->eas_gathering = 1; + H->eas_plus_found = 0; + H->eas_fields_after_plus = 0; + strlcpy ((char*)(H->frame_buf), "ZCZC", sizeof(H->frame_buf)); + H->frame_len = 4; + } + else if (H->eas_acc == PREAMBLE_NNNN) { + //dw_printf ("NNNN\n"); + H->olen = 0; + H->eas_gathering = 1; + strlcpy ((char*)(H->frame_buf), "NNNN", sizeof(H->frame_buf)); + H->frame_len = 4; + done = 1; + } + else if (H->eas_gathering) { + H->olen++; + if (H->olen == 8) { + H->olen = 0; + char ch = H->eas_acc >> 56; + H->frame_buf[H->frame_len++] = ch; + H->frame_buf[H->frame_len] = '\0'; + //dw_printf ("frame_buf = %s\n", H->frame_buf); + + // What characters are acceptable? + // Only ASCII is allowed. i.e. the MSB must be 0. + // The examples show only digits but the geographical area can + // contain anything in range of '!' to DEL or CR or LF. + // There are no restrictions listed for the originator and + // examples contain a slash. + // It's not clear if a space can occur in other places. + + if ( ! (( ch >= ' ' && ch <= 0x7f) || ch == '\r' || ch == '\n')) { +//#define DEBUG_E 1 +#ifdef DEBUG_E + dw_printf ("reject %d invalid character = %s\n", slice, H->frame_buf); +#endif + H->eas_gathering = 0; + return; + } + if (H->frame_len > EAS_MAX_LEN) { // FIXME: look for other places with max length +#ifdef DEBUG_E + dw_printf ("reject %d too long = %s\n", slice, H->frame_buf); +#endif + H->eas_gathering = 0; + return; + } + if (ch == '+') { + H->eas_plus_found = 1; + H->eas_fields_after_plus = 0; + } + if (H->eas_plus_found && ch == '-') { + H->eas_fields_after_plus++; + if (H->eas_fields_after_plus == 3) { + done = 1; // normal case + } + } + } + } + + if (done) { +#ifdef DEBUG_E + dw_printf ("frame_buf %d = %s\n", slice, H->frame_buf); +#endif + alevel_t alevel = demod_get_audio_level (chan, subchan); + multi_modem_process_rec_frame (chan, subchan, slice, H->frame_buf, H->frame_len, alevel, 0, 0); + H->eas_gathering = 0; + } + +} // end eas_rec_bit + + +/* + +EAS has no error detection. +Maybe that doesn't matter because we would normally be dealing with a reasonable +VHF FM or TV signal. +Let's see what happens when we intentionally introduce errors. +When some match and others don't, the multislice voting should give preference +to those matching others. + + $ src/atest -P+ -B EAS -e 3e-3 ../../ref-doc/EAS/same.wav + Demodulator profile set to "+" + 96000 samples per second. 16 bits per sample. 1 audio channels. + 2079360 audio bytes in file. Duration = 10.8 seconds. + Fix Bits level = 0 + Channel 0: 521 baud, AFSK 2083 & 1563 Hz, D+, 96000 sample rate / 3. + +case 1: Slice 6 is different than others (EQS vs. EAS) so we want one of the others that match. + Slice 3 has an unexpected character (in 0120u7) so it is a mismatch. + At this point we are not doing validity checking other than all printable characters. + + We are left with 0 & 4 which don't match (012057 vs. 012077). + So I guess we don't have any two that match so it is a toss up. + + reject 7 invalid character = ZCZC-EAS-RWT-0120â–’ + reject 5 invalid character = ZCZC-ECW-RWT-012057-012081-012101-012103-012115+003 + frame_buf 6 = ZCZC-EQS-RWT-012057-012081-012101-012103-012115+0030-2780415-WTSP/TV- + frame_buf 4 = ZCZC-EAS-RWT-012077-012081-012101-012103-012115+0030-2780415-WTSP/TV- + frame_buf 3 = ZCZC-EAS-RWT-0120u7-012281-012101-012103-092115+0038-2780415-VTSP/TV- + frame_buf 0 = ZCZC-EAS-RWT-012057-412081-012101-012103-012115+0030-2780415-WTSP/TV- + + DECODED[1] 0:01.313 EAS audio level = 194(106/108) |__||_|__ + [0.0] EAS>APDW16:{DEZCZC-EAS-RWT-012057-412081-012101-012103-012115+0030-2780415-WTSP/TV- + +Case 2: We have two that match so pick either one. + + reject 5 invalid character = ZCZC-EAS-RWâ–’ + reject 7 invalid character = ZCZC-EAS-RWT-0 + reject 3 invalid character = ZCZC-EAS-RWT-012057-012080-012101-012103-01211 + reject 0 invalid character = ZCZC-EAS-RWT-012057-012081-012101-012103-012115+0030-2780415-Wâ–’ + frame_buf 6 = ZCZC-EAS-RWT-012057-012081-012!01-012103-012115+0030-2780415-WTSP/TV- + frame_buf 1 = ZCZC-EAS-RWT-012057-012081-012101-012103-012115+0030-2780415-WTSP/TV- + + DECODED[2] 0:03.617 EAS audio level = 194(106/108) _|____|__ + [0.1] EAS>APDW16:{DEZCZC-EAS-RWT-012057-012081-012101-012103-012115+0030-2780415-WTSP/TV- + +Case 3: Slice 6 is a mismatch (EAs vs. EAS). + Slice 7 has RST rather than RWT. + 2 & 4 don't match either (012141 vs. 012101). + We have another case where no two match so there is no clear winner. + + + reject 5 invalid character = ZCZC-EAS-RWT-012057-012081-012101-012103-012115+â–’ + frame_buf 7 = ZCZC-EAS-RST-012057-012081-012101-012103-012115+0030-2780415-WTSP/TV- + frame_buf 6 = ZCZC-EAs-RWT-012057-012081-012101-012103-012115+0030-2780415-WTSP/TV- + frame_buf 4 = ZCZC-EAS-RWT-112057-012081-012101-012103-012115+0030-2780415-WTSP/TV- + frame_buf 2 = ZCZC-EAS-RWT-012057-012081-012141-012103-012115+0030-2780415-WTSP/TV- + + DECODED[3] 0:05.920 EAS audio level = 194(106/108) __|_|_||_ + [0.2] EAS>APDW16:{DEZCZC-EAS-RWT-012057-012081-012141-012103-012115+0030-2780415-WTSP/TV- + +Conclusions: + + (1) The existing algorithm gives a higher preference to those frames matching others. + We didn't see any cases here where that would be to our advantage. + + (2) A partial solution would be more validity checking. (i.e. non-digit where + digit is expected.) But wait... We might want to keep it for consideration: + + (3) If I got REALLY ambitious, some day, we could compare all of them one column + at a time and take the most popular (and valid for that column) character and + use all of the most popular characters. Better yet, at the bit level. + +Of course this is probably all overkill because we would normally expect to have pretty +decent signals. The designers didn't even bother to add any sort of checksum for error checking. + +The random errors injected are also not realistic. Actual noise would probably wipe out the +same bit(s) for all of the slices. + +The protocol specification suggests comparing all 3 transmissions and taking the best 2 out of 3. +I think that would best be left to an external application and we just concentrate on being +a good modem here and providing a result when it is received. + +*/ + + +/*********************************************************************************** + * + * Name: hdlc_rec_bit + * + * Purpose: Extract HDLC frames from a stream of bits. + * + * Inputs: chan - Channel number. + * + * subchan - This allows multiple demodulators per channel. + * + * slice - Allows multiple slicers per demodulator (subchannel). + * + * raw - One bit from the demodulator. + * should be 0 or 1. + * + * is_scrambled - Is the data scrambled? + * + * descram_state - Current descrambler state. (not used - remove) + * Not so fast - plans to add new parameter. PSK already provides it. + * + * + * Description: This is called once for each received bit. + * For each valid frame, process_rec_frame() + * is called for further processing. + * + ***********************************************************************************/ + +void hdlc_rec_bit (int chan, int subchan, int slice, int raw, int is_scrambled, int not_used_remove) +{ + + int dbit; /* Data bit after undoing NRZI. */ + /* Should be only 0 or 1. */ + struct hdlc_state_s *H; + + assert (was_init == 1); + + assert (chan >= 0 && chan < MAX_CHANS); + assert (subchan >= 0 && subchan < MAX_SUBCHANS); + + assert (slice >= 0 && slice < MAX_SLICERS); + +// -e option can be used to artificially introduce the desired +// Bit Error Rate (BER) for testing. + + if (g_audio_p->recv_ber != 0) { + double r = (double)my_rand() / (double)MY_RAND_MAX; // calculate as double to preserve all 31 bits. + if (g_audio_p->recv_ber > r) { + +// FIXME +//text_color_set(DW_COLOR_DEBUG); +//dw_printf ("hdlc_rec_bit randomly clobber bit, ber = %.6f\n", g_audio_p->recv_ber); + + raw = ! raw; + } + } + +// EAS does not use HDLC. + + if (g_audio_p->achan[chan].modem_type == MODEM_EAS) { + eas_rec_bit (chan, subchan, slice, raw, not_used_remove); + return; + } + +/* + * Different state information for each channel / subchannel / slice. + */ + H = &hdlc_state[chan][subchan][slice]; + + +/* + * Using NRZI encoding, + * A '0' bit is represented by an inversion since previous bit. + * A '1' bit is represented by no change. + */ + + if (is_scrambled) { + int descram; + + descram = descramble(raw, &(H->lfsr)); + + dbit = (descram == H->prev_descram); + H->prev_descram = descram; + H->prev_raw = raw; + } + else { + + dbit = (raw == H->prev_raw); + + H->prev_raw = raw; + } + +// After BER insertion, NRZI, and any descrambling, feed into FX.25 decoder as well. +// Don't waste time on this if AIS. EAS does not get this far. + + if (g_audio_p->achan[chan].modem_type != MODEM_AIS) { + fx25_rec_bit (chan, subchan, slice, dbit); + il2p_rec_bit (chan, subchan, slice, raw); // Note: skip NRZI. + } + +/* + * Octets are sent LSB first. + * Shift the most recent 8 bits thru the pattern detector. + */ + H->pat_det >>= 1; + if (dbit) { + H->pat_det |= 0x80; + } + + H->flag4_det >>= 1; + if (dbit) { + H->flag4_det |= 0x80000000; + } + + rrbb_append_bit (H->rrbb, raw); + + if (H->pat_det == 0x7e) { + + rrbb_chop8 (H->rrbb); + +/* + * The special pattern 01111110 indicates beginning and ending of a frame. + * If we have an adequate number of whole octets, it is a candidate for + * further processing. + * + * It might look odd that olen is being tested for 7 instead of 0. + * This is because oacc would already have 7 bits from the special + * "flag" pattern before it is detected here. + */ + + +#if OLD_WAY + +#if TEST + text_color_set(DW_COLOR_DEBUG); + dw_printf ("\nfound flag, olen = %d, frame_len = %d\n", olen, frame_len); +#endif + if (H->olen == 7 && H->frame_len >= MIN_FRAME_LEN) { + + unsigned short actual_fcs, expected_fcs; + +#if TEST + int j; + dw_printf ("TRADITIONAL: frame len = %d\n", H->frame_len); + for (j=0; jframe_len; j++) { + dw_printf (" %02x", H->frame_buf[j]); + } + dw_printf ("\n"); + +#endif + /* Check FCS, low byte first, and process... */ + + /* Alternatively, it is possible to include the two FCS bytes */ + /* in the CRC calculation and look for a magic constant. */ + /* That would be easier in the case where the CRC is being */ + /* accumulated along the way as the octets are received. */ + /* I think making a second pass over it and comparing is */ + /* easier to understand. */ + + actual_fcs = H->frame_buf[H->frame_len-2] | (H->frame_buf[H->frame_len-1] << 8); + + expected_fcs = fcs_calc (H->frame_buf, H->frame_len - 2); + + if (actual_fcs == expected_fcs) { + alevel_t alevel = demod_get_audio_level (chan, subchan); + + multi_modem_process_rec_frame (chan, subchan, slice, H->frame_buf, H->frame_len - 2, alevel, RETRY_NONE, 0); /* len-2 to remove FCS. */ + } + else { + +#if TEST + dw_printf ("*** actual fcs = %04x, expected fcs = %04x ***\n", actual_fcs, expected_fcs); +#endif + + } + + } + +#else + +/* + * New way - Decode the raw bits in later step. + */ + +#if TEST + text_color_set(DW_COLOR_DEBUG); + dw_printf ("\nfound flag, channel %d.%d, %d bits in frame\n", chan, subchan, rrbb_get_len(H->rrbb) - 1); +#endif + if (rrbb_get_len(H->rrbb) >= MIN_FRAME_LEN * 8) { + + alevel_t alevel = demod_get_audio_level (chan, subchan); + + rrbb_set_audio_level (H->rrbb, alevel); + hdlc_rec2_block (H->rrbb); + /* Now owned by someone else who will free it. */ + + H->rrbb = rrbb_new (chan, subchan, slice, is_scrambled, H->lfsr, H->prev_descram); /* Allocate a new one. */ + } + else { + rrbb_clear (H->rrbb, is_scrambled, H->lfsr, H->prev_descram); + } + + H->olen = 0; /* Allow accumulation of octets. */ + H->frame_len = 0; + + + rrbb_append_bit (H->rrbb, H->prev_raw); /* Last bit of flag. Needed to get first data bit. */ + /* Now that we are saving other initial state information, */ + /* it would be sensible to do the same for this instead */ + /* of lumping it in with the frame data bits. */ +#endif + + } + +//#define EXPERIMENT12B 1 + +#if EXPERIMENT12B + + else if (H->pat_det == 0xff) { + +/* + * Valid data will never have seven 1 bits in a row. + * + * 11111110 + * + * This indicates loss of signal. + * But we will let it slip thru because it might diminish + * our single bit fixup effort. Instead give up on frame + * only when we see eight 1 bits in a row. + * + * 11111111 + * + * What is the impact? No difference. + * + * Before: atest -P E -F 1 ../02_Track_2.wav = 1003 + * After: atest -P E -F 1 ../02_Track_2.wav = 1003 + */ + +#else + else if (H->pat_det == 0xfe) { + +/* + * Valid data will never have 7 one bits in a row. + * + * 11111110 + * + * This indicates loss of signal. + */ + +#endif + + H->olen = -1; /* Stop accumulating octets. */ + H->frame_len = 0; /* Discard anything in progress. */ + + rrbb_clear (H->rrbb, is_scrambled, H->lfsr, H->prev_descram); + + } + else if ( (H->pat_det & 0xfc) == 0x7c ) { + +/* + * If we have five '1' bits in a row, followed by a '0' bit, + * + * 0111110xx + * + * the current '0' bit should be discarded because it was added for + * "bit stuffing." + */ + ; + + } else { + +/* + * In all other cases, accumulate bits into octets, and complete octets + * into the frame buffer. + */ + if (H->olen >= 0) { + + H->oacc >>= 1; + if (dbit) { + H->oacc |= 0x80; + } + H->olen++; + + if (H->olen == 8) { + H->olen = 0; + + if (H->frame_len < MAX_FRAME_LEN) { + H->frame_buf[H->frame_len] = H->oacc; + H->frame_len++; + } + } + } + } +} + +// TODO: Data Carrier Detect (DCD) is now based on DPLL lock +// rather than data patterns found here. +// It would make sense to move the next 2 functions to demod.c +// because this is done at the modem level, rather than HDLC decoder. + +/*------------------------------------------------------------------- + * + * Name: dcd_change + * + * Purpose: Combine DCD states of all subchannels/ into an overall + * state for the channel. + * + * Inputs: chan + * + * subchan 0 to MAX_SUBCHANS-1 for HDLC. + * SPECIAL CASE --> MAX_SUBCHANS for DTMF decoder. + * + * slice slicer number, 0 .. MAX_SLICERS - 1. + * + * state 1 for active, 0 for not. + * + * Returns: None. Use hdlc_rec_data_detect_any to retrieve result. + * + * Description: DCD for the channel is active if ANY of the subchannels/slices + * are active. Update the DCD indicator. + * + * version 1.3: Add DTMF detection into the final result. + * This is now called from dtmf.c too. + * + *--------------------------------------------------------------------*/ + +void dcd_change (int chan, int subchan, int slice, int state) +{ + int old, new; + + assert (chan >= 0 && chan < MAX_CHANS); + assert (subchan >= 0 && subchan <= MAX_SUBCHANS); + assert (slice >= 0 && slice < MAX_SLICERS); + assert (state == 0 || state == 1); + +#if DEBUG3 + text_color_set(DW_COLOR_DEBUG); + dw_printf ("DCD %d.%d.%d = %d \n", chan, subchan, slice, state); +#endif + + old = hdlc_rec_data_detect_any(chan); + + if (state) { + composite_dcd[chan][subchan] |= (1 << slice); + } + else { + composite_dcd[chan][subchan] &= ~ (1 << slice); + } + + new = hdlc_rec_data_detect_any(chan); + + if (new != old) { + ptt_set (OCTYPE_DCD, chan, new); + } +} + + +/*------------------------------------------------------------------- + * + * Name: hdlc_rec_data_detect_any + * + * Purpose: Determine if the radio channel is currently busy + * with packet data. + * This version doesn't care about voice or other sounds. + * This is used by the transmit logic to transmit only + * when the channel is clear. + * + * Inputs: chan - Audio channel. + * + * Returns: True if channel is busy (data detected) or + * false if OK to transmit. + * + * + * Description: We have two different versions here. + * + * hdlc_rec_data_detect_any sees if ANY of the decoders + * for this channel are receiving a signal. This is + * used to determine whether the channel is clear and + * we can transmit. This would apply to the 300 baud + * HF SSB case where we have multiple decoders running + * at the same time. The channel is busy if ANY of them + * thinks the channel is busy. + * + * Version 1.3: New option for input signal to inhibit transmit. + * + *--------------------------------------------------------------------*/ + +int hdlc_rec_data_detect_any (int chan) +{ + + int sc; + assert (chan >= 0 && chan < MAX_CHANS); + + for (sc = 0; sc < num_subchan[chan]; sc++) { + if (composite_dcd[chan][sc] != 0) + return (1); + } + + if (get_input(ICTYPE_TXINH, chan) == 1) return (1); + + return (0); + +} /* end hdlc_rec_data_detect_any */ + +/* end hdlc_rec.c */ + + diff --git a/src/hdlc_rec.h b/src/hdlc_rec.h new file mode 100644 index 00000000..69b60a92 --- /dev/null +++ b/src/hdlc_rec.h @@ -0,0 +1,25 @@ + + +#include "audio.h" + + +void hdlc_rec_init (struct audio_s *pa); + +void hdlc_rec_bit (int chan, int subchan, int slice, int raw, int is_scrambled, int descram_state); + +/* Provided elsewhere to process a complete frame. */ + +//void process_rec_frame (int chan, unsigned char *fbuf, int flen, int level); + + +/* Is HLDC decoder is currently gathering bits into a frame? */ +/* Similar to, but not exactly the same as, data carrier detect. */ +/* We use this to influence the PLL inertia. */ + +int hdlc_rec_gathering (int chan, int subchan, int slice); + +/* Transmit needs to know when someone else is transmitting. */ + +void dcd_change (int chan, int subchan, int slice, int state); + +int hdlc_rec_data_detect_any (int chan); diff --git a/src/hdlc_rec2.c b/src/hdlc_rec2.c new file mode 100644 index 00000000..b817018f --- /dev/null +++ b/src/hdlc_rec2.c @@ -0,0 +1,1041 @@ +// This file is part of Dire Wolf, an amateur radio packet TNC. +// +// Copyright (C) 2011, 2012, 2013, 2014, 2015 John Langner, WB2OSZ +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . +// + + + +/******************************************************************************** + * + * File: hdlc_rec2.c + * + * Purpose: Extract HDLC frame from a block of bits after someone + * else has done the work of pulling it out from between + * the special "flag" sequences. + * + * + * New in version 1.1: + * + * Several enhancements provided by Fabrice FAURE: + * + * - Additional types of attempts to fix a bad CRC. + * - Optimized code to reduce execution time. + * - Improved detection of duplicate packets from different fixup attempts. + * - Set limit on number of packets in fix up later queue. + * + * One of the new recovery attempt cases recovers three additional + * packets that were lost before. The one thing I disagree with is + * use of the word "swap" because that sounds like two things + * are being exchanged for each other. I would prefer "flip" + * or "invert" to describe changing a bit to the opposite state. + * I took "swap" out of the user-visible messages but left the + * rest of the source code as provided. + * + * Test results: We intentionally use the worst demodulator so there + * is more opportunity to try to fix the frames. + * + * atest -P A -F n 02_Track_2.wav + * + * n description frames sec + * -- ----------- ------ --- + * 0 no attempt 963 40 error-free frames + * 1 invert 1 979 41 16 more + * 2 invert 2 982 42 3 more + * 3 invert 3 982 42 no change + * 4 remove 1 982 43 no change + * 5 remove 2 982 43 no change + * 6 remove 3 982 43 no change + * 7 insert 1 982 45 no change + * 8 insert 2 982 47 no change + * 9 invert two sep 993 178 11 more, some visually obvious errors. + * 10 invert many? 993 190 no change + * 11 remove many 995 190 2 more, need to investigate in detail. + * 12 remove two sep 995 201 no change + * + * Observations: The "insert" and "remove" techniques had no benefit. I would not expect them to. + * We have a phase locked loop that attempts to track any slight variations in the + * timing so we sample near the middle of the bit interval. Bits can get corrupted + * by noise but not disappear or just appear. That would be a gap in the timing. + * These should probably be removed in a future version. + * + * + * Version 1.2: Now works for 9600 baud. + * This was more complicated due to the data scrambling. + * It was necessary to retain more initial state information after + * the start flag octet. + * + * Version 1.3: Took out all of the "insert" and "remove" cases because they + * offer no benenfit. + * + * Took out the delayed processing and just do it realtime. + * Changed SWAP to INVERT because it is more descriptive. + * + *******************************************************************************/ + +#include "direwolf.h" + +#include +#include +#include +#include + +//Optimize processing by accessing directly to decoded bits +#define RRBB_C 1 +#include "hdlc_rec2.h" +#include "fcs_calc.h" +#include "textcolor.h" +#include "ax25_pad.h" +#include "rrbb.h" +#include "multi_modem.h" +#include "dtime_now.h" +#include "demod_9600.h" /* for descramble() */ +#include "audio.h" /* for struct audio_s */ +//#include "ax25_pad.h" /* for AX25_MAX_ADDR_LEN */ +#include "ais.h" + +//#define DEBUG 1 +//#define DEBUGx 1 +//#define DEBUG_LATER 1 + +/* Audio configuration. */ + +static struct audio_s *save_audio_config_p; + + +/* + * Minimum & maximum sizes of an AX.25 frame including the 2 octet FCS. + */ + +#define MIN_FRAME_LEN ((AX25_MIN_PACKET_LEN) + 2) + +#define MAX_FRAME_LEN ((AX25_MAX_PACKET_LEN) + 2) + + +/* + * This is the current state of the HDLC decoder. + * + * It is possible to run multiple decoders concurrently by + * having a separate set of state variables for each. + * + * Should have a reset function instead of initializations here. + */ + +// TODO: Clean up. This is a remnant of splitting hdlc_rec.c into 2 parts. +// This is not the same as hdlc_state_s in hdlc_rec.c +// "2" was added to reduce confusion. Can be trimmed down. + +struct hdlc_state2_s { + + int prev_raw; /* Keep track of previous bit so */ + /* we can look for transitions. */ + /* Should be only 0 or 1. */ + + int is_scrambled; /* Set for 9600 baud. */ + int lfsr; /* Descrambler shift register for 9600 baud. */ + int prev_descram; /* Previous unscrambled for 9600 baud. */ + + + unsigned char pat_det; /* 8 bit pattern detector shift register. */ + /* See below for more details. */ + + unsigned char oacc; /* Accumulator for building up an octet. */ + + int olen; /* Number of bits in oacc. */ + /* When this reaches 8, oacc is copied */ + /* to the frame buffer and olen is zeroed. */ + + unsigned char frame_buf[MAX_FRAME_LEN]; + /* One frame is kept here. */ + + int frame_len; /* Number of octets in frame_buf. */ + /* Should be in range of 0 .. MAX_FRAME_LEN. */ + +}; + + +static int try_decode (rrbb_t block, int chan, int subchan, int slice, alevel_t alevel, retry_conf_t retry_conf, int passall); + +static int try_to_fix_quick_now (rrbb_t block, int chan, int subchan, int slice, alevel_t alevel); + +static int sanity_check (unsigned char *buf, int blen, retry_t bits_flipped, enum sanity_e sanity_test); + + +/*********************************************************************************** + * + * Name: hdlc_rec2_init + * + * Purpose: Initialization. + * + * Inputs: p_audio_config - Pointer to configuration settings. + * This is what we care about for each channel. + * + * enum retry_e fix_bits; + * Level of effort to recover from + * a bad FCS on the frame. + * 0 = no effort + * 1 = try inverting a single bit + * 2... = more techniques... + * + * enum sanity_e sanity_test; + * Sanity test to apply when finding a good + * CRC after changing one or more bits. + * Must look like APRS, AX.25, or anything. + * + * int passall; + * Allow thru even with bad CRC after exhausting + * all fixup attempts. + * + * Description: Save pointer to configuration for later use. + * + ***********************************************************************************/ + +void hdlc_rec2_init (struct audio_s *p_audio_config) +{ + save_audio_config_p = p_audio_config; +} + + + +/*********************************************************************************** + * + * Name: hdlc_rec2_block + * + * Purpose: Extract HDLC frame from a stream of bits. + * + * Inputs: block - Handle for bit array. + * + * Description: The other (original) hdlc decoder took one bit at a time + * right out of the demodulator. + * + * This is different in that it processes a block of bits + * previously extracted from between two "flag" patterns. + * + * This allows us to try decoding the same received data more + * than once. + * + * Version 1.2: Now works properly for G3RUH type scrambling. + * + ***********************************************************************************/ + + +void hdlc_rec2_block (rrbb_t block) +{ + int chan = rrbb_get_chan(block); + int subchan = rrbb_get_subchan(block); + int slice = rrbb_get_slice(block); + alevel_t alevel = rrbb_get_audio_level(block); + retry_t fix_bits = save_audio_config_p->achan[chan].fix_bits; + int passall = save_audio_config_p->achan[chan].passall; + int ok; + +#if DEBUGx + text_color_set(DW_COLOR_DEBUG); + dw_printf ("\n--- try to decode ---\n"); +#endif + + /* Create an empty retry configuration */ + retry_conf_t retry_cfg; + + memset (&retry_cfg, 0, sizeof(retry_cfg)); + +/* + * For our first attempt we don't try to alter any bits. + * Still let it thru if passall AND no retries are desired. + */ + + retry_cfg.type = RETRY_TYPE_NONE; + retry_cfg.mode = RETRY_MODE_CONTIGUOUS; + retry_cfg.retry = RETRY_NONE; + retry_cfg.u_bits.contig.nr_bits = 0; + retry_cfg.u_bits.contig.bit_idx = 0; + + ok = try_decode (block, chan, subchan, slice, alevel, retry_cfg, passall & (fix_bits == RETRY_NONE)); + if (ok) { +#if DEBUG + text_color_set(DW_COLOR_INFO); + dw_printf ("Got it the first time.\n"); +#endif + rrbb_delete (block); + return; + } + +/* + * Not successful with frame in original form. + * See if we can "fix" it. + */ + if (try_to_fix_quick_now (block, chan, subchan, slice, alevel)) { + rrbb_delete (block); + return; + } + + + if (passall) { + /* Exhausted all desired fix up attempts. */ + /* Let thru even with bad CRC. Of course, it still */ + /* needs to be a minimum number of whole octets. */ + ok = try_decode (block, chan, subchan, slice, alevel, retry_cfg, 1); + rrbb_delete (block); + } + else { + rrbb_delete (block); + } + +} /* end hdlc_rec2_block */ + + +/*********************************************************************************** + * + * Name: try_to_fix_quick_now + * + * Purpose: Attempt some quick fixups that don't take very long. + * + * Inputs: block - Stream of bits that might be a frame. + * chan - Radio channel from which it was received. + * subchan - Which demodulator when more than one per channel. + * alevel - Audio level for later reporting. + * + * Global In: configuration fix_bits - Maximum level of fix up to attempt. + * + * RETRY_NONE (0) - Don't try any. + * RETRY_INVERT_SINGLE (1) - Try inverting single bits. + * etc. + * + * configuration passall - Let it thru with bad CRC after exhausting + * all fixup attempts. + * + * + * Returns: 1 for success. "try_decode" has passed the result along to the + * processing step. + * 0 for failure. Caller might continue with more aggressive attempts. + * + * Original: Some of the attempted fix up techniques are quick. + * We will attempt them immediately after receiving the frame. + * Others, that take time order N**2, will be done in a later section. + * + * Version 1.2: Now works properly for G3RUH type scrambling. + * + * Version 1.3: Removed the extra cases that didn't help. + * The separated bit case is now handled immediately instead of + * being thrown in a queue for later processing. + * + ***********************************************************************************/ + +static int try_to_fix_quick_now (rrbb_t block, int chan, int subchan, int slice, alevel_t alevel) +{ + int ok; + int len, i; + retry_t fix_bits = save_audio_config_p->achan[chan].fix_bits; + //int passall = save_audio_config_p->achan[chan].passall; + + + len = rrbb_get_len(block); + /* Prepare the retry configuration */ + retry_conf_t retry_cfg; + + memset (&retry_cfg, 0, sizeof(retry_cfg)); + + /* Will modify only contiguous bits*/ + retry_cfg.mode = RETRY_MODE_CONTIGUOUS; +/* + * Try inverting one bit. + */ + if (fix_bits < RETRY_INVERT_SINGLE) { + + /* Stop before single bit fix up. */ + + return 0; /* failure. */ + } + /* Try to swap one bit */ + retry_cfg.type = RETRY_TYPE_SWAP; + retry_cfg.retry = RETRY_INVERT_SINGLE; + retry_cfg.u_bits.contig.nr_bits = 1; + + for (i=0; iachan[chan].fix_bits; + int passall = save_audio_config_p->achan[chan].passall; +#if DEBUG_LATER + double tstart, tend; +#endif + retry_conf_t retry_cfg; + + memset (&retry_cfg, 0, sizeof(retry_cfg)); + + //len = rrbb_get_len(block); + + +/* + * All fix up attempts have failed. + * Should we pass it along anyhow with a bad CRC? + * Note that we still need a minimum number of whole octets. + */ + if (passall) { + + retry_cfg.type = RETRY_TYPE_NONE; + retry_cfg.mode = RETRY_MODE_CONTIGUOUS; + retry_cfg.retry = RETRY_NONE; + retry_cfg.u_bits.contig.nr_bits = 0; + retry_cfg.u_bits.contig.bit_idx = 0; + ok = try_decode (block, chan, subchan, slice, alevel, retry_cfg, passall); + return (ok); + } + + return (0); + +} /* end hdlc_rec2_try_to_fix_later */ + + + +/* + * Check if the specified index of bit has been modified with the current type of configuration + * Provide a specific implementation for contiguous mode to optimize number of tests done in the loop + */ + +inline static char is_contig_bit_modified(int bit_idx, retry_conf_t retry_conf) { + int cont_bit_idx = retry_conf.u_bits.contig.bit_idx; + int cont_nr_bits = retry_conf.u_bits.contig.nr_bits; + + if (bit_idx >= cont_bit_idx && (bit_idx < cont_bit_idx + cont_nr_bits )) + return 1; + else + return 0; +} + +/* + * Check if the specified index of bit has been modified with the current type of configuration in separated bit index mode + * Provide a specific implementation for separated mode to optimize number of tests done in the loop + */ + +inline static char is_sep_bit_modified(int bit_idx, retry_conf_t retry_conf) { + if (bit_idx == retry_conf.u_bits.sep.bit_idx_a || + bit_idx == retry_conf.u_bits.sep.bit_idx_b || + bit_idx == retry_conf.u_bits.sep.bit_idx_c) + return 1; + else + return 0; +} + + + +/*********************************************************************************** + * + * Name: try_decode + * + * Purpose: + * + * Inputs: block - Bit string that was collected between "flag" patterns. + * + * chan, subchan - where it came from. + * + * alevel - audio level for later reporting. + * + * retry_conf - Controls changes that will be attempted to get a good CRC. + * + * retry: + * Level of effort to recover from a bad FCS on the frame. + * RETRY_NONE = 0 + * RETRY_INVERT_SINGLE = 1 + * RETRY_INVERT_DOUBLE = 2 + * RETRY_INVERT_TRIPLE = 3 + * RETRY_INVERT_TWO_SEP = 4 + * + * mode: RETRY_MODE_CONTIGUOUS - change adjacent bits. + * contig.bit_idx - first bit position + * contig.nr_bits - number of bits + * + * RETRY_MODE_SEPARATED - change bits not next to each other. + * sep.bit_idx_a - bit positions + * sep.bit_idx_b - bit positions + * sep.bit_idx_c - bit positions + * + * type: RETRY_TYPE_NONE - Make no changes. + * RETRY_TYPE_SWAP - Try inverting. + * + * passall - All it thru even with bad CRC. + * Valid only when no changes make. i.e. + * retry == RETRY_NONE, type == RETRY_TYPE_NONE + * + * Returns: 1 = successfully extracted something. + * 0 = failure. + * + ***********************************************************************************/ + +static int try_decode (rrbb_t block, int chan, int subchan, int slice, alevel_t alevel, retry_conf_t retry_conf, int passall) +{ + struct hdlc_state2_s H2; + int blen; /* Block length in bits. */ + int i; + int raw; /* From demodulator. Should be 0 or 1. */ +#if DEBUGx + int crc_failed = 1; +#endif + int retry_conf_mode = retry_conf.mode; + int retry_conf_type = retry_conf.type; + int retry_conf_retry = retry_conf.retry; + + + H2.is_scrambled = rrbb_get_is_scrambled (block); + H2.prev_descram = rrbb_get_prev_descram (block); + H2.lfsr = rrbb_get_descram_state (block); + H2.prev_raw = rrbb_get_bit (block, 0); /* Actually last bit of the */ + /* opening flag so we can derive the */ + /* first data bit. */ + + /* Does this make sense? */ + /* This is the last bit of the "flag" pattern. */ + /* If it was corrupted we wouldn't have detected */ + /* the start of frame. */ + + if ((retry_conf.mode == RETRY_MODE_CONTIGUOUS && is_contig_bit_modified(0, retry_conf)) || + (retry_conf.mode == RETRY_MODE_SEPARATED && is_sep_bit_modified(0, retry_conf))) { + H2.prev_raw = ! H2.prev_raw; + } + + H2.pat_det = 0; + H2.oacc = 0; + H2.olen = 0; + H2.frame_len = 0; + + blen = rrbb_get_len(block); + +#if DEBUGx + text_color_set(DW_COLOR_DEBUG); + if (retry_conf.type == RETRY_TYPE_NONE) + dw_printf ("try_decode: blen=%d\n", blen); +#endif + for (i=1; i>= 1; + +/* + * Using NRZI encoding, + * A '0' bit is represented by an inversion since previous bit. + * A '1' bit is represented by no change. + * Note: this code can be factorized with the raw != H2.prev_raw code at the cost of processing time + */ + + int dbit ; + + if (H2.is_scrambled) { + int descram; + + descram = descramble(raw, &(H2.lfsr)); + + dbit = (descram == H2.prev_descram); + H2.prev_descram = descram; + H2.prev_raw = raw; + } + else { + + dbit = (raw == H2.prev_raw); + H2.prev_raw = raw; + } + + if (dbit) { + + H2.pat_det |= 0x80; + /* Valid data will never have 7 one bits in a row: exit. */ + if (H2.pat_det == 0xfe) { +#if DEBUGx + text_color_set(DW_COLOR_DEBUG); + dw_printf ("try_decode: found abort, i=%d\n", i); +#endif + return 0; + } + H2.oacc >>= 1; + H2.oacc |= 0x80; + } else { + + /* The special pattern 01111110 indicates beginning and ending of a frame: exit. */ + if (H2.pat_det == 0x7e) { +#if DEBUGx + text_color_set(DW_COLOR_DEBUG); + dw_printf ("try_decode: found flag, i=%d\n", i); +#endif + return 0; +/* + * If we have five '1' bits in a row, followed by a '0' bit, + * + * 011111xx + * + * the current '0' bit should be discarded because it was added for + * "bit stuffing." + */ + + } else if ( (H2.pat_det >> 2) == 0x1f ) { + continue; + } + H2.oacc >>= 1; + } + +/* + * Now accumulate bits into octets, and complete octets + * into the frame buffer. + */ + + H2.olen++; + + if (H2.olen & 8) { + H2.olen = 0; + + if (H2.frame_len < MAX_FRAME_LEN) { + H2.frame_buf[H2.frame_len] = H2.oacc; + H2.frame_len++; + + } + } + } /* end of loop on all bits in block */ +/* + * Do we have a minimum number of complete bytes? + */ + +#if DEBUGx + text_color_set(DW_COLOR_DEBUG); + dw_printf ("try_decode: olen=%d, frame_len=%d\n", H2.olen, H2.frame_len); +#endif + + if (H2.olen == 0 && H2.frame_len >= MIN_FRAME_LEN) { + + unsigned short actual_fcs, expected_fcs; + +#if DEBUGx + if (retry_conf.type == RETRY_TYPE_NONE) { + int j; + text_color_set(DW_COLOR_DEBUG); + dw_printf ("NEW WAY: frame len = %d\n", H2.frame_len); + for (j=0; jachan[chan].modem_type == MODEM_AIS) { + + // Sanity check for AIS. + if (ais_check_length((H2.frame_buf[0] >> 2) & 0x3f, H2.frame_len - 2) == 0) { + multi_modem_process_rec_frame (chan, subchan, slice, H2.frame_buf, H2.frame_len - 2, alevel, retry_conf.retry, 0); /* len-2 to remove FCS. */ + return 1; /* success */ + } + else { + return 0; /* did not pass sanity check */ + } + } + else if (actual_fcs == expected_fcs && + sanity_check (H2.frame_buf, H2.frame_len - 2, retry_conf.retry, save_audio_config_p->achan[chan].sanity_test)) { + + // TODO: Shouldn't be necessary to pass chan, subchan, alevel into + // try_decode because we can obtain them from block. + // Let's make sure that assumption is good... + + assert (rrbb_get_chan(block) == chan); + assert (rrbb_get_subchan(block) == subchan); + multi_modem_process_rec_frame (chan, subchan, slice, H2.frame_buf, H2.frame_len - 2, alevel, retry_conf.retry, 0); /* len-2 to remove FCS. */ + return 1; /* success */ + + } else if (passall) { + if (retry_conf_retry == RETRY_NONE && retry_conf_type == RETRY_TYPE_NONE) { + + //text_color_set(DW_COLOR_ERROR); + //dw_printf ("ATTEMPTING PASSALL PROCESSING\n"); + + multi_modem_process_rec_frame (chan, subchan, slice, H2.frame_buf, H2.frame_len - 2, alevel, RETRY_MAX, 0); /* len-2 to remove FCS. */ + return 1; /* success */ + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("try_decode: internal error passall = %d, retry_conf_retry = %d, retry_conf_type = %d\n", + passall, retry_conf_retry, retry_conf_type); + } + } else { + + goto failure; + } + } else { +#if DEBUGx + crc_failed = 0; +#endif + goto failure; + } +failure: +#if DEBUGx + if (retry_conf.type == RETRY_TYPE_NONE ) { + int j; + text_color_set(DW_COLOR_ERROR); + if (crc_failed) + dw_printf ("CRC failed\n"); + if (H2.olen != 0) + dw_printf ("Bad olen: %d \n", H2.olen); + else if (H2.frame_len < MIN_FRAME_LEN) { + dw_printf ("Frame too small\n"); + goto end; + } + + dw_printf ("FAILURE with frame: frame len = %d\n", H2.frame_len); + dw_printf ("\n"); + for (j=0; j>1); + } + dw_printf ("\nORIG\n"); + for (j=0; j 10) { +#if DEBUGx + text_color_set(DW_COLOR_ERROR); + dw_printf ("sanity_check: FAILED. Too few or many addresses.\n"); +#endif + return 0; + } + +/* + * Addresses can contain only upper case letters, digits, and space. + */ + + for (j=0; j> 1; + addr[1] = buf[j+1] >> 1; + addr[2] = buf[j+2] >> 1; + addr[3] = buf[j+3] >> 1; + addr[4] = buf[j+4] >> 1; + addr[5] = buf[j+5] >> 1; + addr[6] = '\0'; + + + if ( (! isupper(addr[0]) && ! isdigit(addr[0])) || + (! isupper(addr[1]) && ! isdigit(addr[1]) && addr[1] != ' ') || + (! isupper(addr[2]) && ! isdigit(addr[2]) && addr[2] != ' ') || + (! isupper(addr[3]) && ! isdigit(addr[3]) && addr[3] != ' ') || + (! isupper(addr[4]) && ! isdigit(addr[4]) && addr[4] != ' ') || + (! isupper(addr[5]) && ! isdigit(addr[5]) && addr[5] != ' ')) { +#if DEBUGx + text_color_set(DW_COLOR_ERROR); + dw_printf ("sanity_check: FAILED. Invalid characters in addresses \"%s\"\n", addr); +#endif + return 0; + } + } + + +/* + * That's good enough for the AX.25 sanity check. + * Continue below for additional APRS checking. + */ + if (sanity_test == SANITY_AX25) { + return (1); + } + +/* + * The next two bytes should be 0x03 and 0xf0 for APRS. + */ + + if (buf[alen] != 0x03 || buf[alen+1] != 0xf0) { + return (0); + } + +/* + * Finally, look for bogus characters in the information part. + * In theory, the bytes could have any values. + * In practice, we find only printable ASCII characters and: + * + * 0x0a line feed + * 0x0d carriage return + * 0x1c MIC-E + * 0x1d MIC-E + * 0x1e MIC-E + * 0x1f MIC-E + * 0x7f MIC-E + * 0x80 "{UIV32N}<0x0d><0x9f><0x80>" + * 0x9f "{UIV32N}<0x0d><0x9f><0x80>" + * 0xb0 degree symbol, ISO LATIN1 + * (Note: UTF-8 uses two byte sequence 0xc2 0xb0.) + * 0xbe invalid MIC-E encoding. + * 0xf8 degree symbol, Microsoft code page 437 + * + * So, if we have something other than these (in English speaking countries!), + * chances are that we have bogus data from twiddling the wrong bits. + * + * Notice that we shouldn't get here for good packets. This extra level + * of checking happens only if we twiddled a couple of bits, possibly + * creating bad data. We want to be very fussy. + */ + + for (j=alen+2; j= 0x1c && ch <= 0x7f) + || ch == 0x0a + || ch == 0x0d + || ch == 0x80 + || ch == 0x9f + || ch == 0xc2 + || ch == 0xb0 + || ch == 0xf8) ) { +#if DEBUGx + text_color_set(DW_COLOR_ERROR); + dw_printf ("sanity_check: FAILED. Probably bogus info char 0x%02x\n", ch); +#endif + return 0; + } + } + + return 1; +} + + +/* end hdlc_rec2.c */ + + diff --git a/hdlc_rec2.h b/src/hdlc_rec2.h similarity index 53% rename from hdlc_rec2.h rename to src/hdlc_rec2.h index 1008e7c0..01ef3238 100644 --- a/hdlc_rec2.h +++ b/src/hdlc_rec2.h @@ -3,24 +3,13 @@ #define HDLC_REC2_H 1 -#include "ax25_pad.h" /* for packet_t */ +#include "ax25_pad.h" /* for packet_t, alevel_t */ #include "rrbb.h" +#include "audio.h" /* for struct audio_s */ +#include "dlq.h" // for fec_type_t definition. + + -typedef enum retry_e { - RETRY_NONE=0, - RETRY_SWAP_SINGLE=1, - RETRY_SWAP_DOUBLE=2, - RETRY_SWAP_TRIPLE=3, - RETRY_REMOVE_SINGLE=4, - RETRY_REMOVE_DOUBLE=5, - RETRY_REMOVE_TRIPLE=6, - RETRY_INSERT_SINGLE=7, - RETRY_INSERT_DOUBLE=8, - RETRY_SWAP_TWO_SEP=9, - RETRY_SWAP_MANY=10, - RETRY_REMOVE_MANY=11, - RETRY_REMOVE_TWO_SEP=12, - RETRY_MAX = 13} retry_t; typedef enum retry_mode_e { RETRY_MODE_CONTIGUOUS=0, @@ -29,9 +18,7 @@ typedef enum retry_mode_e { typedef enum retry_type_e { RETRY_TYPE_NONE=0, - RETRY_TYPE_SWAP=1, - RETRY_TYPE_REMOVE=2, - RETRY_TYPE_INSERT=3} retry_type_t; + RETRY_TYPE_SWAP=1 } retry_type_t; typedef struct retry_conf_s { retry_t retry; @@ -64,24 +51,18 @@ static const char * retry_text[] = { "SINGLE", "DOUBLE", "TRIPLE", - "REMOVE_SINGLE", - "REMOVE_DOUBLE", - "REMOVE_TRIPLE", - "INSERT_SINGLE", - "INSERT_DOUBLE", "TWO_SEP", - "MANY", - "REMOVE_MANY", - "REMOVE_SEP"}; + "PASSALL" }; #endif -void hdlc_rec2_block (rrbb_t block, retry_t fix_bits); +void hdlc_rec2_init (struct audio_s *audio_config_p); -void hdlc_rec2_try_to_fix_later (rrbb_t block, int chan, int subchan, int alevel); +void hdlc_rec2_block (rrbb_t block); -/* Provided by the top level application to process a complete frame. */ +int hdlc_rec2_try_to_fix_later (rrbb_t block, int chan, int subchan, int slice, alevel_t alevel); -void app_process_rec_packet (int chan, int subchan, packet_t pp, int level, retry_t retries, char *spectrum); +/* Provided by the top level application to process a complete frame. */ +void app_process_rec_packet (int chan, int subchan, int slice, packet_t pp, alevel_t level, fec_type_t fec_type, retry_t retries, char *spectrum); #endif diff --git a/src/hdlc_send.c b/src/hdlc_send.c new file mode 100644 index 00000000..8a1cdc6d --- /dev/null +++ b/src/hdlc_send.c @@ -0,0 +1,376 @@ + +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// +// Copyright (C) 2011, 2013, 2014, 2019, 2021 John Langner, WB2OSZ +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . +// + +#include "direwolf.h" + +#include + +#include "hdlc_send.h" +#include "audio.h" +#include "gen_tone.h" +#include "textcolor.h" +#include "fcs_calc.h" +#include "ax25_pad.h" +#include "fx25.h" +#include "il2p.h" + +static void send_byte_msb_first (int chan, int x, int polarity); + +static void send_control_nrzi (int, int); +static void send_data_nrzi (int, int); +static void send_bit_nrzi (int, int); + + + +static int number_of_bits_sent[MAX_CHANS]; // Count number of bits sent by "hdlc_send_frame" or "hdlc_send_flags" + + + +/*------------------------------------------------------------- + * + * Name: layer2_send_frame + * + * Purpose: Convert frames to a stream of bits. + * Originally this was for AX.25 only, hence the file name. + * Over time, FX.25 and IL2P were shoehorned in. + * + * Inputs: chan - Audio channel number, 0 = first. + * + * pp - Packet object. + * + * bad_fcs - Append an invalid FCS for testing purposes. + * Applies only to regular AX.25. + * + * Outputs: Bits are shipped out by calling tone_gen_put_bit(). + * + * Returns: Number of bits sent including "flags" and the + * stuffing bits. + * The required time can be calculated by dividing this + * number by the transmit rate of bits/sec. + * + * Description: For AX.25, send: + * start flag + * bit stuffed data + * calculated FCS + * end flag + * NRZI encoding for all but the "flags." + * + * + * Assumptions: It is assumed that the tone_gen module has been + * properly initialized so that bits sent with + * tone_gen_put_bit() are processed correctly. + * + *--------------------------------------------------------------*/ + +static int ax25_only_hdlc_send_frame (int chan, unsigned char *fbuf, int flen, int bad_fcs); + + +int layer2_send_frame (int chan, packet_t pp, int bad_fcs, struct audio_s *audio_config_p) +{ + if (audio_config_p->achan[chan].layer2_xmit == LAYER2_IL2P) { + + int n = il2p_send_frame (chan, pp, audio_config_p->achan[chan].il2p_max_fec, + audio_config_p->achan[chan].il2p_invert_polarity); + if (n > 0) { + return (n); + } + text_color_set(DW_COLOR_ERROR); + dw_printf ("Unable to send IL2p frame. Falling back to regular AX.25.\n"); + // Not sure if we should fall back to AX.25 or not here. + } + else if (audio_config_p->achan[chan].layer2_xmit == LAYER2_FX25) { + unsigned char fbuf[AX25_MAX_PACKET_LEN+2]; + int flen = ax25_pack (pp, fbuf); + int n = fx25_send_frame (chan, fbuf, flen, audio_config_p->achan[chan].fx25_strength); + if (n > 0) { + return (n); + } + text_color_set(DW_COLOR_ERROR); + dw_printf ("Unable to send FX.25. Falling back to regular AX.25.\n"); + // Definitely need to fall back to AX.25 here because + // the FX.25 frame length is so limited. + } + + unsigned char fbuf[AX25_MAX_PACKET_LEN+2]; + int flen = ax25_pack (pp, fbuf); + return (ax25_only_hdlc_send_frame (chan, fbuf, flen, bad_fcs)); +} + + + +static int ax25_only_hdlc_send_frame (int chan, unsigned char *fbuf, int flen, int bad_fcs) +{ + int j, fcs; + + + number_of_bits_sent[chan] = 0; + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("hdlc_send_frame ( chan = %d, fbuf = %p, flen = %d, bad_fcs = %d)\n", chan, fbuf, flen, bad_fcs); + fflush (stdout); +#endif + + send_control_nrzi (chan, 0x7e); /* Start frame */ + + for (j=0; j> 8) & 0xff); + } + else { + send_data_nrzi (chan, fcs & 0xff); + send_data_nrzi (chan, (fcs >> 8) & 0xff); + } + + send_control_nrzi (chan, 0x7e); /* End frame */ + + return (number_of_bits_sent[chan]); +} + + +/*------------------------------------------------------------- + * + * Name: layer2_preamble_postamble + * + * Purpose: Send filler pattern before and after the frame. + * For HDLC it is 01111110, for IL2P 01010101. + * + * Inputs: chan - Audio channel number, 0 = first. + * + * nbytes - Number of bytes to send. + * + * finish - True for end of transmission. + * This causes the last audio buffer to be flushed. + * + * audio_config_p - Configuration for audio and modems. + * + * Outputs: Bits are shipped out by calling tone_gen_put_bit(). + * + * Returns: Number of bits sent. + * There is no bit-stuffing so we would expect this to + * be 8 * nbytes. + * The required time can be calculated by dividing this + * number by the transmit rate of bits/sec. + * + * Assumptions: It is assumed that the tone_gen module has been + * properly initialized so that bits sent with + * tone_gen_put_bit() are processed correctly. + * + *--------------------------------------------------------------*/ + +int layer2_preamble_postamble (int chan, int nbytes, int finish, struct audio_s *audio_config_p) +{ + int j; + + number_of_bits_sent[chan] = 0; + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("hdlc_send_flags ( chan = %d, nflags = %d, finish = %d )\n", chan, nflags, finish); + fflush (stdout); +#endif + + // When the transmitter is on but not sending data, it should be sending + // a stream of a filler pattern. + // For AX.25, it is the 01111110 "flag" pattern with NRZI and no bit stuffing. + // For IL2P, it is 01010101 without NRZI. + + for (j=0; jachan[chan].layer2_xmit == LAYER2_IL2P) { + send_byte_msb_first (chan, IL2P_PREAMBLE, audio_config_p->achan[chan].il2p_invert_polarity); + } + else { + send_control_nrzi (chan, 0x7e); + } + } + +/* Push out the final partial buffer! */ + + if (finish) { + audio_flush(ACHAN2ADEV(chan)); + } + + return (number_of_bits_sent[chan]); +} + + + +// The next one is only for IL2P. No NRZI. +// MSB first, opposite of AX.25. + +static void send_byte_msb_first (int chan, int x, int polarity) +{ + int i; + + for (i=0; i<8; i++) { + int dbit = (x & 0x80) != 0; + tone_gen_put_bit (chan, (dbit ^ polarity) & 1); + x <<= 1; + number_of_bits_sent[chan]++; + } +} + + +// The following are only for HDLC. +// All bits are sent NRZI. +// Data (non flags) use bit stuffing. + + +static int stuff[MAX_CHANS]; // Count number of "1" bits to keep track of when we + // need to break up a long run by "bit stuffing." + // Needs to be array because we could be transmitting + // on multiple channels at the same time. + +static void send_control_nrzi (int chan, int x) +{ + int i; + + for (i=0; i<8; i++) { + send_bit_nrzi (chan, x & 1); + x >>= 1; + } + + stuff[chan] = 0; +} + +static void send_data_nrzi (int chan, int x) +{ + int i; + + for (i=0; i<8; i++) { + send_bit_nrzi (chan, x & 1); + if (x & 1) { + stuff[chan]++; + if (stuff[chan] == 5) { + send_bit_nrzi (chan, 0); + stuff[chan] = 0; + } + } else { + stuff[chan] = 0; + } + x >>= 1; + } +} + +/* + * NRZI encoding. + * data 1 bit -> no change. + * data 0 bit -> invert signal. + */ + +static void send_bit_nrzi (int chan, int b) +{ + static int output[MAX_CHANS]; + + if (b == 0) { + output[chan] = ! output[chan]; + } + + tone_gen_put_bit (chan, output[chan]); + + number_of_bits_sent[chan]++; +} + + +// The rest of this is for EAS SAME. +// This is sort of a logical place because it serializes a frame, but not in HDLC. +// We have a parallel where SAME deserialization is in hdlc_rec. +// Maybe both should be pulled out and moved to a same.c. + + +/*------------------------------------------------------------------- + * + * Name: eas_send + * + * Purpose: Serialize EAS SAME for transmission. + * + * Inputs: chan - Radio channel number. + * str - Character string to send. + * repeat - Number of times to repeat with 1 sec quiet between. + * txdelay - Delay (ms) from PTT to first preamble bit. + * txtail - Delay (ms) from last data bit to PTT off. + * + * + * Returns: Total number of milliseconds to activate PTT. + * This includes delays before the first character + * and after the last to avoid chopping off part of it. + * + * Description: xmit_thread calls this instead of the usual hdlc_send + * when we have a special packet that means send EAS SAME + * code. + * + *--------------------------------------------------------------------*/ + +static inline void eas_put_byte (int chan, unsigned char b) +{ + for (int n=0; n<8; n++) { + tone_gen_put_bit (chan, (b & 1)); + b >>= 1; + } +} + +int eas_send (int chan, unsigned char *str, int repeat, int txdelay, int txtail) +{ + int bytes_sent = 0; + const int gap = 1000; + int gaps_sent = 0; + + gen_tone_put_quiet_ms (chan, txdelay); + + for (int r=0; r. +// + + +/*------------------------------------------------------------------ + * + * Module: igate.c + * + * Purpose: IGate client. + * + * Description: Establish connection with a tier 2 IGate server + * and relay packets between RF and Internet. + * + * References: APRS-IS (Automatic Packet Reporting System-Internet Service) + * http://www.aprs-is.net/Default.aspx + * + * APRS iGate properties + * http://wiki.ham.fi/APRS_iGate_properties + * (now gone but you can find a copy here:) + * https://web.archive.org/web/20120503201832/http://wiki.ham.fi/APRS_iGate_properties + * + * Notes to iGate developers + * https://github.com/hessu/aprsc/blob/master/doc/IGATE-HINTS.md#igates-dropping-duplicate-packets-unnecessarily + * + * SATgate mode. + * http://www.tapr.org/pipermail/aprssig/2016-January/045283.html + * + *---------------------------------------------------------------*/ + +/*------------------------------------------------------------------ + * + * From http://windows.microsoft.com/en-us/windows7/ipv6-frequently-asked-questions + * + * How can I enable IPv6? + * Follow these steps: + * + * Open Network Connections by clicking the Start button, and then clicking + * Control Panel. In the search box, type adapter, and then, under Network + * and Sharing Center, click View network connections. + * + * Right-click your network connection, and then click Properties. + * If you're prompted for an administrator password or confirmation, type + * the password or provide confirmation. + * + * Select the check box next to Internet Protocol Version 6 (TCP/IPv6). + * + *---------------------------------------------------------------*/ + +/* + * Native Windows: Use the Winsock interface. + * Linux: Use the BSD socket interface. + * Cygwin: Can use either one. + */ + +#include "direwolf.h" // Sets _WIN32_WINNT for XP API level needed by ws2tcpip.h + +#if __WIN32__ + +/* The goal is to support Windows XP and later. */ + +#include +#include // _WIN32_WINNT must be set to 0x0501 before including this + +#else +#include +#include +#include +#include +#include +#include +#include +#include +#endif + +#include +#include +#include +#include +#include + +#include "direwolf.h" +#include "ax25_pad.h" +#include "textcolor.h" +#include "version.h" +#include "digipeater.h" +#include "tq.h" +#include "dlq.h" +#include "igate.h" +#include "latlong.h" +#include "pfilter.h" +#include "dtime_now.h" +#include "mheard.h" + + + +#if __WIN32__ +static unsigned __stdcall connnect_thread (void *arg); +static unsigned __stdcall igate_recv_thread (void *arg); +static unsigned __stdcall satgate_delay_thread (void *arg); +#else +static void * connnect_thread (void *arg); +static void * igate_recv_thread (void *arg); +static void * satgate_delay_thread (void *arg); +#endif + + +static dw_mutex_t dp_mutex; /* Critical section for delayed packet queue. */ +static packet_t dp_queue_head; + +static void satgate_delay_packet (packet_t pp, int chan); +static void send_packet_to_server (packet_t pp, int chan); +static void send_msg_to_server (const char *msg, int msg_len); +static void maybe_xmit_packet_from_igate (char *message, int chan); + +static void rx_to_ig_init (void); +static void rx_to_ig_remember (packet_t pp); +static int rx_to_ig_allow (packet_t pp); + +static void ig_to_tx_init (void); +static int ig_to_tx_allow (packet_t pp, int chan); + + +/* + * File descriptor for socket to IGate server. + * Set to -1 if not connected. + * (Don't use SOCKET type because it is unsigned.) +*/ + +static volatile int igate_sock = -1; + +/* + * After connecting to server, we want to make sure + * that the login sequence is sent first. + * This is set to true after the login is complete. + */ + +static volatile int ok_to_send = 0; + + + + +/* + * Convert Internet address to text. + * Can't use InetNtop because it is supported only on Windows Vista and later. + */ + +static char * ia_to_text (int Family, void * pAddr, char * pStringBuf, size_t StringBufSize) +{ + struct sockaddr_in *sa4; + struct sockaddr_in6 *sa6; + + switch (Family) { + case AF_INET: + sa4 = (struct sockaddr_in *)pAddr; +#if __WIN32__ + snprintf (pStringBuf, StringBufSize, "%d.%d.%d.%d", sa4->sin_addr.S_un.S_un_b.s_b1, + sa4->sin_addr.S_un.S_un_b.s_b2, + sa4->sin_addr.S_un.S_un_b.s_b3, + sa4->sin_addr.S_un.S_un_b.s_b4); +#else + inet_ntop (AF_INET, &(sa4->sin_addr), pStringBuf, StringBufSize); +#endif + break; + case AF_INET6: + sa6 = (struct sockaddr_in6 *)pAddr; +#if __WIN32__ + snprintf (pStringBuf, StringBufSize, "%x:%x:%x:%x:%x:%x:%x:%x", + ntohs(((unsigned short *)(&(sa6->sin6_addr)))[0]), + ntohs(((unsigned short *)(&(sa6->sin6_addr)))[1]), + ntohs(((unsigned short *)(&(sa6->sin6_addr)))[2]), + ntohs(((unsigned short *)(&(sa6->sin6_addr)))[3]), + ntohs(((unsigned short *)(&(sa6->sin6_addr)))[4]), + ntohs(((unsigned short *)(&(sa6->sin6_addr)))[5]), + ntohs(((unsigned short *)(&(sa6->sin6_addr)))[6]), + ntohs(((unsigned short *)(&(sa6->sin6_addr)))[7])); +#else + inet_ntop (AF_INET6, &(sa6->sin6_addr), pStringBuf, StringBufSize); +#endif + break; + default: + snprintf (pStringBuf, StringBufSize, "Invalid address family!"); + } + //assert (strlen(pStringBuf) < StringBufSize); + return pStringBuf; +} + + +#if ITEST + +// TODO: Add to automated tests. + +/* For unit testing. */ + +int main (int argc, char *argv[]) +{ + struct audio_s audio_config; + struct igate_config_s igate_config; + struct digi_config_s digi_config; + packet_t pp; + + memset (&audio_config, 0, sizeof(audio_config)); + audio_config.adev[0].num_channels = 2; + strlcpy (audio_config.achan[0].mycall, "WB2OSZ-1", sizeof(audio_config.achan[0].mycall)); + strlcpy (audio_config.achan[1].mycall, "WB2OSZ-2", sizeof(audio_config.achan[0].mycall)); + + memset (&igate_config, 0, sizeof(igate_config)); + + strlcpy (igate_config.t2_server_name, "localhost", sizeof(igate_config.t2_server_name)); + igate_config.t2_server_port = 14580; + strlcpy (igate_config.t2_login, "WB2OSZ-JL", sizeof(igate_config.t2_login)); + strlcpy (igate_config.t2_passcode, "-1", sizeof(igate_config.t2_passcode)); + igate_config.t2_filter = strdup ("r/1/2/3"); + + igate_config.tx_chan = 0; + strlcpy (igate_config.tx_via, ",WIDE2-1", sizeof(igate_config.tx_via)); + igate_config.tx_limit_1 = 3; + igate_config.tx_limit_5 = 5; + + memset (&digi_config, 0, sizeof(digi_config)); + + igate_init(&audio_config, &igate_config, &digi_config, 0); + + while (igate_sock == -1) { + SLEEP_SEC(1); + } + + SLEEP_SEC (2); + pp = ax25_from_text ("A>B,C,D:Ztest message 1", 0); + igate_send_rec_packet (0, pp); + ax25_delete (pp); + + SLEEP_SEC (2); + pp = ax25_from_text ("A>B,C,D:Ztest message 2", 0); + igate_send_rec_packet (0, pp); + ax25_delete (pp); + + SLEEP_SEC (2); + pp = ax25_from_text ("A>B,C,D:Ztest message 2", 0); /* Should suppress duplicate. */ + igate_send_rec_packet (0, pp); + ax25_delete (pp); + + SLEEP_SEC (2); + pp = ax25_from_text ("A>B,TCPIP,D:ZShould drop this due to path", 0); + igate_send_rec_packet (0, pp); + ax25_delete (pp); + + SLEEP_SEC (2); + pp = ax25_from_text ("A>B,C,D:?Should drop query", 0); + igate_send_rec_packet (0, pp); + ax25_delete (pp); + + SLEEP_SEC (5); + pp = ax25_from_text ("A>B,C,D:}E>F,G*,H:Zthird party stuff", 0); + igate_send_rec_packet (0, pp); + ax25_delete (pp); + +#if 1 + while (1) { + SLEEP_SEC (20); + text_color_set(DW_COLOR_INFO); + dw_printf ("Send received packet\n"); + send_msg_to_server ("W1ABC>APRS:?", strlen("W1ABC>APRS:?")); + } +#endif + return 0; +} + +#endif + + +/* + * Global stuff (to this file) + * + * These are set by init function and need to + * be kept around in case connection is lost and + * we need to reestablish the connection later. + */ + + +static struct audio_s *save_audio_config_p; +static struct igate_config_s *save_igate_config_p; +static struct digi_config_s *save_digi_config_p; +static int s_debug; + + +/* + * Statistics for IGate function. + * Note that the RF related counters are just a subset of what is happening on radio channels. + * + * TODO: should have debug option to print these occasionally. + */ + +static int stats_failed_connect; /* Number of times we tried to connect to */ + /* a server and failed. A small number is not */ + /* a bad thing. Each name should have a bunch */ + /* of addresses for load balancing and */ + /* redundancy. */ + +static int stats_connects; /* Number of successful connects to a server. */ + /* Normally you'd expect this to be 1. */ + /* Could be larger if one disappears and we */ + /* try again to find a different one. */ + +static time_t stats_connect_at; /* Most recent time connection was established. */ + /* can be used to determine elapsed connect time. */ + +static int stats_rf_recv_packets; /* Number of candidate packets from the radio. */ + /* This is not the total number of AX.25 frames received */ + /* over the radio; only APRS packets get this far. */ + +static int stats_uplink_packets; /* Number of packets passed along to the IGate */ + /* server after filtering. */ + +static int stats_uplink_bytes; /* Total number of bytes sent to IGate server */ + /* including login, packets, and heartbeats. */ + +static int stats_downlink_bytes; /* Total number of bytes from IGate server including */ + /* packets, heartbeats, other messages. */ + +static int stats_downlink_packets; /* Number of packets from IGate server for possible transmission. */ + /* Fewer might be transmitted due to filtering or rate limiting. */ + +static int stats_rf_xmit_packets; /* Number of packets passed along to radio, for the IGate function, */ + /* after filtering, rate limiting, or other restrictions. */ + /* Number of packets transmitted for beacons, digipeating, */ + /* or client applications are not included here. */ + +static int stats_msg_cnt; /* Number of "messages" transmitted. Subset of above. */ + /* A "message" has the data type indicator of ":" and it is */ + /* not the special case of telemetry metadata. */ + + +/* + * Make some of these available for IGate statistics beacon like + * + * WB2OSZ>APDW14,WIDE1-1:t2_server_name, + p_igate_config->t2_server_port, + p_igate_config->t2_login, + p_igate_config->t2_passcode, + p_igate_config->t2_filter); +#endif + +/* + * Save the arguments for later use. + */ + save_audio_config_p = p_audio_config; + save_igate_config_p = p_igate_config; + save_digi_config_p = p_digi_config; + + stats_failed_connect = 0; + stats_connects = 0; + stats_connect_at = 0; + stats_rf_recv_packets = 0; + stats_uplink_packets = 0; + stats_uplink_bytes = 0; + stats_downlink_bytes = 0; + stats_downlink_packets = 0; + stats_rf_xmit_packets = 0; + stats_msg_cnt = 0; + + rx_to_ig_init (); + ig_to_tx_init (); + + +/* + * Continue only if we have server name, login, and passcode. + */ + if (strlen(p_igate_config->t2_server_name) == 0 || + strlen(p_igate_config->t2_login) == 0 || + strlen(p_igate_config->t2_passcode) == 0) { + return; + } + +/* + * This connects to the server and sets igate_sock. + * It also sends periodic messages to say I'm still alive. + */ + +#if __WIN32__ + connnect_th = (HANDLE)_beginthreadex (NULL, 0, connnect_thread, (void *)NULL, 0, NULL); + if (connnect_th == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Internal error: Could not create IGate connection thread\n"); + return; + } +#else + e = pthread_create (&connect_listen_tid, NULL, connnect_thread, NULL); + if (e != 0) { + text_color_set(DW_COLOR_ERROR); + perror("Internal error: Could not create IGate connection thread"); + return; + } +#endif + +/* + * This reads messages from client when igate_sock is valid. + */ + +#if __WIN32__ + cmd_recv_th = (HANDLE)_beginthreadex (NULL, 0, igate_recv_thread, NULL, 0, NULL); + if (cmd_recv_th == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Internal error: Could not create IGate reading thread\n"); + return; + } +#else + e = pthread_create (&cmd_listen_tid, NULL, igate_recv_thread, NULL); + if (e != 0) { + text_color_set(DW_COLOR_ERROR); + perror("Internal error: Could not create IGate reading thread"); + return; + } +#endif + +/* + * This lets delayed packets continue after specified amount of time. + */ + + if (p_igate_config->satgate_delay > 0) { +#if __WIN32__ + satgate_delay_th = (HANDLE)_beginthreadex (NULL, 0, satgate_delay_thread, NULL, 0, NULL); + if (satgate_delay_th == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Internal error: Could not create SATgate delay thread\n"); + return; + } +#else + e = pthread_create (&satgate_delay_tid, NULL, satgate_delay_thread, NULL); + if (e != 0) { + text_color_set(DW_COLOR_ERROR); + perror("Internal error: Could not create SATgate delay thread"); + return; + } +#endif + dw_mutex_init(&dp_mutex); + } + +} /* end igate_init */ + + +/*------------------------------------------------------------------- + * + * Name: connnect_thread + * + * Purpose: Establish connection with IGate server. + * Send periodic heartbeat to keep keep connection active. + * Reconnect if something goes wrong and we got disconnected. + * + * Inputs: arg - Not used. + * + * Outputs: igate_sock - File descriptor for communicating with client app. + * Will be -1 if not connected. + * + * References: TCP client example. + * http://msdn.microsoft.com/en-us/library/windows/desktop/ms737591(v=vs.85).aspx + * + * Linux IPv6 HOWTO + * http://www.tldp.org/HOWTO/Linux+IPv6-HOWTO/ + * + *--------------------------------------------------------------------*/ + +/* + * Addresses don't get mixed up very well. + * IPv6 always shows up last so we'd probably never + * end up using any of them. Use our own shuffle. + */ + +static void shuffle (struct addrinfo *host[], int nhosts) +{ + int j, k; + + assert (RAND_MAX >= nhosts); /* for % to work right */ + + if (nhosts < 2) return; + + srand (time(NULL)); + + for (j=0; j=0 && kt2_server_port); +#if DEBUGx + text_color_set(DW_COLOR_DEBUG); + dw_printf ("DEBUG: igate connect_thread start, port = %d = '%s'\n", save_igate_config_p->t2_server_port, server_port_str); +#endif + +#if __WIN32__ + err = WSAStartup (MAKEWORD(2,2), &wsadata); + if (err != 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf("WSAStartup failed: %d\n", err); + return (0); + } + + if (LOBYTE(wsadata.wVersion) != 2 || HIBYTE(wsadata.wVersion) != 2) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Could not find a usable version of Winsock.dll\n"); + WSACleanup(); + //sleep (1); + return (0); + } +#endif + + memset (&hints, 0, sizeof(hints)); + + hints.ai_family = AF_UNSPEC; /* Allow either IPv4 or IPv6. */ + + // IPv6 is half baked on Windows XP. + // We might need to leave out IPv6 support for Windows version. + // hints.ai_family = AF_INET; /* IPv4 only. */ + +#if IPV6_ONLY + /* IPv6 addresses always show up at end of list. */ + /* Force use of them for testing. */ + hints.ai_family = AF_INET6; /* IPv6 only */ +#endif + hints.ai_socktype = SOCK_STREAM; + hints.ai_protocol = IPPROTO_TCP; + + +/* + * Repeat forever. + */ + + while (1) { + +/* + * Connect to IGate server if not currently connected. + */ + + if (igate_sock == -1) { + + SLEEP_SEC (5); + + ai_head = NULL; + err = getaddrinfo(save_igate_config_p->t2_server_name, server_port_str, &hints, &ai_head); + if (err != 0) { + text_color_set(DW_COLOR_ERROR); +#if __WIN32__ + dw_printf ("Can't get address for IGate server %s, err=%d\n", + save_igate_config_p->t2_server_name, WSAGetLastError()); +#else + dw_printf ("Can't get address for IGate server %s, %s\n", + save_igate_config_p->t2_server_name, gai_strerror(err)); +#endif + freeaddrinfo(ai_head); + + continue; + } + +#if DEBUG_DNS + text_color_set(DW_COLOR_DEBUG); + dw_printf ("getaddrinfo returns:\n"); +#endif + num_hosts = 0; + for (ai = ai_head; ai != NULL; ai = ai->ai_next) { +#if DEBUG_DNS + text_color_set(DW_COLOR_DEBUG); + ia_to_text (ai->ai_family, ai->ai_addr, ipaddr_str, sizeof(ipaddr_str)); + dw_printf (" %s\n", ipaddr_str); +#endif + hosts[num_hosts] = ai; + if (num_hosts < MAX_HOSTS) num_hosts++; + } + + // We can get multiple addresses back for the host name. + // These should be somewhat randomized for load balancing. + // It turns out the IPv6 addresses are always at the + // end for both Windows and Linux. We do our own shuffling + // to mix them up better and give IPv6 a chance. + + shuffle (hosts, num_hosts); + +#if DEBUG_DNS + text_color_set(DW_COLOR_DEBUG); + dw_printf ("after shuffling:\n"); + for (n=0; nai_family, hosts[n]->ai_addr, ipaddr_str, sizeof(ipaddr_str)); + dw_printf (" %s\n", ipaddr_str); + } +#endif + + // Try each address until we find one that is successful. + + for (n=0; nai_family, ai->ai_addr, ipaddr_str, sizeof(ipaddr_str)); + is = socket(ai->ai_family, ai->ai_socktype, ai->ai_protocol); +#if __WIN32__ + if (is == INVALID_SOCKET) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("IGate: Socket creation failed, err=%d", WSAGetLastError()); + WSACleanup(); + is = -1; + stats_failed_connect++; + continue; + } +#else + if (err != 0) { + text_color_set(DW_COLOR_INFO); + dw_printf("Connect to IGate server %s (%s) failed.\n\n", + save_igate_config_p->t2_server_name, ipaddr_str); + (void) close (is); + is = -1; + stats_failed_connect++; + continue; + } +#endif + +#ifndef DEBUG_DNS + err = connect(is, ai->ai_addr, (int)ai->ai_addrlen); +#if __WIN32__ + if (err == SOCKET_ERROR) { + text_color_set(DW_COLOR_INFO); + dw_printf("Connect to IGate server %s (%s) failed.\n\n", + save_igate_config_p->t2_server_name, ipaddr_str); + closesocket (is); + is = -1; + stats_failed_connect++; + continue; + } + // TODO: set TCP_NODELAY? +#else + if (err != 0) { + text_color_set(DW_COLOR_INFO); + dw_printf("Connect to IGate server %s (%s) failed.\n\n", + save_igate_config_p->t2_server_name, ipaddr_str); + (void) close (is); + is = -1; + stats_failed_connect++; + continue; + } + /* IGate documentation says to use it. */ + /* Does it really make a difference for this application? */ + int flag = 1; + err = setsockopt (is, IPPROTO_TCP, TCP_NODELAY, (void*)(long)(&flag), sizeof(flag)); + if (err < 0) { + text_color_set(DW_COLOR_INFO); + dw_printf("setsockopt TCP_NODELAY failed.\n"); + } +#endif + stats_connects++; + stats_connect_at = time(NULL); + +/* Success. */ + + text_color_set(DW_COLOR_INFO); + dw_printf("\nNow connected to IGate server %s (%s)\n", save_igate_config_p->t2_server_name, ipaddr_str ); + if (strchr(ipaddr_str, ':') != NULL) { + dw_printf("Check server status here http://[%s]:14501\n\n", ipaddr_str); + } + else { + dw_printf("Check server status here http://%s:14501\n\n", ipaddr_str); + } + +/* + * Set igate_sock so everyone else can start using it. + * But make the Rx -> Internet messages wait until after login. + */ + + ok_to_send = 0; + igate_sock = is; +#endif + break; + } + + freeaddrinfo(ai_head); + + if (igate_sock != -1) { + char stemp[256]; + +/* + * Send login message. + * Software name and version must not contain spaces. + */ + + SLEEP_SEC(3); + snprintf (stemp, sizeof(stemp), "user %s pass %s vers Dire-Wolf %d.%d", + save_igate_config_p->t2_login, save_igate_config_p->t2_passcode, + MAJOR_VERSION, MINOR_VERSION); + if (save_igate_config_p->t2_filter != NULL) { + strlcat (stemp, " filter ", sizeof(stemp)); + strlcat (stemp, save_igate_config_p->t2_filter, sizeof(stemp)); + } + send_msg_to_server (stemp, strlen(stemp)); + +/* Delay until it is ok to start sending packets. */ + + SLEEP_SEC(7); + ok_to_send = 1; + } + } + +/* + * If connected to IGate server, send heartbeat periodically to keep connection active. + */ + if (igate_sock != -1) { + SLEEP_SEC(10); + } + if (igate_sock != -1) { + SLEEP_SEC(10); + } + if (igate_sock != -1) { + SLEEP_SEC(10); + } + + + if (igate_sock != -1) { + + char heartbeat[10]; + + strlcpy (heartbeat, "#", sizeof(heartbeat)); + + /* This will close the socket if any error. */ + send_msg_to_server (heartbeat, strlen(heartbeat)); + + } + } + + exit(0); // Unreachable but stops compiler from complaining + // about function not returning a value. +} /* end connnect_thread */ + + + + +/*------------------------------------------------------------------- + * + * Name: igate_send_rec_packet + * + * Purpose: Send a packet to the IGate server + * + * Inputs: chan - Radio channel it was received on. + * This is required for the RF>IS filtering. + * Beaconing (sendto=ig, chan=-1) and a client app sending + * to ICHANNEL should bypass the filtering. + * + * recv_pp - Pointer to packet object. + * *** CALLER IS RESPONSIBLE FOR DELETING IT! ** + * + * + * Description: Send message to IGate Server if connected. + * + * Assumptions: (1) Caller has already verified it is an APRS packet. + * i.e. control = 3 for UI frame, protocol id = 0xf0 for no layer 3 + * + * (2) This is being called only for packets received with + * a correct CRC. We don't want to propagate corrupted data. + * + *--------------------------------------------------------------------*/ + +#define IGATE_MAX_MSG 512 /* "All 'packets' sent to APRS-IS must be in the TNC2 format terminated */ + /* by a carriage return, line feed sequence. No line may exceed 512 bytes */ + /* including the CR/LF sequence." */ + +void igate_send_rec_packet (int chan, packet_t recv_pp) +{ + packet_t pp; + int n; + unsigned char *pinfo; + int info_len; + + + if (igate_sock == -1) { + return; /* Silently discard if not connected. */ + } + + if ( ! ok_to_send) { + return; /* Login not complete. */ + } + + /* Gather statistics. */ + + stats_rf_recv_packets++; + +/* + * Check for filtering from specified channel to the IGate server. + * + * Should we do this after unwrapping the payload from a third party packet? + * In my experience, third party packets have only been seen coming from IGates. + * In that case, the payload will have TCPIP in the path and it will be dropped. + */ + +// Apply RF>IS filtering only if it same from a radio channel. +// Beacon will be channel -1. +// Client app to ICHANNEL is outside of radio channel range. + + if (chan >= 0 && chan < MAX_CHANS && // in radio channel range + save_digi_config_p->filter_str[chan][MAX_CHANS] != NULL) { + + if (pfilter(chan, MAX_CHANS, save_digi_config_p->filter_str[chan][MAX_CHANS], recv_pp, 1) != 1) { + + // Is this useful troubleshooting information or just distracting noise? + // Originally this was always printed but there was a request to add a "quiet" option to suppress this. + // version 1.4: Instead, make the default off and activate it only with the debug igate option. + + if (s_debug >= 1) { + text_color_set(DW_COLOR_INFO); + dw_printf ("Packet from channel %d to IGate was rejected by filter: %s\n", chan, save_digi_config_p->filter_str[chan][MAX_CHANS]); + } + return; + } + } + +/* + * First make a copy of it because it might be modified in place. + */ + + pp = ax25_dup (recv_pp); + assert (pp != NULL); + +/* + * Third party frames require special handling to unwrap payload. + */ + while (ax25_get_dti(pp) == '}') { + packet_t inner_pp; + + for (n = 0; n < ax25_get_num_repeaters(pp); n++) { + char via[AX25_MAX_ADDR_LEN]; /* includes ssid. Do we want to ignore it? */ + + ax25_get_addr_with_ssid (pp, n + AX25_REPEATER_1, via); + + if (strcmp(via, "TCPIP") == 0 || + strcmp(via, "TCPXX") == 0 || + strcmp(via, "RFONLY") == 0 || + strcmp(via, "NOGATE") == 0) { + + if (s_debug >= 1) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("Rx IGate: Do not relay with %s in path.\n", via); + } + + ax25_delete (pp); + return; + } + } + + if (s_debug >= 1) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("Rx IGate: Unwrap third party message.\n"); + } + + inner_pp = ax25_unwrap_third_party(pp); + if (inner_pp == NULL) { + ax25_delete (pp); + return; + } + ax25_delete (pp); + pp = inner_pp; + } + +/* + * Do not relay packets with TCPIP, TCPXX, RFONLY, or NOGATE in the via path. + */ + for (n = 0; n < ax25_get_num_repeaters(pp); n++) { + char via[AX25_MAX_ADDR_LEN]; /* includes ssid. Do we want to ignore it? */ + + ax25_get_addr_with_ssid (pp, n + AX25_REPEATER_1, via); + + if (strcmp(via, "TCPIP") == 0 || + strcmp(via, "TCPXX") == 0 || + strcmp(via, "RFONLY") == 0 || + strcmp(via, "NOGATE") == 0) { + + if (s_debug >= 1) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("Rx IGate: Do not relay with %s in path.\n", via); + } + + ax25_delete (pp); + return; + } + } + +/* + * Do not relay generic query. + */ + if (ax25_get_dti(pp) == '?') { + if (s_debug >= 1) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("Rx IGate: Do not relay generic query.\n"); + } + ax25_delete (pp); + return; + } + + +/* + * Cut the information part at the first CR or LF. + * This is required because CR/LF is used as record separator when sending to server. + * Do NOT trim trailing spaces. + * Starting in 1.4 we preserve any nul characters in the information part. + */ + + if (ax25_cut_at_crlf (pp) > 0) { + if (s_debug >= 1) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("Rx IGate: Truncated information part at CR.\n"); + } + } + + info_len = ax25_get_info (pp, &pinfo); + + +/* + * Someone around here occasionally sends a packet with no information part. + */ + if (info_len == 0) { + + if (s_debug >= 1) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("Rx IGate: Information part length is zero.\n"); + } + ax25_delete (pp); + return; + } + +// TODO: Should we drop raw touch tone data object type generated here? + + +/* + * If the SATgate mode is enabled, see if it should be delayed. + * The rule is if we hear it directly and it has at least one + * digipeater so there is potential of being re-transmitted. + * (Digis are all unused if we are hearing it directly from source.) + */ + if (save_igate_config_p->satgate_delay > 0 && + ax25_get_heard(pp) == AX25_SOURCE && + ax25_get_num_repeaters(pp) > 0) { + + satgate_delay_packet (pp, chan); + } + else { + send_packet_to_server (pp, chan); + } + +} /* end igate_send_rec_packet */ + + + +/*------------------------------------------------------------------- + * + * Name: send_packet_to_server + * + * Purpose: Convert to text and send to the IGate server. + * + * Inputs: pp - Packet object. + * + * chan - Radio channel where it was received. + * + * Description: Duplicate detection is handled here. + * Suppress if same was sent recently. + * + *--------------------------------------------------------------------*/ + +static void send_packet_to_server (packet_t pp, int chan) +{ + unsigned char *pinfo; + int info_len; + char msg[IGATE_MAX_MSG]; + + + info_len = ax25_get_info (pp, &pinfo); + +/* + * We will often see the same packet multiple times close together due to digipeating. + * The consensus seems to be that we should just send the first and drop the later duplicates. + * There is some dissent on this issue. http://www.tapr.org/pipermail/aprssig/2016-July/045907.html + * There could be some value to sending them all to provide information about digipeater paths. + * However, the servers should drop all duplicates so we wasting everyone's time but sending duplicates. + * If you feel strongly about this issue, you could remove the following section. + * Currently rx_to_ig_allow only checks for recent duplicates. + */ + + if ( ! rx_to_ig_allow(pp)) { + if (s_debug >= 1) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("Rx IGate: Drop duplicate of same packet seen recently.\n"); + } + ax25_delete (pp); + return; + } + +/* + * Finally, append ",qAR," and my call to the path. + */ + +/* + * It seems that the specification has changed recently. + * http://www.tapr.org/pipermail/aprssig/2016-December/046456.html + * + * We can see the history at the Internet Archive Wayback Machine. + * + * http://www.aprs-is.net/Connecting.aspx + * captured Oct 19, 2016: + * ... Only the qAR construct may be generated by a client (IGate) on APRS-IS. + * Captured Dec 1, 2016: + * ... Only the qAR and qAO constructs may be generated by a client (IGate) on APRS-IS. + * + * http://www.aprs-is.net/q.aspx + * Captured April 23, 2016: + * (no mention of client generating qAO.) + * Captured July 19, 2016: + * qAO - (letter O) Packet is placed on APRS-IS by a receive-only IGate from RF. + * The callSSID following the qAO is the callSSID of the IGate. Note that receive-only + * IGates are discouraged on standard APRS frequencies. Please consider a bidirectional + * IGate that only gates to RF messages for stations heard directly. + */ + + ax25_format_addrs (pp, msg); + msg[strlen(msg)-1] = '\0'; /* Remove trailing ":" */ + + if (save_igate_config_p->tx_chan >= 0) { + strlcat (msg, ",qAR,", sizeof(msg)); + } + else { + strlcat (msg, ",qAO,", sizeof(msg)); // new for version 1.4. + } + + strlcat (msg, save_audio_config_p->achan[chan].mycall, sizeof(msg)); + strlcat (msg, ":", sizeof(msg)); + + + +// It was reported that APRS packets, containing a nul byte in the information part, +// are being truncated. https://github.com/wb2osz/direwolf/issues/84 +// +// One might argue that the packets are invalid and the proper behavior would be +// to simply discard them, the same way we do if the CRC is bad. One might argue +// that we should simply pass along whatever we receive even if we don't like it. +// We really shouldn't modify it and make the situation even worse. +// +// Chapter 5 of the APRS spec ( http://www.aprs.org/doc/APRS101.PDF ) says: +// +// "The comment may contain any printable ASCII characters (except | and ~, +// which are reserved for TNC channel switching)." +// +// "Printable" would exclude character values less than space (00100000), e.g. +// tab, carriage return, line feed, nul. Sometimes we see carriage return +// (00001010) at the end of APRS packets. This would be in violation of the +// specification. +// +// The MIC-E position format can have non printable characters (0x1c ... 0x1f, 0x7f) +// in the information part. An unfortunate decision, but it is not in the comment part. +// +// The base 91 telemetry format (http://he.fi/doc/aprs-base91-comment-telemetry.txt ), +// which is not part of the APRS spec, uses the | character in the comment to delimit encoded +// telemetry data. This would be in violation of the original spec. No one cares. +// +// The APRS Spec Addendum 1.2 Proposals ( http://www.aprs.org/aprs12/datum.txt) +// adds use of UTF-8 (https://en.wikipedia.org/wiki/UTF-8 )for the free form text in +// messages and comments. It can't be used in the fixed width fields. +// +// Non-ASCII characters are represented by multi-byte sequences. All bytes in these +// multi-byte sequences have the most significant bit set to 1. Using UTF-8 would not +// add any nul (00000000) bytes to the stream. +// +// Based on all of that, we would not expect to see a nul character in the information part. +// +// There are two known cases where we can have a nul character value. +// +// * The Kenwood TM-D710A sometimes sends packets like this: +// +// VA3AJ-9>T2QU6X,VE3WRC,WIDE1,K8UNS,WIDE2*:4P<0x00><0x0f>4T<0x00><0x0f>4X<0x00><0x0f>4\<0x00>`nW<0x1f>oS8>/]"6M}driving fast= +// K4JH-9>S5UQ6X,WR4AGC-3*,WIDE1*:4P<0x00><0x0f>4T<0x00><0x0f>4X<0x00><0x0f>4\<0x00>`jP}l"&>/]"47}QRV from the EV = +// +// Notice that the data type indicator of "4" is not valid. If we remove +// 4P<0x00><0x0f>4T<0x00><0x0f>4X<0x00><0x0f>4\<0x00> we are left with a good MIC-E format. +// This same thing has been observed from others and is intermittent. +// +// * AGW Tracker can send UTF-16 if an option is selected. This can introduce nul bytes. +// This is wrong, it should be using UTF-8. +// +// Rather than using strlcat here, we need to use memcpy and maintain our +// own lengths, being careful to avoid buffer overflow. + + int msg_len = strlen(msg); // What we have so far before info part. + + if (info_len > IGATE_MAX_MSG - msg_len - 2) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Rx IGate: Too long. Truncating.\n"); + info_len = IGATE_MAX_MSG - msg_len - 2; + } + if (info_len > 0) { + memcpy (msg + msg_len, pinfo, info_len); + msg_len += info_len; + } + + send_msg_to_server (msg, msg_len); + stats_uplink_packets++; + +/* + * Remember what was sent to avoid duplicates in near future. + */ + rx_to_ig_remember (pp); + + ax25_delete (pp); + +} /* end send_packet_to_server */ + + + +/*------------------------------------------------------------------- + * + * Name: send_msg_to_server + * + * Purpose: Send something to the IGate server. + * This one function should be used for login, heartbeats, + * and packets. + * + * Inputs: imsg - Message. We will add CR/LF here. + * + * imsg_len - Length of imsg in bytes. + * It could contain nul characters so we can't + * use the normal C string functions. + * + * Description: Send message to IGate Server if connected. + * Disconnect from server, and notify user, if any error. + * Should use a word other than message because that has + * a specific meaning for APRS. + * + *--------------------------------------------------------------------*/ + + +static void send_msg_to_server (const char *imsg, int imsg_len) +{ + int err; + char stemp[IGATE_MAX_MSG+1]; + int stemp_len; + + if (igate_sock == -1) { + return; /* Silently discard if not connected. */ + } + + stemp_len = imsg_len; + if (stemp_len + 2 > IGATE_MAX_MSG) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Rx IGate: Too long. Truncating.\n"); + stemp_len = IGATE_MAX_MSG - 2; + } + + memcpy (stemp, imsg, stemp_len); + + if (s_debug >= 1) { + text_color_set(DW_COLOR_XMIT); + dw_printf ("[rx>ig] "); + ax25_safe_print (stemp, stemp_len, 0); + dw_printf ("\n"); + } + + stemp[stemp_len++] = '\r'; + stemp[stemp_len++] = '\n'; + stemp[stemp_len] = '\0'; + + stats_uplink_bytes += stemp_len; + + +#if __WIN32__ + err = SOCK_SEND (igate_sock, stemp, stemp_len); + if (err == SOCKET_ERROR) + { + text_color_set(DW_COLOR_ERROR); + dw_printf ("\nError %d sending to IGate server. Closing connection.\n\n", WSAGetLastError()); + //dw_printf ("DEBUG: igate_sock=%d, line=%d\n", igate_sock, __LINE__); + closesocket (igate_sock); + igate_sock = -1; + WSACleanup(); + } +#else + err = SOCK_SEND (igate_sock, stemp, stemp_len); + if (err <= 0) + { + text_color_set(DW_COLOR_ERROR); + dw_printf ("\nError sending to IGate server. Closing connection.\n\n"); + close (igate_sock); + igate_sock = -1; + } +#endif + +} /* end send_msg_to_server */ + + +/*------------------------------------------------------------------- + * + * Name: get1ch + * + * Purpose: Read one byte from socket. + * + * Inputs: igate_sock - file handle for socket. + * + * Returns: One byte from stream. + * Waits and tries again later if any error. + * + * + *--------------------------------------------------------------------*/ + +static int get1ch (void) +{ + unsigned char ch; + int n; + + while (1) { + + while (igate_sock == -1) { + SLEEP_SEC(5); /* Not connected. Try again later. */ + } + + /* Just get one byte at a time. */ + // TODO: might read complete packets and unpack from own buffer + // rather than using a system call for each byte. + + n = SOCK_RECV (igate_sock, (char*)(&ch), 1); + + if (n == 1) { +#if DEBUG9 + dw_printf (log_fp, "%02x %c %c", ch, + isprint(ch) ? ch : '.' , + (isupper(ch>>1) || isdigit(ch>>1) || (ch>>1) == ' ') ? (ch>>1) : '.'); + if (ch == '\r') fprintf (log_fp, " CR"); + if (ch == '\n') fprintf (log_fp, " LF"); + fprintf (log_fp, "\n"); +#endif + return(ch); + } + + text_color_set(DW_COLOR_ERROR); + dw_printf ("\nError reading from IGate server. Closing connection.\n\n"); +#if __WIN32__ + closesocket (igate_sock); +#else + close (igate_sock); +#endif + igate_sock = -1; + } + +} /* end get1ch */ + + + + +/*------------------------------------------------------------------- + * + * Name: igate_recv_thread + * + * Purpose: Wait for messages from IGate Server. + * + * Inputs: arg - Not used. + * + * Outputs: igate_sock - File descriptor for communicating with client app. + * + * Description: Process messages from the IGate server. + * + *--------------------------------------------------------------------*/ + +#if __WIN32__ +static unsigned __stdcall igate_recv_thread (void *arg) +#else +static void * igate_recv_thread (void *arg) +#endif +{ + unsigned char ch; + unsigned char message[1000]; // Spec says max 512. + int len; + + +#if DEBUGx + text_color_set(DW_COLOR_DEBUG); + dw_printf ("igate_recv_thread ( socket = %d )\n", igate_sock); +#endif + + while (1) { + + len = 0; + + do + { + ch = get1ch(); + stats_downlink_bytes++; + + // I never expected to see a nul character but it can happen. + // If found, change it to <0x00> and ax25_from_text will change it back to a single byte. + // Along the way we can use the normal C string handling. + + if (ch == 0 && len < (int)(sizeof(message)) - 5) { + message[len++] = '<'; + message[len++] = '0'; + message[len++] = 'x'; + message[len++] = '0'; + message[len++] = '0'; + message[len++] = '>'; + } + else if (len < (int)(sizeof(message))) + { + message[len++] = ch; + } + + } while (ch != '\n'); + + message[sizeof(message)-1] = '\0'; + +/* + * We have a complete message terminated by LF. + * + * Remove CR LF from end. + * This is a record separator for the protocol, not part of the data. + * Should probably have an error if we don't have this. + */ + if (len >=2 && message[len-1] == '\n') { message[len-1] = '\0'; len--; } + if (len >=1 && message[len-1] == '\r') { message[len-1] = '\0'; len--; } + +/* + * I've seen a case where the original RF packet had a trailing CR but + * after someone else sent it to the server and it came back to me, that + * CR was now a trailing space. + * + * At first I was tempted to trim a trailing space as well. + * By fixing this one case it might corrupt the data in other cases. + * We compensate for this by ignoring trailing spaces when performing + * the duplicate detection and removal. + * + * We need to transmit exactly as we get it. + */ + +/* + * I've also seen a multiple trailing spaces like this. + * Notice how safe_print shows a trailing space in hexadecimal to make it obvious. + * + * W1CLA-1>APVR30,TCPIP*,qAC,T2TOKYO3:;IRLP-4942*141503z4218.46NI07108.24W0446325-146IDLE <0x20> + */ + + if (len == 0) + { +/* + * Discard if zero length. + */ + } + else if (message[0] == '#') { +/* + * Heartbeat or other control message. + * + * Print only if within seconds of logging in. + * That way we can see login confirmation but not + * be bothered by the heart beat messages. + */ + + if ( ! ok_to_send) { + text_color_set(DW_COLOR_REC); + dw_printf ("[ig] "); + ax25_safe_print ((char *)message, len, 0); + dw_printf ("\n"); + } + } + else + { +/* + * Convert to third party packet and transmit. + * + * Future: might have ability to configure multiple transmit + * channels, each with own client side filtering and via path. + * If so, loop here over all configured channels. + */ + text_color_set(DW_COLOR_REC); + dw_printf ("\n[ig>tx] "); // formerly just [ig] + ax25_safe_print ((char *)message, len, 0); + dw_printf ("\n"); + + if ((int)strlen((char*)message) != len) { + + // Invalid. Either drop it or pass it along as-is. Don't change. + + text_color_set(DW_COLOR_ERROR); + dw_printf("'nul' character found in packet from IS. This should never happen.\n"); + dw_printf("The source station is probably transmitting with defective software.\n"); + + //if (strcmp((char*)pinfo, "4P") == 0) { + // dw_printf("The TM-D710 will do this intermittently. A firmware upgrade is needed to fix it.\n"); + //} + } + +/* + * Record that we heard from the source address. + */ + mheard_save_is ((char *)message); + + stats_downlink_packets++; + +/* + * Possibly transmit if so configured. + */ + int to_chan = save_igate_config_p->tx_chan; + + if (to_chan >= 0) { + maybe_xmit_packet_from_igate ((char*)message, to_chan); + } + + +/* + * New in 1.7: If ICHANNEL was specified, send packet to client app as specified channel. + */ + if (save_audio_config_p->igate_vchannel >= 0) { + + int ichan = save_audio_config_p->igate_vchannel; + + // My original poorly thoughtout idea was to parse it into a packet object, + // using the non-strict option, and send to the client app. + // + // A lot of things can go wrong with that approach. + + // (1) Up to 8 digipeaters are allowed in radio format. + // There is a potential of finding a larger number here. + // + // (2) The via path can have names that are not valid in the radio format. + // e.g. qAC, T2HAKATA, N5JXS-F1. + // Non-strict parsing would force uppercase, truncate names too long, + // and drop unacceptable SSIDs. + // + // (3) The source address could be invalid for the RF address format. + // e.g. WHO-IS>APJIW4,TCPIP*,qAC,AE5PL-JF::ZL1JSH-9 :Charles Beadfield/New Zealand{583 + // That is essential information that we absolutely need to preserve. + // + // I think the only correct solution is to apply a third party header + // wrapper so the original contents are preserved. This will be a little + // more work for the application developer. Search for ":}" and use only + // the part after that. At this point, I don't see any value in encoding + // information in the source/destination so I will just use "X>X:}" as a prefix + + char stemp[AX25_MAX_INFO_LEN]; + strlcpy (stemp, "X>X:}", sizeof(stemp)); + strlcat (stemp, (char*)message, sizeof(stemp)); + + packet_t pp3 = ax25_from_text(stemp, 0); // 0 means not strict + if (pp3 != NULL) { + + alevel_t alevel; + memset (&alevel, 0, sizeof(alevel)); + alevel.mark = -2; // FIXME: Do we want some other special case? + alevel.space = -2; + + int subchan = -2; // FIXME: -1 is special case for APRStt. + // See what happens with -2 and follow up on this. + // Do we need something else here? + int slice = 0; + fec_type_t fec_type = fec_type_none; + char spectrum[] = "APRS-IS"; + dlq_rec_frame (ichan, subchan, slice, pp3, alevel, fec_type, RETRY_NONE, spectrum); + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("ICHANNEL %d: Could not parse message from APRS-IS server.\n", ichan); + dw_printf ("%s\n", message); + } + } // end ICHANNEL option + } + + } /* while (1) */ + return (0); + +} /* end igate_recv_thread */ + + + +/*------------------------------------------------------------------- + * + * Name: satgate_delay_packet + * + * Purpose: Put packet into holding area for a while rather than + * sending it immediately to the IS server. + * + * Inputs: pp - Packet object. + * + * chan - Radio channel where received. + * + * Outputs: Appended to queue. + * + * Description: If we hear a packet directly and the same one digipeated, + * we only send the first to the APRS IS due to duplicate removal. + * It may be desirable to favor the digipeated packet over the + * original. For this situation, we have an option which delays + * a packet if we hear it directly and the via path is not empty. + * We know we heard it directly if none of the digipeater + * addresses have been used. + * This way the digipeated packet will go first. + * The original is sent about 10 seconds later. + * Duplicate removal will drop the original if there is no + * corresponding digipeated version. + * + * + * This was an idea that came up in one of the discussion forums. + * I rushed in without thinking about it very much. + * + * In retrospect, I don't think this was such a good idea. + * It would be of value only if there is no other IGate nearby + * that would report on the original transmission. + * I wonder if anyone would notice if this silently disappeared. + * + *--------------------------------------------------------------------*/ + +static void satgate_delay_packet (packet_t pp, int chan) +{ + packet_t pnext, plast; + + + //if (s_debug >= 1) { + text_color_set(DW_COLOR_INFO); + dw_printf ("Rx IGate: SATgate mode, delay packet heard directly.\n"); + //} + + ax25_set_release_time (pp, dtime_now() + save_igate_config_p->satgate_delay); +//TODO: save channel too. + + dw_mutex_lock (&dp_mutex); + + if (dp_queue_head == NULL) { + dp_queue_head = pp; + } + else { + plast = dp_queue_head; + while ((pnext = ax25_get_nextp(plast)) != NULL) { + plast = pnext; + } + ax25_set_nextp (plast, pp); + } + + dw_mutex_unlock (&dp_mutex); + +} /* end satgate_delay_packet */ + + + +/*------------------------------------------------------------------- + * + * Name: satgate_delay_thread + * + * Purpose: Release packet when specified release time has arrived. + * + * Inputs: dp_queue_head - Queue of packets. + * + * Outputs: Sent to APRS IS. + * + * Description: For simplicity we'll just poll each second. + * Release the packet when its time has arrived. + * + *--------------------------------------------------------------------*/ + +#if __WIN32__ +static unsigned __stdcall satgate_delay_thread (void *arg) +#else +static void * satgate_delay_thread (void *arg) +#endif +{ + double release_time; + int chan = 0; // TODO: get receive channel somehow. + // only matters if multi channel with different names. + + while (1) { + SLEEP_SEC (1); + +/* Don't need critical region just to peek */ + + if (dp_queue_head != NULL) { + + double now = dtime_now(); + + release_time = ax25_get_release_time (dp_queue_head); + +#if 0 + text_color_set(DW_COLOR_DEBUG); + dw_printf ("SATgate: %.1f sec remaining\n", release_time - now); +#endif + if (now > release_time) { + packet_t pp; + + dw_mutex_lock (&dp_mutex); + + pp = dp_queue_head; + dp_queue_head = ax25_get_nextp(pp); + + dw_mutex_unlock (&dp_mutex); + ax25_set_nextp (pp, NULL); + + send_packet_to_server (pp, chan); + } + } /* if something in queue */ + } /* while (1) */ + return (0); + +} /* end satgate_delay_thread */ + + +/*------------------------------------------------------------------- + * + * Name: maybe_xmit_packet_from_igate + * + * Purpose: Convert text string, from IGate server, to third party + * packet and send to transmit queue if appropriate. + * + * Inputs: message - As sent by the server. + * Any trailing CRLF should have been removed. + * Typical examples: + * + * KA1BTK-5>APDR13,TCPIP*,qAC,T2IRELAND:=4237.62N/07040.68W$/A=-00054 http://aprsdroid.org/ + * N1HKO-10>APJI40,TCPIP*,qAC,N1HKO-JS:APWW10,WIDE1-1,WIDE2-1,qAS,K1RI:/221700h/9AmAT3PQ3S,WIDE1-1,WIDE2-1,qAR,W1TG-1:`c)@qh\>/"50}TinyTrak4 Mobile + * + * This is interesting because the source is not a valid AX.25 address. + * Non-RF stations can have 2 alphanumeric characters for SSID. + * In this example, the WHO-IS server is responding to a message. + * + * WHO-IS>APJIW4,TCPIP*,qAC,AE5PL-JF::ZL1JSH-9 :Charles Beadfield/New Zealand{583 + * + * + * Notice how the final digipeater address, in the header, might not + * be a valid AX.25 address. We see a 9 character address + * (with no ssid) and an ssid of two letters. + * We don't care because we end up discarding them before + * repackaging to go over the radio. + * + * The "q construct" ( http://www.aprs-is.net/q.aspx ) provides + * a clue about the journey taken. "qAX" means that the station sending + * the packet to the server did not login properly as a ham radio + * operator so we don't want to put this on to RF. + * + * to_chan - Radio channel for transmitting. + * + *--------------------------------------------------------------------*/ + + +// It is unforunate that the : data type indicator (DTI) was overloaded with +// so many different meanings. Simply looking at the DTI is not adequate for +// determining whether a packet is a message. +// We need to exclude the other special cases of telemetry metadata, +// bulletins, and weather bulletins. + +static int is_message_message (char *infop) +{ + if (*infop != ':') return (0); + if (strlen(infop) < 11) return (0); // too short for : addressee : + if (strlen(infop) >= 16) { + if (strncmp(infop+10, ":PARM.", 6) == 0) return (0); + if (strncmp(infop+10, ":UNIT.", 6) == 0) return (0); + if (strncmp(infop+10, ":EQNS.", 6) == 0) return (0); + if (strncmp(infop+10, ":BITS.", 6) == 0) return (0); + } + if (strlen(infop) >= 4) { + if (strncmp(infop+1, "BLN", 3) == 0) return (0); + if (strncmp(infop+1, "NWS", 3) == 0) return (0); + if (strncmp(infop+1, "SKY", 3) == 0) return (0); + if (strncmp(infop+1, "CWA", 3) == 0) return (0); + if (strncmp(infop+1, "BOM", 3) == 0) return (0); + } + return (1); // message, including ack, rej +} + + +static void maybe_xmit_packet_from_igate (char *message, int to_chan) +{ + int n; + + assert (to_chan >= 0 && to_chan < MAX_CHANS); + +/* + * Try to parse it into a packet object; we need this for the packet filtering. + * + * We use the non-strict option because there the via path can have: + * - station names longer than 6. + * - alphanumeric SSID. + * - lower case for "q constructs. + * We don't care about any of those because the via path will be discarded anyhow. + * + * The other issue, that I did not think of originally, is that the "source" + * address might not conform to AX.25 restrictions when it originally came + * from a non-RF source. For example an APRS "message" might be sent to the + * "WHO-IS" server, and the reply message would have that for the source address. + * + * Originally, I used the source address from the packet object but that was + * missing the alphanumeric SSID. This needs to be done differently. + * + * Potential Bug: Up to 8 digipeaters are allowed in radio format. + * Is there a possibility of finding a larger number here? + */ + packet_t pp3 = ax25_from_text(message, 0); + if (pp3 == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Tx IGate: Could not parse message from server.\n"); + dw_printf ("%s\n", message); + return; + } + +// Issue 408: The source address might not be valid AX.25 because it +// came from a non-RF station. e.g. some server responding to a message. +// We need to take source address from original rather than extracting it +// from the packet object. + + char src[AX25_MAX_ADDR_LEN]; /* Source address. */ + memset (src, 0, sizeof(src)); + memcpy (src, message, sizeof(src)-1); + char *gt = strchr(src, '>'); + if (gt != NULL) { + *gt = '\0'; + } + +/* + * Drop if path contains: + * NOGATE or RFONLY - means IGate should not pass them. + * TCPXX or qAX - means it came from somewhere that did not identify itself correctly. + */ + for (n = 0; n < ax25_get_num_repeaters(pp3); n++) { + char via[AX25_MAX_ADDR_LEN]; /* includes ssid. Do we want to ignore it? */ + + ax25_get_addr_with_ssid (pp3, n + AX25_REPEATER_1, via); + + if (strcmp(via, "qAX") == 0 || // qAX deprecated. http://www.aprs-is.net/q.aspx + strcmp(via, "TCPXX") == 0 || // TCPXX deprecated. + strcmp(via, "RFONLY") == 0 || + strcmp(via, "NOGATE") == 0) { + + if (s_debug >= 1) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("Tx IGate: Do not transmit with %s in path.\n", via); + } + + ax25_delete (pp3); + return; + } + } + +/* + * Apply our own packet filtering if configured. + * Do we want to do this before or after removing the VIA path? + * I suppose by doing it first, we have the possibility of + * filtering by stations along the way or the q construct. + */ + + assert (to_chan >= 0 && to_chan < MAX_CHANS); + + +/* + * We have a rather strange special case here. + * If we recently transmitted a 'message' from some station, + * send the position of the message sender when it comes along later. + * + * Some refer to this as a "courtesy posit report" but I don't + * think that is an official term. + * + * If we have a position report, look up the sender and see if we should + * bypass the normal filtering. + * + * Reference: https://www.aprs-is.net/IGating.aspx + * + * "Passing all message packets also includes passing the sending station's position + * along with the message. When APRS-IS was small, we did this using historical position + * packets. This has become problematic as it introduces historical data on to RF. + * The IGate should note the station(s) it has gated messages to RF for and pass + * the next position packet seen for that station(s) to RF." + */ + +// TODO: Not quite this simple. Should have a function to check for position. +// $ raw gps could be a position. @ could be weather data depending on symbol. + + char *pinfo = NULL; + int info_len = ax25_get_info (pp3, (unsigned char **)(&pinfo)); + + int msp_special_case = 0; + + if (info_len >= 1 && strchr("!=/@'`", *pinfo) != NULL) { + + int n = mheard_get_msp(src); + + if (n > 0) { + + msp_special_case = 1; + + if (s_debug >= 1) { + text_color_set(DW_COLOR_INFO); + dw_printf ("Special case, allow position from message sender %s, %d remaining.\n", src, n - 1); + } + + mheard_set_msp (src, n - 1); + } + } + + if ( ! msp_special_case) { + + if (save_digi_config_p->filter_str[MAX_CHANS][to_chan] != NULL) { + + if (pfilter(MAX_CHANS, to_chan, save_digi_config_p->filter_str[MAX_CHANS][to_chan], pp3, 1) != 1) { + + // Previously there was a debug message here about the packet being dropped by filtering. + // This is now handled better by the "-df" command line option for filtering details. + + ax25_delete (pp3); + return; + } + } + } + + +/* + * We want to discard the via path, as received from the APRS-IS, then + * replace it with TCPIP and our own call, marked as used. + * + * + * For example, we might get something like this from the server. + * K1USN-1>APWW10,TCPIP*,qAC,N5JXS-F1:T#479,100,048,002,500,000,10000000 + * + * We want to transform it to this before wrapping it as third party traffic. + * K1USN-1>APWW10,TCPIP,mycall*:T#479,100,048,002,500,000,10000000 + */ + +/* + * These are typical examples where we see TCPIP*,qAC, + * + * N3LLO-4>APRX28,TCPIP*,qAC,T2NUENGLD:T#474,21.4,0.3,114.0,4.0,0.0,00000000 + * N1WJO>APWW10,TCPIP*,qAC,T2MAINE:)147.120!4412.27N/07033.27WrW1OCA repeater136.5 Tone Norway Me + * AB1OC-10>APWW10,TCPIP*,qAC,T2IAD2:=4242.70N/07135.41W#(Time 0:00:00)!INSERVICE!!W60! + * + * But sometimes we get a different form: + * + * N1YG-1>T1SY9P,WIDE1-1,WIDE2-2,qAR,W2DAN-15:'c&<0x7f>l <0x1c>-/> + * W1HS-8>TSSP9T,WIDE1-1,WIDE2-1,qAR,N3LLO-2:`d^Vl"W>/'"85}|*&%_'[|!wLK!|3 + * N1RCW-1>APU25N,MA2-2,qAR,KA1VCQ-1:=4140.41N/07030.21W-Home Station/Fill-in Digi {UIV32N} + * N1IEJ>T4PY3U,W1EMA-1,WIDE1*,WIDE2-2,qAR,KD1KE:`a5"l!<0x7f>-/]"4f}Retired & Busy= + * + * Oh! They have qAR rather than qAC. What does that mean? + * From http://www.aprs-is.net/q.aspx + * + * qAC - Packet was received from the client directly via a verified connection (FROMCALL=login). + * The callSSID following the qAC is the server's callsign-SSID. + * + * qAR - Packet was received directly (via a verified connection) from an IGate using the ,I construct. + * The callSSID following the qAR it the callSSID of the IGate. + * + * What is the ",I" construct? + * Do we care here? + * Is it something new and improved that we should be using in the other direction? + */ + + char payload[AX25_MAX_PACKET_LEN]; + + char dest[AX25_MAX_ADDR_LEN]; /* Destination field. */ + ax25_get_addr_with_ssid (pp3, AX25_DESTINATION, dest); + snprintf (payload, sizeof(payload), "%s>%s,TCPIP,%s*:%s", + src, dest, save_audio_config_p->achan[to_chan].mycall, pinfo); + + +#if DEBUGx + text_color_set(DW_COLOR_DEBUG); + dw_printf ("Tx IGate: DEBUG payload=%s\n", payload); +#endif + + + +/* + * Encapsulate for sending over radio if no reason to drop it. + */ + +/* + * We don't want to suppress duplicate "messages" within a short time period. + * Suppose we transmitted a "message" for some station and it did not respond with an ack. + * 25 seconds later the sender retries. Wouldn't we want to pass along that retry? + * + * "Messages" get preferential treatment because they are high value and very rare. + * -> Bypass the duplicate suppression. + * -> Raise the rate limiting value. + */ + if (ig_to_tx_allow (pp3, to_chan)) { + char radio [2400]; + snprintf (radio, sizeof(radio), "%s>%s%d%d%s:}%s", + save_audio_config_p->achan[to_chan].mycall, + APP_TOCALL, MAJOR_VERSION, MINOR_VERSION, + save_igate_config_p->tx_via, + payload); + + packet_t pradio = ax25_from_text (radio, 1); + if (pradio != NULL) { + +#if ITEST + text_color_set(DW_COLOR_XMIT); + dw_printf ("Xmit: %s\n", radio); + ax25_delete (pradio); +#else + /* This consumes packet so don't reference it again! */ + tq_append (to_chan, TQ_PRIO_1_LO, pradio); +#endif + stats_rf_xmit_packets++; // Any type of packet. + + if (is_message_message(pinfo)) { + +// We transmitted a "message." Telemetry metadata is excluded. +// Remember to pass along address of the sender later. + + stats_msg_cnt++; // Update statistics. + + mheard_set_msp (src, save_igate_config_p->igmsp); + } + + ig_to_tx_remember (pp3, save_igate_config_p->tx_chan, 0); // correct. version before encapsulating it. + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Received invalid packet from IGate.\n"); + dw_printf ("%s\n", payload); + dw_printf ("Will not attempt to transmit third party packet.\n"); + dw_printf ("%s\n", radio); + } + + } + + ax25_delete (pp3); + +} /* end maybe_xmit_packet_from_igate */ + + + +/*------------------------------------------------------------------- + * + * Name: rx_to_ig_remember + * + * Purpose: Keep a record of packets sent to the IGate server + * so we don't send duplicates within some set amount of time. + * + * Inputs: pp - Pointer to a packet object. + * + *------------------------------------------------------------------- + * + * Name: rx_to_ig_allow + * + * Purpose: Check whether this is a duplicate of another + * recently received from RF and sent to the Server + * + * Input: pp - Pointer to packet object. + * + * Returns: True if it is OK to send. + * + *------------------------------------------------------------------- + * + * Description: These two functions perform the final stage of filtering + * before sending a received (from radio) packet to the IGate server. + * + * rx_to_ig_remember must be called for every packet sent to the server. + * + * rx_to_ig_allow decides whether this should be allowed thru + * based on recent activity. We will drop the packet if it is a + * duplicate of another sent recently. + * + * Rather than storing the entire packet, we just keep a CRC to + * reduce memory and processing requirements. We do the same in + * the digipeater function to suppress duplicates. + * + * There is a 1 / 65536 chance of getting a false positive match + * which is good enough for this application. + * + * + * Original thinking: + * + * Occasionally someone will get on one of the discussion groups and say: + * I don't think my IGate is working. I look at packets, from local stations, + * on aprs.fi or findu.com, and they are always through some other IGate station, + * never mine. + * Then someone has to explain, this is not a valid strategy for analyzing + * everything going thru the network. The APRS-IS servers drop duplicate + * packets (ignoring the via path) within a 30 second period. If some + * other IGate gets the same thing there a millisecond faster than you, + * the one you send is discarded. + * In this scenario, it would make sense to perform additional duplicate + * suppression before forwarding RF packets to the Server. + * I don't recall if I saw some specific recommendation to do this or if + * it just seemed like the obvious thing to do to avoid sending useless + * stuff that would just be discarded anyhow. It seems others came to the + * same conclusion. http://www.tapr.org/pipermail/aprssig/2016-July/045907.html + * + * Version 1.5: Rethink strategy. + * + * Issue 85, https://github.com/wb2osz/direwolf/issues/85 , + * got me thinking about this some more. Sending more information will + * allow the APRS-IS servers to perform future additional network analysis. + * To make a long story short, the RF>IS direction duplicate checking + * is now disabled. The code is still there in case I change my mind + * and want to add a configuration option to allow it. The dedupe + * time is set to 0 which means don't do the checking. + * + *--------------------------------------------------------------------*/ + +#define RX2IG_HISTORY_MAX 30 /* Remember the last 30 sent to IGate server. */ + +static int rx2ig_insert_next; +static time_t rx2ig_time_stamp[RX2IG_HISTORY_MAX]; +static unsigned short rx2ig_checksum[RX2IG_HISTORY_MAX]; + +static void rx_to_ig_init (void) +{ + int n; + for (n=0; nrx2ig_dedupe_time == 0) { + return; + } + + rx2ig_time_stamp[rx2ig_insert_next] = time(NULL); + rx2ig_checksum[rx2ig_insert_next] = ax25_dedupe_crc(pp); + + if (s_debug >= 3) { + char src[AX25_MAX_ADDR_LEN]; + char dest[AX25_MAX_ADDR_LEN]; + unsigned char *pinfo; + int info_len; + + ax25_get_addr_with_ssid(pp, AX25_SOURCE, src); + ax25_get_addr_with_ssid(pp, AX25_DESTINATION, dest); + info_len = ax25_get_info (pp, &pinfo); + (void)info_len; + + text_color_set(DW_COLOR_DEBUG); + dw_printf ("rx_to_ig_remember [%d] = %d %d \"%s>%s:%s\"\n", + rx2ig_insert_next, + (int)(rx2ig_time_stamp[rx2ig_insert_next]), + rx2ig_checksum[rx2ig_insert_next], + src, dest, pinfo); + } + + rx2ig_insert_next++; + if (rx2ig_insert_next >= RX2IG_HISTORY_MAX) { + rx2ig_insert_next = 0; + } +} + +static int rx_to_ig_allow (packet_t pp) +{ + unsigned short crc = ax25_dedupe_crc(pp); + time_t now = time(NULL); + int j; + + if (s_debug >= 2) { + char src[AX25_MAX_ADDR_LEN]; + char dest[AX25_MAX_ADDR_LEN]; + unsigned char *pinfo; + int info_len; + + ax25_get_addr_with_ssid(pp, AX25_SOURCE, src); + ax25_get_addr_with_ssid(pp, AX25_DESTINATION, dest); + info_len = ax25_get_info (pp, &pinfo); + (void)info_len; + + text_color_set(DW_COLOR_DEBUG); + dw_printf ("rx_to_ig_allow? %d \"%s>%s:%s\"\n", crc, src, dest, pinfo); + } + + +// Do we have duplicate checking at all in the RF>IS direction? + + if (save_igate_config_p->rx2ig_dedupe_time == 0) { + if (s_debug >= 2) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("rx_to_ig_allow? YES, no dedupe checking\n"); + } + return 1; + } + +// Yes, check for duplicates within certain time. + + for (j=0; j= now - save_igate_config_p->rx2ig_dedupe_time) { + if (s_debug >= 2) { + text_color_set(DW_COLOR_DEBUG); + // could be multiple entries and this might not be the most recent. + dw_printf ("rx_to_ig_allow? NO. Seen %d seconds ago.\n", (int)(now - rx2ig_time_stamp[j])); + } + return 0; + } + } + + if (s_debug >= 2) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("rx_to_ig_allow? YES\n"); + } + return 1; + +} /* end rx_to_ig_allow */ + + + +/*------------------------------------------------------------------- + * + * Name: ig_to_tx_remember + * + * Purpose: Keep a record of packets sent from IGate server to radio transmitter + * so we don't send duplicates within some set amount of time. + * + * Inputs: pp - Pointer to a packet object. + * + * chan - Channel number where it is being transmitted. + * Duplicate detection needs to be separate for each radio channel. + * + * bydigi - True if transmitted by digipeater function. False for IGate. + * Why do we care about digpeating here? See discussion below. + * + *------------------------------------------------------------------------------ + * + * Name: ig_to_tx_allow + * + * Purpose: Check whether this is a duplicate of another sent recently + * or if we exceed the transmit rate limits. + * + * Input: pp - Pointer to packet object. + * + * chan - Radio channel number where we want to transmit. + * + * Returns: True if it is OK to send. + * + *------------------------------------------------------------------------------ + * + * Description: These two functions perform the final stage of filtering + * before sending a packet from the IGate server to the radio. + * + * ig_to_tx_remember must be called for every packet, from the IGate + * server, sent to the radio transmitter. + * + * ig_to_tx_allow decides whether this should be allowed thru + * based on recent activity. We will drop the packet if it is a + * duplicate of another sent recently. + * + * This is the essentially the same as the pair of functions + * above, for RF to IS, with one additional restriction. + * + * The typical residential Internet connection is around 10,000 + * to 50,000 times faster than the radio links we are using. It would + * be easy to completely saturate the radio channel if we are + * not careful. + * + * Besides looking for duplicates, this will also tabulate the + * number of packets sent during the past minute and past 5 + * minutes and stop sending if a limit is reached. + * + * More Discussion: + * + * Consider the following example. + * I hear a packet from W1TG-1 three times over the radio then get the + * (almost) same thing twice from APRS-IS. + * + * + * Digipeater N3LEE-10 audio level = 23(10/6) [NONE] __||||||| + * [0.5] W1TG-1>APU25N,N3LEE-10*,WIDE2-1: + * Station Capabilities, Ambulance, UIview 32 bit apps + * IGATE,MSG_CNT=30,LOC_CNT=61 + * + * [0H] W1TG-1>APU25N,N3LEE-10,WB2OSZ-14*: + * + * Digipeater WIDE2 (probably N3LEE-4) audio level = 22(10/6) [NONE] __||||||| + * [0.5] W1TG-1>APU25N,N3LEE-10,N3LEE-4,WIDE2*: + * Station Capabilities, Ambulance, UIview 32 bit apps + * IGATE,MSG_CNT=30,LOC_CNT=61 + * + * Digipeater WIDE2 (probably AB1OC-10) audio level = 31(14/11) [SINGLE] ____:____ + * [0.4] W1TG-1>APU25N,N3LEE-10,AB1OC-10,WIDE2*: + * Station Capabilities, Ambulance, UIview 32 bit apps + * IGATE,MSG_CNT=30,LOC_CNT=61 + * + * [ig] W1TG-1>APU25N,WIDE2-2,qAR,W1GLO-11:APDW13,WIDE1-1:}W1TG-1>APU25N,TCPIP,WB2OSZ-14*:APU25N,K1FFK,WIDE2*,qAR,WB2ZII-15: + * [0L] WB2OSZ-14>APDW13,WIDE1-1:}W1TG-1>APU25N,TCPIP,WB2OSZ-14*: + * + * + * The first one gets retransmitted by digipeating. + * + * Why are we getting the same thing twice from APRS-IS? Shouldn't remove duplicates? + * Look closely. The original packet, on RF, had a CR character at the end. + * At first I thought duplicate removal was broken but it turns out they + * are not exactly the same. + * + * >>> The receive IGate spec says a packet should be cut at a CR. <<< + * + * In one case it is removed as expected In another case, it is replaced by a trailing + * space character. Maybe someone thought non printable characters should be + * replaced by spaces??? (I have since been told someone thought it would be a good + * idea to replace unprintable characters with spaces. How's that working out for MIC-E position???) + * + * At first I was tempted to remove any trailing spaces to make up for the other + * IGate adding it. Two wrongs don't make a right. Trailing spaces are not that + * rare and removing them would corrupt the data. My new strategy is for + * the duplicate detection compare to ignore trailing space, CR, and LF. + * + * We already transmitted the same thing by the digipeater function so this should + * also go into memory for avoiding duplicates out of the transmit IGate. + * + * Future: + * Should the digipeater function avoid transmitting something if it + * was recently transmitted by the IGate function? + * This code is pretty much the same as dedupe.c. Maybe it could all + * be combined into one. Need to ponder this some more. + * + *--------------------------------------------------------------------*/ + +/* +Here is another complete example, with the "-diii" debugging option to show details. + + +We receive the signal directly from the source: (zzz.log 1011) + + N1ZKO-7 audio level = 33(16/10) [NONE] ___|||||| + [0.5] N1ZKO-7>T2TS7X,WIDE1-1,WIDE2-1:`c6wl!i[/>"4]}[scanning]=<0x0d> + MIC-E, Human, Kenwood TH-D72, In Service + N 42 43.7800, W 071 26.9100, 0 MPH, course 177, alt 230 ft + [scanning] + +We did not send it to the IS server recently. + + Rx IGate: Truncated information part at CR. + rx_to_ig_allow? 57185 "N1ZKO-7>T2TS7X:`c6wl!i[/>"4]}[scanning]=" + rx_to_ig_allow? YES + +Send it now and remember that fact. + + [rx>ig] N1ZKO-7>T2TS7X,WIDE1-1,WIDE2-1,qAR,WB2OSZ-14:`c6wl!i[/>"4]}[scanning]= + rx_to_ig_remember [21] = 1447683040 57185 "N1ZKO-7>T2TS7X:`c6wl!i[/>"4]}[scanning]=" + +Digipeat it. Notice how it has a trailing CR. +TODO: Why is the CRC different? Content looks the same. + + ig_to_tx_remember [38] = ch0 d1 1447683040 27598 "N1ZKO-7>T2TS7X:`c6wl!i[/>"4]}[scanning]= " + [0H] N1ZKO-7>T2TS7X,WB2OSZ-14*,WIDE2-1:`c6wl!i[/>"4]}[scanning]=<0x0d> + +Now we hear it again, thru a digipeater. +Not sure who. Was it UNCAN or was it someone else who doesn't use tracing? +See my rant in the User Guide about this. + + Digipeater WIDE2 (probably UNCAN) audio level = 30(15/10) [NONE] __|||::__ + [0.4] N1ZKO-7>T2TS7X,KB1POR-2,UNCAN,WIDE2*:`c6wl!i[/>"4]}[scanning]=<0x0d> + MIC-E, Human, Kenwood TH-D72, In Service + N 42 43.7800, W 071 26.9100, 0 MPH, course 177, alt 230 ft + [scanning] + +Was sent to server recently so don't do it again. + + Rx IGate: Truncated information part at CR. + rx_to_ig_allow? 57185 "N1ZKO-7>T2TS7X:`c6wl!i[/>"4]}[scanning]=" + rx_to_ig_allow? NO. Seen 1 seconds ago. + Rx IGate: Drop duplicate of same packet seen recently. + +We hear it a third time, by a different digipeater. + + Digipeater WIDE1 (probably N3LEE-10) audio level = 23(12/6) [NONE] __||||||| + [0.5] N1ZKO-7>T2TS7X,N3LEE-10,WIDE1*,WIDE2-1:`c6wl!i[/>"4]}[scanning]=<0x0d> + MIC-E, Human, Kenwood TH-D72, In Service + N 42 43.7800, W 071 26.9100, 0 MPH, course 177, alt 230 ft + [scanning] + +It's a duplicate, so don't send to server. + + Rx IGate: Truncated information part at CR. + rx_to_ig_allow? 57185 "N1ZKO-7>T2TS7X:`c6wl!i[/>"4]}[scanning]=" + rx_to_ig_allow? NO. Seen 2 seconds ago. + Rx IGate: Drop duplicate of same packet seen recently. + Digipeater: Drop redundant packet to channel 0. + +The server sends it to us. +NOTICE: The CR at the end has been replaced by a space. + + [ig>tx] N1ZKO-7>T2TS7X,K1FFK,WA2MJM-15*,qAR,WB2ZII-15:`c6wl!i[/>"4]}[scanning]=<0x20> + +Should we transmit it? +No, we sent it recently by the digipeating function (note "bydigi=1"). + + DEBUG: ax25_dedupe_crc ignoring trailing space. + ig_to_tx_allow? ch0 27598 "N1ZKO-7>T2TS7X:`c6wl!i[/>"4]}[scanning]= " + ig_to_tx_allow? NO. Sent 4 seconds ago. bydigi=1 + Tx IGate: Drop duplicate packet transmitted recently. + [0L] WB2OSZ-14>APDW13,WIDE1-1:}W1AST>TRPR4T,TCPIP,WB2OSZ-14*:`d=Ml!3>/"4N} + [rx>ig] # +*/ + + +#define IG2TX_DEDUPE_TIME 60 /* Do not send duplicate within 60 seconds. */ +#define IG2TX_HISTORY_MAX 50 /* Remember the last 50 sent from server to radio. */ + +/* Ideally this should be a critical region because */ +/* it is being written by two threads but I'm not that concerned. */ + +static int ig2tx_insert_next; +static time_t ig2tx_time_stamp[IG2TX_HISTORY_MAX]; +static unsigned short ig2tx_checksum[IG2TX_HISTORY_MAX]; +static unsigned char ig2tx_chan[IG2TX_HISTORY_MAX]; +static unsigned short ig2tx_bydigi[IG2TX_HISTORY_MAX]; + +static void ig_to_tx_init (void) +{ + int n; + for (n=0; n= 3) { + char src[AX25_MAX_ADDR_LEN]; + char dest[AX25_MAX_ADDR_LEN]; + unsigned char *pinfo; + int info_len; + + ax25_get_addr_with_ssid(pp, AX25_SOURCE, src); + ax25_get_addr_with_ssid(pp, AX25_DESTINATION, dest); + info_len = ax25_get_info (pp, &pinfo); + (void)info_len; + + text_color_set(DW_COLOR_DEBUG); + dw_printf ("ig_to_tx_remember [%d] = ch%d d%d %d %d \"%s>%s:%s\"\n", + ig2tx_insert_next, + chan, bydigi, + (int)(now), crc, + src, dest, pinfo); + } + + ig2tx_time_stamp[ig2tx_insert_next] = now; + ig2tx_checksum[ig2tx_insert_next] = crc; + ig2tx_chan[ig2tx_insert_next] = chan; + ig2tx_bydigi[ig2tx_insert_next] = bydigi; + + ig2tx_insert_next++; + if (ig2tx_insert_next >= IG2TX_HISTORY_MAX) { + ig2tx_insert_next = 0; + } +} + + + +static int ig_to_tx_allow (packet_t pp, int chan) +{ + unsigned short crc = ax25_dedupe_crc(pp); + time_t now = time(NULL); + int j; + int count_1, count_5; + int increase_limit; + + unsigned char *pinfo; + int info_len; + + info_len = ax25_get_info (pp, &pinfo); + (void)info_len; + + if (s_debug >= 2) { + char src[AX25_MAX_ADDR_LEN]; + char dest[AX25_MAX_ADDR_LEN]; + + ax25_get_addr_with_ssid(pp, AX25_SOURCE, src); + ax25_get_addr_with_ssid(pp, AX25_DESTINATION, dest); + + text_color_set(DW_COLOR_DEBUG); + dw_printf ("ig_to_tx_allow? ch%d %d \"%s>%s:%s\"\n", chan, crc, src, dest, pinfo); + } + + /* Consider transmissions on this channel only by either digi or IGate. */ + + for (j=0; j= now - IG2TX_DEDUPE_TIME) { + + /* We have a duplicate within some time period. */ + + if (is_message_message((char*)pinfo)) { + + /* I think I want to avoid the duplicate suppression for "messages." */ + /* Suppose we transmit a message from station X and it doesn't get an ack back. */ + /* Station X then sends exactly the same thing 20 seconds later. */ + /* We don't want to suppress the retry. */ + + if (s_debug >= 2) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("ig_to_tx_allow? Yes for duplicate message sent %d seconds ago. bydigi=%d\n", (int)(now - ig2tx_time_stamp[j]), ig2tx_bydigi[j]); + } + } + else { + + /* Normal (non-message) case. */ + + if (s_debug >= 2) { + text_color_set(DW_COLOR_DEBUG); + // could be multiple entries and this might not be the most recent. + dw_printf ("ig_to_tx_allow? NO. Duplicate sent %d seconds ago. bydigi=%d\n", (int)(now - ig2tx_time_stamp[j]), ig2tx_bydigi[j]); + } + + text_color_set(DW_COLOR_INFO); + dw_printf ("Tx IGate: Drop duplicate packet transmitted recently.\n"); + return 0; + } + } + } + + /* IGate transmit counts must not include digipeater transmissions. */ + + count_1 = 0; + count_5 = 0; + for (j=0; j= now - 60) count_1++; + if (ig2tx_time_stamp[j] >= now - 300) count_5++; + } + } + + /* "Messages" (special APRS data type ":") are intentional and more */ + /* important than all of the other mostly repetitive useless junk */ + /* flowing thru here. */ + /* It would be unfortunate to discard a message because we already */ + /* hit our limit. I don't want to completely eliminate limiting for */ + /* messages, in case something goes terribly wrong, but we can triple */ + /* the normal limit for them. */ + + increase_limit = 1; + if (is_message_message((char*)pinfo)) { + increase_limit = 3; + } + + if (count_1 >= save_igate_config_p->tx_limit_1 * increase_limit) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Tx IGate: Already transmitted maximum of %d packets in 1 minute.\n", save_igate_config_p->tx_limit_1); + return 0; + } + if (count_5 >= save_igate_config_p->tx_limit_5 * increase_limit) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Tx IGate: Already transmitted maximum of %d packets in 5 minutes.\n", save_igate_config_p->tx_limit_5); + return 0; + } + + if (s_debug >= 2) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("ig_to_tx_allow? YES\n"); + } + + return 1; + +} /* end ig_to_tx_allow */ + +/* end igate.c */ diff --git a/src/igate.h b/src/igate.h new file mode 100644 index 00000000..8203ac70 --- /dev/null +++ b/src/igate.h @@ -0,0 +1,128 @@ + +/*---------------------------------------------------------------------------- + * + * Name: igate.h + * + * Purpose: Interface to the Internet Gateway functions. + * + *-----------------------------------------------------------------------------*/ + + +#ifndef IGATE_H +#define IGATE_H 1 + + +#include "ax25_pad.h" +#include "digipeater.h" +#include "audio.h" + + +#define DEFAULT_IGATE_PORT 14580 + + + +struct igate_config_s { + +/* + * For logging into the IGate server. + */ + char t2_server_name[40]; /* Tier 2 IGate server name. */ + + int t2_server_port; /* Typically 14580. */ + + char t2_login[AX25_MAX_ADDR_LEN];/* e.g. WA9XYZ-15 */ + /* Note that the ssid could be any two alphanumeric */ + /* characters not just 1 thru 15. */ + /* Could be same or different than the radio call(s). */ + /* Not sure what the consequences would be. */ + + char t2_passcode[8]; /* Max. 5 digits. Could be "-1". */ + + char *t2_filter; /* Optional filter for IS -> RF direction. */ + /* This is the "server side" filter. */ + /* A better name would be subscription or something */ + /* like that because we can only ask for more. */ + +/* + * For transmitting. + */ + int tx_chan; /* Radio channel for transmitting. */ + /* 0=first, etc. -1 for none. */ + /* Presently IGate can transmit on only a single channel. */ + /* A future version might generalize this. */ + /* Each transmit channel would have its own client side filtering. */ + + char tx_via[80]; /* VIA path for transmitting third party packets. */ + /* Usual text representation. */ + /* Must start with "," if not empty so it can */ + /* simply be inserted after the destination address. */ + + int max_digi_hops; /* Maximum number of digipeater hops possible for via path. */ + /* Derived from the SSID when last character of address is a digit. */ + /* e.g. "WIDE1-1,WIDE5-2" would be 3. */ + /* This is useful to know so we can determine how many */ + /* stations we might be able to reach. */ + + int tx_limit_1; /* Max. packets to transmit in 1 minute. */ + + int tx_limit_5; /* Max. packets to transmit in 5 minutes. */ + + int igmsp; /* Number of message sender position reports to allow. */ + /* Common practice is to default to 1. */ + /* We allow additional flexibility of 0 to disable feature */ + /* or a small number to allow more. */ + +/* + * Receiver to IS data options. + */ + int rx2ig_dedupe_time; /* seconds. 0 to disable. */ + +/* + * Special SATgate mode to delay packets heard directly. + */ + int satgate_delay; /* seconds. 0 to disable. */ +}; + + +#define IGATE_TX_LIMIT_1_DEFAULT 6 +#define IGATE_TX_LIMIT_1_MAX 20 + +#define IGATE_TX_LIMIT_5_DEFAULT 20 +#define IGATE_TX_LIMIT_5_MAX 80 + +#define IGATE_RX2IG_DEDUPE_TIME 0 /* Issue 85. 0 means disable dupe checking in RF>IS direction. */ + /* See comments in rx_to_ig_remember & rx_to_ig_allow. */ + /* Currently there is no configuration setting to change this. */ + +#define DEFAULT_SATGATE_DELAY 10 +#define MIN_SATGATE_DELAY 5 +#define MAX_SATGATE_DELAY 30 + + +/* Call this once at startup */ + +void igate_init (struct audio_s *p_audio_config, struct igate_config_s *p_igate_config, struct digi_config_s *p_digi_config, int debug_level); + +/* Call this with each packet received from the radio. */ + +void igate_send_rec_packet (int chan, packet_t recv_pp); + +/* This when digipeater transmits. Set bydigi to 1 . */ + +void ig_to_tx_remember (packet_t pp, int chan, int bydigi); + + + +/* Get statistics for IGATE status beacon. */ + +int igate_get_msg_cnt (void); + +int igate_get_pkt_cnt (void); + +int igate_get_upl_cnt (void); + +int igate_get_dnl_cnt (void); + + + +#endif diff --git a/src/il2p.h b/src/il2p.h new file mode 100644 index 00000000..d18e2d05 --- /dev/null +++ b/src/il2p.h @@ -0,0 +1,145 @@ + + +#ifndef IL2P_H +#define IL2P_H 1 + + +#define IL2P_PREAMBLE 0x55 + +#define IL2P_SYNC_WORD 0xF15E48 + +#define IL2P_SYNC_WORD_SIZE 3 +#define IL2P_HEADER_SIZE 13 // Does not include 2 parity. +#define IL2P_HEADER_PARITY 2 + +#define IL2P_MAX_PAYLOAD_SIZE 1023 +#define IL2P_MAX_PAYLOAD_BLOCKS 5 +#define IL2P_MAX_PARITY_SYMBOLS 16 // For payload only. +#define IL2P_MAX_ENCODED_PAYLOAD_SIZE (IL2P_MAX_PAYLOAD_SIZE + IL2P_MAX_PAYLOAD_BLOCKS * IL2P_MAX_PARITY_SYMBOLS) + +#define IL2P_MAX_PACKET_SIZE (IL2P_SYNC_WORD_SIZE + IL2P_HEADER_SIZE + IL2P_HEADER_PARITY + IL2P_MAX_ENCODED_PAYLOAD_SIZE) + + +/////////////////////////////////////////////////////////////////////////////// +// +// il2p_init.c +// +/////////////////////////////////////////////////////////////////////////////// + + +// Init must be called at start of application. + +extern void il2p_init (int debug); + +#include "fx25.h" // For Reed Solomon stuff. e.g. struct rs + // Maybe rearrange someday because RS now used another place. + +extern struct rs *il2p_find_rs(int nparity); // Internal later? + +extern void il2p_encode_rs (unsigned char *tx_data, int data_size, int num_parity, unsigned char *parity_out); + +extern int il2p_decode_rs (unsigned char *rec_block, int data_size, int num_parity, unsigned char *out); + +extern int il2p_get_debug(void); +extern void il2p_set_debug(int debug); + + +/////////////////////////////////////////////////////////////////////////////// +// +// il2p_rec.c +// +/////////////////////////////////////////////////////////////////////////////// + +// Receives a bit stream from demodulator. + +extern void il2p_rec_bit (int chan, int subchan, int slice, int dbit); + + + + +/////////////////////////////////////////////////////////////////////////////// +// +// il2p_send.c +// +/////////////////////////////////////////////////////////////////////////////// + +#include "ax25_pad.h" // For packet object. + +// Send bit stream to modulator. + +int il2p_send_frame (int chan, packet_t pp, int max_fec, int polarity); + + + +/////////////////////////////////////////////////////////////////////////////// +// +// il2p_codec.c +// +/////////////////////////////////////////////////////////////////////////////// + +#include "ax25_pad.h" + +extern int il2p_encode_frame (packet_t pp, int max_fec, unsigned char *iout); + +packet_t il2p_decode_frame (unsigned char *irec); + +packet_t il2p_decode_header_payload (unsigned char* uhdr, unsigned char *epayload, int *symbols_corrected); + + + + +/////////////////////////////////////////////////////////////////////////////// +// +// il2p_header.c +// +/////////////////////////////////////////////////////////////////////////////// + + +extern int il2p_type_1_header (packet_t pp, int max_fec, unsigned char *hdr); + +extern packet_t il2p_decode_header_type_1 (unsigned char *hdr, int num_sym_changed); + + +extern int il2p_type_0_header (packet_t pp, int max_fec, unsigned char *hdr); + +extern int il2p_clarify_header(unsigned char *rec_hdr, unsigned char *corrected_descrambled_hdr); + + + +/////////////////////////////////////////////////////////////////////////////// +// +// il2p_scramble.c +// +/////////////////////////////////////////////////////////////////////////////// + +extern void il2p_scramble_block (unsigned char *in, unsigned char *out, int len); + +extern void il2p_descramble_block (unsigned char *in, unsigned char *out, int len); + + +/////////////////////////////////////////////////////////////////////////////// +// +// il2p_payload.c +// +/////////////////////////////////////////////////////////////////////////////// + + +typedef struct { + int payload_byte_count; // Total size, 0 thru 1023 + int payload_block_count; + int small_block_size; + int large_block_size; + int large_block_count; + int small_block_count; + int parity_symbols_per_block; // 2, 4, 6, 8, 16 +} il2p_payload_properties_t; + +extern int il2p_payload_compute (il2p_payload_properties_t *p, int payload_size, int max_fec); + +extern int il2p_encode_payload (unsigned char *payload, int payload_size, int max_fec, unsigned char *enc); + +extern int il2p_decode_payload (unsigned char *received, int payload_size, int max_fec, unsigned char *payload_out, int *symbols_corrected); + +extern int il2p_get_header_attributes (unsigned char *hdr, int *hdr_type, int *max_fec); + +#endif diff --git a/src/il2p_codec.c b/src/il2p_codec.c new file mode 100644 index 00000000..a20aed65 --- /dev/null +++ b/src/il2p_codec.c @@ -0,0 +1,263 @@ +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// +// Copyright (C) 2021 John Langner, WB2OSZ +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . +// + +#include "direwolf.h" + +#include +#include +#include +#include + +#include "il2p.h" +#include "textcolor.h" +#include "demod.h" + + +/*------------------------------------------------------------- + * + * File: il2p_codec.c + * + * Purpose: Convert IL2P encoded format from and to direwolf internal packet format. + * + *--------------------------------------------------------------*/ + + +/*------------------------------------------------------------- + * + * Name: il2p_encode_frame + * + * Purpose: Convert AX.25 frame to IL2P encoding. + * + * Inputs: chan - Audio channel number, 0 = first. + * + * pp - Packet object pointer. + * + * max_fec - 1 to send maximum FEC size rather than automatic. + * + * Outputs: iout - Encoded result, excluding the 3 byte sync word. + * Caller should provide IL2P_MAX_PACKET_SIZE bytes. + * + * Returns: Number of bytes for transmission. + * -1 is returned for failure. + * + * Description: Encode into IL2P format. + * + * Errors: If something goes wrong, return -1. + * + * Most likely reason is that the frame is too large. + * IL2P has a max payload size of 1023 bytes. + * For a type 1 header, this is the maximum AX.25 Information part size. + * For a type 0 header, this is the entire AX.25 frame. + * + *--------------------------------------------------------------*/ + +int il2p_encode_frame (packet_t pp, int max_fec, unsigned char *iout) +{ + +// Can a type 1 header be used? + + unsigned char hdr[IL2P_HEADER_SIZE + IL2P_HEADER_PARITY]; + int e; + int out_len = 0; + + e = il2p_type_1_header (pp, max_fec, hdr); + if (e >= 0) { + il2p_scramble_block (hdr, iout, IL2P_HEADER_SIZE); + il2p_encode_rs (iout, IL2P_HEADER_SIZE, IL2P_HEADER_PARITY, iout+IL2P_HEADER_SIZE); + out_len = IL2P_HEADER_SIZE + IL2P_HEADER_PARITY; + + if (e == 0) { + // Success. No info part. + return (out_len); + } + + // Payload is AX.25 info part. + unsigned char *pinfo; + int info_len; + info_len = ax25_get_info (pp, &pinfo); + + int k = il2p_encode_payload (pinfo, info_len, max_fec, iout+out_len); + if (k > 0) { + out_len += k; + // Success. Info part was <= 1023 bytes. + return (out_len); + } + + // Something went wrong with the payload encoding. + return (-1); + } + else if (e == -1) { + +// Could not use type 1 header for some reason. +// e.g. More than 2 addresses, extended (mod 128) sequence numbers, etc. + + e = il2p_type_0_header (pp, max_fec, hdr); + if (e > 0) { + + il2p_scramble_block (hdr, iout, IL2P_HEADER_SIZE); + il2p_encode_rs (iout, IL2P_HEADER_SIZE, IL2P_HEADER_PARITY, iout+IL2P_HEADER_SIZE); + out_len = IL2P_HEADER_SIZE + IL2P_HEADER_PARITY; + + // Payload is entire AX.25 frame. + + unsigned char *frame_data_ptr = ax25_get_frame_data_ptr (pp); + int frame_len = ax25_get_frame_len (pp); + int k = il2p_encode_payload (frame_data_ptr, frame_len, max_fec, iout+out_len); + if (k > 0) { + out_len += k; + // Success. Entire AX.25 frame <= 1023 bytes. + return (out_len); + } + // Something went wrong with the payload encoding. + return (-1); + } + else if (e == 0) { + // Impossible condition. Type 0 header must have payload. + return (-1); + } + else { + // AX.25 frame is too large. + return (-1); + } + } + + // AX.25 Information part is too large. + return (-1); +} + + + +/*------------------------------------------------------------- + * + * Name: il2p_decode_frame + * + * Purpose: Convert IL2P encoding to AX.25 frame. + * This is only used during testing, with a whole encoded frame. + * During reception, the header would have FEC and descrambling + * applied first so we would know how much to collect for the payload. + * + * Inputs: irec - Received IL2P frame excluding the 3 byte sync word. + * + * Future Out: Number of symbols corrected. + * + * Returns: Packet pointer or NULL for error. + * + *--------------------------------------------------------------*/ + +packet_t il2p_decode_frame (unsigned char *irec) +{ + unsigned char uhdr[IL2P_HEADER_SIZE]; // After FEC and descrambling. + int e = il2p_clarify_header (irec, uhdr); + + // TODO?: for symmetry we might want to clarify the payload before combining. + + return (il2p_decode_header_payload(uhdr, irec + IL2P_HEADER_SIZE + IL2P_HEADER_PARITY, &e)); +} + + +/*------------------------------------------------------------- + * + * Name: il2p_decode_header_payload + * + * Purpose: Convert IL2P encoding to AX.25 frame + * + * Inputs: uhdr - Received header after FEC and descrambling. + * epayload - Encoded payload. + * + * In/Out: symbols_corrected - Symbols (bytes) corrected in the header. + * Should be 0 or 1 because it has 2 parity symbols. + * Here we add number of corrections for the payload. + * + * Returns: Packet pointer or NULL for error. + * + *--------------------------------------------------------------*/ + +packet_t il2p_decode_header_payload (unsigned char* uhdr, unsigned char *epayload, int *symbols_corrected) +{ + int hdr_type; + int max_fec; + int payload_len = il2p_get_header_attributes (uhdr, &hdr_type, &max_fec); + + packet_t pp = NULL; + + if (hdr_type == 1) { + +// Header type 1. Any payload is the AX.25 Information part. + + pp = il2p_decode_header_type_1 (uhdr, *symbols_corrected); + if (pp == NULL) { + // Failed for some reason. + return (NULL); + } + + if (payload_len > 0) { + // This is the AX.25 Information part. + + unsigned char extracted[IL2P_MAX_PAYLOAD_SIZE]; + int e = il2p_decode_payload (epayload, payload_len, max_fec, extracted, symbols_corrected); + + // It would be possible to have a good header but too many errors in the payload. + + if (e <= 0) { + ax25_delete (pp); + pp = NULL; + return (pp); + } + + if (e != payload_len) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("IL2P Internal Error: %s(): hdr_type=%d, max_fec=%d, payload_len=%d, e=%d.\n", __func__, hdr_type, max_fec, payload_len, e); + } + + ax25_set_info (pp, extracted, payload_len); + } + return (pp); + } + else { + +// Header type 0. The payload is the entire AX.25 frame. + + unsigned char extracted[IL2P_MAX_PAYLOAD_SIZE]; + int e = il2p_decode_payload (epayload, payload_len, max_fec, extracted, symbols_corrected); + + if (e <= 0) { // Payload was not received correctly. + return (NULL); + } + + if (e != payload_len) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("IL2P Internal Error: %s(): hdr_type=%d, e=%d, payload_len=%d\n", __func__, hdr_type, e, payload_len); + return (NULL); + } + + alevel_t alevel; + memset (&alevel, 0, sizeof(alevel)); + //alevel = demod_get_audio_level (chan, subchan); // What TODO? We don't know channel here. + // I think alevel gets filled in somewhere later making + // this redundant. + + pp = ax25_from_frame (extracted, payload_len, alevel); + return (pp); + } + +} // end il2p_decode_header_payload + +// end il2p_codec.c + + diff --git a/src/il2p_header.c b/src/il2p_header.c new file mode 100644 index 00000000..94fd25ba --- /dev/null +++ b/src/il2p_header.c @@ -0,0 +1,679 @@ +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// +// Copyright (C) 2021 John Langner, WB2OSZ +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . +// + +#include "direwolf.h" + +#include +#include +#include +#include + +#include "textcolor.h" +#include "ax25_pad.h" +#include "ax25_pad2.h" +#include "il2p.h" + + + +/*-------------------------------------------------------------------------------- + * + * File: il2p_header.c + * + * Purpose: Functions to deal with the IL2P header. + * + * Reference: http://tarpn.net/t/il2p/il2p-specification0-4.pdf + * + *--------------------------------------------------------------------------------*/ + + + +// Convert ASCII to/from DEC SIXBIT as defined here: +// https://en.wikipedia.org/wiki/Six-bit_character_code#DEC_six-bit_code + +static inline int ascii_to_sixbit (int a) +{ + if (a >= ' ' && a <= '_') return (a - ' '); + return (31); // '?' for any invalid. +} + +static inline int sixbit_to_ascii (int s) +{ + return (s + ' '); +} + +// Functions for setting the various header fields. +// It is assumed that it was zeroed first so only the '1' bits are set. + +static void set_field (unsigned char *hdr, int bit_num, int lsb_index, int width, int value) +{ + while (width > 0 && value != 0) { + assert (lsb_index >= 0 && lsb_index <= 11); + if (value & 1) { + hdr[lsb_index] |= 1 << bit_num; + } + value >>= 1; + lsb_index--; + width--; + } + assert (value == 0); +} + +#define SET_UI(hdr,val) set_field(hdr, 6, 0, 1, val) + +#define SET_PID(hdr,val) set_field(hdr, 6, 4, 4, val) + +#define SET_CONTROL(hdr,val) set_field(hdr, 6, 11, 7, val) + + +#define SET_FEC_LEVEL(hdr,val) set_field(hdr, 7, 0, 1, val) + +#define SET_HDR_TYPE(hdr,val) set_field(hdr, 7, 1, 1, val) + +#define SET_PAYLOAD_BYTE_COUNT(hdr,val) set_field(hdr, 7, 11, 10, val) + + +// Extracting the fields. + +static int get_field (unsigned char *hdr, int bit_num, int lsb_index, int width) +{ + int result = 0; + lsb_index -= width - 1; + while (width > 0) { + result <<= 1; + assert (lsb_index >= 0 && lsb_index <= 11); + if (hdr[lsb_index] & (1 << bit_num)) { + result |= 1; + } + lsb_index++; + width--; + } + return (result); +} + +#define GET_UI(hdr) get_field(hdr, 6, 0, 1) + +#define GET_PID(hdr) get_field(hdr, 6, 4, 4) + +#define GET_CONTROL(hdr) get_field(hdr, 6, 11, 7) + + +#define GET_FEC_LEVEL(hdr) get_field(hdr, 7, 0, 1) + +#define GET_HDR_TYPE(hdr) get_field(hdr, 7, 1, 1) + +#define GET_PAYLOAD_BYTE_COUNT(hdr) get_field(hdr, 7, 11, 10) + + + +// AX.25 'I' and 'UI' frames have a protocol ID which determines how the +// information part should be interpreted. +// Here we squeeze the most common cases down to 4 bits. +// Return -1 if translation is not possible. Fall back to type 0 header in this case. + +static int encode_pid (packet_t pp) +{ + int pid = ax25_get_pid(pp); + + if ((pid & 0x30) == 0x20) return (0x2); // AX.25 Layer 3 + if ((pid & 0x30) == 0x10) return (0x2); // AX.25 Layer 3 + if (pid == 0x01) return (0x3); // ISO 8208 / CCIT X.25 PLP + if (pid == 0x06) return (0x4); // Compressed TCP/IP + if (pid == 0x07) return (0x5); // Uncompressed TCP/IP + if (pid == 0x08) return (0x6); // Segmentation fragmen + if (pid == 0xcc) return (0xb); // ARPA Internet Protocol + if (pid == 0xcd) return (0xc); // ARPA Address Resolution + if (pid == 0xce) return (0xd); // FlexNet + if (pid == 0xcf) return (0xe); // TheNET + if (pid == 0xf0) return (0xf); // No L3 + return (-1); +} + +// Convert IL2P 4 bit PID to AX.25 8 bit PID. + + +static int decode_pid (int pid) +{ + static const unsigned char axpid[16] = { + 0xf0, // Should not happen. 0 is for 'S' frames. + 0xf0, // Should not happen. 1 is for 'U' frames (but not UI). + 0x20, // AX.25 Layer 3 + 0x01, // ISO 8208 / CCIT X.25 PLP + 0x06, // Compressed TCP/IP + 0x07, // Uncompressed TCP/IP + 0x08, // Segmentation fragment + 0xf0, // Future + 0xf0, // Future + 0xf0, // Future + 0xf0, // Future + 0xcc, // ARPA Internet Protocol + 0xcd, // ARPA Address Resolution + 0xce, // FlexNet + 0xcf, // TheNET + 0xf0 }; // No L3 + + assert (pid >= 0 && pid <= 15); + return (axpid[pid]); +} + + + +/*-------------------------------------------------------------------------------- + * + * Function: il2p_type_1_header + * + * Purpose: Attempt to create type 1 header from packet object. + * + * Inputs: pp - Packet object. + * + * max_fec - 1 to use maximum FEC symbols , 0 for automatic. + * + * Outputs: hdr - IL2P header with no scrambling or parity symbols. + * Must be large enough to hold IL2P_HEADER_SIZE unsigned bytes. + * + * Returns: Number of bytes for information part or -1 for failure. + * In case of failure, fall back to type 0 transparent encapsulation. + * + * Description: Type 1 Headers do not support AX.25 repeater callsign addressing, + * Modulo-128 extended mode window sequence numbers, nor any callsign + * characters that cannot translate to DEC SIXBIT. + * If these cases are encountered during IL2P packet encoding, + * the encoder switches to Type 0 Transparent Encapsulation. + * SABME can't be handled by type 1. + * + *--------------------------------------------------------------------------------*/ + +int il2p_type_1_header (packet_t pp, int max_fec, unsigned char *hdr) +{ + memset (hdr, 0, IL2P_HEADER_SIZE); + + if (ax25_get_num_addr(pp) != 2) { + // Only two addresses are allowed for type 1 header. + return (-1); + } + + // Check does not apply for 'U' frames but put in one place rather than two. + + if (ax25_get_modulo(pp) == 128) return(-1); + +// Destination and source addresses go into low bits 0-5 for bytes 0-11. + + char dst_addr[AX25_MAX_ADDR_LEN]; + char src_addr[AX25_MAX_ADDR_LEN]; + + ax25_get_addr_no_ssid (pp, AX25_DESTINATION, dst_addr); + int dst_ssid = ax25_get_ssid (pp, AX25_DESTINATION); + + ax25_get_addr_no_ssid (pp, AX25_SOURCE, src_addr); + int src_ssid = ax25_get_ssid (pp, AX25_SOURCE); + + unsigned char *a = (unsigned char *)dst_addr; + for (int i = 0; *a != '\0'; i++, a++) { + if (*a < ' ' || *a > '_') { + // Shouldn't happen but follow the rule. + return (-1); + } + hdr[i] = ascii_to_sixbit(*a); + } + + a = (unsigned char *)src_addr; + for (int i = 6; *a != '\0'; i++, a++) { + if (*a < ' ' || *a > '_') { + // Shouldn't happen but follow the rule. + return (-1); + } + hdr[i] = ascii_to_sixbit(*a); + } + + // Byte 12 has DEST SSID in upper nybble and SRC SSID in lower nybble and + hdr[12] = (dst_ssid << 4) | src_ssid; + + ax25_frame_type_t frame_type; + cmdres_t cr; // command or response. + char description[64]; + int pf; // Poll/Final. + int nr, ns; // Sequence numbers. + + frame_type = ax25_frame_type (pp, &cr, description, &pf, &nr, &ns); + + //dw_printf ("%s(): %s-%d>%s-%d: %s\n", __func__, src_addr, src_ssid, dst_addr, dst_ssid, description); + + switch (frame_type) { + + case frame_type_S_RR: // Receive Ready - System Ready To Receive + case frame_type_S_RNR: // Receive Not Ready - TNC Buffer Full + case frame_type_S_REJ: // Reject Frame - Out of Sequence or Duplicate + case frame_type_S_SREJ: // Selective Reject - Request single frame repeat + + // S frames (RR, RNR, REJ, SREJ), mod 8, have control N(R) P/F S S 0 1 + // These are mapped into P/F N(R) C S S + // Bit 6 is not mentioned in documentation but it is used for P/F for the other frame types. + // C is copied from the C bit in the destination addr. + // C from source is not used here. Reception assumes it is the opposite. + // PID is set to 0, meaning none, for S frames. + + SET_UI(hdr, 0); + SET_PID(hdr, 0); + SET_CONTROL(hdr, (pf<<6) | (nr<<3) | (((cr == cr_cmd) | (cr == cr_11))<<2)); + + // This gets OR'ed into the above. + switch (frame_type) { + case frame_type_S_RR: SET_CONTROL(hdr, 0); break; + case frame_type_S_RNR: SET_CONTROL(hdr, 1); break; + case frame_type_S_REJ: SET_CONTROL(hdr, 2); break; + case frame_type_S_SREJ: SET_CONTROL(hdr, 3); break; + default: break; + } + + break; + + case frame_type_U_SABM: // Set Async Balanced Mode + case frame_type_U_DISC: // Disconnect + case frame_type_U_DM: // Disconnect Mode + case frame_type_U_UA: // Unnumbered Acknowledge + case frame_type_U_FRMR: // Frame Reject + case frame_type_U_UI: // Unnumbered Information + case frame_type_U_XID: // Exchange Identification + case frame_type_U_TEST: // Test + + // The encoding allows only 3 bits for frame type and SABME got left out. + // Control format: P/F opcode[3] C n/a n/a + // The grayed out n/a bits are observed as 00 in the example. + // The header UI field must also be set for UI frames. + // PID is set to 1 for all U frames other than UI. + + if (frame_type == frame_type_U_UI) { + SET_UI(hdr, 1); // I guess this is how we distinguish 'I' and 'UI' + // on the receiving end. + int pid = encode_pid(pp); + if (pid < 0) return (-1); + SET_PID(hdr, pid); + } + else { + SET_PID(hdr, 1); // 1 for 'U' other than 'UI'. + } + + // Each of the destination and source addresses has a "C" bit. + // They should normally have the opposite setting. + // IL2P has only a single bit to represent 4 possbilities. + // + // dst src il2p meaning + // --- --- ---- ------- + // 0 0 0 Not valid (earlier protocol version) + // 1 0 1 Command (v2) + // 0 1 0 Response (v2) + // 1 1 1 Not valid (earlier protocol version) + // + // APRS does not mention how to set these bits and all 4 combinations + // are seen in the wild. Apparently these are ignored on receive and no + // one cares. Here we copy from the C bit in the destination address. + // It should be noted that the case of both C bits being the same can't + // be represented so the il2p encode/decode bit not produce exactly the + // same bits. We see this in the second example in the protocol spec. + // The original UI frame has both C bits of 0 so it is received as a response. + + SET_CONTROL(hdr, (pf<<6) | (((cr == cr_cmd) | (cr == cr_11))<<2)); + + // This gets OR'ed into the above. + switch (frame_type) { + case frame_type_U_SABM: SET_CONTROL(hdr, 0<<3); break; + case frame_type_U_DISC: SET_CONTROL(hdr, 1<<3); break; + case frame_type_U_DM: SET_CONTROL(hdr, 2<<3); break; + case frame_type_U_UA: SET_CONTROL(hdr, 3<<3); break; + case frame_type_U_FRMR: SET_CONTROL(hdr, 4<<3); break; + case frame_type_U_UI: SET_CONTROL(hdr, 5<<3); break; + case frame_type_U_XID: SET_CONTROL(hdr, 6<<3); break; + case frame_type_U_TEST: SET_CONTROL(hdr, 7<<3); break; + default: break; + } + break; + + case frame_type_I: // Information + + // I frames (mod 8 only) + // encoded control: P/F N(R) N(S) + + SET_UI(hdr, 0); + + int pid2 = encode_pid(pp); + if (pid2 < 0) return (-1); + SET_PID(hdr, pid2); + + SET_CONTROL(hdr, (pf<<6) | (nr<<3) | ns); + break; + + case frame_type_U_SABME: // Set Async Balanced Mode, Extended + case frame_type_U: // other Unnumbered, not used by AX.25. + case frame_not_AX25: // Could not get control byte from frame. + default: + + // Fall back to the header type 0 for these. + return (-1); + } + +// Common for all header type 1. + + // Bit 7 has [FEC Level:1], [HDR Type:1], [Payload byte Count:10] + + SET_FEC_LEVEL(hdr, max_fec); + SET_HDR_TYPE(hdr, 1); + + unsigned char *pinfo; + int info_len; + + info_len = ax25_get_info (pp, &pinfo); + if (info_len < 0 || info_len > IL2P_MAX_PAYLOAD_SIZE) { + return (-2); + } + + SET_PAYLOAD_BYTE_COUNT(hdr, info_len); + return (info_len); +} + + +// This should create a packet from the IL2P header. +// The information part will not be filled in. + +static void trim (char *stuff) +{ + char *p = stuff + strlen(stuff) - 1; + while (strlen(stuff) > 0 && (*p == ' ')) { + *p = '\0'; + p--; + } +} + + + +/*-------------------------------------------------------------------------------- + * + * Function: il2p_decode_header_type_1 + * + * Purpose: Attempt to convert type 1 header to a packet object. + * + * Inputs: hdr - IL2P header with no scrambling or parity symbols. + * + * num_sym_changed - Number of symbols changed by FEC in the header. + * Should be 0 or 1. + * + * Returns: Packet Object or NULL for failure. + * + * Description: A later step will process the payload for the information part. + * + *--------------------------------------------------------------------------------*/ + +packet_t il2p_decode_header_type_1 (unsigned char *hdr, int num_sym_changed) +{ + + if (GET_HDR_TYPE(hdr) != 1 ) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("IL2P Internal error. Should not be here: %s, when header type is 0.\n", __func__); + return (NULL); + } + +// First get the addresses including SSID. + + char addrs[AX25_MAX_ADDRS][AX25_MAX_ADDR_LEN]; + int num_addr = 2; + memset (addrs, 0, 2*AX25_MAX_ADDR_LEN); + +// The IL2P header uses 2 parity symbols which means a single corrupted symbol (byte) +// can always be corrected. +// However, I have seen cases, where the error rate is very high, where the RS decoder +// thinks it found a valid code block by changing one symbol but it was the wrong one. +// The result is trash. This shows up as address fields like 'R&G4"A' and 'TEW\ !'. +// I added a sanity check here to catch characters other than upper case letters and digits. +// The frame should be rejected in this case. The question is whether to discard it +// silently or print a message so the user can see that something strange is happening? +// My current thinking is that it should be silently ignored if the header has been +// modified (correctee or more likely, made worse in this cases). +// If no changes were made, something weird is happening. We should mention it for +// troubleshooting rather than sweeping it under the rug. + +// The same thing has been observed with the payload, under very high error conditions, +// and max_fec==0. Here I don't see a good solution. AX.25 information can contain +// "binary" data so I'm not sure what sort of sanity check could be added. +// This was not observed with max_fec==1. If we make that the default, same as Nino TNC, +// it would be extremely extremely unlikely unless someone explicitly selects weaker FEC. + +// TODO: We could do something similar for header type 0. +// The address fields should be all binary zero values. +// Someone overly ambitious might check the addresses found in the first payload block. + + for (int i = 0; i <= 5; i++) { + addrs[AX25_DESTINATION][i] = sixbit_to_ascii(hdr[i] & 0x3f); + } + trim (addrs[AX25_DESTINATION]); + for (int i = 0; i < strlen(addrs[AX25_DESTINATION]); i++) { + if (! isupper(addrs[AX25_DESTINATION][i]) && ! isdigit(addrs[AX25_DESTINATION][i])) { + if (num_sym_changed == 0) { + // This can pop up sporadically when receiving random noise. + // Would be better to show only when debug is enabled but variable not available here. + // TODO: For now we will just suppress it. + //text_color_set(DW_COLOR_ERROR); + //dw_printf ("IL2P: Invalid character '%c' in destination address '%s'\n", addrs[AX25_DESTINATION][i], addrs[AX25_DESTINATION]); + } + return (NULL); + } + } + snprintf (addrs[AX25_DESTINATION]+strlen(addrs[AX25_DESTINATION]), 4, "-%d", (hdr[12] >> 4) &0xf); + + for (int i = 0; i <= 5; i++) { + addrs[AX25_SOURCE][i] = sixbit_to_ascii(hdr[i+6] & 0x3f); + } + trim (addrs[AX25_SOURCE]); + for (int i = 0; i < strlen(addrs[AX25_SOURCE]); i++) { + if (! isupper(addrs[AX25_SOURCE][i]) && ! isdigit(addrs[AX25_SOURCE][i])) { + if (num_sym_changed == 0) { + // This can pop up sporadically when receiving random noise. + // Would be better to show only when debug is enabled but variable not available here. + // TODO: For now we will just suppress it. + //text_color_set(DW_COLOR_ERROR); + //dw_printf ("IL2P: Invalid character '%c' in source address '%s'\n", addrs[AX25_SOURCE][i], addrs[AX25_SOURCE]); + } + return (NULL); + } + } + snprintf (addrs[AX25_SOURCE]+strlen(addrs[AX25_SOURCE]), 4, "-%d", hdr[12] &0xf); + +// The PID field gives us the general type. +// 0 = 'S' frame. +// 1 = 'U' frame other than UI. +// others are either 'UI' or 'I' depending on the UI field. + + int pid = GET_PID(hdr); + int ui = GET_UI(hdr); + + if (pid == 0) { + +// 'S' frame. +// The control field contains: P/F N(R) C S S + + int control = GET_CONTROL(hdr); + cmdres_t cr = (control & 0x04) ? cr_cmd : cr_res; + ax25_frame_type_t ftype; + switch (control & 0x03) { + case 0: ftype = frame_type_S_RR; break; + case 1: ftype = frame_type_S_RNR; break; + case 2: ftype = frame_type_S_REJ; break; + default: ftype = frame_type_S_SREJ; break; + } + int modulo = 8; + int nr = (control >> 3) & 0x07; + int pf = (control >> 6) & 0x01; + unsigned char *pinfo = NULL; // Any info for SREJ will be added later. + int info_len = 0; + return (ax25_s_frame (addrs, num_addr, cr, ftype, modulo, nr, pf, pinfo, info_len)); + } + else if (pid == 1) { + +// 'U' frame other than 'UI'. +// The control field contains: P/F OPCODE{3) C x x + + int control = GET_CONTROL(hdr); + cmdres_t cr = (control & 0x04) ? cr_cmd : cr_res; + int axpid = 0; // unused for U other than UI. + ax25_frame_type_t ftype; + switch ((control >> 3) & 0x7) { + case 0: ftype = frame_type_U_SABM; break; + case 1: ftype = frame_type_U_DISC; break; + case 2: ftype = frame_type_U_DM; break; + case 3: ftype = frame_type_U_UA; break; + case 4: ftype = frame_type_U_FRMR; break; + case 5: ftype = frame_type_U_UI; axpid = 0xf0; break; // Should not happen with IL2P pid == 1. + case 6: ftype = frame_type_U_XID; break; + default: ftype = frame_type_U_TEST; break; + } + int pf = (control >> 6) & 0x01; + unsigned char *pinfo = NULL; // Any info for UI, XID, TEST will be added later. + int info_len = 0; + return (ax25_u_frame (addrs, num_addr, cr, ftype, pf, axpid, pinfo, info_len)); + } + else if (ui) { + +// 'UI' frame. +// The control field contains: P/F OPCODE{3) C x x + + int control = GET_CONTROL(hdr); + cmdres_t cr = (control & 0x04) ? cr_cmd : cr_res; + ax25_frame_type_t ftype = frame_type_U_UI; + int pf = (control >> 6) & 0x01; + int axpid = decode_pid(GET_PID(hdr)); + unsigned char *pinfo = NULL; // Any info for UI, XID, TEST will be added later. + int info_len = 0; + return (ax25_u_frame (addrs, num_addr, cr, ftype, pf, axpid, pinfo, info_len)); + } + else { + +// 'I' frame. +// The control field contains: P/F N(R) N(S) + + int control = GET_CONTROL(hdr); + cmdres_t cr = cr_cmd; // Always command. + int pf = (control >> 6) & 0x01; + int nr = (control >> 3) & 0x7; + int ns = control & 0x7; + int modulo = 8; + int axpid = decode_pid(GET_PID(hdr)); + unsigned char *pinfo = NULL; // Any info for UI, XID, TEST will be added later. + int info_len = 0; + return (ax25_i_frame (addrs, num_addr, cr, modulo, nr, ns, pf, axpid, pinfo, info_len)); + } + return (NULL); // unreachable but avoid warning. + +} // end + + +/*-------------------------------------------------------------------------------- + * + * Function: il2p_type_0_header + * + * Purpose: Attempt to create type 0 header from packet object. + * + * Inputs: pp - Packet object. + * + * max_fec - 1 to use maximum FEC symbols, 0 for automatic. + * + * Outputs: hdr - IL2P header with no scrambling or parity symbols. + * Must be large enough to hold IL2P_HEADER_SIZE unsigned bytes. + * + * Returns: Number of bytes for information part or -1 for failure. + * In case of failure, fall back to type 0 transparent encapsulation. + * + * Description: The type 0 header is used when it is not one of the restricted cases + * covered by the type 1 header. + * The AX.25 frame is put in the payload. + * This will cover: more than one address, mod 128 sequences, etc. + * + *--------------------------------------------------------------------------------*/ + +int il2p_type_0_header (packet_t pp, int max_fec, unsigned char *hdr) +{ + memset (hdr, 0, IL2P_HEADER_SIZE); + + // Bit 7 has [FEC Level:1], [HDR Type:1], [Payload byte Count:10] + + SET_FEC_LEVEL(hdr, max_fec); + SET_HDR_TYPE(hdr, 0); + + int frame_len = ax25_get_frame_len (pp); + + if (frame_len < 14 || frame_len > IL2P_MAX_PAYLOAD_SIZE) { + return (-2); + } + + SET_PAYLOAD_BYTE_COUNT(hdr, frame_len); + return (frame_len); +} + + +/*********************************************************************************** + * + * Name: il2p_get_header_attributes + * + * Purpose: Extract a few attributes from an IL2p header. + * + * Inputs: hdr - IL2P header structure. + * + * Outputs: hdr_type - 0 or 1. + * + * max_fec - 0 for automatic or 1 for fixed maximum size. + * + * Returns: Payload byte count. (actual payload size, not the larger encoded format) + * + ***********************************************************************************/ + + +int il2p_get_header_attributes (unsigned char *hdr, int *hdr_type, int *max_fec) +{ + *hdr_type = GET_HDR_TYPE(hdr); + *max_fec = GET_FEC_LEVEL(hdr); + return(GET_PAYLOAD_BYTE_COUNT(hdr)); +} + + +/*********************************************************************************** + * + * Name: il2p_clarify_header + * + * Purpose: Convert received header to usable form. + * This involves RS FEC then descrambling. + * + * Inputs: rec_hdr - Header as received over the radio. + * + * Outputs: corrected_descrambled_hdr - After RS FEC and unscrambling. + * + * Returns: Number of symbols that were corrected: + * 0 = No errors + * 1 = Single symbol corrected. + * <0 = Unable to obtain good header. + * + ***********************************************************************************/ + +int il2p_clarify_header(unsigned char *rec_hdr, unsigned char *corrected_descrambled_hdr) +{ + unsigned char corrected[IL2P_HEADER_SIZE+IL2P_HEADER_PARITY]; + + int e = il2p_decode_rs (rec_hdr, IL2P_HEADER_SIZE, IL2P_HEADER_PARITY, corrected); + + il2p_descramble_block (corrected, corrected_descrambled_hdr, IL2P_HEADER_SIZE); + + return (e); +} + +// end il2p_header.c \ No newline at end of file diff --git a/src/il2p_init.c b/src/il2p_init.c new file mode 100644 index 00000000..533a2213 --- /dev/null +++ b/src/il2p_init.c @@ -0,0 +1,226 @@ +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// +// Copyright (C) 2021 John Langner, WB2OSZ +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . +// + +#include "direwolf.h" + +#include +#include +#include +#include + +#include "textcolor.h" +#include "fx25.h" // For Reed Solomon stuff. +#include "il2p.h" + +// Interesting related stuff: +// https://www.kernel.org/doc/html/v4.15/core-api/librs.html +// https://berthub.eu/articles/posts/reed-solomon-for-programmers/ + + +#define MAX_NROOTS 16 + +#define NTAB 5 + +static struct { + int symsize; // Symbol size, bits (1-8). Always 8 for this application. + int genpoly; // Field generator polynomial coefficients. + int fcs; // First root of RS code generator polynomial, index form. + // FX.25 uses 1 but IL2P uses 0. + int prim; // Primitive element to generate polynomial roots. + int nroots; // RS code generator polynomial degree (number of roots). + // Same as number of check bytes added. + struct rs *rs; // Pointer to RS codec control block. Filled in at init time. +} Tab[NTAB] = { + {8, 0x11d, 0, 1, 2, NULL }, // 2 parity + {8, 0x11d, 0, 1, 4, NULL }, // 4 parity + {8, 0x11d, 0, 1, 6, NULL }, // 6 parity + {8, 0x11d, 0, 1, 8, NULL }, // 8 parity + {8, 0x11d, 0, 1, 16, NULL }, // 16 parity +}; + + + +static int g_il2p_debug = 0; + + +/*------------------------------------------------------------- + * + * Name: il2p_init + * + * Purpose: This must be called at application start up time. + * It sets up tables for the Reed-Solomon functions. + * + * Inputs: debug - Enable debug output. + * + *--------------------------------------------------------------*/ + +void il2p_init (int il2p_debug) +{ + g_il2p_debug = il2p_debug; + + for (int i = 0 ; i < NTAB ; i++) { + assert (Tab[i].nroots <= MAX_NROOTS); + Tab[i].rs = INIT_RS(Tab[i].symsize, Tab[i].genpoly, Tab[i].fcs, Tab[i].prim, Tab[i].nroots); + if (Tab[i].rs == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf("IL2P internal error: init_rs_char failed!\n"); + exit(EXIT_FAILURE); + } + } + +} // end il2p_init + + +int il2p_get_debug(void) +{ + return (g_il2p_debug); +} +void il2p_set_debug(int debug) +{ + g_il2p_debug = debug; +} + + +// Find RS codec control block for specified number of parity symbols. + +struct rs *il2p_find_rs(int nparity) +{ + for (int n = 0; n < NTAB; n++) { + if (Tab[n].nroots == nparity) { + return (Tab[n].rs); + } + } + text_color_set(DW_COLOR_ERROR); + dw_printf ("IL2P INTERNAL ERROR: il2p_find_rs: control block not found for nparity = %d.\n", nparity); + return (Tab[0].rs); +} + + +/*------------------------------------------------------------- + * + * Name: void il2p_encode_rs + * + * Purpose: Add parity symbols to a block of data. + * + * Inputs: tx_data Header or other data to transmit. + * data_size Number of data bytes in above. + * num_parity Number of parity symbols to add. + * Maximum of IL2P_MAX_PARITY_SYMBOLS. + * + * Outputs: parity_out Specified number of parity symbols + * + * Restriction: data_size + num_parity <= 255 which is the RS block size. + * The caller must ensure this. + * + *--------------------------------------------------------------*/ + +void il2p_encode_rs (unsigned char *tx_data, int data_size, int num_parity, unsigned char *parity_out) +{ + assert (data_size >= 1); + assert (num_parity == 2 || num_parity == 4 || num_parity == 6 || num_parity == 8 || num_parity == 16); + assert (data_size + num_parity <= 255); + + unsigned char rs_block[FX25_BLOCK_SIZE]; + memset (rs_block, 0, sizeof(rs_block)); + memcpy (rs_block + sizeof(rs_block) - data_size - num_parity, tx_data, data_size); + ENCODE_RS (il2p_find_rs(num_parity), rs_block, parity_out); +} + +/*------------------------------------------------------------- + * + * Name: void il2p_decode_rs + * + * Purpose: Check and attempt to fix block with FEC. + * + * Inputs: rec_block Received block composed of data and parity. + * Total size is sum of following two parameters. + * data_size Number of data bytes in above. + * num_parity Number of parity symbols (bytes) in above. + * + * Outputs: out Original with possible corrections applied. + * data_size bytes. + * + * Returns: -1 for unrecoverable. + * >= 0 for success. Number of symbols corrected. + * + *--------------------------------------------------------------*/ + +int il2p_decode_rs (unsigned char *rec_block, int data_size, int num_parity, unsigned char *out) +{ + + // Use zero padding in front if data size is too small. + + int n = data_size + num_parity; // total size in. + + unsigned char rs_block[FX25_BLOCK_SIZE]; + + // We could probably do this more efficiently by skipping the + // processing of the bytes known to be zero. Good enough for now. + + memset (rs_block, 0, sizeof(rs_block) - n); + memcpy (rs_block + sizeof(rs_block) - n, rec_block, n); + + if (il2p_get_debug() >= 3) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("============================== il2p_decode_rs ==============================\n"); + dw_printf ("%d filler zeros, %d data, %d parity\n", (int)(sizeof(rs_block) - n), data_size, num_parity); + fx_hex_dump (rs_block, sizeof (rs_block)); + } + + int derrlocs[FX25_MAX_CHECK]; // Half would probably be OK. + + int derrors = DECODE_RS(il2p_find_rs(num_parity), rs_block, derrlocs, 0); + memcpy (out, rs_block + sizeof(rs_block) - n, data_size); + + if (il2p_get_debug() >= 3) { + if (derrors == 0) { + dw_printf ("No errors reported for RS block.\n"); + } + else if (derrors > 0) { + dw_printf ("%d errors fixed in positions:\n", derrors); + for (int j = 0; j < derrors; j++) { + dw_printf (" %3d (0x%02x)\n", derrlocs[j] , derrlocs[j]); + } + fx_hex_dump (rs_block, sizeof (rs_block)); + } + } + + // It is possible to have a situation where too many errors are + // present but the algorithm could get a good code block by "fixing" + // one of the padding bytes that should be 0. + + for (int i = 0; i < derrors; i++) { + if (derrlocs[i] < sizeof(rs_block) - n) { + if (il2p_get_debug() >= 3) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("RS DECODE ERROR! Padding position %d should be 0 but it was set to %02x.\n", derrlocs[i], rs_block[derrlocs[i]]); + } + derrors = -1; + break; + } + } + + if (il2p_get_debug() >= 3) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("============================== il2p_decode_rs returns %d ==============================\n", derrors); + } + return (derrors); +} + +// end il2p_init.c \ No newline at end of file diff --git a/src/il2p_payload.c b/src/il2p_payload.c new file mode 100644 index 00000000..d5fb4887 --- /dev/null +++ b/src/il2p_payload.c @@ -0,0 +1,298 @@ +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// +// Copyright (C) 2021 John Langner, WB2OSZ +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . +// + +#include "direwolf.h" + +#include +#include +#include +#include + +#include "textcolor.h" +#include "il2p.h" + + +/*-------------------------------------------------------------------------------- + * + * File: il2p_payload.c + * + * Purpose: Functions dealing with the payload. + * + *--------------------------------------------------------------------------------*/ + + +/*-------------------------------------------------------------------------------- + * + * Function: il2p_payload_compute + * + * Purpose: Compute number and sizes of data blocks based on total size. + * + * Inputs: payload_size 0 to 1023. (IL2P_MAX_PAYLOAD_SIZE) + * max_fec true for 16 parity symbols, false for automatic. + * + * Outputs: *p Payload block sizes and counts. + * Number of parity symbols per block. + * + * Returns: Number of bytes in the encoded format. + * Could be 0 for no payload blocks. + * -1 for error (i.e. invalid unencoded size: <0 or >1023) + * + *--------------------------------------------------------------------------------*/ + +int il2p_payload_compute (il2p_payload_properties_t *p, int payload_size, int max_fec) +{ + memset (p, 0, sizeof(il2p_payload_properties_t)); + + if (payload_size < 0 || payload_size > IL2P_MAX_PAYLOAD_SIZE) { + return (-1); + } + if (payload_size == 0) { + return (0); + } + + if (max_fec) { + p->payload_byte_count = payload_size; + p->payload_block_count = (p->payload_byte_count + 238) / 239; + p->small_block_size = p->payload_byte_count / p->payload_block_count; + p->large_block_size = p->small_block_size + 1; + p->large_block_count = p->payload_byte_count - (p->payload_block_count * p->small_block_size); + p->small_block_count = p->payload_block_count - p->large_block_count; + p->parity_symbols_per_block = 16; + } + else { + p->payload_byte_count = payload_size; + p->payload_block_count = (p->payload_byte_count + 246) / 247; + p->small_block_size = p->payload_byte_count / p->payload_block_count; + p->large_block_size = p->small_block_size + 1; + p->large_block_count = p->payload_byte_count - (p->payload_block_count * p->small_block_size); + p->small_block_count = p->payload_block_count - p->large_block_count; + //p->parity_symbols_per_block = (p->small_block_size / 32) + 2; // Looks like error in documentation + + // It would work if the number of parity symbols was based on large block size. + + if (p->small_block_size <= 61) p->parity_symbols_per_block = 2; + else if (p->small_block_size <= 123) p->parity_symbols_per_block = 4; + else if (p->small_block_size <= 185) p->parity_symbols_per_block = 6; + else if (p->small_block_size <= 247) p->parity_symbols_per_block = 8; + else { + // Should not happen. But just in case... + text_color_set(DW_COLOR_ERROR); + dw_printf ("IL2P parity symbol per payload block error. small_block_size = %d\n", p->small_block_size); + return (-1); + } + } + + // Return the total size for the encoded format. + + return (p->small_block_count * (p->small_block_size + p->parity_symbols_per_block) + + p->large_block_count * (p->large_block_size + p->parity_symbols_per_block)); + +} // end il2p_payload_compute + + + +/*-------------------------------------------------------------------------------- + * + * Function: il2p_encode_payload + * + * Purpose: Split payload into multiple blocks such that each set + * of data and parity symbols fit into a 255 byte RS block. + * + * Inputs: *payload Array of bytes. + * payload_size 0 to 1023. (IL2P_MAX_PAYLOAD_SIZE) + * max_fec true for 16 parity symbols, false for automatic. + * + * Outputs: *enc Encoded payload for transmission. + * Up to IL2P_MAX_ENCODED_SIZE bytes. + * + * Returns: -1 for error (i.e. invalid size) + * 0 for no blocks. (i.e. size zero) + * Number of bytes generated. Maximum IL2P_MAX_ENCODED_SIZE. + * + * Note: I interpreted the protocol spec as saying the LFSR state is retained + * between data blocks. During interoperability testing, I found that + * was not the case. It is reset for each data block. + * + *--------------------------------------------------------------------------------*/ + + +int il2p_encode_payload (unsigned char *payload, int payload_size, int max_fec, unsigned char *enc) +{ + if (payload_size > IL2P_MAX_PAYLOAD_SIZE) return (-1); + if (payload_size == 0) return (0); + +// Determine number of blocks and sizes. + + il2p_payload_properties_t ipp; + int e; + e = il2p_payload_compute (&ipp, payload_size, max_fec); + if (e <= 0) { + return (e); + } + + unsigned char *pin = payload; + unsigned char *pout = enc; + int encoded_length = 0; + unsigned char scram[256]; + unsigned char parity[IL2P_MAX_PARITY_SYMBOLS]; + +// First the large blocks. + + for (int b = 0; b < ipp.large_block_count; b++) { + + il2p_scramble_block (pin, scram, ipp.large_block_size); + memcpy (pout, scram, ipp.large_block_size); + pin += ipp.large_block_size; + pout += ipp.large_block_size; + encoded_length += ipp.large_block_size; + il2p_encode_rs (scram, ipp.large_block_size, ipp.parity_symbols_per_block, parity); + memcpy (pout, parity, ipp.parity_symbols_per_block); + pout += ipp.parity_symbols_per_block; + encoded_length += ipp.parity_symbols_per_block; + } + +// Then the small blocks. + + for (int b = 0; b < ipp.small_block_count; b++) { + + il2p_scramble_block (pin, scram, ipp.small_block_size); + memcpy (pout, scram, ipp.small_block_size); + pin += ipp.small_block_size; + pout += ipp.small_block_size; + encoded_length += ipp.small_block_size; + il2p_encode_rs (scram, ipp.small_block_size, ipp.parity_symbols_per_block, parity); + memcpy (pout, parity, ipp.parity_symbols_per_block); + pout += ipp.parity_symbols_per_block; + encoded_length += ipp.parity_symbols_per_block; + } + + return (encoded_length); + +} // end il2p_encode_payload + + +/*-------------------------------------------------------------------------------- + * + * Function: il2p_decode_payload + * + * Purpose: Extract original data from encoded payload. + * + * Inputs: received Array of bytes. Size is unknown but in practice it + * must not exceed IL2P_MAX_ENCODED_SIZE. + * payload_size 0 to 1023. (IL2P_MAX_PAYLOAD_SIZE) + * Expected result size based on header. + * max_fec true for 16 parity symbols, false for automatic. + * + * Outputs: payload_out Recovered payload. + * + * In/Out: symbols_corrected Number of symbols corrected. + * + * + * Returns: Number of bytes extracted. Should be same as payload_size going in. + * -3 for unexpected internal inconsistency. + * -2 for unable to recover from signal corruption. + * -1 for invalid size. + * 0 for no blocks. (i.e. size zero) + * + * Description: Each block is scrambled separately but the LSFR state is carried + * from the first payload block to the next. + * + *--------------------------------------------------------------------------------*/ + +int il2p_decode_payload (unsigned char *received, int payload_size, int max_fec, unsigned char *payload_out, int *symbols_corrected) +{ +// Determine number of blocks and sizes. + + il2p_payload_properties_t ipp; + int e; + e = il2p_payload_compute (&ipp, payload_size, max_fec); + if (e <= 0) { + return (e); + } + + unsigned char *pin = received; + unsigned char *pout = payload_out; + int decoded_length = 0; + int failed = 0; + +// First the large blocks. + + for (int b = 0; b < ipp.large_block_count; b++) { + unsigned char corrected_block[255]; + int e = il2p_decode_rs (pin, ipp.large_block_size, ipp.parity_symbols_per_block, corrected_block); + + // dw_printf ("%s:%d: large block decode_rs returned status = %d\n", __FILE__, __LINE__, e); + + if (e < 0) failed = 1; + *symbols_corrected += e; + + il2p_descramble_block (corrected_block, pout, ipp.large_block_size); + + if (il2p_get_debug() >= 2) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("Descrambled large payload block, %d bytes:\n", ipp.large_block_size); + fx_hex_dump(pout, ipp.large_block_size); + } + + pin += ipp.large_block_size + ipp.parity_symbols_per_block; + pout += ipp.large_block_size; + decoded_length += ipp.large_block_size; + } + +// Then the small blocks. + + for (int b = 0; b < ipp.small_block_count; b++) { + unsigned char corrected_block[255]; + int e = il2p_decode_rs (pin, ipp.small_block_size, ipp.parity_symbols_per_block, corrected_block); + + // dw_printf ("%s:%d: small block decode_rs returned status = %d\n", __FILE__, __LINE__, e); + + if (e < 0) failed = 1; + *symbols_corrected += e; + + il2p_descramble_block (corrected_block, pout, ipp.small_block_size); + + if (il2p_get_debug() >= 2) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("Descrambled small payload block, %d bytes:\n", ipp.small_block_size); + fx_hex_dump(pout, ipp.small_block_size); + } + + pin += ipp.small_block_size + ipp.parity_symbols_per_block; + pout += ipp.small_block_size; + decoded_length += ipp.small_block_size; + } + + if (failed) { + //dw_printf ("%s:%d: failed = %0x\n", __FILE__, __LINE__, failed); + return (-2); + } + + if (decoded_length != payload_size) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("IL2P Internal error: decoded_length = %d, payload_size = %d\n", decoded_length, payload_size); + return (-3); + } + + return (decoded_length); + +} // end il2p_decode_payload + +// end il2p_payload.c + diff --git a/src/il2p_rec.c b/src/il2p_rec.c new file mode 100644 index 00000000..5ad457a0 --- /dev/null +++ b/src/il2p_rec.c @@ -0,0 +1,276 @@ +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// +// Copyright (C) 2021 John Langner, WB2OSZ +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . +// + + +/******************************************************************************** + * + * File: il2p_rec.c + * + * Purpose: Extract IL2P frames from a stream of bits and process them. + * + * References: http://tarpn.net/t/il2p/il2p-specification0-4.pdf + * + *******************************************************************************/ + +#include "direwolf.h" + +#include +#include +#include +#include + +#include "textcolor.h" +#include "il2p.h" +#include "multi_modem.h" +#include "demod.h" + + +struct il2p_context_s { + + enum { IL2P_SEARCHING=0, IL2P_HEADER, IL2P_PAYLOAD, IL2P_DECODE } state; + + unsigned int acc; // Accumulate most recent 24 bits for sync word matching. + // Lower 8 bits are also used for accumulating bytes for + // the header and payload. + + int bc; // Bit counter so we know when a complete byte has been accumulated. + + int polarity; // 1 if opposite of expected polarity. + + unsigned char shdr[IL2P_HEADER_SIZE+IL2P_HEADER_PARITY]; + // Scrambled header as received over the radio. Includes parity. + int hc; // Number if bytes placed in above. + + unsigned char uhdr[IL2P_HEADER_SIZE]; // Header after FEC and unscrambling. + + int eplen; // Encoded payload length. This is not the nuumber from + // from the header but rather the number of encoded bytes to gather. + + unsigned char spayload[IL2P_MAX_ENCODED_PAYLOAD_SIZE]; + // Scrambled and encoded payload as received over the radio. + int pc; // Number of bytes placed in above. + + int corrected; // Number of symbols corrected by RS FEC. +}; + +static struct il2p_context_s *il2p_context[MAX_CHANS][MAX_SUBCHANS][MAX_SLICERS]; + + + +/*********************************************************************************** + * + * Name: il2p_rec_bit + * + * Purpose: Extract FX.25 packets from a stream of bits. + * + * Inputs: chan - Channel number. + * + * subchan - This allows multiple demodulators per channel. + * + * slice - Allows multiple slicers per demodulator (subchannel). + * + * dbit - One bit from the received data stream. + * + * Description: This is called once for each received bit. + * For each valid packet, process_rec_frame() is called for further processing. + * It can gather multiple candidates from different parallel demodulators + * ("subchannels") and slicers, then decide which one is the best. + * + ***********************************************************************************/ + +void il2p_rec_bit (int chan, int subchan, int slice, int dbit) +{ + +// Allocate context blocks only as needed. + + struct il2p_context_s *F = il2p_context[chan][subchan][slice]; + if (F == NULL) { + assert (chan >= 0 && chan < MAX_CHANS); + assert (subchan >= 0 && subchan < MAX_SUBCHANS); + assert (slice >= 0 && slice < MAX_SLICERS); + F = il2p_context[chan][subchan][slice] = (struct il2p_context_s *)malloc(sizeof (struct il2p_context_s)); + assert (F != NULL); + memset (F, 0, sizeof(struct il2p_context_s)); + } + +// Accumulate most recent 24 bits received. Most recent is LSB. + + F->acc = ((F->acc << 1) | (dbit & 1)) & 0x00ffffff; + +// State machine to look for sync word then gather appropriate number of header and payload bytes. + + switch (F->state) { + + case IL2P_SEARCHING: // Searching for the sync word. + + if (__builtin_popcount (F->acc ^ IL2P_SYNC_WORD) <= 1) { // allow single bit mismatch + //text_color_set (DW_COLOR_INFO); + //dw_printf ("IL2P header has normal polarity\n"); + F->polarity = 0; + F->state = IL2P_HEADER; + F->bc = 0; + F->hc = 0; + } + else if (__builtin_popcount ((~F->acc & 0x00ffffff) ^ IL2P_SYNC_WORD) <= 1) { + text_color_set (DW_COLOR_INFO); + // FIXME - this pops up occasionally with random noise. Find better way to convey information. + // This also happens for each slicer - to noisy. + //dw_printf ("IL2P header has reverse polarity\n"); + F->polarity = 1; + F->state = IL2P_HEADER; + F->bc = 0; + F->hc = 0; + } + break; + + case IL2P_HEADER: // Gathering the header. + + F->bc++; + if (F->bc == 8) { // full byte has been collected. + F->bc = 0; + if ( ! F->polarity) { + F->shdr[F->hc++] = F->acc & 0xff; + } + else { + F->shdr[F->hc++] = (~ F->acc) & 0xff; + } + if (F->hc == IL2P_HEADER_SIZE+IL2P_HEADER_PARITY) { // Have all of header + + if (il2p_get_debug() >= 1) { + text_color_set (DW_COLOR_DEBUG); + dw_printf ("IL2P header as received [%d.%d.%d]:\n", chan, subchan, slice); + fx_hex_dump (F->shdr, IL2P_HEADER_SIZE+IL2P_HEADER_PARITY); + } + + // Fix any errors and descramble. + F->corrected = il2p_clarify_header(F->shdr, F->uhdr); + + if (F->corrected >= 0) { // Good header. + // How much payload is expected? + il2p_payload_properties_t plprop; + int hdr_type, max_fec; + int len = il2p_get_header_attributes (F->uhdr, &hdr_type, &max_fec); + + F->eplen = il2p_payload_compute (&plprop, len, max_fec); + + if (il2p_get_debug() >= 1) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("IL2P header after correcting %d symbols and unscrambling [%d.%d.%d]:\n", F->corrected, chan, subchan, slice); + fx_hex_dump (F->uhdr, IL2P_HEADER_SIZE); + dw_printf ("Header type %d, max fec = %d\n", hdr_type, max_fec); + dw_printf ("Need to collect %d encoded bytes for %d byte payload.\n", F->eplen, len); + dw_printf ("%d small blocks of %d and %d large blocks of %d. %d parity symbols per block\n", + plprop.small_block_count, plprop.small_block_size, + plprop.large_block_count, plprop.large_block_size, plprop.parity_symbols_per_block); + } + + if (F->eplen >= 1) { // Need to gather payload. + F->pc = 0; + F->state = IL2P_PAYLOAD; + } + else if (F->eplen == 0) { // No payload. + F->pc = 0; + F->state = IL2P_DECODE; + } + else { // Error. + + if (il2p_get_debug() >= 1) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("IL2P header INVALID.\n"); + } + + F->state = IL2P_SEARCHING; + } + } // good header after FEC. + else { + F->state = IL2P_SEARCHING; // Header failed FEC check. + } + } // entire header has been collected. + } // full byte collected. + break; + + case IL2P_PAYLOAD: // Gathering the payload, if any. + + F->bc++; + if (F->bc == 8) { // full byte has been collected. + F->bc = 0; + if ( ! F->polarity) { + F->spayload[F->pc++] = F->acc & 0xff; + } + else { + F->spayload[F->pc++] = (~ F->acc) & 0xff; + } + if (F->pc == F->eplen) { + + // TODO?: for symmetry it seems like we should clarify the payload before combining. + + F->state = IL2P_DECODE; + } + } + break; + + case IL2P_DECODE: + // We get here after a good header and any payload has been collected. + // Processing is delayed by one bit but I think it makes the logic cleaner. + // During unit testing be sure to send an extra bit to flush it out at the end. + + // in uhdr[IL2P_HEADER_SIZE]; // Header after FEC and descrambling. + + // TODO?: for symmetry, we might decode the payload here and later build the frame. + + { + packet_t pp = il2p_decode_header_payload (F->uhdr, F->spayload, &(F->corrected)); + + if (il2p_get_debug() >= 1) { + if (pp != NULL) { + ax25_hex_dump (pp); + } + else { + // Most likely too many FEC errors. + text_color_set(DW_COLOR_ERROR); + dw_printf ("FAILED to construct frame in %s.\n", __func__); + } + } + + if (pp != NULL) { + alevel_t alevel = demod_get_audio_level (chan, subchan); + retry_t retries = F->corrected; + int is_fx25 = 1; // FIXME: distinguish fx.25 and IL2P. + // Currently this just means that a FEC mode was used. + + // TODO: Could we put last 3 arguments in packet object rather than passing around separately? + + multi_modem_process_rec_packet (chan, subchan, slice, pp, alevel, retries, is_fx25); + } + } // end block for local variables. + + if (il2p_get_debug() >= 1) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("-----\n"); + } + + F->state = IL2P_SEARCHING; + break; + + } // end of switch + +} // end il2p_rec_bit + + +// end il2p_rec.c diff --git a/src/il2p_scramble.c b/src/il2p_scramble.c new file mode 100644 index 00000000..6219cddb --- /dev/null +++ b/src/il2p_scramble.c @@ -0,0 +1,157 @@ +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// +// Copyright (C) 2021 John Langner, WB2OSZ +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . +// + +/*-------------------------------------------------------------------------------- + * + * File: il2p_scramble.c + * + * Purpose: Scramble / descramble data as specified in the IL2P protocol specification. + * + *--------------------------------------------------------------------------------*/ + + +#include "direwolf.h" + +#include +#include +#include +#include + +#include "il2p.h" + + +// Scramble bits for il2p transmit. + +// Note that there is a delay of 5 until the first bit comes out. +// So we need to need to ignore the first 5 out and stick in +// an extra 5 filler bits to flush at the end. + +#define INIT_TX_LSFR 0x00f + +static inline int scramble_bit (int in, int *state) +{ + int out = ((*state >> 4) ^ *state) & 1; + *state = ( (((in ^ *state) & 1) << 9) | (*state ^ ((*state & 1) << 4)) ) >> 1; + return (out); +} + + +// Undo data scrambling for il2p receive. + +#define INIT_RX_LSFR 0x1f0 + +static inline int descramble_bit (int in, int *state) +{ + int out = (in ^ *state) & 1; + *state = ((*state >> 1) | ((in & 1) << 8)) ^ ((in & 1) << 3); + return (out); +} + + +/*-------------------------------------------------------------------------------- + * + * Function: il2p_scramble_block + * + * Purpose: Scramble a block before adding RS parity. + * + * Inputs: in Array of bytes. + * len Number of bytes both in and out. + * + * Outputs: out Array of bytes. + * + *--------------------------------------------------------------------------------*/ + +void il2p_scramble_block (unsigned char *in, unsigned char *out, int len) +{ + int tx_lfsr_state = INIT_TX_LSFR; + + memset (out, 0, len); + + int skipping = 1; // Discard the first 5 out. + int ob = 0; // Index to output byte. + int om = 0x80; // Output bit mask; + for (int ib = 0; ib < len; ib++) { + for (int im = 0x80; im != 0; im >>= 1) { + int s = scramble_bit((in[ib] & im) != 0, &tx_lfsr_state); + if (ib == 0 && im == 0x04) skipping = 0; + if ( ! skipping) { + if (s) { + out[ob] |= om; + } + om >>= 1; + if (om == 0) { + om = 0x80; + ob++; + } + } + } + } + // Flush it. + + // This is a relic from when I thought the state would need to + // be passed along for the next block. + // Preserve the LSFR state from before flushing. + // This might be needed as the initial state for later payload blocks. + int x = tx_lfsr_state; + for (int n = 0; n < 5; n++) { + int s = scramble_bit(0, &x); + if (s) { + out[ob] |= om; + } + om >>=1; + if (om == 0) { + om = 0x80; + ob++; + } + } + +} // end il2p_scramble_block + + + +/*-------------------------------------------------------------------------------- + * + * Function: il2p_descramble_block + * + * Purpose: Descramble a block after removing RS parity. + * + * Inputs: in Array of bytes. + * len Number of bytes both in and out. + * + * Outputs: out Array of bytes. + * + *--------------------------------------------------------------------------------*/ + +void il2p_descramble_block (unsigned char *in, unsigned char *out, int len) +{ + int rx_lfsr_state = INIT_RX_LSFR; + + memset (out, 0, len); + + for (int b = 0; b < len; b++) { + for (int m = 0x80; m != 0; m >>= 1) { + int d = descramble_bit((in[b] & m) != 0, &rx_lfsr_state); + if (d) { + out[b] |= m; + } + } + } +} + +// end il2p_scramble.c diff --git a/src/il2p_send.c b/src/il2p_send.c new file mode 100644 index 00000000..3c4554e0 --- /dev/null +++ b/src/il2p_send.c @@ -0,0 +1,147 @@ +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// +// Copyright (C) 2021 John Langner, WB2OSZ +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . +// + +#include "direwolf.h" + +#include +#include +#include +#include + +#include "il2p.h" +#include "textcolor.h" +#include "audio.h" +#include "gen_tone.h" + + +static int number_of_bits_sent[MAX_CHANS]; // Count number of bits sent by "il2p_send_frame" + +static void send_bytes (int chan, unsigned char *b, int count, int polarity); +static void send_bit (int chan, int b, int polarity); + + + +/*------------------------------------------------------------- + * + * Name: il2p_send_frame + * + * Purpose: Convert frames to a stream of bits in IL2P format. + * + * Inputs: chan - Audio channel number, 0 = first. + * + * pp - Pointer to packet object. + * + * max_fec - 1 to force 16 parity symbols for each payload block. + * 0 for automatic depending on block size. + * + * polarity - 0 for normal. 1 to invert signal. + * 2 special case for testing - introduce some errors to test FEC. + * + * Outputs: Bits are shipped out by calling tone_gen_put_bit(). + * + * Returns: Number of bits sent including + * - Preamble (01010101...) + * - 3 byte Sync Word. + * - 15 bytes for Header. + * - Optional payload. + * The required time can be calculated by dividing this + * number by the transmit rate of bits/sec. + * -1 is returned for failure. + * + * Description: Generate an IL2P encoded frame. + * + * Assumptions: It is assumed that the tone_gen module has been + * properly initialized so that bits sent with + * tone_gen_put_bit() are processed correctly. + * + * Errors: Return -1 for error. Probably frame too large. + * + * Note: Inconsistency here. ax25 version has just a byte array + * and length going in. Here we need the full packet object. + * + *--------------------------------------------------------------*/ + +int il2p_send_frame (int chan, packet_t pp, int max_fec, int polarity) +{ + unsigned char encoded[IL2P_MAX_PACKET_SIZE]; + + encoded[0] = ( IL2P_SYNC_WORD >> 16 ) & 0xff; + encoded[1] = ( IL2P_SYNC_WORD >> 8 ) & 0xff; + encoded[2] = ( IL2P_SYNC_WORD ) & 0xff; + + int elen = il2p_encode_frame (pp, max_fec, encoded + IL2P_SYNC_WORD_SIZE); + if (elen <= 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("IL2P: Unable to encode frame into IL2P.\n"); + return (-1); + } + + elen += IL2P_SYNC_WORD_SIZE; + + number_of_bits_sent[chan] = 0; + + if (il2p_get_debug() >= 1) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("IL2P frame, max_fec = %d, %d encoded bytes total\n", max_fec, elen); + fx_hex_dump (encoded, elen); + } + + // Clobber some bytes for testing. + if (polarity >= 2) { + for (int j = 10; j < elen; j+=100) { + encoded[j] = ~ encoded[j]; + } + } + + // Send bits to modulator. + + static unsigned char preamble = IL2P_PREAMBLE; + + send_bytes (chan, &preamble, 1, polarity); + send_bytes (chan, encoded, elen, polarity); + + return (number_of_bits_sent[chan]); +} + + +static void send_bytes (int chan, unsigned char *b, int count, int polarity) +{ + for (int j = 0; j < count; j++) { + unsigned int x = b[j]; + for (int k = 0; k < 8; k++) { + send_bit (chan, (x & 0x80) != 0, polarity); + x <<= 1; + } + } +} + +// NRZI would be applied for AX.25 but IL2P does not use it. +// However we do have an option to invert the signal. +// The direwolf receive implementation will automatically compensate +// for either polarity but other implementations might not. + +static void send_bit (int chan, int b, int polarity) +{ + tone_gen_put_bit (chan, (b ^ polarity) & 1); + number_of_bits_sent[chan]++; +} + + + +// end il2p_send.c \ No newline at end of file diff --git a/src/il2p_test.c b/src/il2p_test.c new file mode 100644 index 00000000..17995259 --- /dev/null +++ b/src/il2p_test.c @@ -0,0 +1,977 @@ +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// +// Copyright (C) 2021 John Langner, WB2OSZ +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . +// + +#include "direwolf.h" + +#include +#include +#include +#include + +#include "textcolor.h" +#include "il2p.h" +#include "ax25_pad.h" +#include "ax25_pad2.h" +#include "multi_modem.h" + + +static void test_scramble(void); +static void test_rs(void); +static void test_payload(void); +static void test_example_headers(void); +static void all_frame_types(void); +static void test_serdes(void); +static void decode_bitstream(void); + +/*------------------------------------------------------------- + * + * Name: il2p_test.c + * + * Purpose: Unit tests for IL2P protocol functions. + * + * Errors: Die if anything goes wrong. + * + *--------------------------------------------------------------*/ + + +int main () +{ + int enable_color = 1; + text_color_init (enable_color); + + int enable_debug_out = 0; + il2p_init(enable_debug_out); + + text_color_set(DW_COLOR_INFO); + dw_printf ("Begin IL2P unit tests.\n"); + +// These start simple and later complex cases build upon earlier successes. + +// Test scramble and descramble. + + test_scramble(); + +// Test Reed Solomon error correction. + + test_rs(); + +// Test payload functions. + + test_payload(); + +// Try encoding the example headers in the protocol spec. + + test_example_headers(); + +// Convert all of the AX.25 frame types to IL2P and back again. + + all_frame_types(); + +// Use same serialize / deserialize functions used on the air. + + test_serdes (); + +// Decode bitstream from demodulator if data file is available. +// TODO: Very large info parts. Appropriate error if too long. +// TODO: More than 2 addresses. + + decode_bitstream(); + + text_color_set(DW_COLOR_REC); + dw_printf ("\n----------\n\n"); + dw_printf ("\nSUCCESS!\n"); + + return (EXIT_SUCCESS); +} + + + +///////////////////////////////////////////////////////////////////////////////////////////// +// +// Test scrambling and descrambling. +// +///////////////////////////////////////////////////////////////////////////////////////////// + +static void test_scramble(void) +{ + text_color_set(DW_COLOR_INFO); + dw_printf ("Test scrambling...\n"); + +// First an example from the protocol specification to make sure I'm compatible. + + static unsigned char scramin1[] = { 0x63, 0xf1, 0x40, 0x40, 0x40, 0x00, 0x6b, 0x2b, 0x54, 0x28, 0x25, 0x2a, 0x0f }; + static unsigned char scramout1[] = { 0x6a, 0xea, 0x9c, 0xc2, 0x01, 0x11, 0xfc, 0x14, 0x1f, 0xda, 0x6e, 0xf2, 0x53 }; + unsigned char scramout[sizeof(scramin1)]; + + il2p_scramble_block (scramin1, scramout, sizeof(scramin1)); + assert (memcmp(scramout, scramout, sizeof(scramout1)) == 0); + +} // end test_scramble. + + + + +///////////////////////////////////////////////////////////////////////////////////////////// +// +// Test Reed Solomon encode/decode examples found in the protocol spec. +// The data part is scrambled but that does not matter here because. +// We are only concerned abound adding the parity and verifying. +// +///////////////////////////////////////////////////////////////////////////////////////////// + + +static void test_rs() +{ + text_color_set(DW_COLOR_INFO); + dw_printf ("Test Reed Solomon functions...\n"); + + static unsigned char example_s[] = { 0x26, 0x57, 0x4d, 0x57, 0xf1, 0x96, 0xcc, 0x85, 0x42, 0xe7, 0x24, 0xf7, 0x2e, + 0x8a, 0x97 }; + unsigned char parity_out[2]; + il2p_encode_rs (example_s, 13, 2, parity_out); + //dw_printf ("DEBUG RS encode %02x %02x\n", parity_out[0], parity_out[1]); + assert (memcmp(parity_out, example_s + 13, 2) == 0); + + + static unsigned char example_u[] = { 0x6a, 0xea, 0x9c, 0xc2, 0x01, 0x11, 0xfc, 0x14, 0x1f, 0xda, 0x6e, 0xf2, 0x53, + 0x91, 0xbd }; + il2p_encode_rs (example_u, 13, 2, parity_out); + //dw_printf ("DEBUG RS encode %02x %02x\n", parity_out[0], parity_out[1]); + assert (memcmp(parity_out, example_u + 13, 2) == 0); + + // See if we can go the other way. + + unsigned char received[15]; + unsigned char corrected[15]; + int e; + + e = il2p_decode_rs (example_s, 13, 2, corrected); + assert (e == 0); + assert (memcmp(example_s, corrected, 13) == 0); + + memcpy (received, example_s, 15); + received[0] = '?'; + e = il2p_decode_rs (received, 13, 2, corrected); + assert (e == 1); + assert (memcmp(example_s, corrected, 13) == 0); + + e = il2p_decode_rs (example_u, 13, 2, corrected); + assert (e == 0); + assert (memcmp(example_u, corrected, 13) == 0); + + memcpy (received, example_u, 15); + received[12] = '?'; + e = il2p_decode_rs (received, 13, 2, corrected); + assert (e == 1); + assert (memcmp(example_u, corrected, 13) == 0); + + received[1] = '?'; + received[2] = '?'; + e = il2p_decode_rs (received, 13, 2, corrected); + assert (e == -1); +} + + + +///////////////////////////////////////////////////////////////////////////////////////////// +// +// Test payload functions. +// +///////////////////////////////////////////////////////////////////////////////////////////// + +static void test_payload(void) +{ + text_color_set(DW_COLOR_INFO); + dw_printf ("Test payload functions...\n"); + + il2p_payload_properties_t ipp; + int e; + +// Examples in specification. + + e = il2p_payload_compute (&ipp, 100, 0); + assert (ipp.small_block_size == 100); + assert (ipp.large_block_size == 101); + assert (ipp.large_block_count == 0); + assert (ipp.small_block_count == 1); + assert (ipp.parity_symbols_per_block == 4); + + e = il2p_payload_compute (&ipp, 236, 0); + assert (ipp.small_block_size == 236); + assert (ipp.large_block_size == 237); + assert (ipp.large_block_count == 0); + assert (ipp.small_block_count == 1); + assert (ipp.parity_symbols_per_block == 8); + + e = il2p_payload_compute (&ipp, 512, 0); + assert (ipp.small_block_size == 170); + assert (ipp.large_block_size == 171); + assert (ipp.large_block_count == 2); + assert (ipp.small_block_count == 1); + assert (ipp.parity_symbols_per_block == 6); + + e = il2p_payload_compute (&ipp, 1023, 0); + assert (ipp.small_block_size == 204); + assert (ipp.large_block_size == 205); + assert (ipp.large_block_count == 3); + assert (ipp.small_block_count == 2); + assert (ipp.parity_symbols_per_block == 8); + +// Now try all possible sizes for Baseline FEC Parity. + + for (int n = 1; n <= IL2P_MAX_PAYLOAD_SIZE; n++) { + e = il2p_payload_compute (&ipp, n, 0); + //dw_printf ("bytecount=%d, smallsize=%d, largesize=%d, largecount=%d, smallcount=%d\n", n, + // ipp.small_block_size, ipp.large_block_size, + // ipp.large_block_count, ipp.small_block_count); + //fflush (stdout); + + assert (ipp.payload_block_count >= 1 && ipp.payload_block_count <= IL2P_MAX_PAYLOAD_BLOCKS); + assert (ipp.payload_block_count == ipp.small_block_count + ipp.large_block_count); + assert (ipp.small_block_count * ipp.small_block_size + + ipp.large_block_count * ipp.large_block_size == n); + assert (ipp.parity_symbols_per_block == 2 || + ipp.parity_symbols_per_block == 4 || + ipp.parity_symbols_per_block == 6 || + ipp.parity_symbols_per_block == 8); + + // Data and parity must fit in RS block size of 255. + // Size test does not apply if block count is 0. + assert (ipp.small_block_count == 0 || ipp.small_block_size + ipp.parity_symbols_per_block <= 255); + assert (ipp.large_block_count == 0 || ipp.large_block_size + ipp.parity_symbols_per_block <= 255); + } + +// All sizes for MAX FEC. + + for (int n = 1; n <= IL2P_MAX_PAYLOAD_SIZE; n++) { + e = il2p_payload_compute (&ipp, n, 1); // 1 for max fec. + //dw_printf ("bytecount=%d, smallsize=%d, largesize=%d, largecount=%d, smallcount=%d\n", n, + // ipp.small_block_size, ipp.large_block_size, + // ipp.large_block_count, ipp.small_block_count); + //fflush (stdout); + + assert (ipp.payload_block_count >= 1 && ipp.payload_block_count <= IL2P_MAX_PAYLOAD_BLOCKS); + assert (ipp.payload_block_count == ipp.small_block_count + ipp.large_block_count); + assert (ipp.small_block_count * ipp.small_block_size + + ipp.large_block_count * ipp.large_block_size == n); + assert (ipp.parity_symbols_per_block == 16); + + // Data and parity must fit in RS block size of 255. + // Size test does not apply if block count is 0. + assert (ipp.small_block_count == 0 || ipp.small_block_size + ipp.parity_symbols_per_block <= 255); + assert (ipp.large_block_count == 0 || ipp.large_block_size + ipp.parity_symbols_per_block <= 255); + } + +// Now let's try encoding payloads and extracting original again. +// This will also provide exercise for scrambling and Reed Solomon under more conditions. + + unsigned char original_payload[IL2P_MAX_PAYLOAD_SIZE]; + for (int n = 0; n < IL2P_MAX_PAYLOAD_SIZE; n++) { + original_payload[n] = n & 0xff; + } + for (int max_fec = 0; max_fec <= 1; max_fec++) { + for (int payload_length = 1; payload_length <= IL2P_MAX_PAYLOAD_SIZE; payload_length++) { + //dw_printf ("\n--------- max_fec = %d, payload_length = %d\n", max_fec, payload_length); + unsigned char encoded[IL2P_MAX_ENCODED_PAYLOAD_SIZE]; + int k = il2p_encode_payload (original_payload, payload_length, max_fec, encoded); + + //dw_printf ("payload length %d %s -> %d\n", payload_length, max_fec ? "M" : "", k); + assert (k > payload_length && k <= IL2P_MAX_ENCODED_PAYLOAD_SIZE); + + // Now extract. + + unsigned char extracted[IL2P_MAX_PAYLOAD_SIZE]; + int symbols_corrected = 0; + int e = il2p_decode_payload (encoded, payload_length, max_fec, extracted, &symbols_corrected); + //dw_printf ("e = %d, payload_length = %d\n", e, payload_length); + assert (e == payload_length); + + // if (memcmp (original_payload, extracted, payload_length) != 0) { + // dw_printf ("********** Received message not as expected. **********\n"); + // fx_hex_dump(extracted, payload_length); + // } + assert (memcmp (original_payload, extracted, payload_length) == 0); + } + } + (void)e; +} // end test_payload + + + +///////////////////////////////////////////////////////////////////////////////////////////// +// +// Test header examples found in protocol specification. +// +///////////////////////////////////////////////////////////////////////////////////////////// + +static void test_example_headers() +{ + +//----------- Example 1: AX.25 S-Frame -------------- + +// This frame sample only includes a 15 byte header, without PID field. +// Destination Callsign: ?KA2DEW-2 +// Source Callsign: ?KK4HEJ-7 +// N(R): 5 +// P/F: 1 +// C: 1 +// Control Opcode: 00 (Receive Ready) +// +// AX.25 data: +// 96 82 64 88 8a ae e4 96 96 68 90 8a 94 6f b1 +// +// IL2P Data Prior to Scrambling and RS Encoding: +// 2b a1 12 24 25 77 6b 2b 54 68 25 2a 27 +// +// IL2P Data After Scrambling and RS Encoding: +// 26 57 4d 57 f1 96 cc 85 42 e7 24 f7 2e 8a 97 + + text_color_set(DW_COLOR_INFO); + dw_printf ("Example 1: AX.25 S-Frame...\n"); + + static unsigned char example1[] = {0x96, 0x82, 0x64, 0x88, 0x8a, 0xae, 0xe4, 0x96, 0x96, 0x68, 0x90, 0x8a, 0x94, 0x6f, 0xb1}; + static unsigned char header1[] = {0x2b, 0xa1, 0x12, 0x24, 0x25, 0x77, 0x6b, 0x2b, 0x54, 0x68, 0x25, 0x2a, 0x27 }; + unsigned char header[IL2P_HEADER_SIZE]; + unsigned char sresult[32]; + memset (header, 0, sizeof(header)); + memset (sresult, 0, sizeof(sresult)); + unsigned char check[2]; + alevel_t alevel; + memset(&alevel, 0, sizeof(alevel)); + + packet_t pp = ax25_from_frame (example1, sizeof(example1), alevel); + assert (pp != NULL); + int e; + e = il2p_type_1_header (pp, 0, header); + assert (e == 0); + ax25_delete(pp); + + //dw_printf ("Example 1 header:\n"); + //for (int i = 0 ; i < sizeof(header); i++) { + // dw_printf (" %02x", header[i]); + //} + ///dw_printf ("\n"); + + assert (memcmp(header, header1, sizeof(header)) == 0); + + il2p_scramble_block (header, sresult, 13); + //dw_printf ("Expect scrambled 26 57 4d 57 f1 96 cc 85 42 e7 24 f7 2e\n"); + //for (int i = 0 ; i < sizeof(sresult); i++) { + // dw_printf (" %02x", sresult[i]); + //} + //dw_printf ("\n"); + + il2p_encode_rs (sresult, 13, 2, check); + + //dw_printf ("expect checksum = 8a 97\n"); + //dw_printf ("check = "); + //for (int i = 0 ; i < sizeof(check); i++) { + // dw_printf (" %02x", check[i]); + //} + //dw_printf ("\n"); + assert (check[0] == 0x8a); + assert (check[1] == 0x97); + +// Can we go from IL2P back to AX.25? + + pp = il2p_decode_header_type_1 (header, 0); + assert (pp != NULL); + + char dst_addr[AX25_MAX_ADDR_LEN]; + char src_addr[AX25_MAX_ADDR_LEN]; + + ax25_get_addr_with_ssid (pp, AX25_DESTINATION, dst_addr); + ax25_get_addr_with_ssid (pp, AX25_SOURCE, src_addr); + + ax25_frame_type_t frame_type; + cmdres_t cr; // command or response. + char description[64]; + int pf; // Poll/Final. + int nr, ns; // Sequence numbers. + + frame_type = ax25_frame_type (pp, &cr, description, &pf, &nr, &ns); + (void)frame_type; +#if 1 + dw_printf ("%s(): %s>%s: %s\n", __func__, src_addr, dst_addr, description); +#endif +// TODO: compare binary. + ax25_delete (pp); + + dw_printf ("Example 1 header OK\n"); + + +// -------------- Example 2 - UI frame, no info part ------------------ + +// This is an AX.25 Unnumbered Information frame, such as APRS. +// Destination Callsign: ?CQ -0 +// Source Callsign: ?KK4HEJ-15 +// P/F: 0 +// C: 0 +// Control Opcode: 3 Unnumbered Information +// PID: 0xF0 No L3 +// +// AX.25 Data: +// 86 a2 40 40 40 40 60 96 96 68 90 8a 94 7f 03 f0 +// +// IL2P Data Prior to Scrambling and RS Encoding: +// 63 f1 40 40 40 00 6b 2b 54 28 25 2a 0f +// +// IL2P Data After Scrambling and RS Encoding: +// 6a ea 9c c2 01 11 fc 14 1f da 6e f2 53 91 bd + + + //dw_printf ("---------- example 2 ------------\n"); + static unsigned char example2[] = { 0x86, 0xa2, 0x40, 0x40, 0x40, 0x40, 0x60, 0x96, 0x96, 0x68, 0x90, 0x8a, 0x94, 0x7f, 0x03, 0xf0 }; + static unsigned char header2[] = { 0x63, 0xf1, 0x40, 0x40, 0x40, 0x00, 0x6b, 0x2b, 0x54, 0x28, 0x25, 0x2a, 0x0f }; + memset (header, 0, sizeof(header)); + memset (sresult, 0, sizeof(sresult)); + memset(&alevel, 0, sizeof(alevel)); + + pp = ax25_from_frame (example2, sizeof(example2), alevel); + assert (pp != NULL); + e = il2p_type_1_header (pp, 0, header); + assert (e == 0); + ax25_delete(pp); + + //dw_printf ("Example 2 header:\n"); + //for (int i = 0 ; i < sizeof(header); i++) { + // dw_printf (" %02x", header[i]); + //} + //dw_printf ("\n"); + + assert (memcmp(header, header2, sizeof(header2)) == 0); + + il2p_scramble_block (header, sresult, 13); + //dw_printf ("Expect scrambled 6a ea 9c c2 01 11 fc 14 1f da 6e f2 53\n"); + //for (int i = 0 ; i < sizeof(sresult); i++) { + // dw_printf (" %02x", sresult[i]); + //} + //dw_printf ("\n"); + + il2p_encode_rs (sresult, 13, 2, check); + + //dw_printf ("expect checksum = 91 bd\n"); + //dw_printf ("check = "); + //for (int i = 0 ; i < sizeof(check); i++) { + // dw_printf (" %02x", check[i]); + //} + //dw_printf ("\n"); + assert (check[0] == 0x91); + assert (check[1] == 0xbd); + +// Can we go from IL2P back to AX.25? + + pp = il2p_decode_header_type_1 (header, 0); + assert (pp != NULL); + + ax25_get_addr_with_ssid (pp, AX25_DESTINATION, dst_addr); + ax25_get_addr_with_ssid (pp, AX25_SOURCE, src_addr); + + frame_type = ax25_frame_type (pp, &cr, description, &pf, &nr, &ns); + (void)frame_type; +#if 1 + dw_printf ("%s(): %s>%s: %s\n", __func__, src_addr, dst_addr, description); +#endif +// TODO: compare binary. + + ax25_delete (pp); +// TODO: more examples + + dw_printf ("Example 2 header OK\n"); + + +// -------------- Example 3 - I Frame ------------------ + +// This is an AX.25 I-Frame with 9 bytes of information after the 16 byte header. +// +// Destination Callsign: ?KA2DEW-2 +// Source Callsign: ?KK4HEJ-2 +// P/F: 1 +// C: 1 +// N(R): 5 +// N(S): 4 +// AX.25 PID: 0xCF TheNET +// IL2P Payload Byte Count: 9 +// +// AX.25 Data: +// 96 82 64 88 8a ae e4 96 96 68 90 8a 94 65 b8 cf 30 31 32 33 34 35 36 37 38 +// +// IL2P Scrambled and Encoded Data: +// 26 13 6d 02 8c fe fb e8 aa 94 2d 6a 34 43 35 3c 69 9f 0c 75 5a 38 a1 7f f3 fc + + + //dw_printf ("---------- example 3 ------------\n"); + static unsigned char example3[] = { 0x96, 0x82, 0x64, 0x88, 0x8a, 0xae, 0xe4, 0x96, 0x96, 0x68, 0x90, 0x8a, 0x94, 0x65, 0xb8, 0xcf, 0x30, 0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37, 0x38 }; + static unsigned char header3[] = { 0x2b, 0xe1, 0x52, 0x64, 0x25, 0x77, 0x6b, 0x2b, 0xd4, 0x68, 0x25, 0xaa, 0x22 }; + static unsigned char complete3[] = { 0x26, 0x13, 0x6d, 0x02, 0x8c, 0xfe, 0xfb, 0xe8, 0xaa, 0x94, 0x2d, 0x6a, 0x34, 0x43, 0x35, 0x3c, 0x69, 0x9f, 0x0c, 0x75, 0x5a, 0x38, 0xa1, 0x7f, 0xf3, 0xfc }; + memset (header, 0, sizeof(header)); + memset (sresult, 0, sizeof(sresult)); + memset(&alevel, 0, sizeof(alevel)); + + pp = ax25_from_frame (example3, sizeof(example3), alevel); + assert (pp != NULL); + e = il2p_type_1_header (pp, 0, header); + assert (e == 9); + ax25_delete(pp); + + //dw_printf ("Example 3 header:\n"); + //for (int i = 0 ; i < sizeof(header); i++) { + // dw_printf (" %02x", header[i]); + //} + //dw_printf ("\n"); + + assert (memcmp(header, header3, sizeof(header)) == 0); + + il2p_scramble_block (header, sresult, 13); + //dw_printf ("Expect scrambled 26 13 6d 02 8c fe fb e8 aa 94 2d 6a 34\n"); + //for (int i = 0 ; i < sizeof(sresult); i++) { + // dw_printf (" %02x", sresult[i]); + //} + //dw_printf ("\n"); + + il2p_encode_rs (sresult, 13, 2, check); + + //dw_printf ("expect checksum = 43 35\n"); + //dw_printf ("check = "); + //for (int i = 0 ; i < sizeof(check); i++) { + // dw_printf (" %02x", check[i]); + //} + //dw_printf ("\n"); + + assert (check[0] == 0x43); + assert (check[1] == 0x35); + + // That was only the header. We will get to the info part in a later test. + +// Can we go from IL2P back to AX.25? + + pp = il2p_decode_header_type_1 (header, 0); + assert (pp != NULL); + + ax25_get_addr_with_ssid (pp, AX25_DESTINATION, dst_addr); + ax25_get_addr_with_ssid (pp, AX25_SOURCE, src_addr); + + frame_type = ax25_frame_type (pp, &cr, description, &pf, &nr, &ns); + (void)frame_type; +#if 1 + dw_printf ("%s(): %s>%s: %s\n", __func__, src_addr, dst_addr, description); +#endif +// TODO: compare binary. + + ax25_delete (pp); + dw_printf ("Example 3 header OK\n"); + +// Example 3 again, this time the Information part is included. + + pp = ax25_from_frame (example3, sizeof(example3), alevel); + assert (pp != NULL); + + int max_fec = 0; + unsigned char iout[IL2P_MAX_PACKET_SIZE]; + e = il2p_encode_frame (pp, max_fec, iout); + + //dw_printf ("expected for example 3:\n"); + //fx_hex_dump(complete3, sizeof(complete3)); + //dw_printf ("actual result for example 3:\n"); + //fx_hex_dump(iout, e); + // Does it match the example in the protocol spec? + assert (e == sizeof(complete3)); + assert (memcmp(iout, complete3, sizeof(complete3)) == 0); + ax25_delete (pp); + + dw_printf ("Example 3 with info OK\n"); + +} // end test_example_headers + + + +///////////////////////////////////////////////////////////////////////////////////////////// +// +// Test all of the frame types. +// +// Encode to IL2P format, decode, and verify that the result is the same as the original. +// +///////////////////////////////////////////////////////////////////////////////////////////// + + +static void enc_dec_compare (packet_t pp1) +{ + for (int max_fec = 0; max_fec <= 1; max_fec++) { + + unsigned char encoded[IL2P_MAX_PACKET_SIZE]; + int enc_len; + enc_len = il2p_encode_frame (pp1, max_fec, encoded); + assert (enc_len >= 0); + + packet_t pp2; + pp2 = il2p_decode_frame (encoded); + assert (pp2 != NULL); + +// Is it the same after encoding to IL2P and then decoding? + + int len1 = ax25_get_frame_len (pp1); + unsigned char *data1 = ax25_get_frame_data_ptr (pp1); + + int len2 = ax25_get_frame_len (pp2); + unsigned char *data2 = ax25_get_frame_data_ptr (pp2); + + if (len1 != len2 || memcmp(data1, data2, len1) != 0) { + + dw_printf ("\nEncode/Decode Error. Original:\n"); + ax25_hex_dump (pp1); + + dw_printf ("IL2P encoded as:\n"); + fx_hex_dump(encoded, enc_len); + + dw_printf ("Got turned into this:\n"); + ax25_hex_dump (pp2); + } + + assert (len1 == len2 && memcmp(data1, data2, len1) == 0); + + ax25_delete (pp2); + } +} + +static void all_frame_types(void) +{ + char addrs[AX25_MAX_ADDRS][AX25_MAX_ADDR_LEN]; + int num_addr = 2; + cmdres_t cr; + ax25_frame_type_t ftype; + int pf = 0; + int pid = 0xf0; + int modulo; + int nr, ns; + unsigned char *pinfo = NULL; + int info_len = 0; + packet_t pp; + + strcpy (addrs[0], "W2UB"); + strcpy (addrs[1], "WB2OSZ-12"); + num_addr = 2; + + text_color_set(DW_COLOR_INFO); + dw_printf ("Testing all frame types.\n"); + +/* U frame */ + + dw_printf ("\nU frames...\n"); + + for (ftype = frame_type_U_SABME; ftype <= frame_type_U_TEST; ftype++) { + + for (pf = 0; pf <= 1; pf++) { + + int cmin = 0, cmax = 1; + + switch (ftype) { + // 0 = response, 1 = command + case frame_type_U_SABME: cmin = 1; cmax = 1; break; + case frame_type_U_SABM: cmin = 1; cmax = 1; break; + case frame_type_U_DISC: cmin = 1; cmax = 1; break; + case frame_type_U_DM: cmin = 0; cmax = 0; break; + case frame_type_U_UA: cmin = 0; cmax = 0; break; + case frame_type_U_FRMR: cmin = 0; cmax = 0; break; + case frame_type_U_UI: cmin = 0; cmax = 1; break; + case frame_type_U_XID: cmin = 0; cmax = 1; break; + case frame_type_U_TEST: cmin = 0; cmax = 1; break; + default: break; // avoid compiler warning. + } + + for (cr = cmin; cr <= cmax; cr++) { + + text_color_set(DW_COLOR_INFO); + dw_printf ("\nConstruct U frame, cr=%d, ftype=%d, pid=0x%02x\n", cr, ftype, pid); + + pp = ax25_u_frame (addrs, num_addr, cr, ftype, pf, pid, pinfo, info_len); + ax25_hex_dump (pp); + enc_dec_compare (pp); + ax25_delete (pp); + } + } + } + + +/* S frame */ + + //strcpy (addrs[2], "DIGI1-1"); + //num_addr = 3; + + dw_printf ("\nS frames...\n"); + + for (ftype = frame_type_S_RR; ftype <= frame_type_S_SREJ; ftype++) { + + for (pf = 0; pf <= 1; pf++) { + + modulo = 8; + nr = modulo / 2 + 1; + + // SREJ can only be response. + + for (cr = 0; cr <= (int)(ftype!=frame_type_S_SREJ); cr++) { + + text_color_set(DW_COLOR_INFO); + dw_printf ("\nConstruct S frame, cmd=%d, ftype=%d, pid=0x%02x\n", cr, ftype, pid); + + pp = ax25_s_frame (addrs, num_addr, cr, ftype, modulo, nr, pf, NULL, 0); + + ax25_hex_dump (pp); + enc_dec_compare (pp); + ax25_delete (pp); + } + + modulo = 128; + nr = modulo / 2 + 1; + + for (cr = 0; cr <= (int)(ftype!=frame_type_S_SREJ); cr++) { + + text_color_set(DW_COLOR_INFO); + dw_printf ("\nConstruct S frame, cmd=%d, ftype=%d, pid=0x%02x\n", cr, ftype, pid); + + pp = ax25_s_frame (addrs, num_addr, cr, ftype, modulo, nr, pf, NULL, 0); + + ax25_hex_dump (pp); + enc_dec_compare (pp); + ax25_delete (pp); + } + } + } + +/* SREJ is only S frame which can have information part. */ + + static unsigned char srej_info[] = { 1<<1, 2<<1, 3<<1, 4<<1 }; + + ftype = frame_type_S_SREJ; + for (pf = 0; pf <= 1; pf++) { + + modulo = 128; + nr = 127; + cr = cr_res; + + text_color_set(DW_COLOR_INFO); + dw_printf ("\nConstruct Multi-SREJ S frame, cmd=%d, ftype=%d, pid=0x%02x\n", cr, ftype, pid); + + pp = ax25_s_frame (addrs, num_addr, cr, ftype, modulo, nr, pf, srej_info, (int)(sizeof(srej_info))); + + ax25_hex_dump (pp); + enc_dec_compare (pp); + ax25_delete (pp); + } + + +/* I frame */ + + dw_printf ("\nI frames...\n"); + + pinfo = (unsigned char*)"The rain in Spain stays mainly on the plain."; + info_len = strlen((char*)pinfo); + + for (pf = 0; pf <= 1; pf++) { + + modulo = 8; + nr = 0x55 & (modulo - 1); + ns = 0xaa & (modulo - 1); + + for (cr = 1; cr <= 1; cr++) { // can only be command + + text_color_set(DW_COLOR_INFO); + dw_printf ("\nConstruct I frame, cmd=%d, ftype=%d, pid=0x%02x\n", cr, ftype, pid); + + pp = ax25_i_frame (addrs, num_addr, cr, modulo, nr, ns, pf, pid, pinfo, info_len); + + ax25_hex_dump (pp); + enc_dec_compare (pp); + ax25_delete (pp); + } + + modulo = 128; + nr = 0x55 & (modulo - 1); + ns = 0xaa & (modulo - 1); + + for (cr = 1; cr <= 1; cr++) { + + text_color_set(DW_COLOR_INFO); + dw_printf ("\nConstruct I frame, cmd=%d, ftype=%d, pid=0x%02x\n", cr, ftype, pid); + + pp = ax25_i_frame (addrs, num_addr, cr, modulo, nr, ns, pf, pid, pinfo, info_len); + + ax25_hex_dump (pp); + enc_dec_compare (pp); + ax25_delete (pp); + } + } + +} // end all_frame_types + + +///////////////////////////////////////////////////////////////////////////////////////////// +// +// Test bitstream tapped off from demodulator. +// +// 5 frames were sent to Nino TNC and a recording was made. +// This was demodulated and the resulting bit stream saved to a file. +// +// No automatic test here - must be done manually with audio recording. +// +///////////////////////////////////////////////////////////////////////////////////////////// + +static int decoding_bitstream = 0; + +static void decode_bitstream(void) +{ + dw_printf("-----\nReading il2p-bitstream.txt if available...\n"); + + FILE *fp = fopen ("il2p-bitstream.txt", "r"); + if (fp == NULL) { + dw_printf ("Bitstream test file not available.\n"); + return; + } + + decoding_bitstream = 1; + int save_previous = il2p_get_debug(); + il2p_set_debug (1); + + int ch; + while ( (ch = fgetc(fp)) != EOF) { + + if (ch == '0' || ch == '1') { + il2p_rec_bit (0, 0, 0, ch - '0'); + } + } + fclose(fp); + il2p_set_debug (save_previous); + decoding_bitstream = 0; + +} // end decode_bitstream + + + + +///////////////////////////////////////////////////////////////////////////////////////////// +// +// Test serialize / deserialize. +// +// This uses same functions used on the air. +// +///////////////////////////////////////////////////////////////////////////////////////////// + +static char addrs2[] = "AA1AAA-1>ZZ9ZZZ-9"; +static char addrs3[] = "AA1AAA-1>ZZ9ZZZ-9,DIGI*"; +static char text[] = + "'... As I was saying, that seems to be done right - though I haven't time to look it over thoroughly just now - and that shows that there are three hundred and sixty-four days when you might get un-birthday presents -'" + "\n" + "'Certainly,' said Alice." + "\n" + "'And only one for birthday presents, you know. There's glory for you!'" + "\n" + "'I don't know what you mean by \"glory\",' Alice said." + "\n" + "Humpty Dumpty smiled contemptuously. 'Of course you don't - till I tell you. I meant \"there's a nice knock-down argument for you!\"'" + "\n" + "'But \"glory\" doesn't mean \"a nice knock-down argument\",' Alice objected." + "\n" + "'When I use a word,' Humpty Dumpty said, in rather a scornful tone, 'it means just what I choose it to mean - neither more nor less.'" + "\n" + "'The question is,' said Alice, 'whether you can make words mean so many different things.'" + "\n" + "'The question is,' said Humpty Dumpty, 'which is to be master - that's all.'" + "\n" ; + + +static int rec_count = -1; // disable deserialized packet test. +static int polarity = 0; + +static void test_serdes (void) +{ + text_color_set(DW_COLOR_INFO); + dw_printf ("\nTest serialize / deserialize...\n"); + rec_count = 0; + + int max_fec = 1; + + // try combinations of header type, max_fec, polarity, errors. + + for (int hdr_type = 0; hdr_type <= 1; hdr_type++) { + char packet[1024]; + snprintf (packet, sizeof(packet), "%s:%s", hdr_type ? addrs2 : addrs3, text); + packet_t pp = ax25_from_text (packet, 1); + assert (pp != NULL); + + int chan = 0; + + + for (max_fec = 0; max_fec <= 1; max_fec++) { + for (polarity = 0; polarity <= 2; polarity++) { // 2 means throw in some errors. + int num_bits_sent = il2p_send_frame (chan, pp, max_fec, polarity); + dw_printf ("%d bits sent.\n", num_bits_sent); + + // Need extra bit at end to flush out state machine. + il2p_rec_bit (0, 0, 0, 0); + } + } + ax25_delete(pp); + } + + dw_printf ("Serdes receive count = %d\n", rec_count); + assert (rec_count == 12); + rec_count = -1; // disable deserialized packet test. +} + + +// Serializing calls this which then simulates the demodulator output. + +void tone_gen_put_bit (int chan, int data) +{ + il2p_rec_bit (chan, 0, 0, data); +} + +// This is called when a complete frame has been deserialized. + +void multi_modem_process_rec_packet (int chan, int subchan, int slice, packet_t pp, alevel_t alevel, retry_t retries, fec_type_t fec_type) +{ + if (rec_count < 0) return; // Skip check before serdes test. + + rec_count++; + + // Does it have the the expected content? + + unsigned char *pinfo; + int len = ax25_get_info(pp, &pinfo); + assert (len == strlen(text)); + assert (strcmp(text, (char*)pinfo) == 0); + + dw_printf ("Number of symbols corrected: %d\n", retries); + if (polarity == 2) { // expecting errors corrected. + assert (retries == 10); + } + else { // should be no errors. + assert (retries == 0); + } + + ax25_delete (pp); +} + +alevel_t demod_get_audio_level (int chan, int subchan) +{ + alevel_t alevel; + memset (&alevel, 0, sizeof(alevel)); + return (alevel); +} + +// end il2p_test.c \ No newline at end of file diff --git a/src/kiss.c b/src/kiss.c new file mode 100644 index 00000000..f93cb94c --- /dev/null +++ b/src/kiss.c @@ -0,0 +1,602 @@ +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// +// Copyright (C) 2011, 2013, 2014, 2016, 2017 John Langner, WB2OSZ +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . +// + + + +/*------------------------------------------------------------------ + * + * Module: kiss.c + * + * Purpose: Act as a virtual KISS TNC for use by other packet radio applications. + * This file implements it with a pseudo terminal for Linux only. + * + * Description: It implements the KISS TNC protocol as described in: + * http://www.ka9q.net/papers/kiss.html + * + * Briefly, a frame is composed of + * + * * FEND (0xC0) + * * Contents - with special escape sequences so a 0xc0 + * byte in the data is not taken as end of frame. + * as part of the data. + * * FEND + * + * The first byte of the frame contains: + * + * * port number in upper nybble. + * * command in lower nybble. + * + * + * Commands from application recognized: + * + * _0 Data Frame AX.25 frame in raw format. + * + * _1 TXDELAY See explanation in xmit.c. + * + * _2 Persistence " " + * + * _3 SlotTime " " + * + * _4 TXtail " " + * Spec says it is obsolete but Xastir + * sends it and we respect it. + * + * _5 FullDuplex Ignored. + * + * _6 SetHardware TNC specific. + * + * FF Return Exit KISS mode. Ignored. + * + * + * Messages sent to client application: + * + * _0 Data Frame Received AX.25 frame in raw format. + * + * + * Platform differences: + * + * For the Linux case, + * We supply a pseudo terminal for use by other applications. + * + * Version 1.5: Split serial port version off into its own file. + * + *---------------------------------------------------------------*/ + + +#if __WIN32__ // Stub for Windows. + +#include "direwolf.h" +#include "kiss.h" + +void kisspt_init (struct misc_config_s *mc) +{ + return; +} + +void kisspt_set_debug (int n) +{ + return; +} + +void kisspt_send_rec_packet (int chan, int kiss_cmd, unsigned char *fbuf, int flen, struct kissport_status_s *kps, int client) +{ + return; +} + + +#else // Rest of file is for Linux only. + + +#include "direwolf.h" + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + + +#include "tq.h" +#include "ax25_pad.h" +#include "textcolor.h" +#include "kiss.h" +#include "kiss_frame.h" +#include "xmit.h" + + +/* + * Accumulated KISS frame and state of decoder. + */ + +static kiss_frame_t kf; + + +/* + * These are for a Linux pseudo terminal. + */ + +static int pt_master_fd = -1; /* File descriptor for my end. */ + +static char pt_slave_name[32]; /* Pseudo terminal slave name */ + /* like /dev/pts/999 */ + + +/* + * Symlink to pseudo terminal name which changes. + */ + +#define TMP_KISSTNC_SYMLINK "/tmp/kisstnc" + + +static void * kisspt_listen_thread (void *arg); + + +static int kisspt_debug = 0; /* Print information flowing from and to client. */ + +void kisspt_set_debug (int n) +{ + kisspt_debug = n; +} + + +/* In server.c. Should probably move to some misc. function file. */ + +void hex_dump (unsigned char *p, int len); + + + + + +/*------------------------------------------------------------------- + * + * Name: kisspt_init + * + * Purpose: Set up a pseudo terminal acting as a virtual KISS TNC. + * + * + * Inputs: + * + * Outputs: + * + * Description: (1) Create a pseudo terminal for the client to use. + * (2) Start a new thread to listen for commands from client app + * so the main application doesn't block while we wait. + * + * + *--------------------------------------------------------------------*/ + +static int kisspt_open_pt (void); + + +void kisspt_init (struct misc_config_s *mc) +{ + + pthread_t kiss_pterm_listen_tid; + int e; + + memset (&kf, 0, sizeof(kf)); + +/* + * This reads messages from client. + */ + pt_master_fd = -1; + + if (mc->enable_kiss_pt) { + + pt_master_fd = kisspt_open_pt (); + + if (pt_master_fd != -1) { + e = pthread_create (&kiss_pterm_listen_tid, (pthread_attr_t*)NULL, kisspt_listen_thread, NULL); + if (e != 0) { + text_color_set(DW_COLOR_ERROR); + perror("Could not create kiss listening thread for Linux pseudo terminal"); + } + } + } + else { + //text_color_set(DW_COLOR_INFO); + //dw_printf ("Use -p command line option to enable KISS pseudo terminal.\n"); + } + + +#if DEBUG + text_color_set (DW_COLOR_DEBUG); + + dw_printf ("end of kisspt_init: pt_master_fd = %d\n", pt_master_fd); +#endif + +} + + +/* + * Returns fd for master side of pseudo terminal or -1 for error. + */ + +static int kisspt_open_pt (void) +{ + int fd; + char *pts; + struct termios ts; + int e; + + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("kisspt_open_pt ( )\n"); +#endif + + fd = posix_openpt(O_RDWR|O_NOCTTY); + + if (fd == -1 + || grantpt (fd) == -1 + || unlockpt (fd) == -1 + || (pts = ptsname (fd)) == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("ERROR - Could not create pseudo terminal for KISS TNC.\n"); + return (-1); + } + + strlcpy (pt_slave_name, pts, sizeof(pt_slave_name)); + + e = tcgetattr (fd, &ts); + if (e != 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Can't get pseudo terminal attributes, err=%d\n", e); + perror ("pt tcgetattr"); + } + + cfmakeraw (&ts); + + ts.c_cc[VMIN] = 1; /* wait for at least one character */ + ts.c_cc[VTIME] = 0; /* no fancy timing. */ + + + e = tcsetattr (fd, TCSANOW, &ts); + if (e != 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Can't set pseudo terminal attributes, err=%d\n", e); + perror ("pt tcsetattr"); + } + +/* + * We had a problem here since the beginning. + * If no one was reading from the other end of the pseudo + * terminal, the buffer space would eventually fill up, + * the write here would block, and the receive decode + * thread would get stuck. + * + * March 2016 - A "select" was put before the read to + * solve a different problem. With that in place, we can + * now use non-blocking I/O and detect the buffer full + * condition here. + */ + + // text_color_set(DW_COLOR_DEBUG); + // dw_printf("Debug: Try using non-blocking mode for pseudo terminal.\n"); + + int flags = fcntl(fd, F_GETFL, 0); + e = fcntl (fd, F_SETFL, flags | O_NONBLOCK); + if (e != 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Can't set pseudo terminal to nonblocking, fcntl returns %d, errno = %d\n", e, errno); + perror ("pt fcntl"); + } + + text_color_set(DW_COLOR_INFO); + dw_printf("Virtual KISS TNC is available on %s\n", pt_slave_name); + + +#if 1 + // Sample code shows this. Why would we open it here? + // On Ubuntu, the slave side disappears after a few + // seconds if no one opens it. Same on Raspbian which + // is also based on Debian. + // Need to revisit this. + + int pt_slave_fd; + + pt_slave_fd = open(pt_slave_name, O_RDWR|O_NOCTTY); + + if (pt_slave_fd < 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Can't open %s\n", pt_slave_name); + perror (""); + return -1; + } +#endif + +/* + * The device name is not the same every time. + * This is inconvenient for the application because it might + * be necessary to change the device name in the configuration. + * Create a symlink, /tmp/kisstnc, so the application configuration + * does not need to change when the pseudo terminal name changes. + */ + + unlink (TMP_KISSTNC_SYMLINK); + + +// TODO: Is this removed when application exits? + + if (symlink (pt_slave_name, TMP_KISSTNC_SYMLINK) == 0) { + dw_printf ("Created symlink %s -> %s\n", TMP_KISSTNC_SYMLINK, pt_slave_name); + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Failed to create symlink %s\n", TMP_KISSTNC_SYMLINK); + perror (""); + } + + return (fd); +} + + + +/*------------------------------------------------------------------- + * + * Name: kisspt_send_rec_packet + * + * Purpose: Send a received packet or text string to the client app. + * + * Inputs: chan - Channel number where packet was received. + * 0 = first, 1 = second if any. + * + * kiss_cmd - Usually KISS_CMD_DATA_FRAME but we can also have + * KISS_CMD_SET_HARDWARE when responding to a query. + * + * pp - Identifier for packet object. + * + * fbuf - Address of raw received frame buffer + * or a text string. + * + * flen - Length of raw received frame not including the FCS + * or -1 for a text string. + * + * kps, client - Not used for pseudo terminal. + * Here so that 3 related functions all have + * the same parameter list. + * + * Description: Send message to client. + * We really don't care if anyone is listening or not. + * I don't even know if we can find out. + * + *--------------------------------------------------------------------*/ + + +void kisspt_send_rec_packet (int chan, int kiss_cmd, unsigned char *fbuf, int flen, struct kissport_status_s *kps, int client) +{ + unsigned char kiss_buff[2 * AX25_MAX_PACKET_LEN + 2]; + int kiss_len; + int err; + + + if (pt_master_fd == -1) { + return; + } + + if (flen < 0) { + flen = strlen((char*)fbuf); + if (kisspt_debug) { + kiss_debug_print (TO_CLIENT, "Fake command prompt", fbuf, flen); + } + strlcpy ((char *)kiss_buff, (char *)fbuf, sizeof(kiss_buff)); + kiss_len = strlen((char *)kiss_buff); + } + else { + + unsigned char stemp[AX25_MAX_PACKET_LEN + 1]; + + if (flen > (int)(sizeof(stemp)) - 1) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("\nPseudo Terminal KISS buffer too small. Truncated.\n\n"); + flen = (int)(sizeof(stemp)) - 1; + } + + stemp[0] = (chan << 4) | kiss_cmd; + memcpy (stemp+1, fbuf, flen); + + if (kisspt_debug >= 2) { + /* AX.25 frame with the CRC removed. */ + text_color_set(DW_COLOR_DEBUG); + dw_printf ("\n"); + dw_printf ("Packet content before adding KISS framing and any escapes:\n"); + hex_dump (fbuf, flen); + } + + kiss_len = kiss_encapsulate (stemp, flen+1, kiss_buff); + + /* This has KISS framing and escapes for sending to client app. */ + + if (kisspt_debug) { + kiss_debug_print (TO_CLIENT, NULL, kiss_buff, kiss_len); + } + + } + + err = write (pt_master_fd, kiss_buff, (size_t)kiss_len); + + if (err == -1 && errno == EWOULDBLOCK) { + text_color_set (DW_COLOR_INFO); + dw_printf ("KISS SEND - Discarding message because no one is listening.\n"); + dw_printf ("This happens when you use the -p option and don't read from the pseudo terminal.\n"); + } + else if (err != kiss_len) + { + text_color_set(DW_COLOR_ERROR); + dw_printf ("\nError sending KISS message to client application on pseudo terminal. fd=%d, len=%d, write returned %d, errno = %d\n\n", + pt_master_fd, kiss_len, err, errno); + perror ("pt write"); + } + +} /* kisspt_send_rec_packet */ + + + + +/*------------------------------------------------------------------- + * + * Name: kisspt_get + * + * Purpose: Read one byte from the KISS client app. + * + * Global In: pt_master_fd + * + * Returns: one byte (value 0 - 255) or terminate thread on error. + * + * Description: There is room for improvement here. Reading one byte + * at a time is inefficient. We could read a large block + * into a local buffer and return a byte from that most of the time. + * Is it worth the effort? I don't know. With GHz processors and + * the low data rate here it might not make a noticeable difference. + * + *--------------------------------------------------------------------*/ + + +static int kisspt_get (void) +{ + unsigned char ch; + + int n = 0; + fd_set fd_in, fd_ex; + int rc; + + while ( n == 0 ) { + +/* + * Since the beginning we've always had a couple annoying problems with + * the pseudo terminal KISS interface. + * When using "kissattach" we would sometimes get the error message: + * + * kissattach: Error setting line discipline: TIOCSETD: Device or resource busy + * Are you sure you have enabled MKISS support in the kernel + * or, if you made it a module, that the module is loaded? + * + * martinhpedersen came up with the interesting idea of putting in a "select" + * before the "read" and explained it like this: + * + * "Reading from master fd of the pty before the client has connected leads + * to trouble with kissattach. Use select to check if the slave has sent + * any data before trying to read from it." + * + * "This fix resolves the issue by not reading from the pty's master fd, until + * kissattach has opened and configured the slave. This is implemented using + * select() to wait for data before reading from the master fd." + * + * The submitted code looked like this: + * + * FD_ZERO(&fd_in); + * rc = select(pt_master_fd + 1, &fd_in, NULL, &fd_in, NULL); + * + * That doesn't look right to me for a couple reasons. + * First, I would expect to use FD_SET for the fd. + * Second, using the same bit mask for two arguments doesn't seem + * like a good idea because select modifies them. + * When I tried running it, we don't get the failure message + * anymore but the select never returns so we can't read data from + * the KISS client app. + * + * I think this is what we want. + * + * Tested on Raspian (ARM) and Ubuntu (x86_64). + * We don't get the error from kissattach anymore. + */ + + FD_ZERO(&fd_in); + FD_SET(pt_master_fd, &fd_in); + + FD_ZERO(&fd_ex); + FD_SET(pt_master_fd, &fd_ex); + + rc = select(pt_master_fd + 1, &fd_in, NULL, &fd_ex, NULL); + +#if 0 + text_color_set(DW_COLOR_DEBUG); + dw_printf ("select returns %d, errno=%d, fd=%d, fd_in=%08x, fd_ex=%08x\n", rc, errno, pt_master_fd, *((int*)(&fd_in)), *((int*)(&fd_in))); +#endif + + if (rc == 0) + { + continue; // When could we get a 0? + } + + if (rc == -1 + || (n = read(pt_master_fd, &ch, (size_t)1)) != 1) + { + + text_color_set(DW_COLOR_ERROR); + dw_printf ("\nError receiving KISS message from client application. Closing %s.\n\n", pt_slave_name); + perror (""); + + close (pt_master_fd); + + pt_master_fd = -1; + unlink (TMP_KISSTNC_SYMLINK); + pthread_exit (NULL); + } + } + +#if DEBUGx + text_color_set(DW_COLOR_DEBUG); + dw_printf ("kisspt_get(%d) returns 0x%02x\n", fd, ch); +#endif + + return (ch); +} + + +/*------------------------------------------------------------------- + * + * Name: kisspt_listen_thread + * + * Purpose: Read messages from serial port KISS client application. + * + * Global In: + * + * Description: Reads bytes from the KISS client app and + * sends them to kiss_rec_byte for processing. + * + *--------------------------------------------------------------------*/ + +static void * kisspt_listen_thread (void *arg) +{ + unsigned char ch; + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("kisspt_listen_thread ( %d )\n", fd); +#endif + + + while (1) { + ch = kisspt_get(); + kiss_rec_byte (&kf, ch, kisspt_debug, NULL, -1, kisspt_send_rec_packet); + } + + return (void *) 0; /* Unreachable but avoids compiler warning. */ +} + +#endif // Linux version + +/* end kiss.c */ diff --git a/src/kiss.h b/src/kiss.h new file mode 100644 index 00000000..1dc40daf --- /dev/null +++ b/src/kiss.h @@ -0,0 +1,24 @@ + +/* + * Name: kiss.h + * + * This is for the pseudo terminal KISS interface. + */ + + +#include "ax25_pad.h" /* for packet_t */ + +#include "config.h" + +#include "kiss_frame.h" // for struct kissport_status_s + + +void kisspt_init (struct misc_config_s *misc_config); + +void kisspt_send_rec_packet (int chan, int kiss_cmd, unsigned char *fbuf, int flen, + struct kissport_status_s *notused1, int notused2); + +void kisspt_set_debug (int n); + + +/* end kiss.h */ diff --git a/src/kiss_frame.c b/src/kiss_frame.c new file mode 100644 index 00000000..aa581dd2 --- /dev/null +++ b/src/kiss_frame.c @@ -0,0 +1,1023 @@ +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// +// Copyright (C) 2013, 2014, 2017, 2023 John Langner, WB2OSZ +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . +// + + + +/*------------------------------------------------------------------ + * + * Module: kiss_frame.c + * + * Purpose: Common code used by Serial port and network versions of KISS protocol. + * + * Description: The KISS TNC protocol is described in http://www.ka9q.net/papers/kiss.html + * + * ( An extended form, to handle multiple TNCs on a single serial port. + * Not applicable for our situation. http://he.fi/pub/oh7lzb/bpq/multi-kiss.pdf ) + * + * Briefly, a frame is composed of + * + * * FEND (0xC0) + * * Contents - with special escape sequences so a 0xc0 + * byte in the data is not taken as end of frame. + * as part of the data. + * * FEND + * + * The first byte of the frame contains: + * + * * radio channel in upper nybble. + * (KISS doc uses "port" but I don't like that because it has too many meanings.) + * * command in lower nybble. + * + * + * Commands from application tp TNC: + * + * _0 Data Frame AX.25 frame in raw format. + * + * _1 TXDELAY See explanation in xmit.c. + * + * _2 Persistence " " + * + * _3 SlotTime " " + * + * _4 TXtail " " + * Spec says it is obsolete but Xastir + * sends it and we respect it. + * + * _5 FullDuplex Full Duplex. Transmit immediately without + * waiting for channel to be clear. + * + * _6 SetHardware TNC specific. + * + * _C XKISS extension - not supported. + * _E XKISS extension - not supported. + * + * FF Return Exit KISS mode. Ignored. + * + * + * Messages sent to client application: + * + * _0 Data Frame Received AX.25 frame in raw format. + * + * _6 SetHardware TNC specific. + * Usually a response to a query. + * + *---------------------------------------------------------------*/ + +#include "direwolf.h" + +#include +#include +#include +#include +#include +#include + +#include "ax25_pad.h" +#include "textcolor.h" +#include "kiss_frame.h" +#include "tq.h" +#include "xmit.h" +#include "version.h" +#include "kissnet.h" + + +/* In server.c. Should probably move to some misc. function file. */ +void hex_dump (unsigned char *p, int len); + +#ifdef KISSUTIL +void hex_dump (unsigned char *p, int len) +{ + int n, i, offset; + + offset = 0; + while (len > 0) { + n = len < 16 ? len : 16; + // FIXME: Is there some reason not to use dw_printf here? + printf (" %03x: ", offset); + for (i=0; i + * <0x0d> + * XFLOW OFF<0x0d> + * FULLDUP OFF<0x0d> + * KISS ON<0x0d> + * RESTART<0x0d> + * <0x03><0x03><0x03> + * TC 1<0x0d> + * TN 2,0<0x0d><0x0d><0x0d> + * XFLOW OFF<0x0d> + * FULLDUP OFF<0x0d> + * KISS ON<0x0d> + * RESTART<0x0d> + * + * This keeps repeating over and over and over and over again if + * it doesn't get any sort of response. + * + * Let's try to keep it happy by sending back a command prompt. + */ + + + + +void kiss_rec_byte (kiss_frame_t *kf, unsigned char ch, int debug, + struct kissport_status_s *kps, int client, + void (*sendfun)(int chan, int kiss_cmd, unsigned char *fbuf, int flen, struct kissport_status_s *onlykps, int onlyclient)) +{ + + //dw_printf ("kiss_frame ( %c %02x ) \n", ch, ch); + + switch (kf->state) { + + case KS_SEARCHING: /* Searching for starting FEND. */ + default: + + if (ch == FEND) { + + /* Start of frame. But first print any collected noise for debugging. */ + + if (kf->noise_len > 0) { + if (debug) { + kiss_debug_print (FROM_CLIENT, "Rejected Noise", kf->noise, kf->noise_len); + } + kf->noise_len = 0; + } + + kf->kiss_len = 0; + kf->kiss_msg[kf->kiss_len++] = ch; + kf->state = KS_COLLECTING; + return; + } + + /* Noise to be rejected. */ + + if (kf->noise_len < MAX_NOISE_LEN) { + kf->noise[kf->noise_len++] = ch; + } + if (ch == '\r') { + if (debug) { + kiss_debug_print (FROM_CLIENT, "Rejected Noise", kf->noise, kf->noise_len); + kf->noise[kf->noise_len] = '\0'; + } + +#ifndef KISSUTIL + /* Try to appease client app by sending something back. */ + if (strcasecmp("restart\r", (char*)(kf->noise)) == 0 || + strcasecmp("reset\r", (char*)(kf->noise)) == 0) { + // first 2 parameters don't matter when length is -1 indicating text. + (*sendfun) (0, 0, (unsigned char *)"\xc0\xc0", -1, kps, client); + } + else { + (*sendfun) (0, 0, (unsigned char *)"\r\ncmd:", -1, kps, client); + } +#endif + kf->noise_len = 0; + } + return; + break; + + case KS_COLLECTING: /* Frame collection in progress. */ + + + if (ch == FEND) { + + unsigned char unwrapped[AX25_MAX_PACKET_LEN]; + int ulen; + + /* End of frame. */ + + if (kf->kiss_len == 0) { + /* Empty frame. Starting a new one. */ + kf->kiss_msg[kf->kiss_len++] = ch; + return; + } + if (kf->kiss_len == 1 && kf->kiss_msg[0] == FEND) { + /* Empty frame. Just go on collecting. */ + return; + } + + kf->kiss_msg[kf->kiss_len++] = ch; + if (debug) { + /* As received over the wire from client app. */ + kiss_debug_print (FROM_CLIENT, NULL, kf->kiss_msg, kf->kiss_len); + } + + ulen = kiss_unwrap (kf->kiss_msg, kf->kiss_len, unwrapped); + + if (debug >= 2) { + /* Append CRC to this and it goes out over the radio. */ + text_color_set(DW_COLOR_DEBUG); + dw_printf ("\n"); + dw_printf ("Packet content after removing KISS framing and any escapes:\n"); + /* Don't include the "type" indicator. */ + /* It contains the radio channel and type should always be 0 here. */ + hex_dump (unwrapped+1, ulen-1); + } + + kiss_process_msg (unwrapped, ulen, debug, kps, client, sendfun); + + kf->state = KS_SEARCHING; + return; + } + + if (kf->kiss_len < MAX_KISS_LEN) { + kf->kiss_msg[kf->kiss_len++] = ch; + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("KISS message exceeded maximum length.\n"); + } + return; + break; + } + + return; /* unreachable but suppress compiler warning. */ + +} /* end kiss_rec_byte */ + + + + +/*------------------------------------------------------------------- + * + * Name: kiss_process_msg + * + * Purpose: Process a message from the KISS client. + * + * Inputs: kiss_msg - Kiss frame with FEND and escapes removed. + * The first byte contains channel and command. + * + * kiss_len - Number of bytes including the command. + * + * debug - Debug option is selected. + * + * kps - Used only for TCP KISS. + * Should be NULL for pseudo terminal and serial port. + * + * client - Client app number for TCP KISS. + * Should be -1 for pseudo termal and serial port. + * + * sendfun - Function to send something to the client application. + * "Set Hardware" can send a response. + * + *-----------------------------------------------------------------*/ + +#ifndef KISSUTIL // All these ifdefs in here are a sign that this should be refactored. + // Should split this into multiple files. + // Some functions are only for the TNC end. + // Other functions are suitble for both TNC and client app. + +// This is used only by the TNC side. + +void kiss_process_msg (unsigned char *kiss_msg, int kiss_len, int debug, struct kissport_status_s *kps, int client, + void (*sendfun)(int chan, int kiss_cmd, unsigned char *fbuf, int flen, struct kissport_status_s *kps, int client)) +{ + int chan; + int cmd; + alevel_t alevel; + +// New in 1.7: +// We can have KISS TCP ports which convey only a single radio channel. +// This is to allow operation by applications which only know how to talk to single radio TNCs. + + if (kps != NULL && kps->chan != -1) { + // Ignore channel from KISS and substitute radio channel for that KISS TCP port. + chan = kps->chan; + } + else { + // Normal case of getting radio channel from the KISS frame. + chan = (kiss_msg[0] >> 4) & 0xf; + } + cmd = kiss_msg[0] & 0xf; + + switch (cmd) + { + case KISS_CMD_DATA_FRAME: /* 0 = Data Frame */ + + // kissnet_copy clobbers first byte but we don't care + // because we have already determined channel and command. + + kissnet_copy (kiss_msg, kiss_len, chan, cmd, kps, client); + + /* Note July 2017: There is a variant of of KISS, called SMACK, that assumes */ + /* a TNC can never have more than 8 channels. http://symek.de/g/smack.html */ + /* It uses the MSB to indicate that a checksum is added. I wonder if this */ + /* is why we sometimes hear about a request to transmit on channel 8. */ + /* Should we have a message that asks the user if SMACK is being used, */ + /* and if so, turn it off in the application configuration? */ + /* Our current default is a maximum of 6 channels but it is easily */ + /* increased by changing one number and recompiling. */ + +// Additional information, from Mike Playle, December 2018, for Issue #42 +// +// I came across this the other day with Xastir, and took a quick look. +// The problem is fixable without the kiss_frame.c hack, which doesn't help with Xastir anyway. +// +// Workaround +// +// After the kissattach command, put the interface into CRC mode "none" with a command like this: +// +// # kissparms -c 1 -p radio +// +// Analysis +// +// The source of this behaviour is the kernel's KISS implementation: +// +// https://elixir.bootlin.com/linux/v4.9/source/drivers/net/hamradio/mkiss.c#L489 +// +// It defaults to starting in state CRC_MODE_SMACK_TEST and ending up in mode CRC_NONE +// after the first two packets, which have their framing byte modified by this code in the process. +// It looks to me like deliberate behaviour on the kernel's part. +// +// Setting the CRC mode explicitly before sending any packets stops this state machine from running. +// +// Is this a bug? I don't know - that's up to you! Maybe it would make sense for Direwolf to set +// the CRC mode itself, or to expect this behaviour and ignore these flags on the first packets +// received from the Linux pty. +// +// This workaround seems sound to me, though, so perhaps this is just a documentation issue. + + +// Would it make sense to implement SMACK? I don't think so. +// Adding a checksum to the KISS data offers no benefit because it is very reliable. +// It violates the original protocol specification which states that 16 radio channels are possible. +// (Some times the term 'port' is used but I try to use 'channel' all the time because 'port' +// has too many other meanings. Serial port, TCP port, ...) +// SMACK imposes a limit of 8. That limit might have been OK back in 1991 but not now. +// There are people using more than 8 radio channels (using SDR not traditional radios) with direwolf. + + + /* Verify that the radio channel number is valid. */ + /* Any sort of medium should be OK here. */ + + if ((chan < 0 || chan >= MAX_CHANS || save_audio_config_p->chan_medium[chan] == MEDIUM_NONE) + && save_audio_config_p->chan_medium[chan] != MEDIUM_IGATE) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Invalid transmit channel %d from KISS client app.\n", chan); + dw_printf ("\n"); + dw_printf ("Are you using AX.25 for Linux? It might be trying to use a modified\n"); + dw_printf ("version of KISS which uses the channel field differently than the\n"); + dw_printf ("original KISS protocol specification. The solution might be to use\n"); + dw_printf ("a command like \"kissparms -c 1 -p radio\" to set CRC none mode.\n"); + dw_printf ("Another way of doing this is pre-loading the \"kiss\" kernel module with CRC disabled:\n"); + dw_printf ("sudo /sbin/modprobe -q mkiss crc_force=1\n"); + + dw_printf ("\n"); + text_color_set(DW_COLOR_DEBUG); + kiss_debug_print (FROM_CLIENT, NULL, kiss_msg, kiss_len); + return; + } + + memset (&alevel, 0xff, sizeof(alevel)); + packet_t pp = ax25_from_frame (kiss_msg+1, kiss_len-1, alevel); + if (pp == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("ERROR - Invalid KISS data frame from client app.\n"); + } + else { + + /* How can we determine if it is an original or repeated message? */ + /* If there is at least one digipeater in the frame, AND */ + /* that digipeater has been used, it should go out quickly thru */ + /* the high priority queue. */ + /* Otherwise, it is an original for the low priority queue. */ + + if (ax25_get_num_repeaters(pp) >= 1 && + ax25_get_h(pp,AX25_REPEATER_1)) { + tq_append (chan, TQ_PRIO_0_HI, pp); + } + else { + tq_append (chan, TQ_PRIO_1_LO, pp); + } + } + break; + + case KISS_CMD_TXDELAY: /* 1 = TXDELAY */ + + if (kiss_len < 2) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("KISS ERROR: Missing value for TXDELAY command.\n"); + return; + } + text_color_set(DW_COLOR_INFO); + dw_printf ("KISS protocol set TXDELAY = %d (*10mS units = %d mS), chan %d\n", kiss_msg[1], kiss_msg[1] * 10, chan); + if (kiss_msg[1] < 4 || kiss_msg[1] > 100) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Are you sure you want such an extreme value for TXDELAY?\n"); + dw_printf ("See \"Radio Channel - Transmit Timing\" section of User Guide for explanation.\n"); + } + xmit_set_txdelay (chan, kiss_msg[1]); + break; + + case KISS_CMD_PERSISTENCE: /* 2 = Persistence */ + + if (kiss_len < 2) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("KISS ERROR: Missing value for PERSISTENCE command.\n"); + return; + } + text_color_set(DW_COLOR_INFO); + dw_printf ("KISS protocol set Persistence = %d, chan %d\n", kiss_msg[1], chan); + if (kiss_msg[1] < 5 || kiss_msg[1] > 250) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Are you sure you want such an extreme value for PERSIST?\n"); + dw_printf ("See \"Radio Channel - Transmit Timing\" section of User Guide for explanation.\n"); + } + xmit_set_persist (chan, kiss_msg[1]); + break; + + case KISS_CMD_SLOTTIME: /* 3 = SlotTime */ + + if (kiss_len < 2) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("KISS ERROR: Missing value for SLOTTIME command.\n"); + return; + } + text_color_set(DW_COLOR_INFO); + dw_printf ("KISS protocol set SlotTime = %d (*10mS units = %d mS), chan %d\n", kiss_msg[1], kiss_msg[1] * 10, chan); + if (kiss_msg[1] < 2 || kiss_msg[1] > 50) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Are you sure you want such an extreme value for SLOTTIME?\n"); + dw_printf ("See \"Radio Channel - Transmit Timing\" section of User Guide for explanation.\n"); + } + xmit_set_slottime (chan, kiss_msg[1]); + break; + + case KISS_CMD_TXTAIL: /* 4 = TXtail */ + + if (kiss_len < 2) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("KISS ERROR: Missing value for TXTAIL command.\n"); + return; + } + text_color_set(DW_COLOR_INFO); + dw_printf ("KISS protocol set TXtail = %d (*10mS units = %d mS), chan %d\n", kiss_msg[1], kiss_msg[1] * 10, chan); + if (kiss_msg[1] < 2) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Setting TXTAIL so low is asking for trouble. You probably don't want to do this.\n"); + dw_printf ("See \"Radio Channel - Transmit Timing\" section of User Guide for explanation.\n"); + } + xmit_set_txtail (chan, kiss_msg[1]); + break; + + case KISS_CMD_FULLDUPLEX: /* 5 = FullDuplex */ + + if (kiss_len < 2) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("KISS ERROR: Missing value for FULLDUPLEX command.\n"); + return; + } + text_color_set(DW_COLOR_INFO); + dw_printf ("KISS protocol set FullDuplex = %d, chan %d\n", kiss_msg[1], chan); + xmit_set_fulldup (chan, kiss_msg[1]); + break; + + case KISS_CMD_SET_HARDWARE: /* 6 = TNC specific */ + + if (kiss_len < 2) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("KISS ERROR: Missing value for SET HARDWARE command.\n"); + return; + } + kiss_msg[kiss_len] = '\0'; + text_color_set(DW_COLOR_INFO); + dw_printf ("KISS protocol set hardware \"%s\", chan %d\n", (char*)(kiss_msg+1), chan); + kiss_set_hardware (chan, (char*)(kiss_msg+1), debug, kps, client, sendfun); + break; + + case KISS_CMD_END_KISS: /* 15 = End KISS mode, channel should be 15. */ + /* Ignore it. */ + text_color_set(DW_COLOR_INFO); + dw_printf ("KISS protocol end KISS mode - Ignored.\n"); + break; + + default: + text_color_set(DW_COLOR_ERROR); + dw_printf ("KISS Invalid command %d\n", cmd); + kiss_debug_print (FROM_CLIENT, NULL, kiss_msg, kiss_len); + + text_color_set(DW_COLOR_INFO); + dw_printf ("Troubleshooting tip:\n"); + dw_printf ("Use \"-d kn\" option on direwolf command line to observe\n"); + dw_printf ("all communication with the client application.\n"); + + if (cmd == XKISS_CMD_DATA || cmd == XKISS_CMD_POLL) { + dw_printf ("\n"); + dw_printf ("It looks like you are trying to use the \"XKISS\" protocol which is not supported.\n"); + dw_printf ("Change your application settings to use standard \"KISS\" rather than some other variant.\n"); + dw_printf ("If you are using Winlink Express, configure like this:\n"); + dw_printf (" Packet TNC Type: KISS\n"); + dw_printf (" Packet TNC Model: NORMAL -- Using ACKMODE will cause this error.\n"); + dw_printf ("\n"); + } + break; + } + +} /* end kiss_process_msg */ + +#endif // ifndef KISSUTIL + + +/*------------------------------------------------------------------- + * + * Name: kiss_set_hardware + * + * Purpose: Process the "set hardware" command. + * + * Inputs: chan - channel, 0 - 15. + * + * command - All but the first byte. e.g. "TXBUF:99" + * Case sensitive. + * Will be modified so be sure caller doesn't care. + * + * debug - debug level. + * + * client - Client app number for TCP KISS. + * Needed so we can send any response to the right client app. + * Ignored for pseudo terminal and serial port. + * + * sendfun - Function to send something to the client application. + * + * This is the tricky part. We can have any combination of + * serial port, pseudo terminal, and multiple TCP clients. + * We need to send the response to same place where query came + * from. The function is different for each class of device + * and we need a client number for the TCP case because we + * can have multiple TCP KISS clients at the same time. + * + * + * Description: This is new in version 1.5. "Set hardware" was previously ignored. + * + * There are times when the client app might want to send configuration + * commands, such as modem speed, to the KISS TNC or inquire about its + * current state. + * + * The immediate motivation for adding this is that one application wants + * to know how many frames are currently in the transmit queue. This can + * be used for throttling of large transmissions and performing some action + * after the last frame has been sent. + * + * The original KISS protocol spec offers no guidance on what "Set Hardware" might look + * like. I'm aware of only two, drastically different, implementations: + * + * fldigi - http://www.w1hkj.com/FldigiHelp-3.22/kiss_command_page.html + * + * Everything is in human readable in both directions: + * + * COMMAND: [ parameter [ , parameter ... ] ] + * + * Lack of a parameter, in the client to TNC direction, is a query + * which should generate a response in the same format. + * + * Used by applications, http://www.w1hkj.com/FldigiHelp/kiss_host_prgs_page.html + * - BPQ32 + * - UIChar + * - YAAC + * + * mobilinkd - https://raw.githubusercontent.com/mobilinkd/tnc1/tnc2/bertos/net/kiss.c + * + * Single byte with the command / response code, followed by + * zero or more value bytes. + * + * Used by applications: + * - APRSdroid + * + * It would be beneficial to adopt one of them rather than doing something + * completely different. It might even be possible to recognize both. + * This might allow leveraging of other existing applications. + * + * Let's start with the easy to understand human readable format. + * + * Commands: (Client to TNC, with parameter(s) to set something.) + * + * none yet + * + * Queries: (Client to TNC, no parameters, generate a response.) + * + * Query Response Comment + * ----- -------- ------- + * + * TNC: TNC:DIREWOLF 9.9 9.9 represents current version. + * + * TXBUF: TXBUF:999 Number of bytes (not frames) in transmit queue. + * + *--------------------------------------------------------------------*/ + +#ifndef KISSUTIL + +static void kiss_set_hardware (int chan, char *command, int debug, struct kissport_status_s *kps, int client, + void (*sendfun)(int chan, int kiss_cmd, unsigned char *fbuf, int flen, struct kissport_status_s *onlykps, int onlyclient)) +{ + char *param; + char response[100]; + + param = strchr (command, ':'); + if (param != NULL) { + *param = '\0'; + param++; + + if (strcmp(command, "TNC") == 0) { /* TNC - Identify software version. */ + + if (strlen(param) > 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("KISS Set Hardware TNC: Did not expect a parameter.\n"); + } + + snprintf (response, sizeof(response), "DIREWOLF %d.%d", MAJOR_VERSION, MINOR_VERSION); + (*sendfun) (chan, KISS_CMD_SET_HARDWARE, (unsigned char *)response, strlen(response), kps, client); + } + + else if (strcmp(command, "TXBUF") == 0) { /* TXBUF - Number of bytes in transmit queue. */ + + if (strlen(param) > 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("KISS Set Hardware TXBUF: Did not expect a parameter.\n"); + } + + int n = tq_count (chan, -1, "", "", 1); + snprintf (response, sizeof(response), "TXBUF:%d", n); + (*sendfun) (chan, KISS_CMD_SET_HARDWARE, (unsigned char *)response, strlen(response), kps, client); + } + + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("KISS Set Hardware unrecognized command: %s.\n", command); + } + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("KISS Set Hardware \"%s\" expected the form COMMAND:[parameter[,parameter...]]\n", command); + } + return; + +} /* end kiss_set_hardware */ + +#endif // ifndef KISSUTIL + + +/*------------------------------------------------------------------- + * + * Name: kiss_debug_print + * + * Purpose: Print message to/from client for debugging. + * + * Inputs: fromto - Direction of message. + * special - Comment if not a KISS frame. + * pmsg - Address of the message block. + * msg_len - Length of the message. + * + *--------------------------------------------------------------------*/ + + +void kiss_debug_print (fromto_t fromto, char *special, unsigned char *pmsg, int msg_len) +{ +#ifndef KISSUTIL + const char *direction [2] = { "from", "to" }; + const char *prefix [2] = { "<<<", ">>>" }; + const char *function[16] = { + "Data frame", "TXDELAY", "P", "SlotTime", + "TXtail", "FullDuplex", "SetHardware", "Invalid 7", + "Invalid 8", "Invalid 9", "Invalid 10", "Invalid 11", + "Invalid 12", "Invalid 13", "Invalid 14", "Return" }; +#endif + + text_color_set(DW_COLOR_DEBUG); + +#ifdef KISSUTIL + dw_printf ("From KISS TNC:\n"); +#else + dw_printf ("\n"); + if (special == NULL) { + unsigned char *p; /* to skip over FEND if present. */ + + p = pmsg; + if (*p == FEND) p++; + + dw_printf ("%s %s %s KISS client application, channel %d, total length = %d\n", + prefix[(int)fromto], function[p[0] & 0xf], direction[(int)fromto], + (p[0] >> 4) & 0xf, msg_len); + } + else { + dw_printf ("%s %s %s KISS client application, total length = %d\n", + prefix[(int)fromto], special, direction[(int)fromto], + msg_len); + } +#endif + hex_dump (pmsg, msg_len); + +} /* end kiss_debug_print */ + + +#endif + +#endif /* DECAMAIN */ + +/* Quick unit test for encapsulate & unwrap */ + +// $ gcc -DKISSTEST kiss_frame.c ; ./a +// Quick KISS test passed OK. + + +#if KISSTEST + + +int main () +{ + unsigned char din[512]; + unsigned char kissed[520]; + unsigned char dout[520]; + int klen; + int dlen; + int k; + + for (k = 0; k < 512; k++) { + if (k < 256) { + din[k] = k; + } + else { + din[k] = 511 - k; + } + } + + klen = kiss_encapsulate (din, 512, kissed); + assert (klen == 512 + 6); + + dlen = kiss_unwrap (kissed, klen, dout); + assert (dlen == 512); + assert (memcmp(din, dout, 512) == 0); + + dlen = kiss_unwrap (kissed+1, klen-1, dout); + assert (dlen == 512); + assert (memcmp(din, dout, 512) == 0); + + dw_printf ("Quick KISS test passed OK.\n"); + exit (EXIT_SUCCESS); +} + +#endif /* KISSTEST */ + +#endif /* WALK96 */ + +/* end kiss_frame.c */ diff --git a/src/kiss_frame.h b/src/kiss_frame.h new file mode 100644 index 00000000..941f5c01 --- /dev/null +++ b/src/kiss_frame.h @@ -0,0 +1,126 @@ + +/* kiss_frame.h */ + +#ifndef KISS_FRAME_H +#define KISS_FRAME_H + + +#include "audio.h" /* for struct audio_s */ + + +/* + * The first byte of a KISS frame has: + * channel in upper nybble. + * command in lower nybble. + */ + +#define KISS_CMD_DATA_FRAME 0 +#define KISS_CMD_TXDELAY 1 +#define KISS_CMD_PERSISTENCE 2 +#define KISS_CMD_SLOTTIME 3 +#define KISS_CMD_TXTAIL 4 +#define KISS_CMD_FULLDUPLEX 5 +#define KISS_CMD_SET_HARDWARE 6 +#define XKISS_CMD_DATA 12 // Not supported. http://he.fi/pub/oh7lzb/bpq/multi-kiss.pdf +#define XKISS_CMD_POLL 14 // Not supported. +#define KISS_CMD_END_KISS 15 + + + +/* + * Special characters used by SLIP protocol. + */ + +#define FEND 0xC0 +#define FESC 0xDB +#define TFEND 0xDC +#define TFESC 0xDD + + + +enum kiss_state_e { + KS_SEARCHING = 0, /* Looking for FEND to start KISS frame. */ + /* Must be 0 so we can simply zero whole structure to initialize. */ + KS_COLLECTING}; /* In process of collecting KISS frame. */ + + +#define MAX_KISS_LEN 2048 /* Spec calls for at least 1024. */ + /* Might want to make it longer to accommodate */ + /* maximum packet length. */ + +#define MAX_NOISE_LEN 100 + +typedef struct kiss_frame_s { + + enum kiss_state_e state; + + unsigned char kiss_msg[MAX_KISS_LEN]; + /* Leading FEND is optional. */ + /* Contains escapes and ending FEND. */ + int kiss_len; + + unsigned char noise[MAX_NOISE_LEN]; + int noise_len; + +} kiss_frame_t; + + +// This is used only for TCPKISS but it put in kissnet.h, +// there would be a circular dependency between the two header files. +// Each KISS TCP port has its own status block. + +struct kissport_status_s { + + struct kissport_status_s *pnext; // To next in list. + + volatile int arg2; // temp for passing second arg into + // kissnet_listen_thread + + int tcp_port; // default 8001 + + int chan; // Radio channel for this tcp port. + // -1 for all. + + // The default is a limit of 3 client applications at the same time. + // You can increase the limit by changing the line below. + // A larger number consumes more resources so don't go crazy by making it larger than needed. + // TODO: Should this be moved to direwolf.h so max number of audio devices + // client apps are in the same place? + +#define MAX_NET_CLIENTS 3 + + int client_sock[MAX_NET_CLIENTS]; + /* File descriptor for socket for */ + /* communication with client application. */ + /* Set to -1 if not connected. */ + /* (Don't use SOCKET type because it is unsigned.) */ + + kiss_frame_t kf[MAX_NET_CLIENTS]; + /* Accumulated KISS frame and state of decoder. */ +}; + + + +#ifndef KISSUTIL +void kiss_frame_init (struct audio_s *pa); +#endif + +int kiss_encapsulate (unsigned char *in, int ilen, unsigned char *out); + +int kiss_unwrap (unsigned char *in, int ilen, unsigned char *out); + +void kiss_rec_byte (kiss_frame_t *kf, unsigned char ch, int debug, struct kissport_status_s *kps, int client, + void (*sendfun)(int chan, int kiss_cmd, unsigned char *fbuf, int flen, struct kissport_status_s *onlykps, int onlyclient)); + +typedef enum fromto_e { FROM_CLIENT=0, TO_CLIENT=1 } fromto_t; + +void kiss_process_msg (unsigned char *kiss_msg, int kiss_len, int debug, struct kissport_status_s *kps, int client, + void (*sendfun)(int chan, int kiss_cmd, unsigned char *fbuf, int flen, struct kissport_status_s *onlykps, int onlyclient)); + +void kiss_debug_print (fromto_t fromto, char *special, unsigned char *pmsg, int msg_len); + + +#endif // KISS_FRAME_H + + +/* end kiss_frame.h */ diff --git a/src/kissnet.c b/src/kissnet.c new file mode 100644 index 00000000..97094a08 --- /dev/null +++ b/src/kissnet.c @@ -0,0 +1,994 @@ +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// Copyright (C) 2011-2014, 2015, 2017, 2021 John Langner, WB2OSZ +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . +// + + +/*------------------------------------------------------------------ + * + * Module: kissnet.c + * + * Purpose: Provide service to other applications via KISS protocol via TCP socket. + * + * Input: + * + * Outputs: + * + * Description: This provides a TCP socket for communication with a client application. + * + * It implements the KISS TNS protocol as described in: + * http://www.ka9q.net/papers/kiss.html + * + * Briefly, a frame is composed of + * + * * FEND (0xC0) + * * Contents - with special escape sequences so a 0xc0 + * byte in the data is not taken as end of frame. + * as part of the data. + * * FEND + * + * The first byte of the frame contains: + * + * * port number in upper nybble. + * * command in lower nybble. + * + * + * Commands from application recognized: + * + * _0 Data Frame AX.25 frame in raw format. + * + * _1 TXDELAY See explanation in xmit.c. + * + * _2 Persistence " " + * + * _3 SlotTime " " + * + * _4 TXtail " " + * Spec says it is obsolete but Xastir + * sends it and we respect it. + * + * _5 FullDuplex Ignored. + * + * _6 SetHardware TNC specific. + * + * FF Return Exit KISS mode. Ignored. + * + * + * Messages sent to client application: + * + * _0 Data Frame Received AX.25 frame in raw format. + * + * + * + * + * References: Getting Started with Winsock + * http://msdn.microsoft.com/en-us/library/windows/desktop/bb530742(v=vs.85).aspx + * + * Future: Originally we had: + * KISS over serial port. + * AGW over socket. + * This is the two of them munged together and we end up with duplicate code. + * It would have been better to separate out the transport and application layers. + * Maybe someday. + * + *---------------------------------------------------------------*/ + +/* + Separate TCP ports per radio: + +An increasing number of people are using multiple radios. +direwolf is capable of handling many radio channels and +provides cross-band repeating, etc. +Maybe a single stereo audio interface is used for 2 radios. + + +------------+ tcp 8001, all channels +Radio A -------- | | -------------------------- Application A + | direwolf | +Radio B -------- | | -------------------------- Application B + +------------+ tcp 8001, all channels + +The KISS protocol has a 4 bit field for the TNC port (which I prefer to +call channel because port has too many different meanings). +direwolf handles this fine. However, most applications were written assuming +that a TNC could only talk to a single radio. On reception, they ignore the +channel in the KISS frame. For transmit, the channel is always set to 0. + +Many people are using the work-around of two separate instances of direwolf. + + +------------+ tcp 8001, KISS ch 0 +Radio A -------- | direwolf | -------------------------- Application A + +------------+ + + +------------+ tcp 8002, KISS ch 0 +Radio B -------- | direwolf | -------------------------- Application B + +------------+ + + +Or they might be using a single application that knows how to talk to multiple +single port TNCs. But they don't know how to multiplex multiple channels +thru a single KISS stream. + + +------------+ tcp 8001, KISS ch 0 +Radio A -------- | direwolf | ------------------------ + +------------+ \ + -- Application + +------------+ tcp 8002, KISS ch 0 / +Radio B -------- | direwolf | ------------------------ + +------------+ + +Using two different instances of direwolf means more complex configuration +and loss of cross-channel digipeating. It is possible to use a stereo +audio interface but some ALSA magic is required to make it look like two +independent virtual mono interfaces. + +In version 1.7, we add the capability of multiple KISS TCP ports, each for +a single radio channel. e.g. + +KISSPORT 8001 1 +KISSPORT 8002 2 + +Now can use a single instance of direwolf. + + + +------------+ tcp 8001, KISS ch 0 +Radio A -------- | | -------------------------- Application A + | direwolf | +Radio B -------- | | -------------------------- Application B + +------------+ tcp 8002, KISS ch 0 + +When receiving, the KISS channel is set to 0. + - only radio channel 1 would be sent over tcp port 8001. + - only radio channel 2 would be sent over tcp port 8001. + +When transmitting, the KISS channel is ignored. + - frames from tcp port 8001 are transmitted on radio channel 1. + - frames from tcp port 8002 are transmitted on radio channel 2. + +Of course, you could also use an application, capable of connecting to +multiple single radio TNCs. Separate TCP ports actually go to the +same direwolf instance. + +*/ + + +/* + * Native Windows: Use the Winsock interface. + * Linux: Use the BSD socket interface. + */ + + +#include "direwolf.h" // Sets _WIN32_WINNT for XP API level needed by ws2tcpip.h + + +#if __WIN32__ +#include +#include // _WIN32_WINNT must be set to 0x0501 before including this +#else +#include +#include +#include +#include +#include +#include +#endif + +#include +#include +#include +#include +#include + + +#include "tq.h" +#include "ax25_pad.h" +#include "textcolor.h" +#include "audio.h" +#include "kissnet.h" +#include "kiss_frame.h" +#include "xmit.h" + +void hex_dump (unsigned char *p, int len); // This should be in a .h file. + + + + + +// TODO: define in one place, use everywhere. +#if __WIN32__ +#define THREAD_F unsigned __stdcall +#else +#define THREAD_F void * +#endif + +static THREAD_F connect_listen_thread (void *arg); +static THREAD_F kissnet_listen_thread (void *arg); + + +static struct misc_config_s *s_misc_config_p; + + +// Each TCP port has its own status block. +// There is a variable number so use a linked list. + +static struct kissport_status_s *all_ports = NULL; + +static int kiss_debug = 0; /* Print information flowing from and to client. */ + +void kiss_net_set_debug (int n) +{ + kiss_debug = n; +} + + + +/*------------------------------------------------------------------- + * + * Name: kissnet_init + * + * Purpose: Set up a server to listen for connection requests from + * an application such as Xastir or APRSIS32. + * This is called once from the main program. + * + * Inputs: mc->kiss_port - TCP port for server. + * 0 means disable. New in version 1.2. + * + * Outputs: + * + * Description: This starts two threads: + * * to listen for a connection from client app. + * * to listen for commands from client app. + * so the main application doesn't block while we wait for these. + * + *--------------------------------------------------------------------*/ + +static void kissnet_init_one (struct kissport_status_s *kps); + +void kissnet_init (struct misc_config_s *mc) +{ + s_misc_config_p = mc; + + for (int i = 0; i < MAX_KISS_TCP_PORTS; i++) { + if (mc->kiss_port[i] != 0) { + struct kissport_status_s *kps = calloc(sizeof(struct kissport_status_s), 1); + if (kps == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("FATAL ERROR: Out of memory.\n"); + exit (EXIT_FAILURE); + } + + kps->tcp_port = mc->kiss_port[i]; + kps->chan = mc->kiss_chan[i]; + kissnet_init_one (kps); + + // Add to list. + kps->pnext = all_ports; + all_ports = kps; + } + } +} + + +static void kissnet_init_one (struct kissport_status_s *kps) +{ + int client; + +#if __WIN32__ + HANDLE connect_listen_th; + HANDLE cmd_listen_th[MAX_NET_CLIENTS]; +#else + pthread_t connect_listen_tid; + pthread_t cmd_listen_tid[MAX_NET_CLIENTS]; + int e; +#endif + + + + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("kissnet_init ( tcp port %d, radio chan = %d )\n", kps->tcp_port, kps->chan); +#endif + + + for (client=0; clientclient_sock[client] = -1; + memset (&(kps->kf[client]), 0, sizeof(kps->kf[client])); + } + + if (kps->tcp_port == 0) { + text_color_set(DW_COLOR_INFO); + dw_printf ("Disabled KISS network client port.\n"); + return; + } + +/* + * This waits for a client to connect and sets client_sock[n]. + */ +#if __WIN32__ + connect_listen_th = (HANDLE)_beginthreadex (NULL, 0, connect_listen_thread, (void *)kps, 0, NULL); + if (connect_listen_th == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Could not create KISS socket connect listening thread for tcp port %d, radio chan %d\n", kps->tcp_port, kps->chan); + return; + } +#else + e = pthread_create (&connect_listen_tid, NULL, connect_listen_thread, (void *)kps); + if (e != 0) { + text_color_set(DW_COLOR_ERROR); + perror("Could not create KISS socket connect listening thread"); + dw_printf ("for tcp port %d, radio chan %d\n", kps->tcp_port, kps->chan); + return; + } +#endif + +/* + * These read messages from client when client_sock[n] is valid. + * Currently we start up a separate thread for each potential connection. + * Possible later refinement. Start one now, others only as needed. + */ + for (client = 0; client < MAX_NET_CLIENTS; client++) { + + kps->arg2 = client; + +#if __WIN32__ + cmd_listen_th[client] = (HANDLE)_beginthreadex (NULL, 0, kissnet_listen_thread, (void*)kps, 0, NULL); + if (cmd_listen_th[client] == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Could not create KISS command listening thread for client %d\n", client); + return; + } +#else + e = pthread_create (&(cmd_listen_tid[client]), NULL, kissnet_listen_thread, (void *)kps); + if (e != 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Could not create KISS command listening thread for client %d\n", client); + // Replace add perror with better message handling. + perror(""); + return; + } +#endif + // Wait for new thread to get content of arg2 before reusing it for the next thread create. + + int timer = 0; + while (kps->arg2 >= 0) { + SLEEP_MS(10); + timer++; + if (timer > 100) { // 1 second - thread did not start + text_color_set(DW_COLOR_ERROR); + dw_printf ("KISS data listening thread did not start for tcp port %d, client slot %d\n", kps->tcp_port, client); + kps->arg2 = -1; // Keep moving along. + } + } + } +} + + +/*------------------------------------------------------------------- + * + * Name: connect_listen_thread + * + * Purpose: Wait for a connection request from an application. + * + * Inputs: arg - KISS port status block. + * + * Outputs: client_sock - File descriptor for communicating with client app. + * + * Description: Wait for connection request from client and establish + * communication. + * Note that the client can go away and come back again and + * re-establish communication without restarting this application. + * + *--------------------------------------------------------------------*/ + +static THREAD_F connect_listen_thread (void *arg) +{ + struct kissport_status_s *kps = arg; + +#if __WIN32__ + + struct addrinfo hints; + struct addrinfo *ai = NULL; + int err; + char tcp_port_str[12]; + + SOCKET listen_sock; + WSADATA wsadata; + + snprintf (tcp_port_str, sizeof(tcp_port_str), "%d", kps->tcp_port); +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("DEBUG: kissnet port = %d = '%s'\n", (int)(ptrdiff_t)arg, tcp_port_str); +#endif + err = WSAStartup (MAKEWORD(2,2), &wsadata); + if (err != 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf("WSAStartup failed: %d\n", err); + return (0); + } + + if (LOBYTE(wsadata.wVersion) != 2 || HIBYTE(wsadata.wVersion) != 2) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Could not find a usable version of Winsock.dll\n"); + WSACleanup(); + //sleep (1); + return (0); + } + + memset (&hints, 0, sizeof(hints)); + hints.ai_family = AF_INET; + hints.ai_socktype = SOCK_STREAM; + hints.ai_protocol = IPPROTO_TCP; + hints.ai_flags = AI_PASSIVE; + + err = getaddrinfo(NULL, tcp_port_str, &hints, &ai); + if (err != 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf("getaddrinfo failed: %d\n", err); + //sleep (1); + WSACleanup(); + return (0); + } + + listen_sock= socket(ai->ai_family, ai->ai_socktype, ai->ai_protocol); + if (listen_sock == INVALID_SOCKET) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("connect_listen_thread: Socket creation failed, err=%d", WSAGetLastError()); + return (0); + } + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf("Binding to port %s ... \n", tcp_port_str); +#endif + + err = bind( listen_sock, ai->ai_addr, (int)ai->ai_addrlen); + if (err == SOCKET_ERROR) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Bind failed with error: %d\n", WSAGetLastError()); // TODO: provide corresponding text. + dw_printf("Some other application is probably already using port %s.\n", tcp_port_str); + dw_printf("Try using a different port number with KISSPORT in the configuration file.\n"); + freeaddrinfo(ai); + closesocket(listen_sock); + WSACleanup(); + return (0); + } + + freeaddrinfo(ai); + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf("opened KISS socket as fd (%d) on port (%s) for stream i/o\n", listen_sock, tcp_port_str ); +#endif + + while (1) { + + int client; + int c; + + client = -1; + for (c = 0; c < MAX_NET_CLIENTS && client < 0; c++) { + if (kps->client_sock[c] <= 0) { + client = c; + } + } + +/* + * Listen for connection if we have not reached maximum. + */ + if (client >= 0) { + + if(listen(listen_sock, MAX_NET_CLIENTS) == SOCKET_ERROR) + { + text_color_set(DW_COLOR_ERROR); + dw_printf("Listen failed with error: %d\n", WSAGetLastError()); + return (0); + } + + text_color_set(DW_COLOR_INFO); + if (kps->chan == -1) { + dw_printf("Ready to accept KISS TCP client application %d on port %s ...\n", client, tcp_port_str); + } + else { + dw_printf("Ready to accept KISS TCP client application %d on port %s (radio channel %d) ...\n", client, tcp_port_str, kps->chan); + } + + kps->client_sock[client] = accept(listen_sock, NULL, NULL); + + if (kps->client_sock[client] == -1) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Accept failed with error: %d\n", WSAGetLastError()); + closesocket(listen_sock); + WSACleanup(); + return (0); + } + + text_color_set(DW_COLOR_INFO); + if (kps->chan == -1) { + dw_printf("\nAttached to KISS TCP client application %d on port %s ...\n\n", client, tcp_port_str); + } + else { + dw_printf("\nAttached to KISS TCP client application %d on port %s (radio channel %d) ...\n\n", client, tcp_port_str, kps->chan); + } + + // Reset the state and buffer. + memset (&(kps->kf[client]), 0, sizeof(kps->kf[client])); + } + else { + SLEEP_SEC(1); /* wait then check again if more clients allowed. */ + } + } + + +#else /* End of Windows case, now Linux / Unix / Mac OSX. */ + + + struct sockaddr_in sockaddr; /* Internet socket address struct */ + socklen_t sockaddr_size = sizeof(struct sockaddr_in); + int listen_sock; + int bcopt = 1; + + listen_sock= socket(AF_INET,SOCK_STREAM,0); + if (listen_sock == -1) { + text_color_set(DW_COLOR_ERROR); + perror ("connect_listen_thread: Socket creation failed"); + return (NULL); + } + + /* Version 1.3 - as suggested by G8BPQ. */ + /* Without this, if you kill the application then try to run it */ + /* again quickly the port number is unavailable for a while. */ + /* Don't try doing the same thing On Windows; It has a different meaning. */ + /* http://stackoverflow.com/questions/14388706/socket-options-so-reuseaddr-and-so-reuseport-how-do-they-differ-do-they-mean-t */ + + setsockopt (listen_sock, SOL_SOCKET, SO_REUSEADDR, (const char *)&bcopt, 4); + + sockaddr.sin_addr.s_addr = INADDR_ANY; + sockaddr.sin_port = htons(kps->tcp_port); + sockaddr.sin_family = AF_INET; + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf("Binding to port %d ... \n", kps->tcp_port); +#endif + + if (bind(listen_sock,(struct sockaddr*)&sockaddr,sizeof(sockaddr)) == -1) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Bind failed with error: %d\n", errno); + dw_printf("%s\n", strerror(errno)); + dw_printf("Some other application is probably already using port %d.\n", kps->tcp_port); + dw_printf("Try using a different port number with KISSPORT in the configuration file.\n"); + return (NULL); + } + + getsockname( listen_sock, (struct sockaddr *)(&sockaddr), &sockaddr_size); + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf("opened KISS TCP socket as fd (%d) on port (%d) for stream i/o\n", listen_sock, ntohs(sockaddr.sin_port) ); +#endif + + while (1) { + + int client; + int c; + + client = -1; + for (c = 0; c < MAX_NET_CLIENTS && client < 0; c++) { + if (kps->client_sock[c] <= 0) { + client = c; + } + } + + if (client >= 0) { + + if(listen(listen_sock,MAX_NET_CLIENTS) == -1) + { + text_color_set(DW_COLOR_ERROR); + perror ("connect_listen_thread: Listen failed"); + return (NULL); + } + + text_color_set(DW_COLOR_INFO); + if (kps->chan == -1) { + dw_printf("Ready to accept KISS TCP client application %d on port %d ...\n", client, kps->tcp_port); + } + else { + dw_printf("Ready to accept KISS TCP client application %d on port %d (radio channel %d) ...\n", client, kps->tcp_port, kps->chan); + } + + kps->client_sock[client] = accept(listen_sock, (struct sockaddr*)(&sockaddr),&sockaddr_size); + + text_color_set(DW_COLOR_INFO); + if (kps->chan == -1) { + dw_printf("\nAttached to KISS TCP client application %d on port %d ...\n\n", client, kps->tcp_port); + } + else { + dw_printf("\nAttached to KISS TCP client application %d on port %d (radio channel %d) ...\n\n", client, kps->tcp_port, kps->chan); + } + + // Reset the state and buffer. + memset (&(kps->kf[client]), 0, sizeof(kps->kf[client])); + } + else { + SLEEP_SEC(1); /* wait then check again if more clients allowed. */ + } + } +#endif +} + + + + + +/*------------------------------------------------------------------- + * + * Name: kissnet_send_rec_packet + * + * Purpose: Send a packet, received over the radio, to the client app. + * + * Inputs: chan - Channel number where packet was received. + * 0 = first, 1 = second if any. + * +// TODO: add kiss_cmd + * + * fbuf - Address of raw received frame buffer + * or a text string. + * + * kiss_cmd - Usually KISS_CMD_DATA_FRAME but we can also have + * KISS_CMD_SET_HARDWARE when responding to a query. + * + * flen - Number of bytes for AX.25 frame. + * When called from kiss_rec_byte, flen will be -1 + * indicating a text string rather than frame content. + * This is used to fake out an application that thinks + * it is using a traditional TNC and tries to put it + * into KISS mode. + * + * onlykps - KISS TCP status block pointer or NULL. + * + * onlyclient - It is possible to have more than client attached + * at the same time with TCP KISS. + * Starting with version 1.7 we can have multiple TCP ports. + * When a frame is received from the radio we normally want it + * to go to all of the clients. + * In this case specify NULL for onlykps and -1 tcp client. + * When responding to a command from the client, we want + * to send only to that one client app. In this case + * a non NULL kps and onlyclient >= 0. + * + * Description: Send message to client(s) if connected. + * Disconnect from client, and notify user, if any error. + * + *--------------------------------------------------------------------*/ + +void kissnet_send_rec_packet (int chan, int kiss_cmd, unsigned char *fbuf, int flen, + struct kissport_status_s *onlykps, int onlyclient) +{ + unsigned char kiss_buff[2 * AX25_MAX_PACKET_LEN]; + int kiss_len; + int err; + +// Something received over the radio would normally be sent to all attached clients. +// However, there are times we want to send a response only to a particular client. +// In the case of a serial port or pseudo terminal, there is only one potential client. +// so the response would be sent to only one place. A new parameter has been added for this. + + for (struct kissport_status_s *kps = all_ports; kps != NULL; kps = kps->pnext) { + + if (onlykps == NULL || kps == onlykps) { + + for (int client = 0; client < MAX_NET_CLIENTS; client++) { + + if (onlyclient == -1 || client == onlyclient) { + + if (kps->client_sock[client] != -1) { + + if (flen < 0) { + +// A client app might think it is attached to a traditional TNC. +// It might try sending commands over and over again trying to get the TNC into KISS mode. +// We recognize this attempt and send it something to keep it happy. + + text_color_set(DW_COLOR_ERROR); + dw_printf ("KISS TCP: Something unexpected from client application.\n"); + dw_printf ("Is client app treating this like an old TNC with command mode?\n"); + dw_printf ("This can be caused by the application sending commands to put a\n"); + dw_printf ("traditional TNC into KISS mode. It is usually a harmless warning.\n"); + dw_printf ("For best results, configure for a KISS-only TNC to avoid this.\n"); + dw_printf ("In the case of APRSISCE/32, use \"Simply(KISS)\" rather than \"KISS.\"\n"); + + flen = strlen((char*)fbuf); + if (kiss_debug) { + kiss_debug_print (TO_CLIENT, "Fake command prompt", fbuf, flen); + } + strlcpy ((char *)kiss_buff, (char *)fbuf, sizeof(kiss_buff)); + kiss_len = strlen((char *)kiss_buff); + } + else { + unsigned char stemp[AX25_MAX_PACKET_LEN + 1]; + + assert (flen < (int)(sizeof(stemp))); + + // New in 1.7. + // Previously all channels were sent to everyone. + // We now have tcp ports which carry only a single radio channel. + // The application will see KISS channel 0 regardless of the radio channel. + + if (kps->chan == -1) { + // Normal case, all channels. + stemp[0] = (chan << 4) | kiss_cmd; + } + else if (kps->chan == chan) { + // Single radio channel for this port. Application sees 0. + stemp[0] = (0 << 4) | kiss_cmd; + } + else { + // Skip it. + continue; + } + + memcpy (stemp+1, fbuf, flen); + + if (kiss_debug >= 2) { + /* AX.25 frame with the CRC removed. */ + text_color_set(DW_COLOR_DEBUG); + dw_printf ("\n"); + dw_printf ("Packet content before adding KISS framing and any escapes:\n"); + hex_dump (fbuf, flen); + } + + kiss_len = kiss_encapsulate (stemp, flen+1, kiss_buff); + + /* This has the escapes and the surrounding FENDs. */ + + if (kiss_debug) { + kiss_debug_print (TO_CLIENT, NULL, kiss_buff, kiss_len); + } + } + +#if __WIN32__ + err = SOCK_SEND(kps->client_sock[client], (char*)kiss_buff, kiss_len); + if (err == SOCKET_ERROR) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("\nError %d sending message to KISS client application %d on port %d. Closing connection.\n\n", WSAGetLastError(), client, kps->tcp_port); + closesocket (kps->client_sock[client]); + kps->client_sock[client] = -1; + WSACleanup(); + } +#else + err = SOCK_SEND (kps->client_sock[client], kiss_buff, kiss_len); + if (err <= 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("\nError %d sending message to KISS client application %d on port %d. Closing connection.\n\n", err, client, kps->tcp_port); + close (kps->client_sock[client]); + kps->client_sock[client] = -1; + } +#endif + } // frame length >= 0 + } // if all clients or the one specifie + } // for each client on the tcp port + } // if all ports or the one specified + } // for each tcp port + +} /* end kissnet_send_rec_packet */ + + +/*------------------------------------------------------------------- + * + * Name: kissnet_copy + * + * Purpose: Send data from one network KISS client to all others. + * + * Inputs: in_msg - KISS frame data without the framing or escapes. + * The first byte is channel and command (should be data). + * Caller no longer cares this byte. We will clobber it here. + * + * in_len - Number of bytes in above. + * + * chan - Channel. Use this instead of first byte of in_msg. + * + * cmd - KISS command nybble. + * Should be 0 because I'm expecting this only for data. + * + * from_client - Number of network (TCP) client instance. + * Should be 0, 1, 2, ... + * + * + * Global In: kiss_copy - From misc. configuration. + * This enables the feature. + * + * + * Description: Send message to any attached network KISS clients, other than the one where it came from. + * Enable this by putting KISSCOPY in the configuration file. + * Note that this applies only to network (TCP) KISS clients, not serial port, or pseudo terminal. + * + * + *--------------------------------------------------------------------*/ + + +void kissnet_copy (unsigned char *in_msg, int in_len, int chan, int cmd, struct kissport_status_s *from_kps, int from_client) +{ + unsigned char kiss_buff[2 * AX25_MAX_PACKET_LEN]; + int err; + + + if (s_misc_config_p->kiss_copy) { + + for (struct kissport_status_s *kps = all_ports; kps != NULL; kps = kps->pnext) { + + for (int client = 0; client < MAX_NET_CLIENTS; client++) { + + if ( ! ( kps == from_kps && client == from_client ) ) { // To all but origin. + + if (kps->client_sock[client] != -1) { + + if (kps-> chan == -1 || kps->chan == chan) { + + // Two different cases here: + // - The TCP port allows all channels, or + // - The TCP port allows only one channel. In this case set KISS channel to 0. + + if (kps->chan == -1) { + in_msg[0] = (chan << 4) | cmd; + } + else { + in_msg[0] = 0 | cmd; // set channel to zero. + } + + int kiss_len = kiss_encapsulate (in_msg, in_len, kiss_buff); + + /* This has the escapes and the surrounding FENDs. */ + + if (kiss_debug) { + kiss_debug_print (TO_CLIENT, NULL, kiss_buff, kiss_len); + } + +#if __WIN32__ + err = SOCK_SEND(kps->client_sock[client], (char*)kiss_buff, kiss_len); + if (err == SOCKET_ERROR) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("\nError %d copying message to KISS TCP port %d client %d application. Closing connection.\n\n", WSAGetLastError(), kps->tcp_port, client); + closesocket (kps->client_sock[client]); + kps->client_sock[client] = -1; + WSACleanup(); + } +#else + err = SOCK_SEND (kps->client_sock[client], kiss_buff, kiss_len); + if (err <= 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("\nError copying message to KISS TCP port %d client %d application. Closing connection.\n\n", kps->tcp_port, client); + close (kps->client_sock[client]); + kps->client_sock[client] = -1; + } +#endif + } // Channel is allowed on this port. + } // socket is open + } // if origin and destination different. + } // loop over all KISS network clients for one port. + } // loop over all KISS TCP ports + } // Feature enabled. + +} /* end kissnet_copy */ + + + +/*------------------------------------------------------------------- + * + * Name: kissnet_listen_thread + * + * Purpose: Wait for KISS messages from an application. + * + * Inputs: arg - client number, 0 .. MAX_NET_CLIENTS-1 + * + * Outputs: client_sock[n] - File descriptor for communicating with client app. + * + * Description: Process messages from the client application. + * Note that the client can go away and come back again and + * re-establish communication without restarting this application. + * + *--------------------------------------------------------------------*/ + + +/* Return one byte (value 0 - 255) */ + + +static int kiss_get (struct kissport_status_s *kps, int client) +{ + + while (1) { + + while (kps->client_sock[client] <= 0) { + SLEEP_SEC(1); /* Not connected. Try again later. */ + } + + /* Just get one byte at a time. */ + + unsigned char ch; + int n = SOCK_RECV (kps->client_sock[client], (char *)(&ch), 1); + + if (n == 1) { +#if DEBUG9 + dw_printf (log_fp, "%02x %c %c", ch, + isprint(ch) ? ch : '.' , + (isupper(ch>>1) || isdigit(ch>>1) || (ch>>1) == ' ') ? (ch>>1) : '.'); + if (ch == FEND) fprintf (log_fp, " FEND"); + if (ch == FESC) fprintf (log_fp, " FESC"); + if (ch == TFEND) fprintf (log_fp, " TFEND"); + if (ch == TFESC) fprintf (log_fp, " TFESC"); + if (ch == '\r') fprintf (log_fp, " CR"); + if (ch == '\n') fprintf (log_fp, " LF"); + fprintf (log_fp, "\n"); + if (ch == FEND) fflush (log_fp); +#endif + return(ch); + } + + text_color_set(DW_COLOR_ERROR); + dw_printf ("\nKISS client application %d on TCP port %d has gone away.\n\n", client, kps->tcp_port); +#if __WIN32__ + closesocket (kps->client_sock[client]); +#else + close (kps->client_sock[client]); +#endif + kps->client_sock[client] = -1; + } +} + + + +static THREAD_F kissnet_listen_thread (void *arg) +{ + struct kissport_status_s *kps = arg; + + int client = kps->arg2; + assert (client >= 0 && client < MAX_NET_CLIENTS); + + kps->arg2 = -1; // Indicates thread is running so + // arg2 can be reused for the next one. + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("kissnet_listen_thread ( tcp_port = %d, client = %d, socket fd = %d )\n", kps->tcp_port, client, kps->client_sock[client]); +#endif + + + +// So why is kissnet_send_rec_packet mentioned here for incoming from the client app? +// The logic exists for the serial port case where the client might think it is +// attached to a traditional TNC. It might try sending commands over and over again +// trying to get the TNC into KISS mode. To keep it happy, we recognize this attempt +// and send it something to keep it happy. +// In the case of a serial port or pseudo terminal, there is only one potential client +// so the response would be sent to only one place. +// Starting in version 1.5, this now can have multiple attached clients. We wouldn't +// want to send the response to all of them. Actually, we should be providing only +// "Simply KISS" as some call it. + + + while (1) { + unsigned char ch = kiss_get(kps, client); + kiss_rec_byte (&(kps->kf[client]), ch, kiss_debug, kps, client, kissnet_send_rec_packet); + } + +#if __WIN32__ + return(0); +#else + return (THREAD_F) 0; /* Unreachable but avoids compiler warning. */ +#endif + +} /* end kissnet_listen_thread */ + +/* end kissnet.c */ diff --git a/src/kissnet.h b/src/kissnet.h new file mode 100644 index 00000000..469e4e63 --- /dev/null +++ b/src/kissnet.h @@ -0,0 +1,29 @@ + +/* + * Name: kissnet.h + */ + +#ifndef KISSNET_H +#define KISSNET_H + +#include "ax25_pad.h" /* for packet_t */ + +#include "config.h" + +#include "kiss_frame.h" + + + +void kissnet_init (struct misc_config_s *misc_config); + +void kissnet_send_rec_packet (int chan, int kiss_cmd, unsigned char *fbuf, int flen, + struct kissport_status_s *onlykps, int onlyclient); + +void kiss_net_set_debug (int n); + +void kissnet_copy (unsigned char *kiss_msg, int kiss_len, int chan, int cmd, struct kissport_status_s *from_kps, int from_client); + + +#endif // KISSNET_H + +/* end kissnet.h */ diff --git a/src/kissserial.c b/src/kissserial.c new file mode 100644 index 00000000..1ee5356a --- /dev/null +++ b/src/kissserial.c @@ -0,0 +1,503 @@ +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// +// Copyright (C) 2011, 2013, 2014, 2016, 2017 John Langner, WB2OSZ +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . +// + + +/*------------------------------------------------------------------ + * + * Module: kissserial.c + * + * Purpose: Act as a virtual KISS TNC for use by other packet radio applications. + * This file provides the service by good old fashioned serial port. + * Other files implement a pseudo terminal or TCP KISS interface. + * + * Description: This implements the KISS TNC protocol as described in: + * http://www.ka9q.net/papers/kiss.html + * + * Briefly, a frame is composed of + * + * * FEND (0xC0) + * * Contents - with special escape sequences so a 0xc0 + * byte in the data is not taken as end of frame. + * as part of the data. + * * FEND + * + * The first byte of the frame contains: + * + * * port number in upper nybble. + * * command in lower nybble. + * + * Commands from application recognized: + * + * _0 Data Frame AX.25 frame in raw format. + * + * _1 TXDELAY See explanation in xmit.c. + * + * _2 Persistence " " + * + * _3 SlotTime " " + * + * _4 TXtail " " + * Spec says it is obsolete but Xastir + * sends it and we respect it. + * + * _5 FullDuplex Ignored. + * + * _6 SetHardware TNC specific. + * + * FF Return Exit KISS mode. Ignored. + * + * + * Messages sent to client application: + * + * _0 Data Frame Received AX.25 frame in raw format. + * + * + * Platform differences: + * + * This file implements KISS over a serial port. + * It should behave pretty much the same for both Windows and Linux. + * + * When running a client application on Windows, two applications + * can be connected together using a a "Null-modem emulator" + * such as com0com from http://sourceforge.net/projects/com0com/ + * + * (When running a client application, on the same host, with Linux, + * a pseudo terminal can be used for old applications. More modern + * applications will generally have AGW and/or KISS over TCP.) + * + * + * version 1.5: Split out from kiss.c, simplified, consistent for Windows and Linux. + * Add polling option for use with Bluetooth. + * + *---------------------------------------------------------------*/ + +#include "direwolf.h" + +#include +#include +#include +#include +#include +#include + + +#include "ax25_pad.h" +#include "textcolor.h" +#include "serial_port.h" +#include "kissserial.h" +#include "kiss_frame.h" +#include "xmit.h" + + +/* + * Save Configuration for later use. + */ + +static struct misc_config_s *g_misc_config_p; + +/* + * Accumulated KISS frame and state of decoder. + */ + +static kiss_frame_t kf; + + +/* + * The serial port device handle. + * MYFD... are defined in kissserial.h + */ + +static MYFDTYPE serialport_fd = MYFDERROR; + + + + +// TODO: define in one place, use everywhere. +#if __WIN32__ +#define THREAD_F unsigned __stdcall +#else +#define THREAD_F void * +#endif + +static THREAD_F kissserial_listen_thread (void *arg); + + +static int kissserial_debug = 0; /* Print information flowing from and to client. */ + +void kissserial_set_debug (int n) +{ + kissserial_debug = n; +} + + +/* In server.c. Should probably move to some misc. function file. */ + +void hex_dump (unsigned char *p, int len); + + + + +/*------------------------------------------------------------------- + * + * Name: kissserial_init + * + * Purpose: Set up a serial port acting as a virtual KISS TNC. + * + * Inputs: mc-> + * kiss_serial_port - Name of device for real or virtual serial port. + * kiss_serial_speed - Speed, bps, or 0 meaning leave it alone. + * kiss_serial_poll - When non-zero, poll each n seconds to see if + * device has appeared. + * + * Outputs: + * + * Description: (1) Open file descriptor for the device. + * (2) Start a new thread to listen for commands from client app + * so the main application doesn't block while we wait. + * + *--------------------------------------------------------------------*/ + + +void kissserial_init (struct misc_config_s *mc) +{ + +#if __WIN32__ + HANDLE kissserial_listen_th; +#else + pthread_t kissserial_listen_tid; + int e; +#endif + + g_misc_config_p = mc; + + memset (&kf, 0, sizeof(kf)); + + + if (strlen(g_misc_config_p->kiss_serial_port) > 0) { + + if (g_misc_config_p->kiss_serial_poll == 0) { + + // Normal case, try to open the serial port at start up time. + + serialport_fd = serial_port_open (g_misc_config_p->kiss_serial_port, g_misc_config_p->kiss_serial_speed); + + if (serialport_fd != MYFDERROR) { + text_color_set(DW_COLOR_INFO); + dw_printf ("Opened %s for serial port KISS.\n", g_misc_config_p->kiss_serial_port); + } + else { + // An error message was already displayed. + } + } + else { + + // Polling case. Defer until read and device not opened. + text_color_set(DW_COLOR_INFO); + dw_printf ("Will be checking periodically for %s\n", g_misc_config_p->kiss_serial_port); + } + + if (g_misc_config_p->kiss_serial_poll != 0 || serialport_fd != MYFDERROR) { +#if __WIN32__ + kissserial_listen_th = (HANDLE)_beginthreadex (NULL, 0, kissserial_listen_thread, NULL, 0, NULL); + if (kissserial_listen_th == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Could not create kiss serial thread\n"); + return; + } +#else + e = pthread_create (&kissserial_listen_tid, NULL, kissserial_listen_thread, NULL); + if (e != 0) { + text_color_set(DW_COLOR_ERROR); + perror("Could not create kiss serial thread."); + } +#endif + } + } + + +#if DEBUG + text_color_set (DW_COLOR_DEBUG); + + dw_printf ("end of kiss_init: serialport_fd = %d, polling = %d\n", serialport_fd, g_misc_config_p->kiss_serial_poll); +#endif +} + + + + +/*------------------------------------------------------------------- + * + * Name: kissserial_send_rec_packet + * + * Purpose: Send a received packet or text string to the client app. + * + * Inputs: chan - Channel number where packet was received. + * 0 = first, 1 = second if any. + * + * kiss_cmd - Usually KISS_CMD_DATA_FRAME but we can also have + * KISS_CMD_SET_HARDWARE when responding to a query. + * + * pp - Identifier for packet object. + * + * fbuf - Address of raw received frame buffer + * or a text string. + * + * flen - Length of raw received frame not including the FCS + * or -1 for a text string. + * + * kps + * client - Not used for serial port version. + * Here so that 3 related functions all have + * the same parameter list. + * + * Description: Send message to client. + * We really don't care if anyone is listening or not. + * I don't even know if we can find out. + * + *--------------------------------------------------------------------*/ + + +void kissserial_send_rec_packet (int chan, int kiss_cmd, unsigned char *fbuf, int flen, + struct kissport_status_s *notused1, int notused2) +{ + unsigned char kiss_buff[2 * AX25_MAX_PACKET_LEN + 2]; + int kiss_len; + int err; + + +/* + * Quietly discard if we don't have open connection. + */ + if (serialport_fd == MYFDERROR) { + return; + } + + if (flen < 0) { + flen = strlen((char*)fbuf); + if (kissserial_debug) { + kiss_debug_print (TO_CLIENT, "Fake command prompt", fbuf, flen); + } + strlcpy ((char *)kiss_buff, (char *)fbuf, sizeof(kiss_buff)); + kiss_len = strlen((char *)kiss_buff); + } + else { + + unsigned char stemp[AX25_MAX_PACKET_LEN + 1]; + + if (flen > (int)(sizeof(stemp)) - 1) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("\nSerial Port KISS buffer too small. Truncated.\n\n"); + flen = (int)(sizeof(stemp)) - 1; + } + + stemp[0] = (chan << 4) | kiss_cmd; + memcpy (stemp+1, fbuf, flen); + + if (kissserial_debug >= 2) { + /* AX.25 frame with the CRC removed. */ + text_color_set(DW_COLOR_DEBUG); + dw_printf ("\n"); + dw_printf ("Packet content before adding KISS framing and any escapes:\n"); + hex_dump (fbuf, flen); + } + + kiss_len = kiss_encapsulate (stemp, flen+1, kiss_buff); + + /* This has KISS framing and escapes for sending to client app. */ + + if (kissserial_debug) { + kiss_debug_print (TO_CLIENT, NULL, kiss_buff, kiss_len); + } + } + +/* + * This write can block on Windows if using the virtual null modem + * and nothing is connected to the other end. + * The solution is found in the com0com ReadMe file: + * + * Q. My application hangs during its startup when it sends anything to one paired + * COM port. The only way to unhang it is to start HyperTerminal, which is connected + * to the other paired COM port. I didn't have this problem with physical serial + * ports. + * A. Your application can hang because receive buffer overrun is disabled by + * default. You can fix the problem by enabling receive buffer overrun for the + * receiving port. Also, to prevent some flow control issues you need to enable + * baud rate emulation for the sending port. So, if your application use port CNCA0 + * and other paired port is CNCB0, then: + * + * 1. Launch the Setup Command Prompt shortcut. + * 2. Enter the change commands, for example: + * + * command> change CNCB0 EmuOverrun=yes + * command> change CNCA0 EmuBR=yes + */ + + err = serial_port_write (serialport_fd, (char*)kiss_buff, kiss_len); + + if (err != kiss_len) + { + text_color_set(DW_COLOR_ERROR); + dw_printf ("\nError sending KISS message to client application thru serial port.\n\n"); + serial_port_close (serialport_fd); + serialport_fd = MYFDERROR; + } + +} /* kissserial_send_rec_packet */ + + + +/*------------------------------------------------------------------- + * + * Name: kissserial_get + * + * Purpose: Read one byte from the KISS client app. + * + * Global In: serialport_fd + * + * Returns: one byte (value 0 - 255) or terminate thread on error. + * + * Description: There is room for improvement here. Reading one byte + * at a time is inefficient. We could read a large block + * into a local buffer and return a byte from that most of the time. + * Is it worth the effort? I don't know. With GHz processors and + * the low data rate here it might not make a noticeable difference. + * + *--------------------------------------------------------------------*/ + + +static int kissserial_get (void) +{ + int ch; // normally 0-255 but -1 for error. + + + if (g_misc_config_p->kiss_serial_poll == 0) { +/* + * Normal case, was opened at start up time. + */ + ch = serial_port_get1 (serialport_fd); + + if (ch < 0) { + + text_color_set(DW_COLOR_ERROR); + dw_printf ("\nSerial Port KISS read error. Closing connection.\n\n"); + serial_port_close (serialport_fd); + serialport_fd = MYFDERROR; +#if __WIN32__ + ExitThread (0); +#else + pthread_exit (NULL); +#endif + } + +#if DEBUGx + text_color_set(DW_COLOR_DEBUG); + dw_printf ("kissserial_get(%d) returns 0x%02x\n", fd, ch); +#endif + return (ch); + } + +/* + * Polling case. Wait until device is present and open. + */ + while (1) { + + if (serialport_fd != MYFDERROR) { + + // Open, try to read. + + ch = serial_port_get1 (serialport_fd); + + if (ch >= 0) { + return (ch); + } + + text_color_set(DW_COLOR_ERROR); + dw_printf ("\nSerial Port KISS read error. Closing connection.\n\n"); + serial_port_close (serialport_fd); + serialport_fd = MYFDERROR; + } + else { + + // Not open. Wait for it to appear and try opening. + + struct stat buf; + + SLEEP_SEC (g_misc_config_p->kiss_serial_poll); + + if (stat(g_misc_config_p->kiss_serial_port, &buf) == 0) { + + // It's there now. Try to open. + + serialport_fd = serial_port_open (g_misc_config_p->kiss_serial_port, g_misc_config_p->kiss_serial_speed); + + if (serialport_fd != MYFDERROR) { + text_color_set(DW_COLOR_INFO); + dw_printf ("\nOpened %s for serial port KISS.\n\n", g_misc_config_p->kiss_serial_port); + + memset (&kf, 0, sizeof(kf)); // Start with clean state. + } + else { + // An error message was already displayed. + } + } + } + } + +} /* end kissserial_get */ + + + +/*------------------------------------------------------------------- + * + * Name: kissserial_listen_thread + * + * Purpose: Read messages from serial port KISS client application. + * + * Global In: serialport_fd + * + * Description: Reads bytes from the serial port KISS client app and + * sends them to kiss_rec_byte for processing. + * kiss_rec_byte is a common function used by all 3 KISS + * interfaces: serial port, pseudo terminal, and TCP. + * + *--------------------------------------------------------------------*/ + + +static THREAD_F kissserial_listen_thread (void *arg) +{ + unsigned char ch; + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("kissserial_listen_thread ( %d )\n", fd); +#endif + + while (1) { + ch = kissserial_get(); + kiss_rec_byte (&kf, ch, kissserial_debug, NULL, -1, kissserial_send_rec_packet); + } + +#if __WIN32__ + return(0); +#else + return (THREAD_F) 0; /* Unreachable but avoids compiler warning. */ +#endif +} + +/* end kissserial.c */ diff --git a/src/kissserial.h b/src/kissserial.h new file mode 100644 index 00000000..44fb3c3f --- /dev/null +++ b/src/kissserial.h @@ -0,0 +1,23 @@ + +/* + * Name: kissserial.h + */ + + +#include "ax25_pad.h" /* for packet_t */ + +#include "config.h" + +#include "kiss_frame.h" + + +void kissserial_init (struct misc_config_s *misc_config); + +void kissserial_send_rec_packet (int chan, int kiss_cmd, unsigned char *fbuf, int flen, + struct kissport_status_s *notused1, int notused2); + + +void kissserial_set_debug (int n); + + +/* end kissserial.h */ diff --git a/src/kissutil.c b/src/kissutil.c new file mode 100644 index 00000000..fcd86088 --- /dev/null +++ b/src/kissutil.c @@ -0,0 +1,955 @@ +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// +// Copyright (C) 2017 John Langner, WB2OSZ +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . +// + + +/*------------------------------------------------------------------ + * + * Module: kissutil.c + * + * Purpose: Utility for talking to a KISS TNC. + * + * Description: Convert between KISS format and usual text representation. + * This might also serve as the starting point for an application + * that uses a KISS TNC. + * The TNC can be attached by TCP or a serial port. + * + * Usage: kissutil [ options ] + * + * Default is to connect to localhost:8001. + * See the "usage" functions at the bottom for details. + * + *---------------------------------------------------------------*/ + +#include "direwolf.h" // Sets _WIN32_WINNT for XP API level needed by ws2tcpip.h + +#if __WIN32__ + +#include +#include // _WIN32_WINNT must be set to 0x0501 before including this + +#else + +#include +#include +#include +#include + +#endif + +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include "ax25_pad.h" +#include "textcolor.h" +#include "serial_port.h" +#include "kiss_frame.h" +#include "dwsock.h" +#include "audio.h" // for DEFAULT_TXDELAY, etc. +#include "dtime_now.h" + + +// TODO: define in one place, use everywhere. +#if __WIN32__ +#define THREAD_F unsigned __stdcall +#else +#define THREAD_F void * +#endif + +#if __WIN32__ +#define DIR_CHAR "\\" +#else +#define DIR_CHAR "/" +#endif + +static THREAD_F tnc_listen_net (void *arg); +static THREAD_F tnc_listen_serial (void *arg); + +static void send_to_kiss_tnc (int chan, int cmd, char *data, int dlen); +static void hex_dump (unsigned char *p, int len); + +static void usage(void); +static void usage2(void); + + + + +/* Obtained from the command line. */ + +static char hostname[50] = "localhost"; /* -h option. */ + /* DNS host name or IPv4 address. */ + /* Some of the code is there for IPv6 but */ + /* it needs more work. */ + /* Defaults to "localhost" if not specified. */ + +static char port[30] = "8001"; /* -p option. */ + /* If it begins with a digit, it is considered */ + /* a TCP port number at the hostname. */ + /* Otherwise, we treat it as a serial port name. */ + +static int using_tcp = 1; /* Are we using TCP or serial port for TNC? */ + /* Use corresponding one of the next two. */ + /* This is derived from the first character of port. */ + +static int server_sock = -1; /* File descriptor for socket interface. */ + /* Set to -1 if not used. */ + /* (Don't use SOCKET type because it is unsigned.) */ + +static MYFDTYPE serial_fd = (MYFDTYPE)(-1); /* Serial port handle. */ + +static int serial_speed = 9600; /* -s option. */ + /* Serial port speed, bps. */ + +static int verbose = 0; /* -v option. */ + /* Display the KISS protocol in hexadecimal for troubleshooting. */ + +static char transmit_from[120] = ""; /* -f option */ + /* When specified, files are read from this directory */ + /* rather than using stdin. Each file is one or more */ + /* lines in the standard monitoring format. */ + +static char receive_output[120] = ""; /* -o option */ + /* When specified, each received frame is stored as a file */ + /* with a unique name here. */ + /* Directory must already exist; we won't create it. */ + +static char timestamp_format[60] = ""; /* -T option */ + /* Precede received frames with timestamp. */ + /* Command line option uses "strftime" format string. */ + + +#if __WIN32__ +#define THREAD_F unsigned __stdcall +#else +#define THREAD_F void * +#endif + +#if __WIN32__ + static HANDLE tnc_th; +#else + static pthread_t tnc_tid; +#endif + +static void process_input (char *stuff); + +/* Trim any CR, LF from the end of line. */ + +static void trim (char *stuff) +{ + char *p; + p = stuff + strlen(stuff) - 1; + while (strlen(stuff) > 0 && (*p == '\r' || *p == '\n')) { + *p = '\0'; + p--; + } +} /* end trim */ + + +/*------------------------------------------------------------------ + * + * Name: main + * + * Purpose: Attach to KISS TNC and exchange information. + * + * Usage: See "usage" functions at end. + * + *---------------------------------------------------------------*/ + +int main (int argc, char *argv[]) +{ + text_color_init (0); // Turn off text color. + // It could interfere with trying to pipe stdout to some other application. + +#if __WIN32__ + +#else + int e; + setlinebuf (stdout); // TODO: What is the Windows equivalent? +#endif + + +/* + * Extract command line args. + */ + while (1) { + int option_index = 0; + int c; + static struct option long_options[] = { + //{"future1", 1, 0, 0}, + //{"future2", 0, 0, 0}, + //{"future3", 1, 0, 'c'}, + {0, 0, 0, 0} + }; + + /* ':' following option character means arg is required. */ + + c = getopt_long(argc, argv, "h:p:s:vf:o:T:", + long_options, &option_index); + if (c == -1) + break; + + switch (c) { + + case 'h': /* -h for hostname. */ + strlcpy (hostname, optarg, sizeof(hostname)); + break; + + case 'p': /* -p for port, either TCP or serial device. */ + strlcpy (port, optarg, sizeof(port)); + break; + + case 's': /* -s for serial port speed. */ + serial_speed = atoi(optarg); + break; + + case 'v': /* -v for verbose. */ + verbose++; + break; + + case 'f': /* -f for transmit files directory. */ + strlcpy (transmit_from, optarg, sizeof(transmit_from)); + break; + + case 'o': /* -o for receive output directory. */ + strlcpy (receive_output, optarg, sizeof(receive_output)); + break; + + case 'T': /* -T for receive timestamp. */ + strlcpy (timestamp_format, optarg, sizeof(timestamp_format)); + break; + + case '?': + /* Unknown option message was already printed. */ + usage (); + break; + + default: + /* Should not be here. */ + text_color_set(DW_COLOR_DEBUG); + dw_printf("?? getopt returned character code 0%o ??\n", c); + usage (); + } + } /* end while(1) for options */ + + if (optind < argc) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Warning: Unused command line arguments are ignored.\n"); + } + +/* + * If receive queue directory was specified, make sure that it exists. + */ + if (strlen(receive_output) > 0) { + struct stat s; + + if (stat(receive_output, &s) == 0) { + if ( ! S_ISDIR(s.st_mode)) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Receive queue location, %s, is not a directory.\n", receive_output); + exit (EXIT_FAILURE); + } + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Receive queue location, %s, does not exist.\n", receive_output); + exit (EXIT_FAILURE); + } + } + +/* If port begins with digit, consider it to be TCP. */ +/* Otherwise, treat as serial port name. */ + + using_tcp = isdigit(port[0]); + +#if __WIN32__ + if (using_tcp) { + tnc_th = (HANDLE)_beginthreadex (NULL, 0, tnc_listen_net, (void *)(ptrdiff_t)99, 0, NULL); + } + else { + tnc_th = (HANDLE)_beginthreadex (NULL, 0, tnc_listen_serial, (void *)99, 0, NULL); + } + if (tnc_th == NULL) { + printf ("Internal error: Could not create TNC listen thread.\n"); + exit (EXIT_FAILURE); + } +#else + if (using_tcp) { + e = pthread_create (&tnc_tid, NULL, tnc_listen_net, (void *)(ptrdiff_t)99); + } + else { + e = pthread_create (&tnc_tid, NULL, tnc_listen_serial, (void *)(ptrdiff_t)99); + } + if (e != 0) { + perror("Internal error: Could not create TNC listen thread."); + exit (EXIT_FAILURE); + } +#endif + +// Give the threads a little while to open the TNC connection before trying to use it. +// This was a problem when the transmit queue already existed when starting up. + + SLEEP_MS (500); + +/* + * Process keyboard or other input source. + */ + char stuff[AX25_MAX_PACKET_LEN]; + + if (strlen(transmit_from) > 0) { +/* + * Process and delete all files in specified directory. + * When done, sleep for a second and try again. + * This doesn't take them in any particular order. + * A future enhancement might sort by name or timestamp. + */ + while (1) { + DIR *dp; + struct dirent *ep; + + //text_color_set(DW_COLOR_DEBUG); + //dw_printf("Get directory listing...\n"); + + dp = opendir (transmit_from); + if (dp != NULL) { + while ((ep = readdir(dp)) != NULL) { + char path [300]; + FILE *fp; + if (ep->d_name[0] == '.') + continue; + + text_color_set(DW_COLOR_DEBUG); + dw_printf ("Processing %s for transmit...\n", ep->d_name); + strlcpy (path, transmit_from, sizeof(path)); + strlcat (path, DIR_CHAR, sizeof(path)); + strlcat (path, ep->d_name, sizeof(path)); + fp = fopen (path, "r"); + if (fp != NULL) { + while (fgets(stuff, sizeof(stuff), fp) != NULL) { + trim (stuff); + text_color_set(DW_COLOR_DEBUG); + dw_printf ("%s\n", stuff); + // TODO: Don't delete file if errors encountered? + process_input (stuff); + } + fclose (fp); + unlink (path); + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf("Can't open for read: %s\n", path); + } + } + closedir (dp); + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf("Can't access transmit queue directory %s. Quitting.\n", transmit_from); + exit (EXIT_FAILURE); + } + SLEEP_SEC (1); + } + } + else { +/* + * Using stdin. + */ + while (fgets(stuff, sizeof(stuff), stdin) != NULL) { + process_input (stuff); + } + } + + return (EXIT_SUCCESS); + +} /* end main */ + + + +/*------------------------------------------------------------------- + * + * Name: process_input + * + * Purpose: Process frames/commands from user, either interactively or from files. + * + * Inputs: stuff - A frame is in usual format like SOURCE>DEST,DIGI:whatever. + * Commands begin with lower case letter. + * Note that it can be modified by this function. + * + * Later Enhancement: Return success/fail status. The transmit queue processing might want + * to preserve files that were not processed as expected. + * + *--------------------------------------------------------------------*/ + +static int parse_number (char *str, int de_fault) +{ + int n; + + while (isspace(*str)) { + str++; + } + if (strlen(str) == 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Missing number for KISS command. Using default %d.\n", de_fault); + return (de_fault); + } + n = atoi(str); + if (n < 0 || n > 255) { // must fit in a byte. + text_color_set(DW_COLOR_ERROR); + dw_printf ("Number for KISS command is out of range 0-255. Using default %d.\n", de_fault); + return (de_fault); + } + return (n); +} + +static void process_input (char *stuff) +{ + char *p; + int chan = 0; + +/* + * Remove any end of line character(s). + */ + trim (stuff); + +/* + * Optional prefix, like "[9]" or "[99]" to specify channel. + */ + p = stuff; + while (isspace(*p)) p++; + if (*p == '[') { + p++; + if (p[1] == ']') { + chan = atoi(p); + p += 2; + } + else if (p[2] == ']') { + chan = atoi(p); + p += 3; + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("ERROR! One or two digit channel number and ] was expected after [ at beginning of line.\n"); + usage2(); + return; + } + if (chan < 0 || chan > 15) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("ERROR! KISS channel number must be in range of 0 thru 15.\n"); + usage2(); + return; + } + while (isspace(*p)) p++; + } + +/* + * If it starts with upper case letter or digit, assume it is an AX.25 frame in monitor format. + * Lower case is a command (e.g. Persistence or set Hardware). + * Anything else, print explanation of what is expected. + */ + if (isupper(*p) || isdigit(*p)) { + + // Parse the "TNC2 monitor format" and convert to AX.25 frame. + + unsigned char frame_data[AX25_MAX_PACKET_LEN]; + packet_t pp = ax25_from_text (p, 1); + if (pp != NULL) { + int frame_len = ax25_pack (pp, frame_data); + send_to_kiss_tnc (chan, KISS_CMD_DATA_FRAME, (char*)frame_data, frame_len); + ax25_delete (pp); + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("ERROR! Could not convert to AX.25 frame: %s\n", p); + } + } + else if (islower(*p)) { + char value; + + switch (*p) { + case 'd': // txDelay, 10ms units + value = parse_number(p+1, DEFAULT_TXDELAY); + send_to_kiss_tnc (chan, KISS_CMD_TXDELAY, &value, 1); + break; + case 'p': // Persistence + value = parse_number(p+1, DEFAULT_PERSIST); + send_to_kiss_tnc (chan, KISS_CMD_PERSISTENCE, &value, 1); + break; + case 's': // Slot time, 10ms units + value = parse_number(p+1, DEFAULT_SLOTTIME); + send_to_kiss_tnc (chan, KISS_CMD_SLOTTIME, &value, 1); + break; + case 't': // txTail, 10ms units + value = parse_number(p+1, DEFAULT_TXTAIL); + send_to_kiss_tnc (chan, KISS_CMD_TXTAIL, &value, 1); + break; + case 'f': // Full duplex + value = parse_number(p+1, 0); + send_to_kiss_tnc (chan, KISS_CMD_FULLDUPLEX, &value, 1); + break; + case 'h': // set Hardware + p++; + while (*p != '\0' && isspace(*p)) { p++; } + send_to_kiss_tnc (chan, KISS_CMD_SET_HARDWARE, p, strlen(p)); + break; + default: + text_color_set(DW_COLOR_ERROR); + dw_printf ("Invalid command. Must be one of d p s t f h.\n"); + usage2 (); + break; + } + } + else { + usage2 (); + } + +} /* end process_input */ + + + + +/*------------------------------------------------------------------- + * + * Name: send_to_kiss_tnc + * + * Purpose: Encapsulate the data/command, into a KISS frame, and send to the TNC. + * + * Inputs: chan - channel number. + * + * cmd - KISS_CMD_DATA_FRAME, KISS_CMD_SET_HARDWARE, etc. + * + * data - Information for KISS frame. + * + * dlen - Number of bytes in data. + * + * Description: Encapsulate as KISS frame and send to TNC. + * + *--------------------------------------------------------------------*/ + +static void send_to_kiss_tnc (int chan, int cmd, char *data, int dlen) +{ + unsigned char temp[AX25_MAX_PACKET_LEN]; // We don't limit to 256 info bytes. + unsigned char kissed[AX25_MAX_PACKET_LEN*2]; + int klen; + + if (chan < 0 || chan > 15) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("ERROR - Invalid channel %d - must be in range 0 to 15.\n", chan); + chan = 0; + } + if (cmd < 0 || cmd > 15) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("ERROR - Invalid command %d - must be in range 0 to 15.\n", cmd); + cmd = 0; + } + if (dlen < 0 || dlen > (int)(sizeof(temp)-1)) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("ERROR - Invalid data length %d - must be in range 0 to %d.\n", dlen, (int)(sizeof(temp)-1)); + dlen = sizeof(temp)-1; + } + + temp[0] = (chan << 4) | cmd; + memcpy (temp+1, data, dlen); + + klen = kiss_encapsulate(temp, dlen+1, kissed); + + if (verbose) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("Sending to KISS TNC:\n"); + hex_dump (kissed, klen); + } + + if (using_tcp) { + int rc = SOCK_SEND(server_sock, (char*)kissed, klen); + if (rc != klen) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("ERROR writing KISS frame to socket.\n"); + } + } + else { + int rc = serial_port_write (serial_fd, (char*)kissed, klen); + if (rc != klen) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("ERROR writing KISS frame to serial port.\n"); + //dw_printf ("DEBUG wanted %d, got %d\n", klen, rc); + } + } + +} /* end send_to_kiss_tnc */ + + +/*------------------------------------------------------------------- + * + * Name: tnc_listen_net + * + * Purpose: Connect to KISS TNC via TCP port. + * Print everything it sends to us. + * + * Inputs: arg - Currently not used. + * + * Global In: host + * port + * + * Global Out: server_sock - Needed to send to the TNC. + * + *--------------------------------------------------------------------*/ + +static THREAD_F tnc_listen_net (void *arg) +{ + int err; + char ipaddr_str[DWSOCK_IPADDR_LEN]; // Text form of IP address. + char data[4096]; + int allow_ipv6 = 0; // Maybe someday. + int debug = 0; + int client = 0; // Not used in this situation. + kiss_frame_t kstate; + + memset (&kstate, 0, sizeof(kstate)); + + err = dwsock_init (); + if (err < 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Network interface failure. Can't go on.\n"); + exit (EXIT_FAILURE); + } + +/* + * Connect to network KISS TNC. + */ + // For the IGate we would loop around and try to reconnect if the TNC + // goes away. We should probably do the same here. + + server_sock = dwsock_connect (hostname, port, "TCP KISS TNC", allow_ipv6, debug, ipaddr_str); + + if (server_sock == -1) { + text_color_set(DW_COLOR_ERROR); + // Should have been a message already. What else is there to say? + exit (EXIT_FAILURE); + } + +/* + * Print what we get from TNC. + */ + int len; + + while ((len = SOCK_RECV (server_sock, (char*)(data), sizeof(data))) > 0) { + int j; + for (j = 0; j < len; j++) { + + // Feed in one byte at a time. + // kiss_process_msg is called when a complete frame has been accumulated. + + // When verbose is specified, we get debug output like this: + // + // <<< Data frame from KISS client application, port 0, total length = 46 + // 000: c0 00 82 a0 88 ae 62 6a e0 ae 84 64 9e a6 b4 ff ......bj...d.... + // ... + // It says "from KISS client application" because it was written + // on the assumption it was being used in only one direction. + // Not worried enough about it to do anything at this time. + + kiss_rec_byte (&kstate, data[j], verbose, NULL, client, NULL); + } + } + + text_color_set(DW_COLOR_ERROR); + dw_printf ("Read error from TCP KISS TNC. Terminating.\n"); + exit (EXIT_FAILURE); + +} /* end tnc_listen_net */ + + +/*------------------------------------------------------------------- + * + * Name: tnc_listen_serial + * + * Purpose: Connect to KISS TNC via serial port. + * Print everything it sends to us. + * + * Inputs: arg - Currently not used. + * + * Global In: port + * serial_speed + * + * Global Out: serial_fd - Need for sending to the TNC. + * + *--------------------------------------------------------------------*/ + +static THREAD_F tnc_listen_serial (void *arg) +{ + int client = 0; + kiss_frame_t kstate; + + memset (&kstate, 0, sizeof(kstate)); + + serial_fd = serial_port_open (port, serial_speed); + + if (serial_fd == MYFDERROR) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Unable to connect to KISS TNC serial port %s.\n", port); +#if __WIN32__ +#else + // More detail such as "permission denied" or "no such device" + dw_printf("%s\n", strerror(errno)); +#endif + exit (EXIT_FAILURE); + } + +/* + * Read and print. + */ + while (1) { + int ch; + + ch = serial_port_get1(serial_fd); + + if (ch < 0) { + dw_printf("Read error from serial port KISS TNC.\n"); + exit (EXIT_FAILURE); + } + + // Feed in one byte at a time. + // kiss_process_msg is called when a complete frame has been accumulated. + + kiss_rec_byte (&kstate, ch, verbose, NULL, client, NULL); + } + +} /* end tnc_listen_serial */ + + + +/*------------------------------------------------------------------- + * + * Name: kiss_process_msg + * + * Purpose: Process a frame from the KISS TNC. + * This is called when a complete frame has been accumulated. + * In this case, we simply print it. + * + * Inputs: kiss_msg - Kiss frame with FEND and escapes removed. + * The first byte contains channel and command. + * + * kiss_len - Number of bytes including the command. + * + * debug - Debug option is selected. + * + * client - Not used in this case. + * + * sendfun - Not used in this case. + * + *-----------------------------------------------------------------*/ + +void kiss_process_msg (unsigned char *kiss_msg, int kiss_len, int debug, struct kissport_status_s *kps, int client, + void (*sendfun)(int chan, int kiss_cmd, unsigned char *fbuf, int flen, struct kissport_status_s *onlykps, int onlyclient)) +{ + int chan; + int cmd; + packet_t pp; + alevel_t alevel; + + chan = (kiss_msg[0] >> 4) & 0xf; + cmd = kiss_msg[0] & 0xf; + + switch (cmd) + { + case KISS_CMD_DATA_FRAME: /* 0 = Data Frame */ + + memset (&alevel, 0, sizeof(alevel)); + pp = ax25_from_frame (kiss_msg+1, kiss_len-1, alevel); + if (pp == NULL) { + text_color_set(DW_COLOR_ERROR); + printf ("ERROR - Invalid KISS data frame from TNC.\n"); + } + else { + char prefix[120]; // Channel and optional timestamp. + // Like [0] or [2 12:34:56] + + char addrs[AX25_MAX_ADDRS*AX25_MAX_ADDR_LEN]; // Like source>dest,digi,...,digi: + unsigned char *pinfo; + int info_len; + + if (strlen(timestamp_format) > 0) { + char ts[100]; + timestamp_user_format (ts, sizeof(ts), timestamp_format); + snprintf (prefix, sizeof(prefix), "[%d %s]", chan, ts); + } + else { + snprintf (prefix, sizeof(prefix), "[%d]", chan); + } + + ax25_format_addrs (pp, addrs); + + info_len = ax25_get_info (pp, &pinfo); + + text_color_set(DW_COLOR_REC); + + dw_printf ("%s %s", prefix, addrs); // [channel] Addresses followed by : + + // Safe print will replace any unprintable characters with + // hexadecimal representation. + + ax25_safe_print ((char *)pinfo, info_len, 0); + dw_printf ("\n"); +#if __WIN32__ + fflush (stdout); +#endif + +/* + * Add to receive queue directory if specified. + * File name will be based on current local time. + * If you want UTC, just set an environment variable like this: + * + * TZ=UTC kissutil ... + */ + if (strlen(receive_output) > 0) { + char fname [30]; + char path [300]; + FILE *fp; + + timestamp_filename (fname, (int)sizeof(fname)); + + strlcpy (path, receive_output, sizeof(path)); + strlcat (path, DIR_CHAR, sizeof(path)); + strlcat (path, fname, sizeof(path)); + + text_color_set(DW_COLOR_DEBUG); + dw_printf ("Save received frame to %s\n", path); + fp = fopen (path, "w"); + if (fp != NULL) { + fprintf (fp, "%s %s%s\n", prefix, addrs, pinfo); + fclose (fp); + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Unable to open for write: %s\n", path); + } + } + + ax25_delete (pp); + } + break; + + case KISS_CMD_SET_HARDWARE: /* 6 = TNC specific */ + + kiss_msg[kiss_len] = '\0'; + text_color_set(DW_COLOR_REC); + // Display as "h ..." for in/out symmetry. + // Use safe print here? + dw_printf ("[%d] h %s\n", chan, (char*)(kiss_msg+1)); + break; + +/* + * The rest should only go TO the TNC and not come FROM it. + */ + case KISS_CMD_TXDELAY: /* 1 = TXDELAY */ + case KISS_CMD_PERSISTENCE: /* 2 = Persistence */ + case KISS_CMD_SLOTTIME: /* 3 = SlotTime */ + case KISS_CMD_TXTAIL: /* 4 = TXtail */ + case KISS_CMD_FULLDUPLEX: /* 5 = FullDuplex */ + case KISS_CMD_END_KISS: /* 15 = End KISS mode, port should be 15. */ + default: + + text_color_set(DW_COLOR_ERROR); + printf ("Unexpected KISS command %d, channel %d\n", cmd, chan); + break; + } + +} /* end kiss_process_msg */ + + +// TODO: We have multiple copies of this. Move to some misc file. + +void hex_dump (unsigned char *p, int len) +{ + int n, i, offset; + + offset = 0; + while (len > 0) { + n = len < 16 ? len : 16; + printf (" %03x: ", offset); + for (i=0; i. +// + + +/*------------------------------------------------------------------ + * + * Module: latlong.c + * + * Purpose: Various functions for dealing with latitude and longitude. + * + * Description: Originally, these were scattered around in many places. + * Over time they might all be gathered into one place + * for consistency, reuse, and easier maintenance. + * + *---------------------------------------------------------------*/ + +#include "direwolf.h" + +#include +#include +#include +#include +#include +#include +#include +#include + +#include "latlong.h" +#include "textcolor.h" + + +/*------------------------------------------------------------------ + * + * Name: latitude_to_str + * + * Purpose: Convert numeric latitude to string for transmission. + * + * Inputs: dlat - Floating point degrees. + * ambiguity - If 1, 2, 3, or 4, blank out that many trailing digits. + * + * Outputs: slat - String in format ddmm.mm[NS] + * Must always be exactly 8 characters + NUL. + * Put in leading zeros if necessary. + * We must have exactly ddmm.mm and hemisphere because + * the APRS position report has fixed width fields. + * Trailing digits can be blanked for position ambiguity. + * + * Returns: None + * + * Idea for future: + * Non zero ambiguity removes least significant digits without rounding. + * Maybe we could use -1 and -2 to add extra digits using !DAO! as + * documented in http://www.aprs.org/datum.txt + * + * For example, -1 adds one more human readable digit. + * lat minutes 12.345 would produce "12.34" and !W5 ! + * + * -2 would encode almost 2 digits in base 91. + * lat minutes 10.0027 would produce "10.00" and !w: ! + * + *----------------------------------------------------------------*/ + +void latitude_to_str (double dlat, int ambiguity, char *slat) +{ + char hemi; /* Hemisphere: N or S */ + int ideg; /* whole number of degrees. */ + double dmin; /* Minutes after removing degrees. */ + char smin[8]; /* Minutes in format mm.mm */ + + if (dlat < -90.) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Latitude is less than -90. Changing to -90.n"); + dlat = -90.; + } + if (dlat > 90.) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Latitude is greater than 90. Changing to 90.n"); + dlat = 90.; + } + + if (dlat < 0) { + dlat = (- dlat); + hemi = 'S'; + } + else { + hemi = 'N'; + } + + ideg = (int)dlat; + dmin = (dlat - ideg) * 60.; + + // dmin is known to be in range of 0 <= dmin < 60. + + // Minutes must be exactly like 99.99 with leading zeros, + // if needed, to make it fixed width. + // Two digits, decimal point, two digits, nul terminator. + + snprintf (smin, sizeof(smin), "%05.2f", dmin); + /* Due to roundoff, 59.9999 could come out as "60.00" */ + if (smin[0] == '6') { + smin[0] = '0'; + ideg++; + } + + // Assumes slat can hold 8 characters + nul. + // Degrees must be exactly 2 digits, with leading zero, if needed. + + // FIXME: Should pass in sizeof slat and use snprintf + sprintf (slat, "%02d%s%c", ideg, smin, hemi); + + if (ambiguity >= 1) { + slat[6] = ' '; + if (ambiguity >= 2) { + slat[5] = ' '; + if (ambiguity >= 3) { + slat[3] = ' '; + if (ambiguity >= 4) { + slat[2] = ' '; + } + } + } + } + +} /* end latitude_to_str */ + + +/*------------------------------------------------------------------ + * + * Name: longitude_to_str + * + * Purpose: Convert numeric longitude to string for transmission. + * + * Inputs: dlong - Floating point degrees. + * ambiguity - If 1, 2, 3, or 4, blank out that many trailing digits. + * + * Outputs: slong - String in format dddmm.mm[NS] + * Must always be exactly 9 characters + NUL. + * Put in leading zeros if necessary. + * We must have exactly dddmm.mm and hemisphere because + * the APRS position report has fixed width fields. + * Trailing digits can be blanked for position ambiguity. + * Returns: None + * + *----------------------------------------------------------------*/ + +void longitude_to_str (double dlong, int ambiguity, char *slong) +{ + char hemi; /* Hemisphere: N or S */ + int ideg; /* whole number of degrees. */ + double dmin; /* Minutes after removing degrees. */ + char smin[8]; /* Minutes in format mm.mm */ + + if (dlong < -180.) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Longitude is less than -180. Changing to -180.n"); + dlong = -180.; + } + if (dlong > 180.) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Longitude is greater than 180. Changing to 180.n"); + dlong = 180.; + } + + if (dlong < 0) { + dlong = (- dlong); + hemi = 'W'; + } + else { + hemi = 'E'; + } + + ideg = (int)dlong; + dmin = (dlong - ideg) * 60.; + + snprintf (smin, sizeof(smin), "%05.2f", dmin); + /* Due to roundoff, 59.9999 could come out as "60.00" */ + if (smin[0] == '6') { + smin[0] = '0'; + ideg++; + } + + // Assumes slong can hold 9 characters + nul. + // Degrees must be exactly 3 digits, with leading zero, if needed. + + // FIXME: Should pass in sizeof slong and use snprintf + sprintf (slong, "%03d%s%c", ideg, smin, hemi); + +/* + * The spec says position ambiguity in latitude also + * applies to longitude automatically. + * Blanking longitude digits is not necessary but I do it + * because it makes things clearer. + */ + if (ambiguity >= 1) { + slong[7] = ' '; + if (ambiguity >= 2) { + slong[6] = ' '; + if (ambiguity >= 3) { + slong[4] = ' '; + if (ambiguity >= 4) { + slong[3] = ' '; + } + } + } + } + +} /* end longitude_to_str */ + + +/*------------------------------------------------------------------ + * + * Name: latitude_to_comp_str + * + * Purpose: Convert numeric latitude to compressed string for transmission. + * + * Inputs: dlat - Floating point degrees. + * + * Outputs: slat - String in format yyyy. + * Exactly 4 bytes, no nul terminator. + * + *----------------------------------------------------------------*/ + +void latitude_to_comp_str (double dlat, char *clat) +{ + int y, y0, y1, y2, y3; + + if (dlat < -90.) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Latitude is less than -90. Changing to -90.n"); + dlat = -90.; + } + if (dlat > 90.) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Latitude is greater than 90. Changing to 90.n"); + dlat = 90.; + } + + y = (int)round(380926. * (90. - dlat)); + + y0 = y / (91*91*91); + y -= y0 * (91*91*91); + + y1 = y / (91*91); + y -= y1 * (91*91); + + y2 = y / (91); + y -= y2 * (91); + + y3 = y; + + clat[0] = y0 + 33; + clat[1] = y1 + 33; + clat[2] = y2 + 33; + clat[3] = y3 + 33; +} + +/*------------------------------------------------------------------ + * + * Name: longitude_to_comp_str + * + * Purpose: Convert numeric longitude to compressed string for transmission. + * + * Inputs: dlong - Floating point degrees. + * + * Outputs: slat - String in format xxxx. + * Exactly 4 bytes, no nul terminator. + * + *----------------------------------------------------------------*/ + +void longitude_to_comp_str (double dlong, char *clon) +{ + int x, x0, x1, x2, x3; + + if (dlong < -180.) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Longitude is less than -180. Changing to -180.n"); + dlong = -180.; + } + if (dlong > 180.) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Longitude is greater than 180. Changing to 180.n"); + dlong = 180.; + } + + x = (int)round(190463. * (180. + dlong)); + + x0 = x / (91*91*91); + x -= x0 * (91*91*91); + + x1 = x / (91*91); + x -= x1 * (91*91); + + x2 = x / (91); + x -= x2 * (91); + + x3 = x; + + clon[0] = x0 + 33; + clon[1] = x1 + 33; + clon[2] = x2 + 33; + clon[3] = x3 + 33; +} + + +/*------------------------------------------------------------------ + * + * Name: latitude_to_nmea + * + * Purpose: Convert numeric latitude to strings for NMEA sentence. + * + * Inputs: dlat - Floating point degrees. + * + * Outputs: slat - String in format ddmm.mmmm + * hemi - Hemisphere or empty string. + * + * Returns: None + * + *----------------------------------------------------------------*/ + +void latitude_to_nmea (double dlat, char *slat, char *hemi) +{ + int ideg; /* whole number of degrees. */ + double dmin; /* Minutes after removing degrees. */ + char smin[10]; /* Minutes in format mm.mmmm */ + + if (dlat == G_UNKNOWN) { + strcpy (slat, ""); + strcpy (hemi, ""); + return; + } + + if (dlat < -90.) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Latitude is less than -90. Changing to -90.n"); + dlat = -90.; + } + if (dlat > 90.) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Latitude is greater than 90. Changing to 90.n"); + dlat = 90.; + } + + if (dlat < 0) { + dlat = (- dlat); + strcpy (hemi, "S"); + } + else { + strcpy (hemi, "N"); + } + + ideg = (int)dlat; + dmin = (dlat - ideg) * 60.; + + snprintf (smin, sizeof(smin), "%07.4f", dmin); + /* Due to roundoff, 59.99999 could come out as "60.0000" */ + if (smin[0] == '6') { + smin[0] = '0'; + ideg++; + } + + // FIXME: Should pass in sizeof slat and use snprintf + sprintf (slat, "%02d%s", ideg, smin); + +} /* end latitude_to_str */ + + +/*------------------------------------------------------------------ + * + * Name: longitude_to_nmea + * + * Purpose: Convert numeric longitude to strings for NMEA sentence. + * + * Inputs: dlong - Floating point degrees. + * + * Outputs: slong - String in format dddmm.mmmm + * hemi - Hemisphere or empty string. + * + * Returns: None + * + *----------------------------------------------------------------*/ + +void longitude_to_nmea (double dlong, char *slong, char *hemi) +{ + int ideg; /* whole number of degrees. */ + double dmin; /* Minutes after removing degrees. */ + char smin[10]; /* Minutes in format mm.mmmm */ + + if (dlong == G_UNKNOWN) { + strcpy (slong, ""); + strcpy (hemi, ""); + return; + } + + if (dlong < -180.) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("longitude is less than -180. Changing to -180.n"); + dlong = -180.; + } + if (dlong > 180.) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("longitude is greater than 180. Changing to 180.n"); + dlong = 180.; + } + + if (dlong < 0) { + dlong = (- dlong); + strcpy (hemi, "W"); + } + else { + strcpy (hemi, "E"); + } + + ideg = (int)dlong; + dmin = (dlong - ideg) * 60.; + + snprintf (smin, sizeof(smin), "%07.4f", dmin); + /* Due to roundoff, 59.99999 could come out as "60.0000" */ + if (smin[0] == '6') { + smin[0] = '0'; + ideg++; + } + + // FIXME: Should pass in sizeof slong and use snprintf + sprintf (slong, "%03d%s", ideg, smin); + +} /* end longitude_to_nmea */ + + + +/*------------------------------------------------------------------ + * + * Function: latitude_from_nmea + * + * Purpose: Convert NMEA latitude encoding to degrees. + * + * Inputs: pstr - Pointer to numeric string. + * phemi - Pointer to following field. Should be N or S. + * + * Returns: Double precision value in degrees. Negative for South. + * + * Description: Latitude field has + * 2 digits for degrees + * 2 digits for minutes + * period + * Variable number of fractional digits for minutes. + * I've seen 2, 3, and 4 fractional digits. + * + * + * Bugs: Very little validation of data. + * + * Errors: Return constant G_UNKNOWN for any type of error. + * + *------------------------------------------------------------------*/ + + +double latitude_from_nmea (char *pstr, char *phemi) +{ + + double lat; + + if ( ! isdigit((unsigned char)(pstr[0]))) return (G_UNKNOWN); + + if (pstr[4] != '.') return (G_UNKNOWN); + + + lat = (pstr[0] - '0') * 10 + (pstr[1] - '0') + atof(pstr+2) / 60.0; + + if (lat < 0 || lat > 90) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Error: Latitude not in range of 0 to 90.\n"); + } + + // Saw this one time: + // $GPRMC,000000,V,0000.0000,0,00000.0000,0,000,000,000000,,*01 + + // If location is unknown, I think the hemisphere should be + // an empty string. TODO: Check on this. + // 'V' means void, so sentence should be discarded rather than + // trying to extract any data from it. + + if (*phemi != 'N' && *phemi != 'S' && *phemi != '\0') { + text_color_set(DW_COLOR_ERROR); + dw_printf("Error: Latitude hemisphere should be N or S.\n"); + } + + if (*phemi == 'S') lat = ( - lat); + + return (lat); +} + + + + +/*------------------------------------------------------------------ + * + * Function: longitude_from_nmea + * + * Purpose: Convert NMEA longitude encoding to degrees. + * + * Inputs: pstr - Pointer to numeric string. + * phemi - Pointer to following field. Should be E or W. + * + * Returns: Double precision value in degrees. Negative for West. + * + * Description: Longitude field has + * 3 digits for degrees + * 2 digits for minutes + * period + * Variable number of fractional digits for minutes + * + * + * Bugs: Very little validation of data. + * + * Errors: Return constant G_UNKNOWN for any type of error. + * + *------------------------------------------------------------------*/ + + +double longitude_from_nmea (char *pstr, char *phemi) +{ + double lon; + + if ( ! isdigit((unsigned char)(pstr[0]))) return (G_UNKNOWN); + + if (pstr[5] != '.') return (G_UNKNOWN); + + lon = (pstr[0] - '0') * 100 + (pstr[1] - '0') * 10 + (pstr[2] - '0') + atof(pstr+3) / 60.0; + + if (lon < 0 || lon > 180) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Error: Longitude not in range of 0 to 180.\n"); + } + + if (*phemi != 'E' && *phemi != 'W' && *phemi != '\0') { + text_color_set(DW_COLOR_ERROR); + dw_printf("Error: Longitude hemisphere should be E or W.\n"); + } + + if (*phemi == 'W') lon = ( - lon); + + return (lon); +} + + +/*------------------------------------------------------------------ + * + * Function: ll_distance_km + * + * Purpose: Calculate distance between two locations. + * + * Inputs: lat1, lon1 - One location, in degrees. + * lat2, lon2 - other location + * + * Returns: Distance in km. + * + * Description: The Ubiquitous Haversine formula. + * + *------------------------------------------------------------------*/ + +#define R 6371 + +double ll_distance_km (double lat1, double lon1, double lat2, double lon2) +{ + double a; + + lat1 *= M_PI / 180; + lon1 *= M_PI / 180; + lat2 *= M_PI / 180; + lon2 *= M_PI / 180; + + a = pow(sin((lat2-lat1)/2),2) + cos(lat1) * cos(lat2) * pow(sin((lon2-lon1)/2),2); + + return (R * 2 *atan2(sqrt(a), sqrt(1-a))); +} + + +/*------------------------------------------------------------------ + * + * Function: ll_bearing_deg + * + * Purpose: Calculate bearing between two locations. + * + * Inputs: lat1, lon1 - starting location, in degrees. + * lat2, lon2 - destination location + * + * Returns: Initial Bearing, in degrees. + * The calculation produces Range +- 180 degrees. + * But I think that 0 - 360 would be more customary? + * + *------------------------------------------------------------------*/ + +double ll_bearing_deg (double lat1, double lon1, double lat2, double lon2) +{ + double b; + + lat1 *= M_PI / 180; + lon1 *= M_PI / 180; + lat2 *= M_PI / 180; + lon2 *= M_PI / 180; + + b = atan2 (sin(lon2-lon1) * cos(lat2), + cos(lat1) * sin(lat2) - sin(lat1) * cos(lat2) * cos(lon2-lon1)); + + b *= 180 / M_PI; + if (b < 0) b += 360; + + return (b); +} + + +/*------------------------------------------------------------------ + * + * Function: ll_dest_lat + * ll_dest_lon + * + * Purpose: Calculate the destination location given a starting point, + * distance, and bearing, + * + * Inputs: lat1, lon1 - starting location, in degrees. + * dist - distance in km. + * bearing - direction in degrees. Shouldn't matter + * if it is in +- 180 or 0 to 360 range. + * + * Returns: New latitude or longitude. + * + *------------------------------------------------------------------*/ + +double ll_dest_lat (double lat1, double lon1, double dist, double bearing) +{ + double lat2; + + lat1 *= M_PI / 180; // Everything to radians. + lon1 *= M_PI / 180; + bearing *= M_PI / 180; + + lat2 = asin(sin(lat1) * cos(dist/R) + cos(lat1) * sin(dist/R) * cos(bearing)); + + lat2 *= 180 / M_PI; // Back to degrees. + + return (lat2); +} + +double ll_dest_lon (double lat1, double lon1, double dist, double bearing) +{ + double lon2; + double lat2; + + lat1 *= M_PI / 180; // Everything to radians. + lon1 *= M_PI / 180; + bearing *= M_PI / 180; + + lat2 = asin(sin(lat1) * cos(dist/R) + cos(lat1) * sin(dist/R) * cos(bearing)); + + lon2 = lon1 + atan2(sin(bearing) * sin(dist/R) * cos(lat1), cos(dist/R) - sin(lat1) * sin(lat2)); + + lon2 *= 180 / M_PI; // Back to degrees. + + return (lon2); +} + + + +/*------------------------------------------------------------------ + * + * Function: ll_from_grid_square + * + * Purpose: Convert Maidenhead locator to latitude and longitude. + * + * Inputs: maidenhead - 2, 4, 6, 8, 10, or 12 character grid square locator. + * + * Outputs: dlat, dlon - Latitude and longitude. + * Original values unchanged if error. + * + * Returns: 1 for success, 0 if error. + * + * Reference: A good converter for spot checking. Only handles 4 or 6 characters :-( + * http://home.arcor.de/waldemar.kebsch/The_Makrothen_Contest/fmaidenhead.html + * + * Rambling: What sort of resolution does this provide? + * For 8 character form, each latitude unit is 0.25 minute. + * (Longitude can be up to twice that around the equator.) + * 6371 km * 2 * pi * 0.25 / 60 / 360 = 0.463 km. Is that right? + * + * Using this calculator, http://www.earthpoint.us/Convert.aspx + * It gives lower left corner of square rather than the middle. :-( + * + * FN42MA00 --> 19T 334361mE 4651711mN + * FN42MA11 --> 19T 335062mE 4652157mN + * ------ ------- + * 701 446 meters difference. + * + * With another two pairs, we are down around 2 meters for latitude. + * + *------------------------------------------------------------------*/ + +#define MH_MIN_PAIR 1 +#define MH_MAX_PAIR 6 +#define MH_UNITS ( 18 * 10 * 24 * 10 * 24 * 10 * 2 ) + +static const struct { + char *position; + char min_ch; + char max_ch; + int value; +} mh_pair[MH_MAX_PAIR] = { + { "first", 'A', 'R', 10 * 24 * 10 * 24 * 10 * 2 }, + { "second", '0', '9', 24 * 10 * 24 * 10 * 2 }, + { "third", 'A', 'X', 10 * 24 * 10 * 2 }, + { "fourth", '0', '9', 24 * 10 * 2 }, + { "fifth", 'A', 'X', 10 * 2 }, + { "sixth", '0', '9', 2 } }; // Even so we can get center of square. + + + +#if 1 + +int ll_from_grid_square (char *maidenhead, double *dlat, double *dlon) +{ + char mh[16]; /* Local copy, changed to upper case. */ + int ilat = 0, ilon = 0; /* In units in table above. */ + char *p; + int n; + + int np = strlen(maidenhead) / 2; /* Number of pairs of characters. */ + + if (strlen(maidenhead) %2 != 0 || np < MH_MIN_PAIR || np > MH_MAX_PAIR) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Maidenhead locator \"%s\" must from 1 to %d pairs of characters.\n", maidenhead, MH_MAX_PAIR); + return (0); + } + + strlcpy (mh, maidenhead, sizeof(mh)); + for (p = mh; *p != '\0'; p++) { + if (islower(*p)) *p = toupper(*p); + } + + for (n = 0; n < np; n++) { + + if (mh[2*n] < mh_pair[n].min_ch || mh[2*n] > mh_pair[n].max_ch || + mh[2*n+1] < mh_pair[n].min_ch || mh[2*n+1] > mh_pair[n].max_ch) { + text_color_set(DW_COLOR_ERROR); + dw_printf("The %s pair of characters in Maidenhead locator \"%s\" must be in range of %c thru %c.\n", + mh_pair[n].position, maidenhead, mh_pair[n].min_ch, mh_pair[n].max_ch); + return (0); + } + + ilon += ( mh[2*n] - mh_pair[n].min_ch ) * mh_pair[n].value; + ilat += ( mh[2*n+1] - mh_pair[n].min_ch ) * mh_pair[n].value; + + if (n == np-1) { // If last pair, take center of square. + ilon += mh_pair[n].value / 2; + ilat += mh_pair[n].value / 2; + } + } + + *dlat = (double)ilat / MH_UNITS * 180. - 90.; + *dlon = (double)ilon / MH_UNITS * 360. - 180.; + + //text_color_set(DW_COLOR_DEBUG); + //dw_printf("DEBUG: Maidenhead conversion \"%s\" -> %.6f %.6f\n", maidenhead, *dlat, *dlon); + + return (1); +} +#else + +int ll_from_grid_square (char *maidenhead, double *dlat, double *dlon) +{ + double lat, lon; + char mh[16]; + + + if (strlen(maidenhead) != 2 && strlen(maidenhead) != 4 && strlen(maidenhead) != 6 && strlen(maidenhead) != 8) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Maidenhead locator \"%s\" must 2, 4, 6, or 8 characters.\n", maidenhead); + return (0); + } + + strcpy (mh, maidenhead); + if (islower(mh[0])) mh[0] = toupper(mh[0]); + if (islower(mh[1])) mh[1] = toupper(mh[1]); + + if (mh[0] < 'A' || mh[0] > 'R' || mh[1] < 'A' || mh[1] > 'R') { + text_color_set(DW_COLOR_ERROR); + dw_printf("The first pair of characters in Maidenhead locator \"%s\" must be in range of A thru R.\n", maidenhead); + return (0); + } + + + /* Lon: 360 deg / 18 squares = 20 deg / square */ + /* Lat: 180 deg / 18 squares = 10 deg / square */ + + lon = (mh[0] - 'A') * 20 - 180; + lat = (mh[1] - 'A') * 10 - 90; + + if (strlen(mh) >= 4) { + + if ( ! isdigit(mh[2]) || ! isdigit(mh[3]) ) { + text_color_set(DW_COLOR_ERROR); + dw_printf("The second pair of characters in Maidenhead locator \"%s\" must be digits.\n", maidenhead); + return (0); + } + + /* Lon: 20 deg / 10 squares = 2 deg / square */ + /* Lat: 10 deg / 10 squares = 1 deg / square */ + + lon += (mh[2] - '0') * 2; + lat += (mh[3] - '0'); + + + if (strlen(mh) >=6) { + + if (islower(mh[4])) mh[4] = toupper(mh[4]); + if (islower(mh[5])) mh[5] = toupper(mh[5]); + + if (mh[4] < 'A' || mh[4] > 'X' || mh[5] < 'A' || mh[5] > 'X') { + text_color_set(DW_COLOR_ERROR); + dw_printf("The third pair of characters in Maidenhead locator \"%s\" must be in range of A thru X.\n", maidenhead); + return (0); + } + + /* Lon: 2 deg / 24 squares = 5 minutes / square */ + /* Lat: 1 deg / 24 squares = 2.5 minutes / square */ + + lon += (mh[4] - 'A') * 5.0 / 60.0; + lat += (mh[5] - 'A') * 2.5 / 60.0; + + if (strlen(mh) >= 8) { + + if ( ! isdigit(mh[6]) || ! isdigit(mh[7]) ) { + text_color_set(DW_COLOR_ERROR); + dw_printf("The fourth pair of characters in Maidenhead locator \"%s\" must be digits.\n", maidenhead); + return (0); + } + + /* Lon: 5 min / 10 squares = 0.5 minutes / square */ + /* Lat: 2.5 min / 10 squares = 0.25 minutes / square */ + + lon += (mh[6] - '0') * 0.50 / 60.0; + lat += (mh[7] - '0') * 0.25 / 60.0; + + lon += 0.250 / 60.0; /* Move from corner to center of square */ + lat += 0.125 / 60.0; + } + else { + lon += 2.5 / 60.0; /* Move from corner to center of square */ + lat += 1.25 / 60.0; + } + } + else { + lon += 1.0; /* Move from corner to center of square */ + lat += 0.5; + } + } + else { + lon += 10; /* Move from corner to center of square */ + lat += 5; + } + + //text_color_set(DW_COLOR_DEBUG); + //dw_printf("DEBUG: Maidenhead conversion \"%s\" -> %.6f %.6f\n", maidenhead, lat, lon); + + *dlat = lat; + *dlon = lon; + + return (1); +} + +#endif + +/* end ll_from_grid_square */ + + +#if LLTEST + +/* gcc -o lltest -DLLTEST latlong.c textcolor.o misc.a && lltest */ + + +int main (int argc, char *argv[]) +{ + char result[20]; + int errors = 0; + int ok; + double dlat, dlon; + double d, b; + +/* Latitude to APRS format. */ + + latitude_to_str (45.25, 0, result); + if (strcmp(result, "4515.00N") != 0) { errors++; dw_printf ("Error 1.1: Did not expect \"%s\"\n", result); } + + latitude_to_str (-45.25, 0, result); + if (strcmp(result, "4515.00S") != 0) { errors++; dw_printf ("Error 1.2: Did not expect \"%s\"\n", result); } + + + latitude_to_str (45.999830, 0, result); + if (strcmp(result, "4559.99N") != 0) { errors++; dw_printf ("Error 1.3: Did not expect \"%s\"\n", result); } + + latitude_to_str (45.99999, 0, result); + if (strcmp(result, "4600.00N") != 0) { errors++; dw_printf ("Error 1.4: Did not expect \"%s\"\n", result); } + + + latitude_to_str (45.999830, 1, result); + if (strcmp(result, "4559.9 N") != 0) { errors++; dw_printf ("Error 1.5: Did not expect \"%s\"\n", result); } + + latitude_to_str (45.999830, 2, result); + if (strcmp(result, "4559. N") != 0) { errors++; dw_printf ("Error 1.6: Did not expect \"%s\"\n", result); } + + latitude_to_str (45.999830, 3, result); + if (strcmp(result, "455 . N") != 0) { errors++; dw_printf ("Error 1.7: Did not expect \"%s\"\n", result); } + + latitude_to_str (45.999830, 4, result); + if (strcmp(result, "45 . N") != 0) { errors++; dw_printf ("Error 1.8: Did not expect \"%s\"\n", result); } + + // Test for leading zeros for small values. Result must be fixed width. + + latitude_to_str (0.016666666, 0, result); + if (strcmp(result, "0001.00N") != 0) { errors++; dw_printf ("Error 1.9: Did not expect \"%s\"\n", result); } + + latitude_to_str (-1.999999, 0, result); + if (strcmp(result, "0200.00S") != 0) { errors++; dw_printf ("Error 1.10: Did not expect \"%s\"\n", result); } + +/* Longitude to APRS format. */ + + longitude_to_str (45.25, 0, result); + if (strcmp(result, "04515.00E") != 0) { errors++; dw_printf ("Error 2.1: Did not expect \"%s\"\n", result); } + + longitude_to_str (-45.25, 0, result); + if (strcmp(result, "04515.00W") != 0) { errors++; dw_printf ("Error 2.2: Did not expect \"%s\"\n", result); } + + + longitude_to_str (45.999830, 0, result); + if (strcmp(result, "04559.99E") != 0) { errors++; dw_printf ("Error 2.3: Did not expect \"%s\"\n", result); } + + longitude_to_str (45.99999, 0, result); + if (strcmp(result, "04600.00E") != 0) { errors++; dw_printf ("Error 2.4: Did not expect \"%s\"\n", result); } + + + longitude_to_str (45.999830, 1, result); + if (strcmp(result, "04559.9 E") != 0) { errors++; dw_printf ("Error 2.5: Did not expect \"%s\"\n", result); } + + longitude_to_str (45.999830, 2, result); + if (strcmp(result, "04559. E") != 0) { errors++; dw_printf ("Error 2.6: Did not expect \"%s\"\n", result); } + + longitude_to_str (45.999830, 3, result); + if (strcmp(result, "0455 . E") != 0) { errors++; dw_printf ("Error 2.7: Did not expect \"%s\"\n", result); } + + longitude_to_str (45.999830, 4, result); + if (strcmp(result, "045 . E") != 0) { errors++; dw_printf ("Error 2.8: Did not expect \"%s\"\n", result); } + + // Test for leading zeros for small values. Result must be fixed width. + + longitude_to_str (0.016666666, 0, result); + if (strcmp(result, "00001.00E") != 0) { errors++; dw_printf ("Error 2.9: Did not expect \"%s\"\n", result); } + + longitude_to_str (-1.999999, 0, result); + if (strcmp(result, "00200.00W") != 0) { errors++; dw_printf ("Error 2.10: Did not expect \"%s\"\n", result); } + + +/* Compressed format. */ +/* Protocol spec example has <*e7 but I got <*e8 due to rounding rather than truncation to integer. */ + + memset(result, 0, sizeof(result)); + + latitude_to_comp_str (-90.0, result); + if (strcmp(result, "{{!!") != 0) { errors++; dw_printf ("Error 3.1: Did not expect \"%s\"\n", result); } + + latitude_to_comp_str (49.5, result); + if (strcmp(result, "5L!!") != 0) { errors++; dw_printf ("Error 3.2: Did not expect \"%s\"\n", result); } + + latitude_to_comp_str (90.0, result); + if (strcmp(result, "!!!!") != 0) { errors++; dw_printf ("Error 3.3: Did not expect \"%s\"\n", result); } + + + longitude_to_comp_str (-180.0, result); + if (strcmp(result, "!!!!") != 0) { errors++; dw_printf ("Error 3.4: Did not expect \"%s\"\n", result); } + + longitude_to_comp_str (-72.75, result); + if (strcmp(result, "<*e8") != 0) { errors++; dw_printf ("Error 3.5: Did not expect \"%s\"\n", result); } + + longitude_to_comp_str (180.0, result); + if (strcmp(result, "{{!!") != 0) { errors++; dw_printf ("Error 3.6: Did not expect \"%s\"\n", result); } + +// to be continued for others... NMEA... + + +/* Distance & bearing - Take a couple examples from other places and see if we get similar results. */ + + // http://www.movable-type.co.uk/scripts/latlong.html + + d = ll_distance_km (35., 45., 35., 135.); + b = ll_bearing_deg (35., 45., 35., 135.); + + if (d < 7862 || d > 7882) { errors++; dw_printf ("Error 5.1: Did not expect distance %.1f\n", d); } + + if (b < 59.7 || b > 60.3) { errors++; dw_printf ("Error 5.2: Did not expect bearing %.1f\n", b); } + + // Sydney to Kinsale. https://woodshole.er.usgs.gov/staffpages/cpolloni/manitou/ccal.htm + + d = ll_distance_km (-33.8688, 151.2093, 51.7059, -8.5222); + b = ll_bearing_deg (-33.8688, 151.2093, 51.7059, -8.5222); + + if (d < 17435 || d > 17455) { errors++; dw_printf ("Error 5.3: Did not expect distance %.1f\n", d); } + + if (b < 327-1 || b > 327+1) { errors++; dw_printf ("Error 5.4: Did not expect bearing %.1f\n", b); } + + +/* + * More distance and bearing. + * Here we will start at some location1 (lat1,lon1) and go some distance (d1) at some bearing (b1). + * This results in a new location2 (lat2, lon2). + * We then calculate the distance and bearing from location1 to location2 and compare with the intention. + */ + int lat1, lon1, d1 = 10, b1; + double lat2, lon2, d2, b2; + + for (lat1 = -60; lat1 <= 60; lat1 += 30) { + for (lon1 = -180; lon1 <= 180; lon1 +=30) { + for (b1 = 0; b1 < 360; b1 += 15) { + + lat2 = ll_dest_lat ((double)lat1, (double)lon1, (double)d1, (double)b1); + lon2 = ll_dest_lon ((double)lat1, (double)lon1, (double)d1, (double)b1); + + d2 = ll_distance_km ((double)lat1, (double)lon1, lat2, lon2); + b2 = ll_bearing_deg ((double)lat1, (double)lon1, lat2, lon2); + if (b2 > 359.9 && b2 < 360.1) b2 = 0; + + // must be within 0.1% of distance and 0.1 degree. + if (d2 < 0.999 * d1 || d2 > 1.001 * d1) { errors++; dw_printf ("Error 5.8: lat1=%d, lon2=%d, d1=%d, b1=%d, d2=%.2f\n", lat1, lon1, d1, b1, d2); } + if (b2 < b1 - 0.1 || b2 > b1 + 0.1) { errors++; dw_printf ("Error 5.9: lat1=%d, lon2=%d, d1=%d, b1=%d, b2=%.2f\n", lat1, lon1, d1, b1, b2); } + } + } + } + + +/* Maidenhead locator to lat/long. */ + + + ok = ll_from_grid_square ("BL11", &dlat, &dlon); + if (!ok || dlat < 20.4999999 || dlat > 21.5000001 || dlon < -157.0000001 || dlon > -156.9999999) { errors++; dw_printf ("Error 7.1: Did not expect %.6f %.6f\n", dlat, dlon); } + + ok = ll_from_grid_square ("BL11BH", &dlat, &dlon); + if (!ok || dlat < 21.31249 || dlat > 21.31251 || dlon < -157.87501 || dlon > -157.87499) { errors++; dw_printf ("Error 7.2: Did not expect %.6f %.6f\n", dlat, dlon); } + +#if 0 // TODO: add more test cases after comparing results with other cconverters. + // Many other converters are limited to smaller number of characters, + // or return corner rather than center of square, or return 3 decimal places for degrees. + + ok = ll_from_grid_square ("BL11BH16", &dlat, &dlon); + if (!ok || dlat < 21.? || dlat > 21.? || dlon < -157.? || dlon > -157.?) { errors++; dw_printf ("Error 7.3: Did not expect %.6f %.6f\n", dlat, dlon); } + + ok = ll_from_grid_square ("BL11BH16oo", &dlat, &dlon); + if (!ok || dlat < 21.? || dlat > 21.? || dlon < -157.? || dlon > -157.?) { errors++; dw_printf ("Error 7.4: Did not expect %.6f %.6f\n", dlat, dlon); } + + ok = ll_from_grid_square ("BL11BH16oo66", &dlat, &dlon); + if (!ok || dlat < 21.? || dlat > 21.? || dlon < -157.? || dlon > -157.?) { errors++; dw_printf ("Error 7.5: Did not expect %.6f %.6f\n", dlat, dlon); } +#endif + if (errors > 0) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("\nLocation Coordinate Conversion Test - FAILED!\n"); + exit (EXIT_FAILURE); + } + text_color_set (DW_COLOR_REC); + dw_printf ("\nLocation Coordinate Conversion Test - SUCCESS!\n"); + exit (EXIT_SUCCESS); + +} + + + +#endif + + +/* end latlong.c */ \ No newline at end of file diff --git a/latlong.h b/src/latlong.h similarity index 79% rename from latlong.h rename to src/latlong.h index 5c926ec5..ae98fe60 100644 --- a/latlong.h +++ b/src/latlong.h @@ -18,3 +18,7 @@ void longitude_to_nmea (double dlong, char *slong, char *hemi); double latitude_from_nmea (char *pstr, char *phemi); double longitude_from_nmea (char *pstr, char *phemi); + +double ll_distance_km (double lat1, double lon1, double lat2, double lon2); + +int ll_from_grid_square (char *maidenhead, double *dlat, double *dlon); \ No newline at end of file diff --git a/src/ll2utm.c b/src/ll2utm.c new file mode 100644 index 00000000..e06cd563 --- /dev/null +++ b/src/ll2utm.c @@ -0,0 +1,116 @@ +/* Latitude / Longitude to UTM conversion */ + +#include "direwolf.h" + +#include +#include +#include + + +#include "utm.h" +#include "mgrs.h" +#include "usng.h" +#include "error_string.h" + + +#define D2R(d) ((d) * M_PI / 180.) +#define R2D(r) ((r) * 180. / M_PI) + + +static void usage(); + + +int main (int argc, char *argv[]) +{ + double easting; + double northing; + double lat, lon; + char mgrs[32]; + char usng[32]; + char hemisphere; + long lzone; + long err; + char message[300]; + + + if (argc != 3) usage(); + + lat = atof(argv[1]); + + lon = atof(argv[2]); + + +// UTM + + err = Convert_Geodetic_To_UTM (D2R(lat), D2R(lon), &lzone, &hemisphere, &easting, &northing); + if (err == 0) { + printf ("UTM zone = %ld, hemisphere = %c, easting = %.0f, northing = %.0f\n", lzone, hemisphere, easting, northing); + } + else { + utm_error_string (err, message); + fprintf (stderr, "Conversion to UTM failed:\n%s\n\n", message); + + // Others could still succeed, keep going. + } + + +// Practice run with MGRS to see if it will succeed + + err = Convert_Geodetic_To_MGRS (D2R(lat), D2R(lon), 5L, mgrs); + if (err == 0) { + +// OK, hope changing precision doesn't make a difference. + + long precision; + + printf ("MGRS ="); + for (precision = 1; precision <= 5; precision++) { + Convert_Geodetic_To_MGRS (D2R(lat), D2R(lon), precision, mgrs); + printf (" %s", mgrs); + } + printf ("\n"); + } + else { + mgrs_error_string (err, message); + fprintf (stderr, "Conversion to MGRS failed:\n%s\n", message); + } + +// Same for USNG. + + err = Convert_Geodetic_To_USNG (D2R(lat), D2R(lon), 5L, usng); + if (err == 0) { + + long precision; + + printf ("USNG ="); + for (precision = 1; precision <= 5; precision++) { + Convert_Geodetic_To_USNG (D2R(lat), D2R(lon), precision, usng); + printf (" %s", usng); + } + printf ("\n"); + } + else { + usng_error_string (err, message); + fprintf (stderr, "Conversion to USNG failed:\n%s\n", message); + } + + exit (0); +} + + +static void usage (void) +{ + fprintf (stderr, "Latitude / Longitude to UTM conversion\n"); + fprintf (stderr, "\n"); + fprintf (stderr, "Usage:\n"); + fprintf (stderr, "\tll2utm latitude longitude\n"); + fprintf (stderr, "\n"); + fprintf (stderr, "where,\n"); + fprintf (stderr, "\tLatitude and longitude are in decimal degrees.\n"); + fprintf (stderr, "\t Use negative for south or west.\n"); + fprintf (stderr, "\n"); + fprintf (stderr, "Example:\n"); + fprintf (stderr, "\tll2utm 42.662139 -71.365553\n"); + + exit (1); +} \ No newline at end of file diff --git a/src/log.c b/src/log.c new file mode 100644 index 00000000..d7ef544b --- /dev/null +++ b/src/log.c @@ -0,0 +1,546 @@ +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// +// Copyright (C) 2014, 2015 John Langner, WB2OSZ +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . +// + + +/*------------------------------------------------------------------ + * + * File: log.c + * + * Purpose: Save received packets to a log file. + * + * Description: Rather than saving the raw, sometimes rather cryptic and + * unreadable, format, write separated properties into + * CSV format for easy reading and later processing. + * + * There are two alternatives here. + * + * -L logfile Specify full file path. + * + * -l logdir Daily names will be created here. + * + * Use one or the other but not both. + * + *------------------------------------------------------------------*/ + +#include "direwolf.h" + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#if __WIN32__ +#include // for _mkdir() +#endif + +#include "ax25_pad.h" +#include "textcolor.h" +#include "decode_aprs.h" +#include "log.h" + + +/* + * CSV format needs quotes if value contains comma or quote. + */ + +static void quote_for_csv (char *out, size_t outsize, const char *in) { + const char *p; + char *q = out; + int need_quote = 0; + + for (p = in; *p != '\0'; p++) { + if (*p == ',' || *p == '"') { + need_quote = 1; + break; + } + } + +// BUG: need to avoid buffer overflow on "out". *strcpy* + + if (need_quote) { + *q++ = '"'; + for (p = in; *p != '\0'; p++) { + if (*p == '"') { + *q++ = *p; + } + *q++ = *p; + } + *q++ = '"'; + *q = '\0'; + } + else { + strlcpy (out, in, outsize); + } +} + + +/*------------------------------------------------------------------ + * + * Function: log_init + * + * Purpose: Initialization at start of application. + * + * Inputs: daily_names - True if daily names should be generated. + * In this case path is a directory. + * When false, path would be the file name. + * + * path - Log file name or just directory. + * Use "." for current directory. + * Empty string disables feature. + * + * Global Out: g_daily_names - True if daily names should be generated. + * + * g_log_path - Save directory or full name here for later use. + * + * g_log_fp - File pointer for writing. + * Note that file is kept open. + * We don't open/close for every new item. + * + * g_open_fname - Name of currently open file. + * Applicable only when g_daily_names is true. + * + *------------------------------------------------------------------*/ + +static int g_daily_names; +static char g_log_path[80]; +static FILE *g_log_fp; +static char g_open_fname[20]; + + +void log_init (int daily_names, char *path) +{ + struct stat st; + + g_daily_names = daily_names; + strlcpy (g_log_path, "", sizeof(g_log_path)); + g_log_fp = NULL; + strlcpy (g_open_fname, "", sizeof(g_open_fname)); + + if (strlen(path) == 0) { + return; + } + + if (g_daily_names) { + +// Original strategy. Automatic daily file names. + + if (stat(path,&st) == 0) { + // Exists, but is it a directory? + if (S_ISDIR(st.st_mode)) { + // Specified directory exists. + strlcpy (g_log_path, path, sizeof(g_log_path)); + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Log file location \"%s\" is not a directory.\n", path); + dw_printf ("Using current working directory \".\" instead.\n"); + strlcpy (g_log_path, ".", sizeof(g_log_path)); + } + } + else { + // Doesn't exist. Try to create it. + // parent directory must exist. + // We don't create multiple levels like "mkdir -p" +#if __WIN32__ + if (_mkdir (path) == 0) { +#else + if (mkdir (path, 0777) == 0) { +#endif + // Success. + text_color_set(DW_COLOR_INFO); + dw_printf ("Log file location \"%s\" has been created.\n", path); + strlcpy (g_log_path, path, sizeof(g_log_path)); + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Failed to create log file location \"%s\".\n", path); + dw_printf ("%s\n", strerror(errno)); + dw_printf ("Using current working directory \".\" instead.\n"); + strlcpy (g_log_path, ".", sizeof(g_log_path)); + } + } + } + else { + +// Added in version 1.5. Single file. +// Typically logrotate would be used to keep size under control. + + text_color_set(DW_COLOR_INFO); + dw_printf ("Log file is \"%s\"\n", path); + strlcpy (g_log_path, path, sizeof(g_log_path)); + } + +} /* end log_init */ + + + +/*------------------------------------------------------------------ + * + * Function: log_write + * + * Purpose: Save information to log file. + * + * Inputs: chan - Radio channel where heard. + * + * A - Explode information from APRS packet. + * + * pp - Received packet object. + * + * alevel - audio level. + * + * retries - Amount of effort to get a good CRC. + * + *------------------------------------------------------------------*/ + +void log_write (int chan, decode_aprs_t *A, packet_t pp, alevel_t alevel, retry_t retries) +{ + time_t now; + struct tm tm; + + + if (strlen(g_log_path) == 0) return; + + now = time(NULL); // Get current time. + (void)gmtime_r (&now, &tm); +// FIXME: https://github.com/wb2osz/direwolf/issues/473 + + if (g_daily_names) { + +// Original strategy. Automatic daily file names. + + char fname[20]; + + // Generate the file name from current date, UTC. + // Why UTC rather than local time? I don't recall the reasoning. + // It's been there a few years and no on complained so leave it alone for now. + + // Microsoft doesn't recognize %F as equivalent to %Y-%m-%d + + strftime (fname, sizeof(fname), "%Y-%m-%d.log", &tm); + + // Close current file if name has changed + + if (g_log_fp != NULL && strcmp(fname, g_open_fname) != 0) { + log_term (); + } + + // Open for append if not already open. + + if (g_log_fp == NULL) { + char full_path[120]; + struct stat st; + int already_there; + + strlcpy (full_path, g_log_path, sizeof(full_path)); +#if __WIN32__ + strlcat (full_path, "\\", sizeof(full_path)); +#else + strlcat (full_path, "/", sizeof(full_path)); +#endif + strlcat (full_path, fname, sizeof(full_path)); + + // See if file already exists and not empty. + // This is used later to write a header if it did not exist already. + + already_there = (stat(full_path,&st) == 0) && (st.st_size > 0); + + text_color_set(DW_COLOR_INFO); + dw_printf("Opening log file \"%s\".\n", fname); + + g_log_fp = fopen (full_path, "a"); + + if (g_log_fp != NULL) { + strlcpy (g_open_fname, fname, sizeof(g_open_fname)); + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf("Can't open log file \"%s\" for write.\n", full_path); + dw_printf ("%s\n", strerror(errno)); + strlcpy (g_open_fname, "", sizeof(g_open_fname)); + return; + } + + // Write a header suitable for importing into a spreadsheet + // only if this will be the first line. + + if ( ! already_there) { + fprintf (g_log_fp, "chan,utime,isotime,source,heard,level,error,dti,name,symbol,latitude,longitude,speed,course,altitude,frequency,offset,tone,system,status,telemetry,comment\n"); + } + } + } + else { + +// Added in version 1.5. Single file. + + // Open for append if not already open. + + if (g_log_fp == NULL) { + struct stat st; + int already_there; + + // See if file already exists and not empty. + // This is used later to write a header if it did not exist already. + + already_there = (stat(g_log_path,&st) == 0) && (st.st_size > 0); + + text_color_set(DW_COLOR_INFO); + dw_printf("Opening log file \"%s\"\n", g_log_path); + + g_log_fp = fopen (g_log_path, "a"); + + if (g_log_fp == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Can't open log file \"%s\" for write.\n", g_log_path); + dw_printf ("%s\n", strerror(errno)); + strlcpy (g_log_path, "", sizeof(g_log_path)); + return; + } + + // Write a header suitable for importing into a spreadsheet + // only if this will be the first line. + + if ( ! already_there) { + fprintf (g_log_fp, "chan,utime,isotime,source,heard,level,error,dti,name,symbol,latitude,longitude,speed,course,altitude,frequency,offset,tone,system,status,telemetry,comment\n"); + } + } + } + + +// Add line to file if it is now open. + + if (g_log_fp != NULL) { + + char itime[24]; + char heard[AX25_MAX_ADDR_LEN+1]; + int h; + char stemp[256]; + char slat[16], slon[16], sspd[12], scse[12], salt[12]; + char sfreq[20], soffs[10], stone[10]; + char sdti[10]; + char sname[24]; + char ssymbol[8]; + char smfr[60]; + char sstatus[40]; + char stelemetry[200]; + char scomment[256]; + char alevel_text[40]; + + + + // Microsoft doesn't recognize %T as equivalent to %H:%M:%S + + strftime (itime, sizeof(itime), "%Y-%m-%dT%H:%M:%SZ", &tm); + + /* Who are we hearing? Original station or digipeater? */ + /* Similar code in direwolf.c. Combine into one function? */ + + strlcpy(heard, "", sizeof(heard)); + if (pp != NULL) { + if (ax25_get_num_addr(pp) == 0) { + /* Not AX.25. No station to display below. */ + h = -1; + strlcpy (heard, "", sizeof(heard)); + } + else { + h = ax25_get_heard(pp); + ax25_get_addr_with_ssid(pp, h, heard); + } + + if (h >= AX25_REPEATER_2 && + strncmp(heard, "WIDE", 4) == 0 && + isdigit(heard[4]) && + heard[5] == '\0') { + + ax25_get_addr_with_ssid(pp, h-1, heard); + strlcat (heard, "?", sizeof(heard)); + } + } + + ax25_alevel_to_text (alevel, alevel_text); + + + // Might need to quote anything that could contain comma or quote. + + strlcpy(sdti, "", sizeof(sdti)); + if (pp != NULL) { + stemp[0] = ax25_get_dti(pp); + stemp[1] = '\0'; + quote_for_csv (sdti, sizeof(sdti), stemp); + } + + quote_for_csv (sname, sizeof(sname), (strlen(A->g_name) > 0) ? A->g_name : A->g_src); + + stemp[0] = A->g_symbol_table; + stemp[1] = A->g_symbol_code; + stemp[2] = '\0'; + quote_for_csv (ssymbol, sizeof(ssymbol), stemp); + + quote_for_csv (smfr, sizeof(smfr), A->g_mfr); + quote_for_csv (sstatus, sizeof(sstatus), A->g_mic_e_status); + quote_for_csv (stelemetry, sizeof(stelemetry), A->g_telemetry); + quote_for_csv (scomment, sizeof(scomment), A->g_comment); + + strlcpy (slat, "", sizeof(slat)); if (A->g_lat != G_UNKNOWN) snprintf (slat, sizeof(slat), "%.6f", A->g_lat); + strlcpy (slon, "", sizeof(slon)); if (A->g_lon != G_UNKNOWN) snprintf (slon, sizeof(slon), "%.6f", A->g_lon); + strlcpy (sspd, "", sizeof(sspd)); if (A->g_speed_mph != G_UNKNOWN) snprintf (sspd, sizeof(sspd), "%.1f", DW_MPH_TO_KNOTS(A->g_speed_mph)); + strlcpy (scse, "", sizeof(scse)); if (A->g_course != G_UNKNOWN) snprintf (scse, sizeof(scse), "%.1f", A->g_course); + strlcpy (salt, "", sizeof(salt)); if (A->g_altitude_ft != G_UNKNOWN) snprintf (salt, sizeof(salt), "%.1f", DW_FEET_TO_METERS(A->g_altitude_ft)); + + strlcpy (sfreq, "", sizeof(sfreq)); if (A->g_freq != G_UNKNOWN) snprintf (sfreq, sizeof(sfreq), "%.3f", A->g_freq); + strlcpy (soffs, "", sizeof(soffs)); if (A->g_offset != G_UNKNOWN) snprintf (soffs, sizeof(soffs), "%+d", A->g_offset); + strlcpy (stone, "", sizeof(stone)); if (A->g_tone != G_UNKNOWN) snprintf (stone, sizeof(stone), "%.1f", A->g_tone); + if (A->g_dcs != G_UNKNOWN) snprintf (stone, sizeof(stone), "D%03o", A->g_dcs); + + fprintf (g_log_fp, "%d,%d,%s,%s,%s,%s,%d,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s\n", + chan, (int)now, itime, + A->g_src, heard, alevel_text, (int)retries, sdti, + sname, ssymbol, + slat, slon, sspd, scse, salt, + sfreq, soffs, stone, + smfr, sstatus, stelemetry, scomment); + + fflush (g_log_fp); + } + +} /* end log_write */ + + + +/*------------------------------------------------------------------ + * + * Function: log_rr_bits + * + * Purpose: Quick hack to look at the C and RR bits just to see what is there. + * This seems like a good place because it is a small subset of the function above. + * + * Inputs: A - Explode information from APRS packet. + * + * pp - Received packet object. + * + *------------------------------------------------------------------*/ + +void log_rr_bits (decode_aprs_t *A, packet_t pp) +{ + + if (1) { + + char heard[AX25_MAX_ADDR_LEN+1]; + char smfr[60]; + char *p; + int src_c, dst_c; + int src_rr, dst_rr; + + // Sanitize system type (manufacturer) changing any comma to period. + + strlcpy (smfr, A->g_mfr, sizeof(smfr)); + for (p=smfr; *p!='\0'; p++) { + if (*p == ',') *p = '.'; + } + + /* Who are we hearing? Original station or digipeater? */ + /* Similar code in direwolf.c. Combine into one function? */ + + strlcpy(heard, "", sizeof(heard)); + + if (pp != NULL) { + int h; + + if (ax25_get_num_addr(pp) == 0) { + /* Not AX.25. No station to display below. */ + h = -1; + strlcpy (heard, "", sizeof(heard)); + } + else { + h = ax25_get_heard(pp); + ax25_get_addr_with_ssid(pp, h, heard); + } + + if (h >= AX25_REPEATER_2 && + strncmp(heard, "WIDE", 4) == 0 && + isdigit(heard[4]) && + heard[5] == '\0') { + + ax25_get_addr_with_ssid(pp, h-1, heard); + strlcat (heard, "?", sizeof(heard)); + } + + src_c = ax25_get_h (pp, AX25_SOURCE); + dst_c = ax25_get_h (pp, AX25_DESTINATION); + src_rr = ax25_get_rr (pp, AX25_SOURCE); + dst_rr = ax25_get_rr (pp, AX25_DESTINATION); + + // C RR for source + // C RR for destination + // system type + // source + // station heard + + text_color_set(DW_COLOR_INFO); + + dw_printf ("%d %d%d %d %d%d,%s,%s,%s\n", + src_c, (src_rr >> 1) & 1, src_rr & 1, + dst_c, (dst_rr >> 1) & 1, dst_rr & 1, + smfr, A->g_src, heard); + } + } + +} /* end log_rr_bits */ + + + + +/*------------------------------------------------------------------ + * + * Function: log_term + * + * Purpose: Close any open log file. + * Called when exiting or when date changes. + * + *------------------------------------------------------------------*/ + + +void log_term (void) +{ + if (g_log_fp != NULL) { + + text_color_set(DW_COLOR_INFO); + + if (g_daily_names) { + dw_printf("Closing log file \"%s\".\n", g_open_fname); + } + else { + dw_printf("Closing log file \"%s\".\n", g_log_path); + } + + fclose (g_log_fp); + + g_log_fp = NULL; + strlcpy (g_open_fname, "", sizeof(g_open_fname)); + } + +} /* end log_term */ + + +/* end log.c */ diff --git a/src/log.h b/src/log.h new file mode 100644 index 00000000..3afb6b17 --- /dev/null +++ b/src/log.h @@ -0,0 +1,19 @@ + +/* log.h */ + + +#include "hdlc_rec2.h" // for retry_t + +#include "decode_aprs.h" // for decode_aprs_t + +#include "ax25_pad.h" + + + +void log_init (int daily_names, char *path); + +void log_write (int chan, decode_aprs_t *A, packet_t pp, alevel_t alevel, retry_t retries); + +void log_rr_bits (decode_aprs_t *A, packet_t pp); + +void log_term (void); \ No newline at end of file diff --git a/log2gpx.c b/src/log2gpx.c similarity index 89% rename from log2gpx.c rename to src/log2gpx.c index 24c1b39e..15d389f4 100644 --- a/log2gpx.c +++ b/src/log2gpx.c @@ -18,15 +18,12 @@ // along with this program. If not, see . // +#include "direwolf.h" #include #include #include -#if __WIN32__ -char *strsep(char **stringp, const char *delim); -#endif - /* * Information we gather for each thing. @@ -228,6 +225,20 @@ static void read_csv(FILE *fp) ptelemetry = strsep(&next,"\t"); /* Currently unused. Add to description? */ pcomment = strsep(&next,"\t"); + /* Suppress the 'set but not used' warnings. */ + /* Alternatively, we might use __attribute__((unused)) */ + + (void)(ptelemetry); + (void)(psystem); + (void)(psymbol); + (void)(pdti); + (void)(perror); + (void)(plevel); + (void)(pheard); + (void)(psource); + (void)(putime); + + /* * Skip header line with names of fields. */ @@ -247,8 +258,6 @@ static void read_csv(FILE *fp) float speed = UNKNOWN_VALUE; float course = UNKNOWN_VALUE; float alt = UNKNOWN_VALUE; - double freq = UNKNOWN_VALUE; - int offset = UNKNOWN_VALUE; char stemp[16], desc[32], comment[256]; if (pspeed != NULL && strlen(pspeed) > 0) { @@ -264,43 +273,43 @@ static void read_csv(FILE *fp) /* combine freq/offset/tone into one description string. */ if (pfreq != NULL && strlen(pfreq) > 0) { - freq = atof(pfreq); - sprintf (desc, "%.3f MHz", freq); + double freq = atof(pfreq); + snprintf (desc, sizeof(desc), "%.3f MHz", freq); } else { - strcpy (desc, ""); + strlcpy (desc, "", sizeof(desc)); } if (poffset != NULL && strlen(poffset) > 0) { - offset = atoi(poffset); + int offset = atoi(poffset); if (offset != 0 && offset % 1000 == 0) { - sprintf (stemp, "%+dM", offset / 1000); + snprintf (stemp, sizeof(stemp), "%+dM", offset / 1000); } else { - sprintf (stemp, "%+dk", offset); + snprintf (stemp, sizeof(stemp), "%+dk", offset); } - if (strlen(desc) > 0) strcat (desc, " "); - strcat (desc, stemp); + if (strlen(desc) > 0) strlcat (desc, " ", sizeof(desc)); + strlcat (desc, stemp, sizeof(desc)); } if (ptone != NULL && strlen(ptone) > 0) { if (*ptone == 'D') { - sprintf (stemp, "DCS %s", ptone+1); + snprintf (stemp, sizeof(stemp), "DCS %s", ptone+1); } else { - sprintf (stemp, "PL %s", ptone); + snprintf (stemp, sizeof(stemp), "PL %s", ptone); } - if (strlen(desc) > 0) strcat (desc, " "); - strcat (desc, stemp); + if (strlen(desc) > 0) strlcat (desc, " ", sizeof(desc)); + strlcat (desc, stemp, sizeof(desc)); } - strcpy (comment, ""); + strlcpy (comment, "", sizeof(comment)); if (pstatus != NULL && strlen(pstatus) > 0) { - strcpy (comment, pstatus); + strlcpy (comment, pstatus, sizeof(comment)); } if (pcomment != NULL && strlen(pcomment) > 0) { - if (strlen(comment) > 0) strcat (comment, ", "); - strcat (comment, pcomment); + if (strlen(comment) > 0) strlcat (comment, ", ", sizeof(comment)); + strlcat (comment, pcomment, sizeof(comment)); } if (num_things == max_things) { @@ -314,10 +323,10 @@ static void read_csv(FILE *fp) things[num_things].speed = speed; things[num_things].course = course; things[num_things].alt = alt; - strncpy (things[num_things].time, pisotime, sizeof(things[num_things].time)); - strncpy (things[num_things].name, pname, sizeof(things[num_things].name)); - strncpy (things[num_things].desc, desc, sizeof(things[num_things].desc)); - strncpy (things[num_things].comment, comment, sizeof(things[num_things].comment)); + strlcpy (things[num_things].time, pisotime, sizeof(things[num_things].time)); + strlcpy (things[num_things].name, pname, sizeof(things[num_things].name)); + strlcpy (things[num_things].desc, desc, sizeof(things[num_things].desc)); + strlcpy (things[num_things].comment, comment, sizeof(things[num_things].comment)); num_things++; } @@ -532,4 +541,4 @@ static void process_things (int first, int last) } printf (" %s\n", safe_name); printf (" \n"); -} \ No newline at end of file +} diff --git a/mgn_icon.h b/src/mgn_icon.h similarity index 91% rename from mgn_icon.h rename to src/mgn_icon.h index 9ffb6f78..c870bc0e 100644 --- a/mgn_icon.h +++ b/src/mgn_icon.h @@ -5,9 +5,18 @@ * * Waypoint icon codes for use in the $PMGNWPL sentence. * - * Derived from Data Transmission Protocol For Magellan Products – version 2.11 + * Derived from Data Transmission Protocol For Magellan Products - version 2.11, March 2003 + * + * http://www.gpsinformation.org/mag-proto-2-11.pdf + * + * + * That's 13 years ago. There should be something newer available but I can't find it. + * + * The is based on the newer models at the time. Earlier models had shorter incompatible icon lists. */ + + #define MGN_crossed_square "a" #define MGN_box "b" #define MGN_house "c" @@ -110,7 +119,7 @@ static const char mgn_primary_symtab[SYMTAB_SIZE][3] = { MGN_default, // E 37 EYEBALL (Eye catcher!) MGN_default, // F 38 Farm Vehicle (tractor) MGN_default, // G 39 Grid Square (6 digit) - MGN_default, // H 40 HOTEL (blue bed symbol) + MGN_hotel, // H 40 HOTEL (blue bed symbol) MGN_aerial, // I 41 TcpIp on air network stn MGN_default, // J 42 MGN_default, // K 43 School @@ -150,7 +159,7 @@ static const char mgn_primary_symtab[SYMTAB_SIZE][3] = { MGN_aerial, // m 77 Mic-E Repeater MGN_default, // n 78 Node (black bulls-eye) MGN_default, // o 79 EOC - MGN_default, // p 80 ROVER (puppy, or dog) + MGN_zoo, // p 80 ROVER (puppy, or dog) MGN_default, // q 81 GRID SQ shown above 128 m MGN_aerial, // r 82 Repeater MGN_default, // s 83 SHIP (pwr boat) @@ -199,10 +208,10 @@ static const char mgn_alternate_symtab[SYMTAB_SIZE][3] = { MGN_park, // ; 27 Park/Picnic area MGN_default, // < 28 ADVISORY (one WX flag) MGN_default, // = 29 APRStt Touchtone (DTMF users) - MGN_default, // > 30 OVERLAYED CAR + MGN_default, // > 30 OVERLAID CAR MGN_tourist_info, // ? 31 INFO Kiosk (Blue box with ?) - MGN_default, // @ 32 HURICANE/Trop-Storm - MGN_default, // A 33 overlayBOX DTMF & RFID & XO + MGN_default, // @ 32 HURRICANE/Trop-Storm + MGN_box, // A 33 overlayBOX DTMF & RFID & XO MGN_default, // B 34 Blwng Snow (& future codes) MGN_boating, // C 35 Coast Guard MGN_default, // D 36 Drizzle (proposed APRStt) @@ -211,11 +220,11 @@ static const char mgn_alternate_symtab[SYMTAB_SIZE][3] = { MGN_default, // G 39 Snow Shwr (& future ovrlys) MGN_default, // H 40 Haze (& Overlay Hazards) MGN_default, // I 41 Rain Shower - MGN_default, // J 42 Lightening (& future ovrlys) + MGN_default, // J 42 Lightning (& future ovrlys) MGN_default, // K 43 Kenwood HT (W) MGN_lighthouse, // L 44 Lighthouse MGN_default, // M 45 MARS (A=Army,N=Navy,F=AF) - MGN_nav_aid, // N 46 Navigation Buoy + MGN_buoy, // N 46 Navigation Buoy MGN_airport, // O 47 Rocket MGN_default, // P 48 Parking MGN_default, // Q 49 QUAKE @@ -223,7 +232,7 @@ static const char mgn_alternate_symtab[SYMTAB_SIZE][3] = { MGN_aerial, // S 51 Satellite/Pacsat MGN_default, // T 52 Thunderstorm MGN_default, // U 53 SUNNY - MGN_default, // V 54 VORTAC Nav Aid + MGN_nav_aid, // V 54 VORTAC Nav Aid MGN_default, // W 55 # NWS site (NWS options) MGN_default, // X 56 Pharmacy Rx (Apothicary) MGN_aerial, // Y 57 Radios and devices @@ -242,7 +251,7 @@ static const char mgn_alternate_symtab[SYMTAB_SIZE][3] = { MGN_default, // f 70 Funnel Cloud MGN_default, // g 71 Gale Flags MGN_default, // h 72 Store. or HAMFST Hh=HAM store - MGN_default, // i 73 BOX or points of Interest + MGN_box, // i 73 BOX or points of Interest MGN_default, // j 74 WorkZone (Steam Shovel) MGN_default, // k 75 Special Vehicle SUV,ATV,4x4 MGN_default, // l 76 Areas (box,circles,etc) @@ -254,12 +263,12 @@ static const char mgn_alternate_symtab[SYMTAB_SIZE][3] = { MGN_default, // r 82 Restrooms MGN_default, // s 83 OVERLAY SHIP/boat (top view) MGN_default, // t 84 Tornado - MGN_default, // u 85 OVERLAYED TRUCK - MGN_default, // v 86 OVERLAYED Van + MGN_default, // u 85 OVERLAID TRUCK + MGN_default, // v 86 OVERLAID Van MGN_default, // w 87 Flooding MGN_wreck, // x 88 Wreck or Obstruction ->X<- MGN_default, // y 89 Skywarn - MGN_default, // z 90 OVERLAYED Shelter + MGN_default, // z 90 OVERLAID Shelter MGN_default, // { 91 Fog (& future ovrly codes) MGN_default, // | 92 TNC Stream Switch MGN_default, // } 93 diff --git a/src/mheard.c b/src/mheard.c new file mode 100644 index 00000000..f11c68f0 --- /dev/null +++ b/src/mheard.c @@ -0,0 +1,865 @@ +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// +// Copyright (C) 2016 John Langner, WB2OSZ +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . +// + + +/*------------------------------------------------------------------ + * + * File: mheard.c + * + * Purpose: Maintain a list of all stations heard. + * + * Description: This was added for IGate statistics and checking if a user is local + * but would also be useful for the AGW network protocol 'H' request. + * + * This application has no GUI and is not interactive so + * I'm not sure what else we might do with the information. + * + * Why mheard instead of just heard? The KPC-3+ has an MHEARD command + * to list stations heard. I guess that stuck in my mind. + * It should be noted that here "heard" refers to the AX.25 source station. + * Before printing the received packet, the "heard" line refers to who + * we heard over the radio. This would be the digipeater with "*" after + * its name. + * + * Future Ideas: Someone suggested using SQLite to store the information + * so other applications could access it. + * + *------------------------------------------------------------------*/ + +#include "direwolf.h" + +#include +#include +#include +#include +#include +#include + +#include "textcolor.h" +#include "decode_aprs.h" +#include "ax25_pad.h" +#include "hdlc_rec2.h" // for retry_t +#include "mheard.h" +#include "latlong.h" + + +// This is getting updated from two different threads so we need a critical region +// for adding new nodes. + +static dw_mutex_t mheard_mutex; + + +// I think we can get away without a critical region for reading if we follow these +// rules: +// +// (1) When adding a new node, make sure it is complete, including next ptr, +// before adding it to the list. +// (2) Update the start of list pointer last. +// (2) Nothing gets deleted. + +// If we ever decide to start cleaning out very old data, all access would then +// need to use the mutex. + + +/* + * Information for each station heard over the radio or from Internet Server. + */ + +typedef struct mheard_s { + + struct mheard_s *pnext; // Pointer to next in list. + + char callsign[AX25_MAX_ADDR_LEN]; // Callsign from the AX.25 source field. + + int count; // Number of times heard. + // We don't use this for anything. + // Just something potentially interesting when looking at data dump. + + int chan; // Most recent channel where heard. + + int num_digi_hops; // Number of digipeater hops before we heard it. + // over radio. Zero when heard directly. + + time_t last_heard_rf; // Timestamp when last heard over the radio. + + time_t last_heard_is; // Timestamp when last heard from Internet Server. + + double dlat, dlon; // Last position. G_UNKNOWN for unknown. + + int msp; // Allow message sender position report. + // When non zero, an IS>RF position report is allowed. + // Then decremented. + + // What else would be useful? + // The AGW protocol is by channel and returns + // first heard in addition to last heard. +} mheard_t; + + + + + + + +/* + * The list could be quite long and we hit this a lot so use a hash table. + */ + +#define MHEARD_HASH_SIZE 73 // Best if prime number. + +static mheard_t *mheard_hash[MHEARD_HASH_SIZE]; + +static inline int hash_index(char *callsign) { + int n = 0; + char *p = callsign; + + while (*p != '\0') { + n += *p++; + } + return (n % MHEARD_HASH_SIZE); +} + +static mheard_t *mheard_ptr(char *callsign) { + int n = hash_index(callsign); + mheard_t *p = mheard_hash[n]; + + while (p != NULL) { + if (strcmp(callsign,p->callsign) == 0) return (p); + p = p->pnext; + } + return (NULL); +} + + +static int mheard_debug = 0; + + +/*------------------------------------------------------------------ + * + * Function: mheard_init + * + * Purpose: Initialization at start of application. + * + * Inputs: debug - Debug level. + * + * Description: Clear pointer table. + * Save debug level for later use. + * + *------------------------------------------------------------------*/ + + +void mheard_init (int debug) +{ + int i; + + mheard_debug = debug; + + for (i = 0; i < MHEARD_HASH_SIZE; i++) { + mheard_hash[i] = NULL; + } + +/* + * Mutex to coordinate adding new nodes. + */ + dw_mutex_init(&mheard_mutex); + +} /* end mheard_init */ + + + +/*------------------------------------------------------------------ + * + * Function: mheard_dump + * + * Purpose: Print list of stations heard for debugging. + * + *------------------------------------------------------------------*/ + +/* convert some time in past to hours:minutes text format. */ + +static void age(char *result, time_t now, time_t t) +{ + int s, h, m; + + if (t == 0) { + strcpy (result, "- "); + return; + } + + s = (int)(now - t); + m = s / 60; + h = m / 60; + m -= h * 60; + + sprintf (result, "%4d:%02d", h, m); +} + +/* Convert latitude, longitude to text or - if not defined. */ + +static void latlon (char * result, double dlat, double dlon) +{ + if (dlat != G_UNKNOWN && dlon != G_UNKNOWN) { + sprintf (result, "%6.2f %7.2f", dlat, dlon); + } + else { + strcpy (result, " - - "); + } +} + +/* Compare last heard time for use with qsort. */ + +#define MAXX(x,y) (((x)>(y))?(x):(y)) +static int compar(const void *a, const void *b) +{ + mheard_t *ma = *((mheard_t **)a); + mheard_t *mb = *((mheard_t **)b); + + time_t ta = MAXX(ma->last_heard_rf, ma->last_heard_is); + time_t tb = MAXX(mb->last_heard_rf, mb->last_heard_is); + + return (tb - ta); +} + +#define MAXDUMP 1000 + +static void mheard_dump (void) +{ + int i; + mheard_t *mptr; + time_t now = time(NULL); + char stuff[120]; + char rf[20]; // hours:minutes + char is[20]; + char position[40]; + mheard_t *station[MAXDUMP]; + int num_stations = 0; + + +/* Get linear array of node pointers so they can be sorted easily. */ + + num_stations = 0; + + for (i = 0; i < MHEARD_HASH_SIZE; i++) { + for (mptr = mheard_hash[i]; mptr != NULL; mptr = mptr->pnext) { + + if (num_stations < MAXDUMP) { + station[num_stations] = mptr; + num_stations++; + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("mheard_dump - max number of stations exceeded.\n"); + } + } + } + +/* Sort most recently heard to the top then print. */ + + qsort (station, num_stations, sizeof(mheard_t *), compar); + + text_color_set(DW_COLOR_DEBUG); + + dw_printf ("callsign cnt chan hops RF IS lat long msp\n"); + + for (i = 0; i < num_stations; i++) { + + mptr = station[i]; + + age (rf, now, mptr->last_heard_rf); + age (is, now, mptr->last_heard_is); + latlon (position, mptr->dlat, mptr->dlon); + + snprintf (stuff, sizeof(stuff), "%-9s %3d %d %d %7s %7s %s %d\n", + mptr->callsign, mptr->count, mptr->chan, mptr->num_digi_hops, rf, is, position, mptr->msp); + dw_printf ("%s", stuff); + } + +} /* end mheard_dump */ + + +/*------------------------------------------------------------------ + * + * Function: mheard_save_rf + * + * Purpose: Save information about station heard over the radio. + * + * Inputs: chan - Radio channel where heard. + * + * A - Exploded information from APRS packet. + * + * pp - Received packet object. + * + * alevel - audio level. + * + * retries - Amount of effort to get a good CRC. + * + * Description: Calling sequence was copied from "log_write." + * It has a lot more than what we currently keep but the + * hooks are there so it will be easy to capture additional + * information when the need arises. + * + *------------------------------------------------------------------*/ + +void mheard_save_rf (int chan, decode_aprs_t *A, packet_t pp, alevel_t alevel, retry_t retries) +{ + time_t now = time(NULL); + char source[AX25_MAX_ADDR_LEN]; + int hops; + mheard_t *mptr; + + ax25_get_addr_with_ssid (pp, AX25_SOURCE, source); + +/* + * How many digipeaters has it gone thru before we hear it? + * We can count the number of digi addresses that are marked as "has been used." + * This is not always accurate because there is inconsistency in digipeater behavior. + * The base AX.25 spec seems clear in this regard. The used digipeaters should + * should accurately reflict the path taken by the packet. Sometimes we see excess + * stuff in there. Even when you understand what is going on, it is still an ambiguous + * situation. Look for my rant in the User Guide. + */ + + hops = ax25_get_heard(pp) - AX25_SOURCE; +/* + * Consider the following scenario: + * + * (1) We hear AA1PR-9 by a path of 4 digipeaters. + * Looking closer, it's probably only two because there are left over WIDE1-0 and WIDE2-0. + * + * Digipeater WIDE2 (probably N3LLO-3) audio level = 72(19/15) [NONE] _|||||___ + * [0.3] AA1PR-9>APY300,K1EQX-7,WIDE1,N3LLO-3,WIDE2*,ARISS::ANSRVR :cq hotg vt aprsthursday{01<0x0d> + * ----- ----- + * + * (2) APRS-IS sends a response to us. + * + * [ig>tx] ANSRVR>APWW11,KJ4ERJ-15*,TCPIP*,qAS,KJ4ERJ-15::AA1PR-9 :N:HOTG 161 Messages Sent{JL} + * + * (3) Here is our analysis of whether it should be sent to RF. + * + * Was message addressee AA1PR-9 heard in the past 180 minutes, with 2 or fewer digipeater hops? + * No, AA1PR-9 was last heard over the radio with 4 digipeater hops 0 minutes ago. + * + * The wrong hop count caused us to drop a packet that should have been transmitted. + * We could put in a hack to not count the "WIDEn-0" addresses. + * That is not correct because other prefixes could be used and we don't know + * what they are for other digipeaters. + * I think the best solution is to simply ignore the hop count. + * Maybe next release will have a major cleanup. + */ + + // HACK - Reduce hop count by number of used WIDEn-0 addresses. + + if (hops > 1) { + for (int k = 0; k < ax25_get_num_repeaters(pp); k++) { + char digi[AX25_MAX_ADDR_LEN]; + ax25_get_addr_no_ssid (pp, AX25_REPEATER_1 + k, digi); + int ssid = ax25_get_ssid (pp, AX25_REPEATER_1 + k); + int used = ax25_get_h (pp, AX25_REPEATER_1 + k); + + //text_color_set(DW_COLOR_DEBUG); + //dw_printf ("Examining %s-%d used=%d.\n", digi, ssid, used); + + if (used && strlen(digi) == 5 && strncmp(digi, "WIDE", 4) == 0 && isdigit(digi[4]) && ssid == 0) { + hops--; + //text_color_set(DW_COLOR_DEBUG); + //dw_printf ("Decrease hop count to %d for problematic %s.\n", hops, digi); + } + } + } + + mptr = mheard_ptr(source); + if (mptr == NULL) { + int i; +/* + * Not heard before. Add it. + */ + + if (mheard_debug) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("mheard_save_rf: %s %d - added new\n", source, hops); + } + + mptr = calloc(sizeof(mheard_t),1); + if (mptr == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("FATAL ERROR: Out of memory.\n"); + exit (EXIT_FAILURE); + } + strlcpy (mptr->callsign, source, sizeof(mptr->callsign)); + mptr->count = 1; + mptr->chan = chan; + mptr->num_digi_hops = hops; + mptr->last_heard_rf = now; + mptr->dlat = G_UNKNOWN; + mptr->dlon = G_UNKNOWN; + + i = hash_index(source); + + dw_mutex_lock (&mheard_mutex); + mptr->pnext = mheard_hash[i]; // before inserting into list. + mheard_hash[i] = mptr; + dw_mutex_unlock (&mheard_mutex); + } + else { + +/* + * Update existing entry. + * The only tricky part here is that we might hear the same transmission + * several times. First direct, then thru various digipeater paths. + * We are interested in the shortest path if heard very recently. + */ + + if (hops > mptr->num_digi_hops && (int)(now - mptr->last_heard_rf) < 15) { + + if (mheard_debug) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("mheard_save_rf: %s %d - skip because hops was %d %d seconds ago.\n", source, hops, mptr->num_digi_hops, (int)(now - mptr->last_heard_rf) ); + } + } + else { + + if (mheard_debug) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("mheard_save_rf: %s %d - update time, was %d hops %d seconds ago.\n", source, hops, mptr->num_digi_hops, (int)(now - mptr->last_heard_rf)); + } + + mptr->count++; + mptr->chan = chan; + mptr->num_digi_hops = hops; + mptr->last_heard_rf = now; + } + } + + if (A->g_lat != G_UNKNOWN && A->g_lon != G_UNKNOWN) { + mptr->dlat = A->g_lat; + mptr->dlon = A->g_lon; + } + + if (mheard_debug >= 2) { + int limit = 10; // normally 30 or 60. more frequent when debugging. + text_color_set(DW_COLOR_DEBUG); + dw_printf ("mheard debug, %d min, DIR_CNT=%d,LOC_CNT=%d,RF_CNT=%d\n", limit, mheard_count(0,limit), mheard_count(2,limit), mheard_count(8,limit)); + } + + if (mheard_debug) { + mheard_dump (); + } + +} /* end mheard_save_rf */ + + + +/*------------------------------------------------------------------ + * + * Function: mheard_save_is + * + * Purpose: Save information about station heard via Internet Server. + * + * Inputs: ptext - Packet in monitoring text form as sent by the Internet server. + * + * Any trailing CRLF should have been removed. + * Typical examples: + * + * KA1BTK-5>APDR13,TCPIP*,qAC,T2IRELAND:=4237.62N/07040.68W$/A=-00054 http://aprsdroid.org/ + * N1HKO-10>APJI40,TCPIP*,qAC,N1HKO-JS:APWW10,WIDE1-1,WIDE2-1,qAS,K1RI:/221700h/9AmAT3PQ3S,WIDE1-1,WIDE2-1,qAR,W1TG-1:`c)@qh\>/"50}TinyTrak4 Mobile + * WHO-IS>APJIW4,TCPIP*,qAC,AE5PL-JF::WB2OSZ :C/Billerica Amateur Radio Society/MA/United States{XF}WO + * + * Notice how the final address in the header might not + * be a valid AX.25 address. We see a 9 character address + * (with no ssid) and an ssid of two letters. + * + * The "q construct" ( http://www.aprs-is.net/q.aspx ) provides + * a clue about the journey taken but I don't think we care here. + * + * All we should care about here is the the source address. + * Note that the source address might not adhere to the AX.25 format. + * + * Description: + * + *------------------------------------------------------------------*/ + +void mheard_save_is (char *ptext) +{ + time_t now = time(NULL); + char source[AX25_MAX_ADDR_LEN]; + +#if 1 +// It is possible that source won't adhere to the AX.25 restrictions. +// So we simply extract the source address, as text, from the beginning rather than +// using ax25_from_text() and ax25_get_addr_with_ssid(). + + memset (source, 0, sizeof(source)); + memcpy (source, ptext, sizeof(source)-1); + char *g = strchr(source, '>'); + if (g != NULL) *g = '\0'; + +#else + +/* + * Keep this here in case I want to revive it to get location. + */ + packet_t pp = ax25_from_text(ptext, 0); + + if (pp == NULL) { + if (mheard_debug) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("mheard_save_is: Could not parse message from server.\n"); + dw_printf ("%s\n", ptext); + } + return; + } + + //////ax25_get_addr_with_ssid (pp, AX25_SOURCE, source); +#endif + + mheard_t *mptr = mheard_ptr(source); + if (mptr == NULL) { + int i; +/* + * Not heard before. Add it. + * Observation years later: + * Hmmmm. I wonder why I did not store the location if available. + * An earlier example has an APRSdroid station reporting location without using [ham] RF. + */ + + if (mheard_debug) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("mheard_save_is: %s - added new\n", source); + } + + mptr = calloc(sizeof(mheard_t),1); + if (mptr == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("FATAL ERROR: Out of memory.\n"); + exit (EXIT_FAILURE); + } + strlcpy (mptr->callsign, source, sizeof(mptr->callsign)); + mptr->count = 1; + mptr->last_heard_is = now; + mptr->dlat = G_UNKNOWN; + mptr->dlon = G_UNKNOWN; + + i = hash_index(source); + + dw_mutex_lock (&mheard_mutex); + mptr->pnext = mheard_hash[i]; // before inserting into list. + mheard_hash[i] = mptr; + dw_mutex_unlock (&mheard_mutex); + } + else { + +/* Already there. UPdate last heard from IS time. */ + + if (mheard_debug) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("mheard_save_is: %s - update time, was %d seconds ago.\n", source, (int)(now - mptr->last_heard_rf)); + } + mptr->count++; + mptr->last_heard_is = now; + } + + // Is is desirable to save any location in this case? + // I don't think it would help. + // The whole purpose of keeping the location is for message sending filter. + // We wouldn't want to try sending a message to the station if we didn't hear it over the radio. + // On the other hand, I don't think it would hurt. + // The filter always includes a time since last heard over the radi. + + if (mheard_debug >= 2) { + int limit = 10; // normally 30 or 60 + text_color_set(DW_COLOR_DEBUG); + dw_printf ("mheard debug, %d min, DIR_CNT=%d,LOC_CNT=%d,RF_CNT=%d\n", limit, mheard_count(0,limit), mheard_count(2,limit), mheard_count(8,limit)); + } + + if (mheard_debug) { + mheard_dump (); + } + +#if 0 + ax25_delete (pp); +#endif + +} /* end mheard_save_is */ + + +/*------------------------------------------------------------------ + * + * Function: mheard_count + * + * Purpose: Count local stations for IGate statistics report like this: + * + * pnext) { + if (p->last_heard_rf >= since && p->num_digi_hops <= max_hops) { + count++; + } + } + } + + if (mheard_debug == 1) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("mheard_count(<= %d digi hops, last %d minutes) returns %d\n", max_hops, time_limit, count); + } + + return (count); + +} /* end mheard_count */ + + + +/*------------------------------------------------------------------ + * + * Function: mheard_was_recently_nearby + * + * Purpose: Determine whether given station was heard recently on the radio. + * + * Inputs: role - "addressee" or "source" if debug out is desired. + * Otherwise empty string. + * + * callsign - Callsign for station. + * + * time_limit - Include only stations heard within this many minutes. + * Typically 180. + * + * max_hops - Include only stations heard with this number of + * digipeater hops or less. For reporting, we might use: + * + * dlat, dlon, km - Include only stations within distance of location. + * Not used if G_UNKNOWN is supplied. + * + * Returns: 1 for true, 0 for false. + * + *------------------------------------------------------------------*/ + +int mheard_was_recently_nearby (char *role, char *callsign, int time_limit, int max_hops, double dlat, double dlon, double km) +{ + mheard_t *mptr; + time_t now; + int heard_ago; + + + if (role != NULL && strlen(role) > 0) { + + text_color_set(DW_COLOR_INFO); + if (dlat != G_UNKNOWN && dlon != G_UNKNOWN && km != G_UNKNOWN) { + dw_printf ("Was message %s %s heard in the past %d minutes, with %d or fewer digipeater hops, and within %.1f km of %.2f %.2f?\n", role, callsign, time_limit, max_hops, km, dlat, dlon); + } + else { + dw_printf ("Was message %s %s heard in the past %d minutes, with %d or fewer digipeater hops?\n", role, callsign, time_limit, max_hops); + } + } + + mptr = mheard_ptr(callsign); + + if (mptr == NULL || mptr->last_heard_rf == 0) { + + if (role != NULL && strlen(role) > 0) { + text_color_set(DW_COLOR_INFO); + dw_printf ("No, we have not heard %s over the radio.\n", callsign); + } + return (0); + } + + now = time(NULL); + heard_ago = (int)(now - mptr->last_heard_rf) / 60; + + if (heard_ago > time_limit) { + + if (role != NULL && strlen(role) > 0) { + text_color_set(DW_COLOR_INFO); + dw_printf ("No, %s was last heard over the radio %d minutes ago with %d digipeater hops.\n", callsign, heard_ago, mptr->num_digi_hops); + } + return (0); + } + + if (mptr->num_digi_hops > max_hops) { + + if (role != NULL && strlen(role) > 0) { + text_color_set(DW_COLOR_INFO); + dw_printf ("No, %s was last heard over the radio with %d digipeater hops %d minutes ago.\n", callsign, mptr->num_digi_hops, heard_ago); + } + return (0); + } + +// Apply physical distance check? + + if (dlat != G_UNKNOWN && dlon != G_UNKNOWN && km != G_UNKNOWN && mptr->dlat != G_UNKNOWN && mptr->dlon != G_UNKNOWN) { + + double dist = ll_distance_km (mptr->dlat, mptr->dlon, dlat, dlon); + + if (dist > km) { + + if (role != NULL && strlen(role) > 0) { + text_color_set(DW_COLOR_INFO); + dw_printf ("No, %s was %.1f km away although it was %d digipeater hops %d minutes ago.\n", callsign, dist, mptr->num_digi_hops, heard_ago); + } + return (0); + } + else { + if (role != NULL && strlen(role) > 0) { + text_color_set(DW_COLOR_INFO); + dw_printf ("Yes, %s last heard over radio %d minutes ago, %d digipeater hops. Last location %.1f km away.\n", callsign, heard_ago, mptr->num_digi_hops, dist); + } + return (1); + } + } + +// Passed all the tests. + + if (role != NULL && strlen(role) > 0) { + text_color_set(DW_COLOR_INFO); + dw_printf ("Yes, %s last heard over radio %d minutes ago, %d digipeater hops.\n", callsign, heard_ago, mptr->num_digi_hops); + } + + return (1); + +} /* end mheard_was_recently_nearby */ + + + +/*------------------------------------------------------------------ + * + * Function: mheard_set_msp + * + * Purpose: Set the "message sender position" count for specified station. + * + * Inputs: callsign - Callsign for station which sent the "message." + * + * num - Number of position reports to allow. Typically 1. + * + *------------------------------------------------------------------*/ + +void mheard_set_msp (char *callsign, int num) +{ + mheard_t *mptr; + + mptr = mheard_ptr(callsign); + + if (mptr != NULL) { + + mptr->msp = num; + + if (mheard_debug) { + text_color_set(DW_COLOR_INFO); + dw_printf ("MSP for %s set to %d\n", callsign, num); + } + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Internal error: Can't find %s to set MSP.\n", callsign); + } + +} /* end mheard_set_msp */ + + +/*------------------------------------------------------------------ + * + * Function: mheard_get_msp + * + * Purpose: Get the "message sender position" count for specified station. + * + * Inputs: callsign - Callsign for station which sent the "message." + * + * Returns: The count for the specified station. + * 0 if not found. + * + *------------------------------------------------------------------*/ + +int mheard_get_msp (char *callsign) +{ + mheard_t *mptr; + + mptr = mheard_ptr(callsign); + + if (mptr != NULL) { + + if (mheard_debug) { + text_color_set(DW_COLOR_INFO); + dw_printf ("MSP for %s is %d\n", callsign, mptr->msp); + } + return (mptr->msp); // Should we have a time limit? + } + + return (0); + +} /* end mheard_get_msp */ + + + +/* end mheard.c */ diff --git a/src/mheard.h b/src/mheard.h new file mode 100644 index 00000000..f8466bab --- /dev/null +++ b/src/mheard.h @@ -0,0 +1,20 @@ + + +/* mheard.h */ + +#include "decode_aprs.h" // for decode_aprs_t + + +void mheard_init (int debug); + +void mheard_save_rf (int chan, decode_aprs_t *A, packet_t pp, alevel_t alevel, retry_t retries); + +void mheard_save_is (char *ptext); + +int mheard_count (int max_hops, int time_limit); + +int mheard_was_recently_nearby (char *role, char *callsign, int time_limit, int max_hops, double dlat, double dlon, double km); + +void mheard_set_msp (char *callsign, int num); + +int mheard_get_msp (char *callsign); \ No newline at end of file diff --git a/morse.c b/src/morse.c similarity index 56% rename from morse.c rename to src/morse.c index bc7ea807..b61e75cb 100644 --- a/morse.c +++ b/src/morse.c @@ -1,7 +1,7 @@ // // This file is part of Dire Wolf, an amateur radio packet TNC. // -// Copyright (C) 2013 John Langner, WB2OSZ +// Copyright (C) 2013, 2015 John Langner, WB2OSZ // // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by @@ -30,52 +30,37 @@ * *---------------------------------------------------------------*/ +#include "direwolf.h" + #include #include #include #include #include -#include +#include +#include +#include -#if __WIN32__ -#include -#else -#include -#include -#include -#endif - -#include "direwolf.h" #include "textcolor.h" #include "audio.h" #include "ptt.h" - - -#define WPM 10 -#define TIME_UNITS_TO_MS(tu,wpm) (((tu)*1200)/(wpm)) - - -// TODO : should be in .h file. +#include "gen_tone.h" /* for gen_tone_put_sample */ +#include "morse.h" /* - * Delay from PTT on to start of first character. - * Currently the only anticipated use for this is - * APRStt responses. In this case, we want an adequate - * delay for someone to press the # button, release - * the PTT button, and start listening for a response. + * Might get ambitious and make this adjustable some day. + * Good enough for now. */ -#define MORSE_TXDELAY_MS 1500 -/* - * Delay from end of last character to PTT off. - * Avoid chopping off the last element. - */ -#define MORSE_TXTAIL_MS 200 +#define MORSE_TONE 800 + +#define TIME_UNITS_TO_MS(tu,wpm) (((tu)*1200.0)/(wpm)) + static const struct morse_s { char ch; - char enc[7]; + char enc[8]; /* $ has 7 elements */ } morse[] = { { 'A', ".-" }, { 'B', "-..." }, @@ -85,7 +70,7 @@ static const struct morse_s { { 'F', "..-." }, { 'G', "--." }, { 'H', "...." }, - { 'I', "." }, + { 'I', ".." }, { 'J', ".---" }, { 'K', "-.-" }, { 'L', ".-.." }, @@ -117,19 +102,103 @@ static const struct morse_s { { '.', ".-.-.-" }, { ',', "--..--" }, { '?', "..--.." }, - { '/', "-..-." } + { '/', "-..-." }, + + { '=', "-...-" }, /* from ARRL */ + { '-', "-....-" }, + { ')', "-.--.-" }, /* does not distinguish open/close */ + { ':', "---..." }, + { ';', "-.-.-." }, + { '"', ".-..-." }, + { '\'', ".----." }, + { '$', "...-..-" }, + + { '!', "-.-.--" }, /* more from wikipedia */ + { '(', "-.--." }, + { '&', ".-..." }, + { '+', ".-.-." }, + { '_', "..--.-" }, + { '@', ".--.-." }, + }; -#define NUM_MORSE (sizeof(morse) / sizeof(struct morse_s)) +#define NUM_MORSE ((int)(sizeof(morse) / sizeof(struct morse_s))) -static void morse_tone (int tu); -static void morse_quiet (int tu); +static void morse_tone (int chan, int tu, int wpm); +static void morse_quiet (int chan, int tu, int wpm); +static void morse_quiet_ms (int chan, int ms); static int morse_lookup (int ch); static int morse_units_ch (int ch); static int morse_units_str (char *str); +/* + * Properties of the digitized sound stream. + */ + +static struct audio_s *save_audio_config_p; + + +/* Constants after initialization. */ + +#define TICKS_PER_CYCLE ( 256.0 * 256.0 * 256.0 * 256.0 ) + +static short sine_table[256]; + + + +/*------------------------------------------------------------------ + * + * Name: morse_init + * + * Purpose: Initialize for tone generation. + * + * Inputs: audio_config_p - Pointer to audio configuration structure. + * + * The fields we care about are: + * + * samples_per_sec + * + * amp - Signal amplitude on scale of 0 .. 100. + * + * 100 will produce maximum amplitude of +-32k samples. + * + * Returns: 0 for success. + * -1 for failure. + * + * Description: Precompute a sine wave table. + * + *----------------------------------------------------------------*/ + + +int morse_init (struct audio_s *audio_config_p, int amp) +{ + int j; + +/* + * Save away modem parameters for later use. + */ + + save_audio_config_p = audio_config_p; + + for (j=0; j<256; j++) { + double a; + int s; + + a = ((double)(j) / 256.0) * (2 * M_PI); + s = (int) (sin(a) * 32767.0 * amp / 100.0); + + /* 16 bit sound sample is in range of -32768 .. +32767. */ + assert (s >= -32768 && s <= 32767); + sine_table[j] = s; + } + + return (0); + +} /* end morse_init */ + + /*------------------------------------------------------------------- * * Name: morse_send @@ -159,7 +228,11 @@ int morse_send (int chan, char *str, int wpm, int txdelay, int txtail) int time_units; char *p; + time_units = 0; + + morse_quiet_ms (chan, txdelay); + for (p = str; *p != '\0'; p++) { int i; @@ -169,37 +242,40 @@ int morse_send (int chan, char *str, int wpm, int txdelay, int txtail) for (e = morse[i].enc; *e != '\0'; e++) { if (*e == '.') { - morse_tone (1); + morse_tone (chan,1,wpm); time_units++; } else { - morse_tone (3); + morse_tone (chan,3,wpm); time_units += 3; } if (e[1] != '\0') { - morse_quiet (1); + morse_quiet (chan,1,wpm); time_units++; } } } else { - morse_quiet (1); + morse_quiet (chan,1,wpm); time_units++; } if (p[1] != '\0') { - morse_quiet (3); + morse_quiet (chan,3,wpm); time_units += 3; } } + morse_quiet_ms (chan, txtail); + if (time_units != morse_units_str(str)) { dw_printf ("morse: Internal error. Inconsistent length, %d vs. %d calculated.\n", time_units, morse_units_str(str)); } + audio_flush(ACHAN2ADEV(chan)); return (txdelay + - TIME_UNITS_TO_MS(time_units, wpm) + + (int) (TIME_UNITS_TO_MS(time_units, wpm) + 0.5) + txtail); } /* end morse_send */ @@ -212,18 +288,52 @@ int morse_send (int chan, char *str, int wpm, int txdelay, int txtail) * * Purpose: Generate tone for specified number of time units. * - * Inputs: tu - Number of time units. + * Inputs: chan - Radio channel. + * tu - Number of time units. Should be 1 or 3. + * wpm - Speed in WPM. * *--------------------------------------------------------------------*/ -static void morse_tone (int tu) { - int num_cycles; - int n; +static void morse_tone (int chan, int tu, int wpm) { +#if MTEST1 + int n; for (n=0; nchan_medium[chan] != MEDIUM_RADIO) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Invalid channel %d for sending Morse Code.\n", chan); + return; + } + + tone_phase = 0; + + f1_change_per_sample = (int) (((double)MORSE_TONE * TICKS_PER_CYCLE / (double)save_audio_config_p->adev[a].samples_per_sec ) + 0.5); + + nsamples = (int) ((TIME_UNITS_TO_MS(tu,wpm) * (float)save_audio_config_p->adev[a].samples_per_sec / 1000.) + 0.5); + for (j=0; j> 24) & 0xff]; + gen_tone_put_sample (chan, a, sam); + + }; + +#endif } /* end morse_tone */ @@ -235,20 +345,83 @@ static void morse_tone (int tu) { * * Purpose: Generate silence for specified number of time units. * - * Inputs: tu - Number of time units. + * Inputs: chan - Radio channel. + * tu - Number of time units. + * wpm - Speed in WPM. * *--------------------------------------------------------------------*/ -static void morse_quiet (int tu) { - int n; +static void morse_quiet (int chan, int tu, int wpm) { + +#if MTEST1 + int n; for (n=0; nchan_medium[chan] != MEDIUM_RADIO) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Invalid channel %d for sending Morse Code.\n", chan); + return; + } + + nsamples = (int) ((TIME_UNITS_TO_MS(tu,wpm) * (float)save_audio_config_p->adev[a].samples_per_sec / 1000.) + 0.5); + + for (j=0; jchan_medium[chan] != MEDIUM_RADIO) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Invalid channel %d for sending Morse Code.\n", chan); + return; + } + + nsamples = (int) ((ms * (float)save_audio_config_p->adev[a].samples_per_sec / 1000.) + 0.5); + + for (j=0; j. +// + + +/*------------------------------------------------------------------ + * + * Name: multi_modem.c + * + * Purpose: Use multiple modems in parallel to increase chances + * of decoding less than ideal signals. + * + * Description: The initial motivation was for HF SSB where mistuning + * causes a shift in the audio frequencies. Here, we can + * have multiple modems tuned to staggered pairs of tones + * in hopes that one will be close enough. + * + * The overall structure opens the door to other approaches + * as well. For VHF FM, the tones should always have the + * right frequencies but we might want to tinker with other + * modem parameters instead of using a single compromise. + * + * Originally: The the interface application is in 3 places: + * + * (a) Main program (direwolf.c or atest.c) calls + * demod_init to set up modem properties and + * hdlc_rec_init for the HDLC decoders. + * + * (b) demod_process_sample is called for each audio sample + * from the input audio stream. + * + * (c) When a valid AX.25 frame is found, process_rec_frame, + * provided by the application, in direwolf.c or atest.c, + * is called. Normally this comes from hdlc_rec.c but + * there are a couple other special cases to consider. + * It can be called from hdlc_rec2.c if it took a long + * time to "fix" corrupted bits. aprs_tt.c constructs + * a fake packet when a touch tone message is received. + * + * New in version 0.9: + * + * Put an extra layer in between which potentially uses + * multiple modems & HDLC decoders per channel. The tricky + * part is picking the best one when there is more than one + * success and discarding the rest. + * + * New in version 1.1: + * + * Several enhancements provided by Fabrice FAURE: + * + * Additional types of attempts to fix a bad CRC. + * Optimized code to reduce execution time. + * Improved detection of duplicate packets from + * different fixup attempts. + * Set limit on number of packets in fix up later queue. + * + * New in version 1.6: + * + * FX.25. Previously a delay of a couple bits (or more accurately + * symbols) was fine because the decoders took about the same amount of time. + * Now, we can have an additional delay of up to 64 check bytes and + * some filler in the data portion. We can't simply wait that long. + * With normal AX.25 a couple frames can come and go during that time. + * We want to delay the duplicate removal while FX.25 block reception + * is going on. + * + *------------------------------------------------------------------*/ + +//#define DEBUG 1 + +#define DIGIPEATER_C // Why? + +#include "direwolf.h" + +#include +#include +#include +#include +#include + +#include "ax25_pad.h" +#include "textcolor.h" +#include "multi_modem.h" +#include "demod.h" +#include "hdlc_rec.h" +#include "hdlc_rec2.h" +#include "dlq.h" +#include "fx25.h" +#include "version.h" +#include "ais.h" + + + +// Properties of the radio channels. + +static struct audio_s *save_audio_config_p; + + +// Candidates for further processing. + +static struct { + packet_t packet_p; + alevel_t alevel; + float speed_error; + fec_type_t fec_type; // Type of FEC: none(0), fx25, il2p + retry_t retries; // For the old "fix bits" strategy, this is the + // number of bits that were modified to get a good CRC. + // It would be 0 to something around 4. + // For FX.25, it is the number of corrected. + // This could be from 0 thru 32. + int age; + unsigned int crc; + int score; +} candidate[MAX_CHANS][MAX_SUBCHANS][MAX_SLICERS]; + + + +//#define PROCESS_AFTER_BITS 2 // version 1.4. Was a little short for skew of PSK with different modem types, optional pre-filter + +#define PROCESS_AFTER_BITS 3 + + +static int process_age[MAX_CHANS]; + +static void pick_best_candidate (int chan); + + + +/*------------------------------------------------------------------------------ + * + * Name: multi_modem_init + * + * Purpose: Called at application start up to initialize appropriate + * modems and HDLC decoders. + * + * Input: Modem properties structure as filled in from the configuration file. + * + * Outputs: + * + * Description: Called once at application startup time. + * + *------------------------------------------------------------------------------*/ + +void multi_modem_init (struct audio_s *pa) +{ + int chan; + + +/* + * Save audio configuration for later use. + */ + + save_audio_config_p = pa; + + memset (candidate, 0, sizeof(candidate)); + + demod_init (save_audio_config_p); + hdlc_rec_init (save_audio_config_p); + + for (chan=0; chanchan_medium[chan] == MEDIUM_RADIO) { + if (save_audio_config_p->achan[chan].baud <= 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Internal error, chan=%d, %s, %d\n", chan, __FILE__, __LINE__); + save_audio_config_p->achan[chan].baud = DEFAULT_BAUD; + } + int real_baud = save_audio_config_p->achan[chan].baud; + if (save_audio_config_p->achan[chan].modem_type == MODEM_QPSK) real_baud = save_audio_config_p->achan[chan].baud / 2; + if (save_audio_config_p->achan[chan].modem_type == MODEM_8PSK) real_baud = save_audio_config_p->achan[chan].baud / 3; + + process_age[chan] = PROCESS_AFTER_BITS * save_audio_config_p->adev[ACHAN2ADEV(chan)].samples_per_sec / real_baud ; + //crc_queue_of_last_to_app[chan] = NULL; + } + } + +} + + +/*------------------------------------------------------------------------------ + * + * Name: multi_modem_process_sample + * + * Purpose: Feed the sample into the proper modem(s) for the channel. + * + * Inputs: chan - Radio channel number + * + * audio_sample + * + * Description: In earlier versions we always had a one-to-one mapping with + * demodulators and HDLC decoders. + * This was added so we could have multiple modems running in + * parallel with different mark/space tones to compensate for + * mistuning of HF SSB signals. + * It was also possible to run multiple filters, for the same + * tones, in parallel (e.g. ABC). + * + * Version 1.2: Let's try something new for an experiment. + * We will have a single mark/space demodulator but multiple + * slicers, using different levels, each with its own HDLC decoder. + * We now have a separate variable, num_demod, which could be 1 + * while num_subchan is larger. + * + * Version 1.3: Go back to num_subchan with single meaning of number of demodulators. + * We now have separate independent variable, num_slicers, for the + * mark/space imbalance compensation. + * num_demod, while probably more descriptive, should not exist anymore. + * + *------------------------------------------------------------------------------*/ + +static float dc_average[MAX_CHANS]; + +int multi_modem_get_dc_average (int chan) +{ + // Scale to +- 200 so it will like the deviation measurement. + + return ( (int) ((float)(dc_average[chan]) * (200.0f / 32767.0f) ) ); +} + +__attribute__((hot)) +void multi_modem_process_sample (int chan, int audio_sample) +{ + int d; + int subchan; + +// Accumulate an average DC bias level. +// Shouldn't happen with a soundcard but could with mistuned SDR. + + dc_average[chan] = dc_average[chan] * 0.999f + (float)audio_sample * 0.001f; + + +// Issue 128. Someone ran into this. + + //assert (save_audio_config_p->achan[chan].num_subchan > 0 && save_audio_config_p->achan[chan].num_subchan <= MAX_SUBCHANS); + //assert (save_audio_config_p->achan[chan].num_slicers > 0 && save_audio_config_p->achan[chan].num_slicers <= MAX_SLICERS); + + if (save_audio_config_p->achan[chan].num_subchan <= 0 || save_audio_config_p->achan[chan].num_subchan > MAX_SUBCHANS || + save_audio_config_p->achan[chan].num_slicers <= 0 || save_audio_config_p->achan[chan].num_slicers > MAX_SLICERS) { + + text_color_set(DW_COLOR_ERROR); + dw_printf ("ERROR! Something is seriously wrong in %s %s.\n", __FILE__, __func__); + dw_printf ("chan = %d, num_subchan = %d [max %d], num_slicers = %d [max %d]\n", chan, + save_audio_config_p->achan[chan].num_subchan, MAX_SUBCHANS, + save_audio_config_p->achan[chan].num_slicers, MAX_SLICERS); + dw_printf ("Please report this message and include a copy of your configuration file.\n"); + exit (EXIT_FAILURE); + } + + /* Formerly one loop. */ + /* 1.2: We can feed one demodulator but end up with multiple outputs. */ + + /* Send same thing to all. */ + for (d = 0; d < save_audio_config_p->achan[chan].num_subchan; d++) { + demod_process_sample(chan, d, audio_sample); + } + + for (subchan = 0; subchan < save_audio_config_p->achan[chan].num_subchan; subchan++) { + int slice; + + for (slice = 0; slice < save_audio_config_p->achan[chan].num_slicers; slice++) { + + if (candidate[chan][subchan][slice].packet_p != NULL) { + candidate[chan][subchan][slice].age++; + if (candidate[chan][subchan][slice].age > process_age[chan]) { + if (fx25_rec_busy(chan)) { + candidate[chan][subchan][slice].age = 0; + } + else { + pick_best_candidate (chan); + } + } + } + } + } +} + + + +/*------------------------------------------------------------------- + * + * Name: multi_modem_process_rec_frame + * + * Purpose: This is called when we receive a frame with a valid + * FCS and acceptable size. + * + * Inputs: chan - Audio channel number, 0 or 1. + * subchan - Which modem found it. + * slice - Which slice found it. + * fbuf - Pointer to first byte in HDLC frame. + * flen - Number of bytes excluding the FCS. + * alevel - Audio level, range of 0 - 100. + * (Special case, use negative to skip + * display of audio level line. + * Use -2 to indicate DTMF message.) + * retries - Level of correction used. + * fec_type - none(0), fx25, il2p + * + * Description: Add to list of candidates. Best one will be picked later. + * + *--------------------------------------------------------------------*/ + + +void multi_modem_process_rec_frame (int chan, int subchan, int slice, unsigned char *fbuf, int flen, alevel_t alevel, retry_t retries, fec_type_t fec_type) +{ + packet_t pp; + + + assert (chan >= 0 && chan < MAX_CHANS); + assert (subchan >= 0 && subchan < MAX_SUBCHANS); + assert (slice >= 0 && slice < MAX_SUBCHANS); + +// Special encapsulation for AIS & EAS so they can be treated normally pretty much everywhere else. + + if (save_audio_config_p->achan[chan].modem_type == MODEM_AIS) { + char nmea[256]; + ais_to_nmea (fbuf, flen, nmea, sizeof(nmea)); + + char monfmt[276]; + snprintf (monfmt, sizeof(monfmt), "AIS>%s%1d%1d:{%c%c%s", APP_TOCALL, MAJOR_VERSION, MINOR_VERSION, USER_DEF_USER_ID, USER_DEF_TYPE_AIS, nmea); + pp = ax25_from_text (monfmt, 1); + + // alevel gets in there somehow making me question why it is passed thru here. + } + else if (save_audio_config_p->achan[chan].modem_type == MODEM_EAS) { + char monfmt[300]; // EAS SAME message max length is 268 + + snprintf (monfmt, sizeof(monfmt), "EAS>%s%1d%1d:{%c%c%s", APP_TOCALL, MAJOR_VERSION, MINOR_VERSION, USER_DEF_USER_ID, USER_DEF_TYPE_EAS, fbuf); + pp = ax25_from_text (monfmt, 1); + + // alevel gets in there somehow making me question why it is passed thru here. + } + else { + pp = ax25_from_frame (fbuf, flen, alevel); + } + + multi_modem_process_rec_packet (chan, subchan, slice, pp, alevel, retries, fec_type); +} + +// TODO: Eliminate function above and move code elsewhere? + +void multi_modem_process_rec_packet (int chan, int subchan, int slice, packet_t pp, alevel_t alevel, retry_t retries, fec_type_t fec_type) +{ + if (pp == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Unexpected internal problem, %s %d\n", __FILE__, __LINE__); + return; /* oops! why would it fail? */ + } + +/* + * If only one demodulator/slicer, and no FX.25 in progress, + * push it thru and forget about all this foolishness. + */ + if (save_audio_config_p->achan[chan].num_subchan == 1 && + save_audio_config_p->achan[chan].num_slicers == 1 && + ! fx25_rec_busy(chan)) { + + + int drop_it = 0; + if (save_audio_config_p->recv_error_rate != 0) { + float r = (float)(rand()) / (float)RAND_MAX; // Random, 0.0 to 1.0 + + //text_color_set(DW_COLOR_INFO); + //dw_printf ("TEMP DEBUG. recv error rate = %d\n", save_audio_config_p->recv_error_rate); + + if (save_audio_config_p->recv_error_rate / 100.0 > r) { + drop_it = 1; + text_color_set(DW_COLOR_INFO); + dw_printf ("Intentionally dropping incoming frame. Recv Error rate = %d per cent.\n", save_audio_config_p->recv_error_rate); + } + } + + if (drop_it ) { + ax25_delete (pp); + } + else { + dlq_rec_frame (chan, subchan, slice, pp, alevel, fec_type, retries, ""); + } + return; + } + + +/* + * Otherwise, save them up for a few bit times so we can pick the best. + */ + if (candidate[chan][subchan][slice].packet_p != NULL) { + /* Plain old AX.25: Oops! Didn't expect it to be there. */ + /* FX.25: Quietly replace anything already there. It will have priority. */ + ax25_delete (candidate[chan][subchan][slice].packet_p); + candidate[chan][subchan][slice].packet_p = NULL; + } + + assert (pp != NULL); + + candidate[chan][subchan][slice].packet_p = pp; + candidate[chan][subchan][slice].alevel = alevel; + candidate[chan][subchan][slice].fec_type = fec_type; + candidate[chan][subchan][slice].retries = retries; + candidate[chan][subchan][slice].age = 0; + candidate[chan][subchan][slice].crc = ax25_m_m_crc(pp); +} + + + + +/*------------------------------------------------------------------- + * + * Name: pick_best_candidate + * + * Purpose: This is called when we have one or more candidates + * available for a certain amount of time. + * + * Description: Pick the best one and send it up to the application. + * Discard the others. + * + * Rules: We prefer one received perfectly but will settle for + * one where some bits had to be flipped to get a good CRC. + * + *--------------------------------------------------------------------*/ + +/* This is a suitable order for interleaved "G" demodulators. */ +/* Opposite order would be suitable for multi-frequency although */ +/* multiple slicers are of questionable value for HF SSB. */ + +#define subchan_from_n(x) ((x) % save_audio_config_p->achan[chan].num_subchan) +#define slice_from_n(x) ((x) / save_audio_config_p->achan[chan].num_subchan) + + +static void pick_best_candidate (int chan) +{ + int best_n, best_score; + char spectrum[MAX_SUBCHANS*MAX_SLICERS+1]; + int n, j, k; + if (save_audio_config_p->achan[chan].num_slicers < 1) { + save_audio_config_p->achan[chan].num_slicers = 1; + } + int num_bars = save_audio_config_p->achan[chan].num_slicers * save_audio_config_p->achan[chan].num_subchan; + + memset (spectrum, 0, sizeof(spectrum)); + + for (n = 0; n < num_bars; n++) { + j = subchan_from_n(n); + k = slice_from_n(n); + + /* Build the spectrum display. */ + + if (candidate[chan][j][k].packet_p == NULL) { + spectrum[n] = '_'; + } + else if (candidate[chan][j][k].fec_type != fec_type_none) { // FX.25 or IL2P + // FIXME: using retries both as an enum and later int too. + if ((int)(candidate[chan][j][k].retries) <= 9) { + spectrum[n] = '0' + candidate[chan][j][k].retries; + } + else { + spectrum[n] = '+'; + } + } // AX.25 below + else if (candidate[chan][j][k].retries == RETRY_NONE) { + spectrum[n] = '|'; + } + else if (candidate[chan][j][k].retries == RETRY_INVERT_SINGLE) { + spectrum[n] = ':'; + } + else { + spectrum[n] = '.'; + } + + /* Beginning score depends on effort to get a valid frame CRC. */ + + if (candidate[chan][j][k].packet_p == NULL) { + candidate[chan][j][k].score = 0; + } + else { + if (candidate[chan][j][k].fec_type != fec_type_none) { + candidate[chan][j][k].score = 9000 - 100 * candidate[chan][j][k].retries; // has FEC + } + else { + /* Originally, this produced 0 for the PASSALL case. */ + /* This didn't work so well when looking for the best score. */ + /* Around 1.3 dev H, we add an extra 1 in here so the minimum */ + /* score should now be 1 for anything received. */ + + candidate[chan][j][k].score = RETRY_MAX * 1000 - ((int)candidate[chan][j][k].retries * 1000) + 1; + } + } + } + + // FIXME: IL2p & FX.25 don't have CRC calculated. Must fill it in first. + + + /* Bump it up slightly if others nearby have the same CRC. */ + + for (n = 0; n < num_bars; n++) { + int m; + + j = subchan_from_n(n); + k = slice_from_n(n); + + if (candidate[chan][j][k].packet_p != NULL) { + + for (m = 0; m < num_bars; m++) { + + int mj = subchan_from_n(m); + int mk = slice_from_n(m); + + if (m != n && candidate[chan][mj][mk].packet_p != NULL) { + if (candidate[chan][j][k].crc == candidate[chan][mj][mk].crc) { + candidate[chan][j][k].score += (num_bars+1) - abs(m-n); + } + } + } + } + } + + best_n = 0; + best_score = 0; + + for (n = 0; n < num_bars; n++) { + j = subchan_from_n(n); + k = slice_from_n(n); + + if (candidate[chan][j][k].packet_p != NULL) { + if (candidate[chan][j][k].score > best_score) { + best_score = candidate[chan][j][k].score; + best_n = n; + } + } + } + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("\n%s\n", spectrum); + + for (n = 0; n < num_bars; n++) { + j = subchan_from_n(n); + k = slice_from_n(n); + + if (candidate[chan][j][k].packet_p == NULL) { + dw_printf ("%d.%d.%d: ptr=%p\n", chan, j, k, + candidate[chan][j][k].packet_p); + } + else { + dw_printf ("%d.%d.%d: ptr=%p, fec_type=%d, retry=%d, age=%3d, crc=%04x, score=%d %s\n", chan, j, k, + candidate[chan][j][k].packet_p, + (int)(candidate[chan][j][k].fec_type), + (int)(candidate[chan][j][k].retries), + candidate[chan][j][k].age, + candidate[chan][j][k].crc, + candidate[chan][j][k].score, + (n == best_n) ? "***" : ""); + } + } +#endif + + if (best_score == 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Unexpected internal problem, %s %d. How can best score be zero?\n", __FILE__, __LINE__); + } + +/* + * send the best one along. + */ + + /* Delete those not chosen. */ + + for (n = 0; n < num_bars; n++) { + j = subchan_from_n(n); + k = slice_from_n(n); + if (n != best_n && candidate[chan][j][k].packet_p != NULL) { + ax25_delete (candidate[chan][j][k].packet_p); + candidate[chan][j][k].packet_p = NULL; + } + } + + /* Pass along one. */ + + + j = subchan_from_n(best_n); + k = slice_from_n(best_n); + + int drop_it = 0; + if (save_audio_config_p->recv_error_rate != 0) { + float r = (float)(rand()) / (float)RAND_MAX; // Random, 0.0 to 1.0 + + //text_color_set(DW_COLOR_INFO); + //dw_printf ("TEMP DEBUG. recv error rate = %d\n", save_audio_config_p->recv_error_rate); + + if (save_audio_config_p->recv_error_rate / 100.0 > r) { + drop_it = 1; + text_color_set(DW_COLOR_INFO); + dw_printf ("Intentionally dropping incoming frame. Recv Error rate = %d per cent.\n", save_audio_config_p->recv_error_rate); + } + } + + if ( drop_it ) { + ax25_delete (candidate[chan][j][k].packet_p); + candidate[chan][j][k].packet_p = NULL; + } + else { + assert (candidate[chan][j][k].packet_p != NULL); + dlq_rec_frame (chan, j, k, + candidate[chan][j][k].packet_p, + candidate[chan][j][k].alevel, + candidate[chan][j][k].fec_type, + (int)(candidate[chan][j][k].retries), + spectrum); + + /* Someone else owns it now and will delete it later. */ + candidate[chan][j][k].packet_p = NULL; + } + + /* Clear in preparation for next time. */ + + memset (candidate[chan], 0, sizeof(candidate[chan])); + +} /* end pick_best_candidate */ + + +/* end multi_modem.c */ diff --git a/src/multi_modem.h b/src/multi_modem.h new file mode 100644 index 00000000..51c3cde5 --- /dev/null +++ b/src/multi_modem.h @@ -0,0 +1,24 @@ +/* multi_modem.h */ + +#ifndef MULTI_MODEM_H +#define MULTI_MODEM 1 + +/* Needed for typedef retry_t. */ +#include "hdlc_rec2.h" + +/* Needed for struct audio_s */ +#include "audio.h" + + +void multi_modem_init (struct audio_s *pmodem); + +void multi_modem_process_sample (int c, int audio_sample); + +int multi_modem_get_dc_average (int chan); + +// Deprecated. Replace with ...packet +void multi_modem_process_rec_frame (int chan, int subchan, int slice, unsigned char *fbuf, int flen, alevel_t alevel, retry_t retries, fec_type_t fec_type); + +void multi_modem_process_rec_packet (int chan, int subchan, int slice, packet_t pp, alevel_t alevel, retry_t retries, fec_type_t fec_type); + +#endif diff --git a/src/pfilter.c b/src/pfilter.c new file mode 100644 index 00000000..35767a67 --- /dev/null +++ b/src/pfilter.c @@ -0,0 +1,1777 @@ +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// +// Copyright (C) 2015, 2016, 2023 John Langner, WB2OSZ +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . +// + + + +/*------------------------------------------------------------------ + * + * Module: pfilter.c + * + * Purpose: Packet filtering based on characteristics. + * + * Description: Sometimes it is desirable to digipeat or drop packets based on rules. + * For example, you might want to pass only weather information thru + * a cross band digipeater or you might want to drop all packets from + * an abusive user that is overloading the channel. + * + * The filter specifications are loosely modeled after the IGate Server-side Filter + * Commands: http://www.aprs-is.net/javaprsfilter.aspx + * + * We add AND, OR, NOT, and ( ) to allow very flexible control. + * + *---------------------------------------------------------------*/ + +#include "direwolf.h" + +#include +#include +#include +#include +#include +#include + +#include "ax25_pad.h" +#include "textcolor.h" +#include "decode_aprs.h" +#include "latlong.h" +#include "pfilter.h" +#include "mheard.h" + + + +/* + * Global stuff (to this file) + * + * These are set by init function. + */ + +static struct igate_config_s *save_igate_config_p; +static int s_debug = 0; + + + +/*------------------------------------------------------------------- + * + * Name: pfilter_init + * + * Purpose: One time initialization when main application starts up. + * + * Inputs: p_igate_config - IGate configuration. + * + * debug_level - 0 no debug output. + * 1 single summary line with final result. Indent by 1. + * 2 details from each filter specification. Indent by 3. + * 3 Logical operators. Indent by 2. + * + *--------------------------------------------------------------------*/ + + +void pfilter_init (struct igate_config_s *p_igate_config, int debug_level) +{ + s_debug = debug_level; + save_igate_config_p = p_igate_config; +} + + + + +typedef enum token_type_e { TOKEN_AND, TOKEN_OR, TOKEN_NOT, TOKEN_LPAREN, TOKEN_RPAREN, TOKEN_FILTER_SPEC, TOKEN_EOL } token_type_t; + + +#define MAX_FILTER_LEN 1024 +#define MAX_TOKEN_LEN 1024 + +typedef struct pfstate_s { + + int from_chan; /* From and to channels. MAX_CHANS is used for IGate. */ + int to_chan; /* Used only for debug and error messages. */ + +/* + * Original filter string from config file. + * All control characters should be replaced by spaces. + */ + char filter_str[MAX_FILTER_LEN]; + int nexti; /* Next available character index. */ + +/* + * Packet object. + */ + packet_t pp; + +/* + * Are we processing APRS or connected mode? + * This determines which types of filters are available. + */ + int is_aprs; + +/* + * Packet split into separate parts if APRS. + * Most interesting fields are: + * + * g_symbol_table - / \ or overlay + * g_symbol_code + * g_lat, g_lon - Location + * g_name - for object or item + * g_comment + */ + decode_aprs_t decoded; + +/* + * These are set by next_token. + */ + token_type_t token_type; + char token_str[MAX_TOKEN_LEN]; /* Printable string representation for use in error messages. */ + int tokeni; /* Index in original string for enhanced error messages. */ + +} pfstate_t; + + + +static int parse_expr (pfstate_t *pf); +static int parse_or_expr (pfstate_t *pf); +static int parse_and_expr (pfstate_t *pf); +static int parse_primary (pfstate_t *pf); +static int parse_filter_spec (pfstate_t *pf); + +static void next_token (pfstate_t *pf); +static void print_error (pfstate_t *pf, char *msg); + +static int filt_bodgu (pfstate_t *pf, char *pattern); +static int filt_t (pfstate_t *pf); +static int filt_r (pfstate_t *pf, char *sdist); +static int filt_s (pfstate_t *pf); +static int filt_i (pfstate_t *pf); + +static char *bool2text (int val) +{ + if (val == 1) return "TRUE"; + if (val == 0) return "FALSE"; + if (val == -1) return "ERROR"; + return "OOPS!"; +} + + +/*------------------------------------------------------------------- + * + * Name: pfilter.c + * + * Purpose: Decide whether a packet should be allowed thru. + * + * Inputs: from_chan - Channel packet is coming from. + * to_chan - Channel packet is going to. + * Both are 0 .. MAX_CHANS-1 or MAX_CHANS for IGate. + * For debug/error messages only. + * + * filter - String of filter specs and logical operators to combine them. + * + * pp - Packet object handle. + * + * is_aprs - True for APRS, false for connected mode digipeater. + * Connected mode allows a subset of the filter types, only + * looking at the addresses, not information part contents. + * + * Returns: 1 = yes + * 0 = no + * -1 = error detected + * + * Description: This might be running in multiple threads at the same time so + * no static data allowed and take other thread-safe precautions. + * + *--------------------------------------------------------------------*/ + +int pfilter (int from_chan, int to_chan, char *filter, packet_t pp, int is_aprs) +{ + pfstate_t pfstate; + char *p; + int result; + + assert (from_chan >= 0 && from_chan <= MAX_CHANS); + assert (to_chan >= 0 && to_chan <= MAX_CHANS); + + memset (&pfstate, 0, sizeof(pfstate)); + + if (pp == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("INTERNAL ERROR in pfilter: NULL packet pointer. Please report this!\n"); + return (-1); + } + if (filter == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("INTERNAL ERROR in pfilter: NULL filter string pointer. Please report this!\n"); + return (-1); + } + + pfstate.from_chan = from_chan; + pfstate.to_chan = to_chan; + + /* Copy filter string, changing any control characters to spaces. */ + + strlcpy (pfstate.filter_str, filter, sizeof(pfstate.filter_str)); + + pfstate.nexti = 0; + for (p = pfstate.filter_str; *p != '\0'; p++) { + if (iscntrl(*p)) { + *p = ' '; + } + } + + pfstate.pp = pp; + pfstate.is_aprs = is_aprs; + + if (is_aprs) { + decode_aprs (&pfstate.decoded, pp, 1, NULL); + } + + next_token(&pfstate); + + if (pfstate.token_type == TOKEN_EOL) { + /* Empty filter means reject all. */ + result = 0; + } + else { + result = parse_expr (&pfstate); + + if (pfstate.token_type != TOKEN_AND && + pfstate.token_type != TOKEN_OR && + pfstate.token_type != TOKEN_EOL) { + + print_error (&pfstate, "Expected logical operator or end of line here."); + result = -1; + } + } + + if (s_debug >= 1) { + text_color_set(DW_COLOR_DEBUG); + if (from_chan == MAX_CHANS) { + dw_printf (" Packet filter from IGate to radio channel %d returns %s\n", to_chan, bool2text(result)); + } + else if (to_chan == MAX_CHANS) { + dw_printf (" Packet filter from radio channel %d to IGate returns %s\n", from_chan, bool2text(result)); + } + else if (is_aprs) { + dw_printf (" Packet filter for APRS digipeater from radio channel %d to %d returns %s\n", from_chan, to_chan, bool2text(result)); + } + else { + dw_printf (" Packet filter for traditional digipeater from radio channel %d to %d returns %s\n", from_chan, to_chan, bool2text(result)); + } + } + + return (result); + +} /* end pfilter */ + + + +/*------------------------------------------------------------------- + * + * Name: next_token + * + * Purpose: Extract the next token from input string. + * + * Inputs: pf - Pointer to current state information. + * + * Outputs: See definition of the structure. + * + * Description: Look for these special operators: & | ! ( ) end-of-line + * Anything else is considered a filter specification. + * Note that a filter-spec must be followed by space or + * end of line. This is so the magic characters can appear in one. + * + * Future: Maybe allow words like 'OR' as alternatives to symbols like '|'. + * + * Unresolved Issue: + * + * Adding the special operators adds a new complication. + * How do we handle the case where we want those characters in + * a filter specification? For example how do we know if the + * last character of /#& means HF gateway or AND the next part + * of the expression. + * + * Approach 1: Require white space after all filter specifications. + * Currently implemented. + * Simple. Easy to explain. + * More readable than having everything squashed together. + * + * Approach 2: Use escape character to get literal value. e.g. s/#\& + * Linux people would be comfortable with this but + * others might have a problem with it. + * + * Approach 3: use quotation marks if it contains special characters or space. + * "s/#&" Simple. Allows embedded space but I'm not sure + * that's useful. Doesn't hurt to always put the quotes there + * if you can't remember which characters are special. + * + *--------------------------------------------------------------------*/ + +static void next_token (pfstate_t *pf) +{ + while (pf->filter_str[pf->nexti] == ' ') { + pf->nexti++; + } + + pf->tokeni = pf->nexti; + + if (pf->filter_str[pf->nexti] == '\0') { + pf->token_type = TOKEN_EOL; + strlcpy (pf->token_str, "end-of-line", sizeof(pf->token_str)); + } + else if (pf->filter_str[pf->nexti] == '&') { + pf->nexti++; + pf->token_type = TOKEN_AND; + strlcpy (pf->token_str, "\"&\"", sizeof(pf->token_str)); + } + else if (pf->filter_str[pf->nexti] == '|') { + pf->nexti++; + pf->token_type = TOKEN_OR; + strlcpy (pf->token_str, "\"|\"", sizeof(pf->token_str)); + } + else if (pf->filter_str[pf->nexti] == '!') { + pf->nexti++; + pf->token_type = TOKEN_NOT; + strlcpy (pf->token_str, "\"!\"", sizeof(pf->token_str)); + } + else if (pf->filter_str[pf->nexti] == '(') { + pf->nexti++; + pf->token_type = TOKEN_LPAREN; + strlcpy (pf->token_str, "\"(\"", sizeof(pf->token_str)); + } + else if (pf->filter_str[pf->nexti] == ')') { + pf->nexti++; + pf->token_type = TOKEN_RPAREN; + strlcpy (pf->token_str, "\")\"", sizeof(pf->token_str)); + } + else { + char *p = pf->token_str; + pf->token_type = TOKEN_FILTER_SPEC; + do { + *p++ = pf->filter_str[pf->nexti++]; + } while (pf->filter_str[pf->nexti] != ' ' && pf->filter_str[pf->nexti] != '\0'); + *p = '\0'; + } + +} /* end next_token */ + + +/*------------------------------------------------------------------- + * + * Name: parse_expr + * parse_or_expr + * parse_and_expr + * parse_primary + * + * Purpose: Recursive descent parser to evaluate filter specifications + * contained within expressions with & | ! ( ). + * + * Inputs: pf - Pointer to current state information. + * + * Returns: 1 = yes + * 0 = no + * -1 = error detected + * + *--------------------------------------------------------------------*/ + + +static int parse_expr (pfstate_t *pf) +{ + int result; + + result = parse_or_expr (pf); + + return (result); +} + +/* or_expr:: and_expr [ | and_expr ] ... */ + +static int parse_or_expr (pfstate_t *pf) +{ + int result; + + result = parse_and_expr (pf); + if (result < 0) return (-1); + + while (pf->token_type == TOKEN_OR) { + int e; + + next_token (pf); + e = parse_and_expr (pf); + + if (s_debug >= 3) { + text_color_set(DW_COLOR_DEBUG); + dw_printf (" %s | %s\n", bool2text(result), bool2text(e)); + } + + if (e < 0) return (-1); + result |= e; + } + + return (result); +} + +/* and_expr:: primary [ & primary ] ... */ + +static int parse_and_expr (pfstate_t *pf) +{ + int result; + + result = parse_primary (pf); + if (result < 0) return (-1); + + while (pf->token_type == TOKEN_AND) { + int e; + + next_token (pf); + e = parse_primary (pf); + + if (s_debug >= 3) { + text_color_set(DW_COLOR_DEBUG); + dw_printf (" %s & %s\n", bool2text(result), bool2text(e)); + } + + if (e < 0) return (-1); + result &= e; + } + + return (result); +} + +/* primary:: ( expr ) */ +/* ! primary */ +/* filter_spec */ + +static int parse_primary (pfstate_t *pf) +{ + int result; + + if (pf->token_type == TOKEN_LPAREN) { + + next_token (pf); + result = parse_expr (pf); + + if (pf->token_type == TOKEN_RPAREN) { + next_token (pf); + } + else { + print_error (pf, "Expected \")\" here.\n"); + result = -1; + } + } + else if (pf->token_type == TOKEN_NOT) { + int e; + + next_token (pf); + e = parse_primary (pf); + + if (s_debug >= 3) { + text_color_set(DW_COLOR_DEBUG); + dw_printf (" ! %s\n", bool2text(e)); + } + + if (e < 0) result = -1; + else result = ! e; + } + else if (pf->token_type == TOKEN_FILTER_SPEC) { + result = parse_filter_spec (pf); + } + else { + print_error (pf, "Expected filter specification, (, or ! here."); + result = -1; + } + + return (result); +} + +/*------------------------------------------------------------------- + * + * Name: parse_filter_spec + * + * Purpose: Parse and evaluate filter specification. + * + * Inputs: pf - Pointer to current state information. + * + * Returns: 1 = yes + * 0 = no + * -1 = error detected + * + * Description: All filter specifications are allowed for APRS. + * Only those dealing with addresses are allowed for connected digipeater. + * + * b - budlist (source) + * d - digipeaters used + * v - digipeaters not used + * u - unproto (destination) + * + *--------------------------------------------------------------------*/ + +static int parse_filter_spec (pfstate_t *pf) +{ + int result = -1; + + + if ( ( ! pf->is_aprs) && strchr ("01bdvu", pf->token_str[0]) == NULL) { + + print_error (pf, "Only b, d, v, and u specifications are allowed for connected mode digipeater filtering."); + result = -1; + next_token (pf); + return (result); + } + + +/* undocumented: can use 0 or 1 for testing. */ + + if (strcmp(pf->token_str, "0") == 0) { + result = 0; + } + else if (strcmp(pf->token_str, "1") == 0) { + result = 1; + } + +/* simple string matching */ + +/* b - budlist */ + + else if (pf->token_str[0] == 'b' && ispunct(pf->token_str[1])) { + /* Budlist - AX.25 source address */ + /* Could be different than source encapsulated by 3rd party header. */ + char addr[AX25_MAX_ADDR_LEN]; + ax25_get_addr_with_ssid (pf->pp, AX25_SOURCE, addr); + result = filt_bodgu (pf, addr); + + if (s_debug >= 2) { + text_color_set(DW_COLOR_DEBUG); + dw_printf (" %s returns %s for %s\n", pf->token_str, bool2text(result), addr); + } + } + +/* o - object or item name */ + + else if (pf->token_str[0] == 'o' && ispunct(pf->token_str[1])) { + result = filt_bodgu (pf, pf->decoded.g_name); + + if (s_debug >= 2) { + text_color_set(DW_COLOR_DEBUG); + dw_printf (" %s returns %s for %s\n", pf->token_str, bool2text(result), pf->decoded.g_name); + } + } + +/* d - was digipeated by */ + + else if (pf->token_str[0] == 'd' && ispunct(pf->token_str[1])) { + int n; + // Loop on all AX.25 digipeaters. + result = 0; + for (n = AX25_REPEATER_1; result == 0 && n < ax25_get_num_addr (pf->pp); n++) { + // Consider only those with the H (has-been-used) bit set. + if (ax25_get_h (pf->pp, n)) { + char addr[AX25_MAX_ADDR_LEN]; + ax25_get_addr_with_ssid (pf->pp, n, addr); + result = filt_bodgu (pf, addr); + } + } + + if (s_debug >= 2) { + char path[100]; + + ax25_format_via_path (pf->pp, path, sizeof(path)); + if (strlen(path) == 0) { + strcpy (path, "no digipeater path"); + } + text_color_set(DW_COLOR_DEBUG); + dw_printf (" %s returns %s for %s\n", pf->token_str, bool2text(result), path); + } + } + +/* v - via not used */ + + else if (pf->token_str[0] == 'v' && ispunct(pf->token_str[1])) { + int n; + // loop on all AX.25 digipeaters (mnemonic Via) + result = 0; + for (n = AX25_REPEATER_1; result == 0 && n < ax25_get_num_addr (pf->pp); n++) { + // This is different than the previous "d" filter. + // Consider only those where the the H (has-been-used) bit is NOT set. + if ( ! ax25_get_h (pf->pp, n)) { + char addr[AX25_MAX_ADDR_LEN]; + ax25_get_addr_with_ssid (pf->pp, n, addr); + result = filt_bodgu (pf, addr); + } + } + + if (s_debug >= 2) { + char path[100]; + + ax25_format_via_path (pf->pp, path, sizeof(path)); + if (strlen(path) == 0) { + strcpy (path, "no digipeater path"); + } + text_color_set(DW_COLOR_DEBUG); + dw_printf (" %s returns %s for %s\n", pf->token_str, bool2text(result), path); + } + } + +/* g - Addressee of message. e.g. "BLN*" for bulletins. */ + + else if (pf->token_str[0] == 'g' && ispunct(pf->token_str[1])) { + if (pf->decoded.g_message_subtype == message_subtype_message || + pf->decoded.g_message_subtype == message_subtype_ack || + pf->decoded.g_message_subtype == message_subtype_rej || + pf->decoded.g_message_subtype == message_subtype_bulletin || + pf->decoded.g_message_subtype == message_subtype_nws || + pf->decoded.g_message_subtype == message_subtype_directed_query) { + result = filt_bodgu (pf, pf->decoded.g_addressee); + + if (s_debug >= 2) { + text_color_set(DW_COLOR_DEBUG); + dw_printf (" %s returns %s for %s\n", pf->token_str, bool2text(result), pf->decoded.g_addressee); + } + } + else { + result = 0; + if (s_debug >= 2) { + text_color_set(DW_COLOR_DEBUG); + dw_printf (" %s returns %s for %s\n", pf->token_str, bool2text(result), "not a message"); + } + } + } + +/* u - unproto (AX.25 destination) */ + + else if (pf->token_str[0] == 'u' && ispunct(pf->token_str[1])) { + /* Probably want to exclude mic-e types */ + /* because destination is used for part of location. */ + + if (ax25_get_dti(pf->pp) != '\'' && ax25_get_dti(pf->pp) != '`') { + char addr[AX25_MAX_ADDR_LEN]; + ax25_get_addr_with_ssid (pf->pp, AX25_DESTINATION, addr); + result = filt_bodgu (pf, addr); + + if (s_debug >= 2) { + text_color_set(DW_COLOR_DEBUG); + dw_printf (" %s returns %s for %s\n", pf->token_str, bool2text(result), addr); + } + } + else { + result = 0; + if (s_debug >= 2) { + text_color_set(DW_COLOR_DEBUG); + dw_printf (" %s returns %s for %s\n", pf->token_str, bool2text(result), "MIC-E packet type"); + } + } + } + +/* t - packet type: position, weather, telemetry, etc. */ + + else if (pf->token_str[0] == 't' && ispunct(pf->token_str[1])) { + + result = filt_t (pf); + + if (s_debug >= 2) { + char *infop = NULL; + (void) ax25_get_info (pf->pp, (unsigned char **)(&infop)); + + text_color_set(DW_COLOR_DEBUG); + dw_printf (" %s returns %s for %c data type indicator\n", pf->token_str, bool2text(result), *infop); + } + } + +/* r - range */ + + else if (pf->token_str[0] == 'r' && ispunct(pf->token_str[1])) { + /* range */ + char sdist[30]; + strcpy (sdist, "unknown distance"); + result = filt_r (pf, sdist); + + if (s_debug >= 2) { + text_color_set(DW_COLOR_DEBUG); + dw_printf (" %s returns %s for %s\n", pf->token_str, bool2text(result), sdist); + } + } + +/* s - symbol */ + + else if (pf->token_str[0] == 's' && ispunct(pf->token_str[1])) { + /* symbol */ + result = filt_s (pf); + + if (s_debug >= 2) { + text_color_set(DW_COLOR_DEBUG); + if (pf->decoded.g_symbol_table == '/') { + dw_printf (" %s returns %s for symbol %c in primary table\n", pf->token_str, bool2text(result), pf->decoded.g_symbol_code); + } + else if (pf->decoded.g_symbol_table == '\\') { + dw_printf (" %s returns %s for symbol %c in alternate table\n", pf->token_str, bool2text(result), pf->decoded.g_symbol_code); + } + else { + dw_printf (" %s returns %s for symbol %c with overlay %c\n", pf->token_str, bool2text(result), pf->decoded.g_symbol_code, pf->decoded.g_symbol_table); + } + } + } + +/* i - IGate messaging default */ + + else if (pf->token_str[0] == 'i' && ispunct(pf->token_str[1])) { + /* IGatge messaging */ + result = filt_i (pf); + + if (s_debug >= 2) { + char *infop = NULL; + (void) ax25_get_info (pf->pp, (unsigned char **)(&infop)); + + text_color_set(DW_COLOR_DEBUG); + if (pf->decoded.g_packet_type == packet_type_message) { + dw_printf (" %s returns %s for message to %s\n", pf->token_str, bool2text(result), pf->decoded.g_addressee); + } + else { + dw_printf (" %s returns %s for not an APRS 'message'\n", pf->token_str, bool2text(result)); + } + } + } + +/* unrecognized filter type */ + + else { + char stemp[80]; + snprintf (stemp, sizeof(stemp), "Unrecognized filter type '%c'", pf->token_str[0]); + print_error (pf, stemp); + result = -1; + } + + next_token (pf); + + return (result); +} + + +/*------------------------------------------------------------------------------ + * + * Name: filt_bodgu + * + * Purpose: Filter with text pattern matching + * + * Inputs: pf - Pointer to current state information. + * token_str should have one of these filter specs: + * + * Budlist b/call1/call2... + * Object o/obj1/obj2... + * Digipeater d/digi1/digi2... + * Group Msg g/call1/call2... + * Unproto u/unproto1/unproto2... + * Via-not-yet v/digi1/digi2...noteapd + * + * arg - Value to match from source addr, destination, + * used digipeater, object name, etc. + * + * Returns: 1 = yes + * 0 = no + * -1 = error detected + * + * Description: Same function is used for all of these because they are so similar. + * Look for exact match to any of the specified strings. + * All of them allow wildcarding with single * at the end. + * + *------------------------------------------------------------------------------*/ + +static int filt_bodgu (pfstate_t *pf, char *arg) +{ + char str[MAX_TOKEN_LEN]; + char *cp; + char sep[2]; + char *v; + int result = 0; + + strlcpy (str, pf->token_str, sizeof(str)); + sep[0] = str[1]; + sep[1] = '\0'; + cp = str + 2; + + while (result == 0 && (v = strsep (&cp, sep)) != NULL) { + + int mlen; + char *w; + + if ((w = strchr(v,'*')) != NULL) { + /* Wildcarding. Should have single * on end. */ + + mlen = w - v; + if (mlen != (int)(strlen(v) - 1)) { + print_error (pf, "Any wildcard * must be at the end of pattern.\n"); + return (-1); + } + if (strncmp(v,arg,mlen) == 0) result = 1; + } + else { + /* Try for exact match. */ + if (strcmp(v,arg) == 0) result = 1; + } + } + + return (result); +} + + + +/*------------------------------------------------------------------------------ + * + * Name: filt_t + * + * Purpose: Filter by packet type. + * + * Inputs: pf - Pointer to current state information. + * + * Returns: 1 = yes + * 0 = no + * -1 = error detected + * + * Description: The filter is loosely based the type filtering described here: + * http://www.aprs-is.net/javAPRSFilter.aspx + * + * Mostly use g_packet_type and g_message_subtype from decode_aprs. + * + * References: + * http://www.aprs-is.net/WX/ + * http://wxsvr.aprs.net.au/protocol-new.html (has disappeared) + * + *------------------------------------------------------------------------------*/ + +static int filt_t (pfstate_t *pf) +{ + char src[AX25_MAX_ADDR_LEN]; + char *infop = NULL; + char *f; + + memset (src, 0, sizeof(src)); + ax25_get_addr_with_ssid (pf->pp, AX25_SOURCE, src); + (void) ax25_get_info (pf->pp, (unsigned char **)(&infop)); + + assert (infop != NULL); + + for (f = pf->token_str + 2; *f != '\0'; f++) { + switch (*f) { + + case 'p': /* Position */ + if (pf->decoded.g_packet_type == packet_type_position) return(1); + break; + + case 'o': /* Object */ + if (pf->decoded.g_packet_type == packet_type_object) return(1); + break; + + case 'i': /* Item */ + if (pf->decoded.g_packet_type == packet_type_item) return(1); + break; + + case 'm': // Any "message." + if (pf->decoded.g_packet_type == packet_type_message) return(1); + break; + + case 'q': /* Query */ + if (pf->decoded.g_packet_type == packet_type_query) return(1); + break; + + case 'c': /* station Capabilities - my extension */ + /* Most often used for IGate statistics. */ + if (pf->decoded.g_packet_type == packet_type_capabilities) return(1); + break; + + case 's': /* Status */ + if (pf->decoded.g_packet_type == packet_type_status) return(1); + break; + + case 't': /* Telemetry data or metadata */ + if (pf->decoded.g_packet_type == packet_type_telemetry) return(1); + break; + + case 'u': /* User-defined */ + if (pf->decoded.g_packet_type == packet_type_userdefined) return(1); + break; + + case 'h': /* has third party Header - my extension */ + if (pf->decoded.g_has_thirdparty_header) return (1); + break; + + case 'w': /* Weather */ + + if (pf->decoded.g_packet_type == packet_type_weather) return(1); + + /* Positions !=/@ with symbol code _ are weather. */ + /* Object with _ symbol is also weather. APRS protocol spec page 66. */ + // Can't use *infop because it would not work with 3rd party header. + + if ((pf->decoded.g_packet_type == packet_type_position || + pf->decoded.g_packet_type == packet_type_object) && pf->decoded.g_symbol_code == '_') return (1); + break; + + case 'n': /* NWS format */ + if (pf->decoded.g_packet_type == packet_type_nws) return(1); + break; + + default: + + print_error (pf, "Invalid letter in t/ filter.\n"); + return (-1); + break; + } + } + return (0); /* Didn't match anything. Reject */ + +} /* end filt_t */ + + + + +/*------------------------------------------------------------------------------ + * + * Name: filt_r + * + * Purpose: Is it in range (kilometers) of given location. + * + * Inputs: pf - Pointer to current state information. + * token_str should contain something of format: + * + * r/lat/lon/dist + * + * We also need to know the location (if any) from the packet. + * + * decoded.g_lat & decoded.g_lon + * + * Outputs: sdist - Distance as a string for troubleshooting. + * + * Returns: 1 = yes + * 0 = no + * -1 = error detected + * + * Description: + * + *------------------------------------------------------------------------------*/ + +static int filt_r (pfstate_t *pf, char *sdist) +{ + char str[MAX_TOKEN_LEN]; + char *cp; + char sep[2]; + char *v; + double dlat, dlon, ddist, km; + + + strlcpy (str, pf->token_str, sizeof(str)); + sep[0] = str[1]; + sep[1] = '\0'; + cp = str + 2; + + if (pf->decoded.g_lat == G_UNKNOWN || pf->decoded.g_lon == G_UNKNOWN) { + return (0); + } + + v = strsep (&cp, sep); + if (v == NULL) { + print_error (pf, "Missing latitude for Range filter."); + return (-1); + } + dlat = atof(v); + + v = strsep (&cp, sep); + if (v == NULL) { + print_error (pf, "Missing longitude for Range filter."); + return (-1); + } + dlon = atof(v); + + v = strsep (&cp, sep); + if (v == NULL) { + print_error (pf, "Missing distance for Range filter."); + return (-1); + } + ddist = atof(v); + + km = ll_distance_km (dlat, dlon, pf->decoded.g_lat, pf->decoded.g_lon); + + sprintf (sdist, "%.2f km", km); + + if (km <= ddist) { + return (1); + } + + return (0); +} + + + +/*------------------------------------------------------------------------------ + * + * Name: filt_s + * + * Purpose: Filter by symbol. + * + * Inputs: pf - Pointer to current state information. + * token_str should contain something of format: + * + * s/pri/alt/over + * + * Returns: 1 = yes + * 0 = no + * -1 = error detected + * + * Description: + * + * s/pri + * s/pri/alt + * s/pri/alt/ + * s/pri/alt/over + * + * "pri" is zero or more symbols from the primary symbol set. + * Symbol codes are any printable ASCII character other than | or ~. + * (Zero symbols here would be sensible only if later alt part is specified.) + * "alt" is one or more symbols from the alternate symbol set. + * "over" is overlay characters for the alternate symbol set. + * Only upper case letters, digits, and \ are allowed here. + * If the last part is not specified, any overlay or lack of overlay, is ignored. + * If the last part is specified, only the listed overlays will match. + * An explicit lack of overlay is represented by the \ character. + * + * Examples: + * s/O Balloon. + * s/-> House or car from primary symbol table. + * + * s//# Alternate table digipeater, with or without overlay. + * s//#/\ Alternate table digipeater, only if no overlay. + * s//#/SL1 Alternate table digipeater, with overlay S, L, or 1. + * s//#/SL\ Alternate table digipeater, with S, L, or no overlay. + * + * s/s/s Any variation of watercraft. Either symbol table. With or without overlay. + * s/s/s/ Ship or ship sideview, only if no overlay. + * s//s/J Jet Ski. + * + * What if you want to use the / symbol when / is being used as a delimiter here? Recall that you + * can use some other special character after the initial lower case letter and this becomes the + * delimiter for the rest of the specification. + * + * Examples: + * + * s:/ Red Dot. + * s::/ Waypoint Destination, with or without overlay. + * s:/:/ Either Red Dot or Waypoint Destination. + * s:/:/: Either Red Dot or Waypoint Destination, no overlay. + * + * Bad example: + * + * Someone tried using this to include ballons: s/'/O/-/#/_ + * probably following the buddy filter pattern of / between each alternative. + * There should be an error message because it has more than 3 delimiter characters. + * + * + *------------------------------------------------------------------------------*/ + +static int filt_s (pfstate_t *pf) +{ + char str[MAX_TOKEN_LEN]; + char *cp; + char sep[2]; // Delimiter character. Typically / but it could be different. + char *pri = NULL, *alt = NULL, *over = NULL, *extra = NULL; + char *x; + + + strlcpy (str, pf->token_str, sizeof(str)); + sep[0] = str[1]; + sep[1] = '\0'; + cp = str + 2; + + +// First, separate the parts and do a strict syntax check. + + pri = strsep (&cp, sep); + + if (pri != NULL) { + + // Zero length is acceptable if alternate symbol(s) specified. Will check that later. + + for (x = pri; *x != '\0'; x++) { + if ( ! isprint(*x) || *x == '|' || *x == '~') { + print_error (pf, "Symbol filter, primary must be printable ASCII character(s) other than | or ~."); + return (-1); + } + } + + alt = strsep (&cp, sep); + + if (alt != NULL) { + + // Zero length after second / would be pointless. + + if (strlen(alt) == 0) { + print_error (pf, "Nothing specified for alternate symbol table."); + return (-1); + } + + for (x = alt; *x != '\0'; x++) { + if ( ! isprint(*x) || *x == '|' || *x == '~') { + print_error (pf, "Symbol filter, alternate must be printable ASCII character(s) other than | or ~."); + return (-1); + } + } + + over = strsep (&cp, sep); + + if (over != NULL) { + + // Zero length is acceptable and is not the same as missing. + + for (x = over; *x != '\0'; x++) { + if ( (! isupper(*x)) && (! isdigit(*x)) && *x != '\\') { + print_error (pf, "Symbol filter, overlay must be upper case letter, digit, or \\."); + return (-1); + } + } + + extra = strsep (&cp, sep); + + if (extra != NULL) { + print_error (pf, "More than 3 delimiter characters in Symbol filter."); + return (-1); + } + } + } + else { + // No alt part is OK if at least one primary symbol was specified. + if (strlen(pri) == 0) { + print_error (pf, "No symbols specified for Symbol filter."); + return (-1); + } + } + } + else { + print_error (pf, "Missing arguments for Symbol filter."); + return (-1); + } + + +// This applies only for Position, Object, Item. +// decode_aprs() should set symbol code to space to mean undefined. + + if (pf->decoded.g_symbol_code == ' ') { + return (0); + } + + +// Look for Primary symbols. + + if (pf->decoded.g_symbol_table == '/') { + if (pri != NULL && strlen(pri) > 0) { + return (strchr(pri, pf->decoded.g_symbol_code) != NULL); + } + } + + if (alt == NULL) { + return (0); + } + + //printf ("alt=\"%s\" sym='%c'\n", alt, pf->decoded.g_symbol_code); + +// Look for Alternate symbols. + + if (strchr(alt, pf->decoded.g_symbol_code) != NULL) { + + // We have a match but that might not be enough. + // We must see if there was an overlay part specified. + + if (over != NULL) { + + if (strlen(over) > 0) { + + // Non-zero length overlay part was specified. + // Need to match one of them. + + return (strchr(over, pf->decoded.g_symbol_table) != NULL); + } + else { + + // Zero length overlay part was specified. + // We must have no overlay, i.e. table is \. + + return (pf->decoded.g_symbol_table == '\\'); + } + } + else { + + // No check of overlay part. Just make sure it is not primary table. + + return (pf->decoded.g_symbol_table != '/'); + } + } + + return (0); + +} /* end filt_s */ + + +/*------------------------------------------------------------------------------ + * + * Name: filt_i + * + * Purpose: IGate messaging filter. + * This would make sense only for IS>RF direction. + * + * Inputs: pf - Pointer to current state information. + * token_str should contain something of format: + * + * i/time/hops/lat/lon/km + * + * Returns: 1 = yes + * 0 = no + * -1 = error detected + * + * Description: Selection is based on time since last heard on RF, and distance + * in terms of digipeater hops and/or physical location. + * + * i/time + * i/time/hops + * i/time/hops/lat/lon/km + * + * + * "time" is maximum number of minutes since message addressee was last heard. + * This is required. APRS-IS uses 3 hours so that would be a good value here. + * + * "hops" is maximum number of digpeater hops. (i.e. 0 for heard directly). + * If hops is not specified, the maximum transmit digipeater hop count, + * from the IGTXVIA configuration will be used. + + * The rest is distanced, in kilometers, from given point. + * + * Examples: + * i/180/0 Heard in past 3 hours directly. + * i/45 Past 45 minutes, default max digi hops. + * i/180/3 Default time (3 hours), max 3 digi hops. + * i/180/8/42.6/-71.3/50. + * + * + * It only makes sense to use this for the IS>RF direction. + * The basic idea is that we want to transmit a "message" only if the + * addressee has been heard recently and is not too far away. + * + * That is so we can distinguish messages addressed to a specific + * station, and other sundry uses of the addressee field. + * + * After passing along a "message" we will also allow the next + * position report from the sender of the "message." + * That is done somewhere else. We are not concerned with it here. + * + * IMHO, the rules here are too restrictive. + * + * The APRS-IS would send a "message" to my IGate only if the addressee + * has been heard nearby recently. 180 minutes, I believe. + * Why would I not want to transmit it? + * + * Discussion: In retrospect, I think this is far too complicated. + * In a future release, I think at options other than time should be removed. + * Messages have more value than most packets. Why reduce the chance of successful delivery? + * + * Consider the following scenario: + * + * (1) We hear AA1PR-9 by a path of 4 digipeaters. + * Looking closer, it's probably only two because there are left over WIDE1-0 and WIDE2-0. + * + * Digipeater WIDE2 (probably N3LLO-3) audio level = 72(19/15) [NONE] _|||||___ + * [0.3] AA1PR-9>APY300,K1EQX-7,WIDE1,N3LLO-3,WIDE2*,ARISS::ANSRVR :cq hotg vt aprsthursday{01<0x0d> + * + * (2) APRS-IS sends a response to us. + * + * [ig>tx] ANSRVR>APWW11,KJ4ERJ-15*,TCPIP*,qAS,KJ4ERJ-15::AA1PR-9 :N:HOTG 161 Messages Sent{JL} + * + * (3) Here is our analysis of whether it should be sent to RF. + * + * Was message addressee AA1PR-9 heard in the past 180 minutes, with 2 or fewer digipeater hops? + * No, AA1PR-9 was last heard over the radio with 4 digipeater hops 0 minutes ago. + * + * The wrong hop count caused us to drop a packet that should have been transmitted. + * We could put in a hack to not count the "WIDE*-0" addresses. + * That is not correct because other prefixes could be used and we don't know + * what they are for other digipeaters. + * I think the best solution is to simply ignore the hop count. + * + * Release 1.7: I got overly ambitious and now realize this is just giving people too much + * "rope to hang themselves," drop messages unexpectedly, and accidentally break messaging. + * Change documentation to mention only the time limit. + * The other functionality will be undocumented and maybe disappear over time. + * + *------------------------------------------------------------------------------*/ + +static int filt_i (pfstate_t *pf) +{ + char str[MAX_TOKEN_LEN]; + char *cp; + char sep[2]; + char *v; + +// http://lists.tapr.org/pipermail/aprssig_lists.tapr.org/2020-July/048656.html +// Default of 3 hours should be good. +// One might question why to have a time limit at all. Messages are very rare +// the the APRS-IS wouldn't be sending it to me unless the addressee was in the +// vicinity recently. +// TODO: Should produce a warning if a user specified filter does not include "i". + + int heardtime = 180; // 3 hours * 60 min/hr = 180 minutes +#if PFTEST + int maxhops = 2; +#else + int maxhops = save_igate_config_p->max_digi_hops; // from IGTXVIA config. +#endif + double dlat = G_UNKNOWN; + double dlon = G_UNKNOWN; + double km = G_UNKNOWN; + + + //char src[AX25_MAX_ADDR_LEN]; + //char *infop = NULL; + //int info_len; + //char *f; + //char addressee[AX25_MAX_ADDR_LEN]; + + + strlcpy (str, pf->token_str, sizeof(str)); + sep[0] = str[1]; + sep[1] = '\0'; + cp = str + 2; + +// Get parameters or defaults. + + v = strsep (&cp, sep); + + if (v != NULL && strlen(v) > 0) { + heardtime = atoi(v); + } + else { + print_error (pf, "Missing time limit for IGate message filter."); + return (-1); + } + + v = strsep (&cp, sep); + + if (v != NULL) { + if (strlen(v) > 0) { + maxhops = atoi(v); + } + else { + print_error (pf, "Missing max digipeater hops for IGate message filter."); + return (-1); + } + + v = strsep (&cp, sep); + if (v != NULL && strlen(v) > 0) { + dlat = atof(v); + + v = strsep (&cp, sep); + if (v != NULL && strlen(v) > 0) { + dlon = atof(v); + } + else { + print_error (pf, "Missing longitude for IGate message filter."); + return (-1); + } + + v = strsep (&cp, sep); + if (v != NULL && strlen(v) > 0) { + km = atof(v); + } + else { + print_error (pf, "Missing distance, in km, for IGate message filter."); + return (-1); + } + } + + v = strsep (&cp, sep); + if (v != NULL) { + print_error (pf, "Something unexpected after distance for IGate message filter."); + return (-1); + } + } + +#if PFTEST + text_color_set(DW_COLOR_DEBUG); + dw_printf ("debug: IGate message filter, %d minutes, %d hops, %.2f %.2f %.2f km\n", + heardtime, maxhops, dlat, dlon, km); +#endif + + +/* + * Get source address and info part. + * Addressee has already been extracted into pf->decoded.g_addressee. + */ + if (pf->decoded.g_packet_type != packet_type_message) return(0); + +#if defined(PFTEST) || defined(DIGITEST) // TODO: test functionality too, not just syntax. + + (void)dlat; // Suppress set and not used warning. + (void)dlon; + (void)km; + (void)maxhops; + (void)heardtime; + + return (1); +#else + +/* + * Condition 1: + * "the receiving station has been heard within range within a predefined time + * period (range defined as digi hops, distance, or both)." + */ + + int was_heard = mheard_was_recently_nearby ("addressee", pf->decoded.g_addressee, heardtime, maxhops, dlat, dlon, km); + + if ( ! was_heard) return (0); + +/* + * Condition 2: + * "the sending station has not been heard via RF within a predefined time period + * (packets gated from the Internet by other stations are excluded from this test)." + * + * This is the part I'm not so sure about. + * I guess the intention is that if the sender can be heard over RF, then the addressee + * might hear the sender without the help of Igate stations. + * Suppose the sender was 1 digipeater hop to the west and the addressee was 1 digipeater hop to the east. + * I can communicate with each of them with 1 digipeater hop but for them to reach each other, they + * might need 3 hops and using that many is generally frowned upon and rare. + * + * Maybe we could compromise here and say the sender must have been heard directly. + * It sent the message currently being processed so we must have heard it very recently, i.e. in + * the past minute, rather than the usual 180 minutes for the addressee. + */ + + was_heard = mheard_was_recently_nearby ("source", pf->decoded.g_src, 1, 0, G_UNKNOWN, G_UNKNOWN, G_UNKNOWN); + + if (was_heard) return (0); + + return (1); + +#endif + +} /* end filt_i */ + + +/*------------------------------------------------------------------- + * + * Name: print_error + * + * Purpose: Print error message with context so someone can figure out what caused it. + * + * Inputs: pf - Pointer to current state information. + * + * str - Specific error message. + * + *--------------------------------------------------------------------*/ + +static void print_error (pfstate_t *pf, char *msg) +{ + char intro[50]; + + if (pf->from_chan == MAX_CHANS) { + + if (pf->to_chan == MAX_CHANS) { + snprintf (intro, sizeof(intro), "filter[IG,IG]: "); + } + else { + snprintf (intro, sizeof(intro), "filter[IG,%d]: ", pf->to_chan); + } + } + else { + + if (pf->to_chan == MAX_CHANS) { + snprintf (intro, sizeof(intro), "filter[%d,IG]: ", pf->from_chan); + } + else { + snprintf (intro, sizeof(intro), "filter[%d,%d]: ", pf->from_chan, pf->to_chan); + } + } + + text_color_set (DW_COLOR_ERROR); + + dw_printf ("%s%s\n", intro, pf->filter_str); + dw_printf ("%*s\n", (int)(strlen(intro) + pf->tokeni + 1), "^"); + dw_printf ("%s\n", msg); +} + + + +#if PFTEST + + +/*------------------------------------------------------------------- + * + * Name: main & pftest + * + * Purpose: Unit test for packet filtering. + * + * Usage: gcc -Wall -o pftest -DPFTEST pfilter.c ax25_pad.o textcolor.o fcs_calc.o decode_aprs.o latlong.o symbols.o telemetry.o tt_text.c misc.a regex.a && ./pftest + * + * + *--------------------------------------------------------------------*/ + + +static int error_count = 0; +static void pftest (int test_num, char *filter, char *packet, int expected); + +int main () +{ + + dw_printf ("Quick test for packet filtering.\n"); + dw_printf ("Some error messages are normal. Look at the final success/fail message.\n"); + + pftest (1, "", "WB2OSZ-5>APDW12,WIDE1-1,WIDE2-1:!4237.14NS07120.83W#PHG7140Chelmsford MA", 0); + pftest (2, "0", "WB2OSZ-5>APDW12,WIDE1-1,WIDE2-1:!4237.14NS07120.83W#PHG7140Chelmsford MA", 0); + pftest (3, "1", "WB2OSZ-5>APDW12,WIDE1-1,WIDE2-1:!4237.14NS07120.83W#PHG7140Chelmsford MA", 1); + + pftest (10, "0 | 0", "WB2OSZ-5>APDW12,WIDE1-1,WIDE2-1:!4237.14NS07120.83W#PHG7140Chelmsford MA", 0); + pftest (11, "0 | 1", "WB2OSZ-5>APDW12,WIDE1-1,WIDE2-1:!4237.14NS07120.83W#PHG7140Chelmsford MA", 1); + pftest (12, "1 | 0", "WB2OSZ-5>APDW12,WIDE1-1,WIDE2-1:!4237.14NS07120.83W#PHG7140Chelmsford MA", 1); + pftest (13, "1 | 1", "WB2OSZ-5>APDW12,WIDE1-1,WIDE2-1:!4237.14NS07120.83W#PHG7140Chelmsford MA", 1); + pftest (14, "0 | 0 | 1", "WB2OSZ-5>APDW12,WIDE1-1,WIDE2-1:!4237.14NS07120.83W#PHG7140Chelmsford MA", 1); + + pftest (20, "0 & 0", "WB2OSZ-5>APDW12,WIDE1-1,WIDE2-1:!4237.14NS07120.83W#PHG7140Chelmsford MA", 0); + pftest (21, "0 & 1", "WB2OSZ-5>APDW12,WIDE1-1,WIDE2-1:!4237.14NS07120.83W#PHG7140Chelmsford MA", 0); + pftest (22, "1 & 0", "WB2OSZ-5>APDW12,WIDE1-1,WIDE2-1:!4237.14NS07120.83W#PHG7140Chelmsford MA", 0); + pftest (23, "1 & 1", "WB2OSZ-5>APDW12,WIDE1-1,WIDE2-1:!4237.14NS07120.83W#PHG7140Chelmsford MA", 1); + pftest (24, "1 & 1 & 1", "WB2OSZ-5>APDW12,WIDE1-1,WIDE2-1:!4237.14NS07120.83W#PHG7140Chelmsford MA", 1); + pftest (24, "1 & 0 & 1", "WB2OSZ-5>APDW12,WIDE1-1,WIDE2-1:!4237.14NS07120.83W#PHG7140Chelmsford MA", 0); + pftest (24, "1 & 1 & 0", "WB2OSZ-5>APDW12,WIDE1-1,WIDE2-1:!4237.14NS07120.83W#PHG7140Chelmsford MA", 0); + + pftest (30, "0 | ! 1", "WB2OSZ-5>APDW12,WIDE1-1,WIDE2-1:!4237.14NS07120.83W#PHG7140Chelmsford MA", 0); + pftest (31, "! 1 | ! 0", "WB2OSZ-5>APDW12,WIDE1-1,WIDE2-1:!4237.14NS07120.83W#PHG7140Chelmsford MA", 1); + pftest (32, "! ! 1 | 0", "WB2OSZ-5>APDW12,WIDE1-1,WIDE2-1:!4237.14NS07120.83W#PHG7140Chelmsford MA", 1); + pftest (33, "1 | ! ! 1", "WB2OSZ-5>APDW12,WIDE1-1,WIDE2-1:!4237.14NS07120.83W#PHG7140Chelmsford MA", 1); + + pftest (40, "1 &(!0 |0 )", "WB2OSZ-5>APDW12,WIDE1-1,WIDE2-1:!4237.14NS07120.83W#PHG7140Chelmsford MA", 1); + pftest (41, "0 |(!0 )", "WB2OSZ-5>APDW12,WIDE1-1,WIDE2-1:!4237.14NS07120.83W#PHG7140Chelmsford MA", 1); + pftest (42, "1 |(!!0 )", "WB2OSZ-5>APDW12,WIDE1-1,WIDE2-1:!4237.14NS07120.83W#PHG7140Chelmsford MA", 1); + pftest (42, "(!(1 ) & (1 ))", "WB2OSZ-5>APDW12,WIDE1-1,WIDE2-1:!4237.14NS07120.83W#PHG7140Chelmsford MA", 0); + + pftest (50, "b/W2UB/WB2OSZ-5/N2GH", "WB2OSZ-5>APDW12,WIDE1-1,WIDE2-1:!4237.14NS07120.83W#PHG7140Chelmsford MA", 1); + pftest (51, "b/W2UB/WB2OSZ-14/N2GH", "WB2OSZ-5>APDW12,WIDE1-1,WIDE2-1:!4237.14NS07120.83W#PHG7140Chelmsford MA", 0); + pftest (52, "b#W2UB#WB2OSZ-5#N2GH", "WB2OSZ-5>APDW12,WIDE1-1,WIDE2-1:!4237.14NS07120.83W#PHG7140Chelmsford MA", 1); + pftest (53, "b#W2UB#WB2OSZ-14#N2GH", "WB2OSZ-5>APDW12,WIDE1-1,WIDE2-1:!4237.14NS07120.83W#PHG7140Chelmsford MA", 0); + + pftest (60, "o/HOME", "WB2OSZ>APDW12,WIDE1-1,WIDE2-1:;home *111111z4237.14N/07120.83W-Chelmsford MA", 0); + pftest (61, "o/home", "WB2OSZ>APDW12,WIDE1-1,WIDE2-1:;home *111111z4237.14N/07120.83W-Chelmsford MA", 1); + pftest (62, "o/HOME", "HOME>APDW12,WIDE1-1,WIDE2-1:;AWAY *111111z4237.14N/07120.83W-Chelmsford MA", 0); + pftest (63, "o/WB2OSZ-5", "WB2OSZ-5>APDW12,WIDE1-1,WIDE2-1:!4237.14NS07120.83W#PHG7140Chelmsford MA", 0); + pftest (64, "o/HOME", "WB2OSZ>APDW12,WIDE1-1,WIDE2-1:)home!4237.14N/07120.83W-Chelmsford MA", 0); + pftest (65, "o/home", "WB2OSZ>APDW12,WIDE1-1,WIDE2-1:)home!4237.14N/07120.83W-Chelmsford MA", 1); + + pftest (70, "d/DIGI2/DIGI3", "WB2OSZ-5>APDW12,DIGI1,DIGI2,DIGI3,DIGI4:!4237.14NS07120.83W#PHG7140Chelmsford MA", 0); + pftest (71, "d/DIGI2/DIGI3", "WB2OSZ-5>APDW12,DIGI1*,DIGI2,DIGI3,DIGI4:!4237.14NS07120.83W#PHG7140Chelmsford MA", 0); + pftest (72, "d/DIGI2/DIGI3", "WB2OSZ-5>APDW12,DIGI1,DIGI2*,DIGI3,DIGI4:!4237.14NS07120.83W#PHG7140Chelmsford MA", 1); + pftest (73, "d/DIGI2/DIGI3", "WB2OSZ-5>APDW12,DIGI1,DIGI2,DIGI3*,DIGI4:!4237.14NS07120.83W#PHG7140Chelmsford MA", 1); + pftest (74, "d/DIGI2/DIGI3", "WB2OSZ-5>APDW12,DIGI1,DIGI2,DIGI3,DIGI4*:!4237.14NS07120.83W#PHG7140Chelmsford MA", 1); + pftest (75, "d/DIGI9/DIGI2", "WB2OSZ-5>APDW12,DIGI1,DIGI2*,DIGI3,DIGI4:!4237.14NS07120.83W#PHG7140Chelmsford MA", 1); + + pftest (80, "g/W2UB", "WB2OSZ-5>APDW12::W2UB :text", 1); + pftest (81, "g/W2UB/W2UB-*", "WB2OSZ-5>APDW12::W2UB-9 :text", 1); + pftest (82, "g/W2UB/*", "WB2OSZ-5>APDW12::XXX :text", 1); + pftest (83, "g/W2UB/W*UB", "WB2OSZ-5>APDW12::W2UB-9 :text", -1); + pftest (84, "g/W2UB*", "WB2OSZ-5>APDW12::W2UB-9 :text", 1); + pftest (85, "g/W2UB*", "WB2OSZ-5>APDW12::W2UBZZ :text", 1); + pftest (86, "g/W2UB", "WB2OSZ-5>APDW12::W2UB-9 :text", 0); + pftest (87, "g/*", "WB2OSZ-5>APDW12:!4237.14NS07120.83W#PHG7140Chelmsford MA", 0); + pftest (88, "g/W*", "WB2OSZ-5>APDW12:!4237.14NS07120.83W#PHG7140Chelmsford MA", 0); + + pftest (90, "u/APWW10", "WA1PLE-5>APWW10,W1MHL,N8VIM,WIDE2*:@022301h4208.75N/07115.16WoAPRS-IS for Win32", 1); + pftest (91, "u/TRSY3T", "W1WRA-7>TRSY3T,WIDE1-1,WIDE2-1:`c-:l!hK\\>\"4b}=<0x0d>", 0); + pftest (92, "u/APDW11/APDW12", "WB2OSZ-5>APDW12,DIGI1,DIGI2*,DIGI3,DIGI4:!4237.14NS07120.83W#PHG7140Chelmsford MA", 1); + pftest (93, "u/APDW", "WB2OSZ-5>APDW12,DIGI1,DIGI2*,DIGI3,DIGI4:!4237.14NS07120.83W#PHG7140Chelmsford MA", 0); + + // rather sparse coverage of the cases + pftest (100, "t/mqt", "WB2OSZ-5>APDW12,WIDE1-1,WIDE2-1:!4237.14NS07120.83W#PHG7140Chelmsford MA", 0); + pftest (101, "t/mqtp", "WB2OSZ-5>APDW12,WIDE1-1,WIDE2-1:!4237.14NS07120.83W#PHG7140Chelmsford MA", 1); + pftest (102, "t/mqtp", "WB2OSZ>APDW12,WIDE1-1,WIDE2-1:;home *111111z4237.14N/07120.83W-Chelmsford MA", 0); + pftest (103, "t/mqop", "WB2OSZ>APDW12,WIDE1-1,WIDE2-1:;home *111111z4237.14N/07120.83W-Chelmsford MA", 1); + pftest (104, "t/p", "W1WRA-7>TRSY3T,WIDE1-1,WIDE2-1:`c-:l!hK\\>\"4b}=<0x0d>", 1); + pftest (104, "t/s", "KB1CHU-13>APWW10,W1CLA-1*,WIDE2-1:>FN42pb/_DX: W1MHL 36.0mi 306<0xb0> 13:24 4223.32N 07115.23W", 1); + + pftest (110, "t/p", "N8VIM>APN391,AB1OC-10,W1MRA*,WIDE2:$ULTW0000000001110B6E27F4FFF3897B0001035E004E04DD00030000<0x0d><0x0a>", 0); + pftest (111, "t/w", "N8VIM>APN391,AB1OC-10,W1MRA*,WIDE2:$ULTW0000000001110B6E27F4FFF3897B0001035E004E04DD00030000<0x0d><0x0a>", 1); + pftest (112, "t/t", "WM1X>APU25N:@210147z4235.39N/07106.58W_359/000g000t027r000P000p000h89b10234/WX REPORT {UIV32N}<0x0d>", 0); + pftest (113, "t/w", "WM1X>APU25N:@210147z4235.39N/07106.58W_359/000g000t027r000P000p000h89b10234/WX REPORT {UIV32N}<0x0d>", 1); + + /* Telemetry metadata should not be classified as message. */ + pftest (114, "t/t", "KJ4SNT>APMI04::KJ4SNT :PARM.Vin,Rx1h,Dg1h,Eff1h,Rx10m,O1,O2,O3,O4,I1,I2,I3,I4", 1); + pftest (115, "t/m", "KJ4SNT>APMI04::KJ4SNT :PARM.Vin,Rx1h,Dg1h,Eff1h,Rx10m,O1,O2,O3,O4,I1,I2,I3,I4", 0); + pftest (116, "t/t", "KB1GKN-10>APRX27,UNCAN,WIDE1*:T#491,4.9,0.3,25.0,0.0,1.0,00000000", 1); + + /* Bulletins should not be considered to be messages. Was bug in 1.6. */ + pftest (117, "t/m", "A>B::W1AW :test", 1); + pftest (118, "t/m", "A>B::BLN :test", 0); + pftest (119, "t/m", "A>B::NWS :test", 0); + + // https://www.aprs-is.net/WX/ + pftest (121, "t/p", "CWAPID>APRS::NWS-TTTTT:DDHHMMz,ADVISETYPE,zcs{seq#", 0); + pftest (122, "t/p", "CWAPID>APRS::SKYCWA :DDHHMMz,ADVISETYPE,zcs{seq#", 0); + pftest (123, "t/p", "CWAPID>APRS:;CWAttttz *DDHHMMzLATLONICONADVISETYPE{seq#", 0); + pftest (124, "t/n", "CWAPID>APRS::NWS-TTTTT:DDHHMMz,ADVISETYPE,zcs{seq#", 1); + pftest (125, "t/n", "CWAPID>APRS::SKYCWA :DDHHMMz,ADVISETYPE,zcs{seq#", 1); + //pftest (126, "t/n", "CWAPID>APRS:;CWAttttz *DDHHMMzLATLONICONADVISETYPE{seq#", 1); + pftest (127, "t/", "CWAPID>APRS:;CWAttttz *DDHHMMzLATLONICONADVISETYPE{seq#", 0); + + pftest (128, "t/c", "S0RCE>DEST:DEST:DEST:}WB2OSZ-5>APDW12,DIGI1,DIGI2*,DIGI3,DIGI4:!4237.14NS07120.83W#PHG7140Chelmsford MA", 1); + pftest (131, "t/c", "S0RCE>DEST:}WB2OSZ-5>APDW12,DIGI1,DIGI2*,DIGI3,DIGI4:!4237.14NS07120.83W#PHG7140Chelmsford MA", 0); + + pftest (140, "r/42.6/-71.3/10", "WB2OSZ-5>APDW12,WIDE1-1,WIDE2-1:!4237.14NS07120.83W#PHG7140Chelmsford MA", 1); + pftest (141, "r/42.6/-71.3/10", "WA1PLE-5>APWW10,W1MHL,N8VIM,WIDE2*:@022301h4208.75N/07115.16WoAPRS-IS for Win32", 0); + + pftest (145, "( t/t & b/WB2OSZ ) | ( t/o & ! r/42.6/-71.3/1 )", "WB2OSZ>APDW12:;home *111111z4237.14N/07120.83W-Chelmsford MA", 1); + + pftest (150, "s/->", "WB2OSZ-5>APDW12:!4237.14NS07120.83W#PHG7140Chelmsford MA", 0); + pftest (151, "s/->", "WB2OSZ-5>APDW12:!4237.14N/07120.83W-PHG7140Chelmsford MA", 1); + pftest (152, "s/->", "WB2OSZ-5>APDW12:!4237.14N/07120.83W>PHG7140Chelmsford MA", 1); + pftest (153, "s/->", "WB2OSZ-5>APDW12:!4237.14N\\07120.83W>PHG7140Chelmsford MA", 0); + + pftest (154, "s//#", "WB2OSZ-5>APDW12:!4237.14NS07120.83W#PHG7140Chelmsford MA", 1); + pftest (155, "s//#", "WB2OSZ-5>APDW12:!4237.14N\\07120.83W#PHG7140Chelmsford MA", 1); + pftest (156, "s//#", "WB2OSZ-5>APDW12:!4237.14N/07120.83W#PHG7140Chelmsford MA", 0); + + pftest (157, "s//#/\\", "WB2OSZ-5>APDW12:!4237.14NS07120.83W#PHG7140Chelmsford MA", 0); + pftest (158, "s//#/\\", "WB2OSZ-5>APDW12:!4237.14N\\07120.83W#PHG7140Chelmsford MA", 1); + pftest (159, "s//#/\\", "WB2OSZ-5>APDW12:!4237.14N/07120.83W#PHG7140Chelmsford MA", 0); + + pftest (160, "s//#/LS1", "WB2OSZ-5>APDW12:!4237.14NS07120.83W#PHG7140Chelmsford MA", 1); + pftest (161, "s//#/LS1", "WB2OSZ-5>APDW12:!4237.14N\\07120.83W#PHG7140Chelmsford MA", 0); + pftest (162, "s//#/LS1", "WB2OSZ-5>APDW12:!4237.14N/07120.83W#PHG7140Chelmsford MA", 0); + pftest (163, "s//#/LS\\", "WB2OSZ-5>APDW12:!4237.14N\\07120.83W#PHG7140Chelmsford MA", 1); + + pftest (170, "s:/", "WB2OSZ-5>APDW12:!4237.14N/07120.83W/PHG7140Chelmsford MA", 1); + pftest (171, "s:/", "WB2OSZ-5>APDW12:!4237.14N\\07120.83W/PHG7140Chelmsford MA", 0); + pftest (172, "s::/", "WB2OSZ-5>APDW12:!4237.14N/07120.83W/PHG7140Chelmsford MA", 0); + pftest (173, "s::/", "WB2OSZ-5>APDW12:!4237.14N\\07120.83W/PHG7140Chelmsford MA", 1); + pftest (174, "s:/:/", "WB2OSZ-5>APDW12:!4237.14N/07120.83W/PHG7140Chelmsford MA", 1); + pftest (175, "s:/:/", "WB2OSZ-5>APDW12:!4237.14N\\07120.83W/PHG7140Chelmsford MA", 1); + pftest (176, "s:/:/", "WB2OSZ-5>APDW12:!4237.14NX07120.83W/PHG7140Chelmsford MA", 1); + pftest (177, "s:/:/:X", "WB2OSZ-5>APDW12:!4237.14NX07120.83W/PHG7140Chelmsford MA", 1); + + // FIXME: Different on Windows and 64 bit Linux. + //pftest (178, "s:/:/:", "WB2OSZ-5>APDW12:!4237.14NX07120.83W/PHG7140Chelmsford MA", 1); + + pftest (179, "s:/:/:\\", "WB2OSZ-5>APDW12:!4237.14NX07120.83W/PHG7140Chelmsford MA", 0); + + pftest (180, "v/DIGI2/DIGI3", "WB2OSZ-5>APDW12,DIGI1,DIGI2,DIGI3,DIGI4:!4237.14NS07120.83W#PHG7140Chelmsford MA", 1); + pftest (181, "v/DIGI2/DIGI3", "WB2OSZ-5>APDW12,DIGI1*,DIGI2,DIGI3,DIGI4:!4237.14NS07120.83W#PHG7140Chelmsford MA", 1); + pftest (182, "v/DIGI2/DIGI3", "WB2OSZ-5>APDW12,DIGI1,DIGI2*,DIGI3,DIGI4:!4237.14NS07120.83W#PHG7140Chelmsford MA", 1); + pftest (183, "v/DIGI2/DIGI3", "WB2OSZ-5>APDW12,DIGI1,DIGI2,DIGI3*,DIGI4:!4237.14NS07120.83W#PHG7140Chelmsford MA", 0); + pftest (184, "v/DIGI2/DIGI3", "WB2OSZ-5>APDW12,DIGI1,DIGI2,DIGI3,DIGI4*:!4237.14NS07120.83W#PHG7140Chelmsford MA", 0); + pftest (185, "v/DIGI9/DIGI2", "WB2OSZ-5>APDW12,DIGI1,DIGI2*,DIGI3,DIGI4:!4237.14NS07120.83W#PHG7140Chelmsford MA", 0); + + /* Test error reporting. */ + + pftest (200, "x/", "CWAPID>APRS:;CWAttttz *DDHHMMzLATLONICONADVISETYPE{seq#", -1); + pftest (201, "t/w & ( t/w | t/w ", "CWAPID>APRS:;CWAttttz *DDHHMMzLATLONICONADVISETYPE{seq#", -1); + pftest (202, "t/w ) ", "CWAPID>APRS:;CWAttttz *DDHHMMzLATLONICONADVISETYPE{seq#", -1); + pftest (203, "!", "CWAPID>APRS:;CWAttttz *DDHHMMzLATLONICONADVISETYPE{seq#", -1); + pftest (203, "t/w t/w", "CWAPID>APRS:;CWAttttz *DDHHMMzLATLONICONADVISETYPE{seq#", -1); + pftest (204, "r/42.6/-71.3", "WA1PLE-5>APWW10,W1MHL,N8VIM,WIDE2*:@022301h4208.75N/07115.16WoAPRS-IS for Win32", -1); + + pftest (210, "i/30/8/42.6/-71.3/50", "WB2OSZ-5>APDW14::W2UB :Happy Birthday{001", 1); + pftest (212, "i/30/8/42.6/-71.3/", "WB2OSZ-5>APDW14::W2UB :Happy Birthday{001", -1); + pftest (213, "i/30/8/42.6/-71.3", "WB2OSZ-5>APDW14::W2UB :Happy Birthday{001", -1); + pftest (214, "i/30/8/42.6/", "WB2OSZ-5>APDW14::W2UB :Happy Birthday{001", -1); + pftest (215, "i/30/8/42.6", "WB2OSZ-5>APDW14::W2UB :Happy Birthday{001", -1); + pftest (216, "i/30/8/", "WB2OSZ-5>APDW14::W2UB :Happy Birthday{001", 1); + pftest (217, "i/30/8", "WB2OSZ-5>APDW14::W2UB :Happy Birthday{001", 1); + + // FIXME: behaves differently on Windows and Linux. Why? + // On Windows we have our own version of strsep because it's not in the MS library. + // It must behave differently than the Linux version when nothing follows the last separator. + //pftest (228, "i/30/", "WB2OSZ-5>APDW14::W2UB :Happy Birthday{001", 1); + + pftest (229, "i/30", "WB2OSZ-5>APDW14::W2UB :Happy Birthday{001", 1); + pftest (230, "i/30", "X>X:}WB2OSZ-5>APDW14::W2UB :Happy Birthday{001", 1); + pftest (231, "i/", "WB2OSZ-5>APDW14::W2UB :Happy Birthday{001", -1); + + // Besure bulletins and telemetry metadata don't get included. + pftest (234, "i/30", "KJ4SNT>APMI04::KJ4SNT :PARM.Vin,Rx1h,Dg1h,Eff1h,Rx10m,O1,O2,O3,O4,I1,I2,I3,I4", 0); + pftest (235, "i/30", "A>B::BLN :test", 0); + + pftest (240, "s/", "WB2OSZ-5>APDW12:!4237.14N/07120.83WOPHG7140Chelmsford MA", -1); + pftest (241, "s/'/O/-/#/_", "WB2OSZ-5>APDW12:!4237.14N/07120.83WOPHG7140Chelmsford MA", -1); + pftest (242, "s/O/O/c", "WB2OSZ-5>APDW12:!4237.14N/07120.83WOPHG7140Chelmsford MA", -1); + pftest (243, "s/O/O/1/2", "WB2OSZ-5>APDW12:!4237.14N/07120.83WOPHG7140Chelmsford MA", -1); + pftest (244, "s/O/|/1", "WB2OSZ-5>APDW12:!4237.14N/07120.83WOPHG7140Chelmsford MA", -1); + pftest (245, "s//", "WB2OSZ-5>APDW12:!4237.14N/07120.83WOPHG7140Chelmsford MA", -1); + pftest (246, "s///", "WB2OSZ-5>APDW12:!4237.14N/07120.83WOPHG7140Chelmsford MA", -1); + + // Third party header - done properly in 1.7. + // Packet filter t/h is no longer a mutually exclusive packet type. + // Now it is an independent attribute and the encapsulated part is evaluated. + + pftest (250, "o/home", "A>B:}WB2OSZ>APDW12,WIDE1-1,WIDE2-1:;home *111111z4237.14N/07120.83W-Chelmsford MA", 1); + pftest (251, "t/p", "A>B:}W1WRA-7>TRSY3T,WIDE1-1,WIDE2-1:`c-:l!hK\\>\"4b}=<0x0d>", 1); + pftest (252, "i/180", "A>B:}WB2OSZ-5>APDW14::W2UB :Happy Birthday{001", 1); + pftest (253, "t/m", "A>B:}WB2OSZ-5>APDW14::W2UB :Happy Birthday{001", 1); + pftest (254, "r/42.6/-71.3/10", "A>B:}WB2OSZ-5>APDW12,WIDE1-1,WIDE2-1:!4237.14NS07120.83W#PHG7140Chelmsford MA", 1); + pftest (254, "r/42.6/-71.3/10", "A>B:}WA1PLE-5>APWW10,W1MHL,N8VIM,WIDE2*:@022301h4208.75N/07115.16WoAPRS-IS for Win32", 0); + pftest (255, "t/h", "KB1GKN-10>APRX27,UNCAN,WIDE1*:T#491,4.9,0.3,25.0,0.0,1.0,00000000", 0); + pftest (256, "t/h", "A>B:}KB1GKN-10>APRX27,UNCAN,WIDE1*:T#491,4.9,0.3,25.0,0.0,1.0,00000000", 1); + pftest (258, "t/t", "A>B:}KB1GKN-10>APRX27,UNCAN,WIDE1*:T#491,4.9,0.3,25.0,0.0,1.0,00000000", 1); + pftest (259, "t/t", "A>B:}KJ4SNT>APMI04::KJ4SNT :PARM.Vin,Rx1h,Dg1h,Eff1h,Rx10m,O1,O2,O3,O4,I1,I2,I3,I4", 1); + + pftest (270, "g/BLN*", "WB2OSZ>APDW17::BLN1xxxxx:bulletin text", 1); + pftest (271, "g/BLN*", "A>B:}WB2OSZ>APDW17::BLN1xxxxx:bulletin text", 1); + pftest (272, "g/BLN*", "A>B:}WB2OSZ>APDW17::W1AW :xxxx", 0); + + pftest (273, "g/NWS*", "WB2OSZ>APDW17::NWS-xxxxx:weather bulletin", 1); + pftest (274, "g/NWS*", "A>B:}WB2OSZ>APDW17::NWS-xxxxx:weather bulletin", 1); + pftest (275, "g/NWS*", "A>B:}WB2OSZ>APDW17::W1AW :xxxx", 0); + +// TODO: add b/ with 3rd party header. + +// TODO: to be continued... directed query ... + + if (error_count > 0) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("\nPacket Filtering Test - FAILED! %d errors\n", error_count); + exit (EXIT_FAILURE); + } + text_color_set (DW_COLOR_REC); + dw_printf ("\nPacket Filtering Test - SUCCESS!\n"); + exit (EXIT_SUCCESS); + +} + +static void pftest (int test_num, char *filter, char *monitor, int expected) +{ + int result; + packet_t pp; + + text_color_set (DW_COLOR_DEBUG); + dw_printf ("test number %d\n", test_num); + + pp = ax25_from_text (monitor, 1); + assert (pp != NULL); + + result = pfilter (0, 0, filter, pp, 1); + if (result != expected) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("Unexpected result for test number %d\n", test_num); + error_count++; + } + + ax25_delete (pp); +} + +#endif /* if TEST */ + +/* end pfilter.c */ + + diff --git a/src/pfilter.h b/src/pfilter.h new file mode 100644 index 00000000..d54e0564 --- /dev/null +++ b/src/pfilter.h @@ -0,0 +1,13 @@ + +/* pfilter.h */ + + +#include "igate.h" // for igate_config_s + + + +void pfilter_init (struct igate_config_s *p_igate_config, int debug_level); + +int pfilter (int from_chan, int to_chan, char *filter, packet_t pp, int is_aprs); + +int is_telem_metadata (char *infop); \ No newline at end of file diff --git a/src/ptt.c b/src/ptt.c new file mode 100644 index 00000000..5187f1df --- /dev/null +++ b/src/ptt.c @@ -0,0 +1,1673 @@ +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// +// Copyright (C) 2011, 2013, 2014, 2015, 2016, 2017, 2023 John Langner, WB2OSZ +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . + + +/*------------------------------------------------------------------ + * + * Module: ptt.c + * + * Purpose: Activate the output control lines for push to talk (PTT) and other purposes. + * + * Description: Traditionally this is done with the RTS signal of the serial port. + * + * If we have two radio channels and only one serial port, DTR + * can be used for the second channel. + * + * If __WIN32__ is defined, we use the Windows interface. + * Otherwise we use the Linux interface. + * + * Version 0.9: Add ability to use GPIO pins on Linux. + * + * Version 1.1: Add parallel printer port for x86 Linux only. + * + * This is hardcoded to use the primary motherboard parallel + * printer port at I/O address 0x378. This might work with + * a PCI card configured to use the same address if the + * motherboard does not have a built in parallel port. + * It won't work with a USB-to-parallel-printer-port adapter. + * + * Version 1.2: More than two radio channels. + * Generalize for additional signals besides PTT. + * + * Version 1.3: HAMLIB support. + * + * Version 1.4: The spare "future" indicator is now used when connected to another station. + * + * Take advantage of the new 'gpio' group and new /sys/class/gpio protections in Raspbian Jessie. + * + * Handle more complicated gpio node names for CubieBoard, etc. + * + * Version 1.5: Ability to use GPIO pins of CM108/CM119 for PTT signal. + * + * + * References: http://www.robbayer.com/files/serial-win.pdf + * + * https://www.kernel.org/doc/Documentation/gpio.txt + * + *---------------------------------------------------------------*/ + +/* + A growing number of people have been asking about support for the DMK URI, + RB-USB RIM, etc. + + These use a C-Media CM108/CM119 with an interesting addition, a GPIO + pin is used to drive PTT. Here is some related information. + + DMK URI: + + http://www.dmkeng.com/URI_Order_Page.htm + http://dmkeng.com/images/URI%20Schematic.pdf + + RB-USB RIM: + + http://www.repeater-builder.com/products/usb-rim-lite.html + http://www.repeater-builder.com/voip/pdf/cm119-datasheet.pdf + + RA-35: + + http://www.masterscommunications.com/products/radio-adapter/ra35.html + + DINAH: + + https://hamprojects.info/dinah/ + + + Homebrew versions of the same idea: + + http://images.ohnosec.org/usbfob.pdf + http://www.qsl.net/kb9mwr/projects/voip/usbfob-119.pdf + http://rtpdir.weebly.com/uploads/1/6/8/7/1687703/usbfob.pdf + http://www.repeater-builder.com/projects/fob/USB-Fob-Construction.pdf + + Applications that have support for this: + + http://docs.allstarlink.org/drupal/ + http://soundmodem.sourcearchive.com/documentation/0.16-1/ptt_8c_source.html + https://github.com/N0NB/hamlib/blob/master/src/cm108.c#L190 + http://permalink.gmane.org/gmane.linux.hams.hamlib.devel/3420 + + Information about the "hidraw" device: + + http://unix.stackexchange.com/questions/85379/dev-hidraw-read-permissions + http://www.signal11.us/oss/udev/ + http://www.signal11.us/oss/hidapi/ + https://github.com/signal11/hidapi/blob/master/libusb/hid.c + http://stackoverflow.com/questions/899008/howto-write-to-the-gpio-pin-of-the-cm108-chip-in-linux + https://www.kernel.org/doc/Documentation/hid/hidraw.txt + https://github.com/torvalds/linux/blob/master/samples/hidraw/hid-example.c + + Similar chips: SSS1621, SSS1623 + + https://irongarment.wordpress.com/2011/03/29/cm108-compatible-chips-with-gpio/ + + Here is an attempt to add direct CM108 support. + Seems to be hardcoded for only a single USB audio adapter. + + https://github.com/donothingloop/direwolf_cm108 + + In version 1.3, we add HAMLIB support which should be able to do this in a roundabout way. + (Linux only at this point.) + + This is documented in the User Guide, section called, + "Hamlib PTT Example 2: Use GPIO of USB audio adapter. (e.g. DMK URI)" + + It's rather involved and the explanation doesn't cover the case of multiple + USB-Audio adapters. It would be nice to have a little script which lists all + of the USB-Audio adapters and the corresponding /dev/hidraw device. + ( We now have it. The included "cm108" application. ) + + In version 1.5 we have a flexible, easy to use implementation for Linux. + Windows would be a lot of extra work because USB devices are nothing like Linux. + We'd be starting from scratch to figure out how to do it. +*/ + + +#include "direwolf.h" // should be first. This includes windows.h. + +#include +#include +#include +#include +#include +#include + +#if __WIN32__ +#else +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#ifdef USE_HAMLIB +#include +#endif + +/* So we can have more common code for fd. */ +typedef int HANDLE; +#define INVALID_HANDLE_VALUE (-1) + +#endif /* __WIN32__ */ + +#ifdef USE_CM108 +#include "cm108.h" +#endif /* USE_CM108 */ + +#include "textcolor.h" +#include "audio.h" +#include "ptt.h" +#include "dlq.h" +#include "demod.h" // to mute recv audio during xmit if half duplex. + + +#if __WIN32__ + +#define RTS_ON(fd) EscapeCommFunction(fd,SETRTS); +#define RTS_OFF(fd) EscapeCommFunction(fd,CLRRTS); +#define DTR_ON(fd) EscapeCommFunction(fd,SETDTR); +#define DTR_OFF(fd) EscapeCommFunction(fd,CLRDTR); + +#else + +#define RTS_ON(fd) { int stuff; ioctl (fd, TIOCMGET, &stuff); stuff |= TIOCM_RTS; ioctl (fd, TIOCMSET, &stuff); } +#define RTS_OFF(fd) { int stuff; ioctl (fd, TIOCMGET, &stuff); stuff &= ~TIOCM_RTS; ioctl (fd, TIOCMSET, &stuff); } +#define DTR_ON(fd) { int stuff; ioctl (fd, TIOCMGET, &stuff); stuff |= TIOCM_DTR; ioctl (fd, TIOCMSET, &stuff); } +#define DTR_OFF(fd) { int stuff; ioctl (fd, TIOCMGET, &stuff); stuff &= ~TIOCM_DTR; ioctl (fd, TIOCMSET, &stuff); } + +#define LPT_IO_ADDR 0x378 + +#endif + + + +static struct audio_s *save_audio_config_p; /* Save config information for later use. */ + +static int ptt_debug_level = 0; + +void ptt_set_debug(int debug) +{ + ptt_debug_level = debug; +} + + +/*------------------------------------------------------------------- + * + * Name: get_access_to_gpio + * + * Purpose: Try to get access to the GPIO device. + * + * Inputs: path - Path to device node. + * /sys/class/gpio/export + * /sys/class/gpio/unexport + * /sys/class/gpio/gpio??/direction + * /sys/class/gpio/gpio??/value + * + * Description: First see if we have access thru the usual uid/gid/mode method. + * If that fails, we try a hack where we use "sudo chmod ..." to open up access. + * That requires that sudo be configured to work without a password. + * That's the case for 'pi' user in Raspbian but not not be for other boards / operating systems. + * + * Debug: Use the "-doo" command line option. + * + *------------------------------------------------------------------*/ + +#ifndef __WIN32__ + +#define MAX_GROUPS 50 + + +static void get_access_to_gpio (const char *path) +{ + + static int my_uid = -1; + static int my_gid = -1; + static gid_t my_groups[MAX_GROUPS]; + static int num_groups = 0; + static int first_time = 1; + + struct stat finfo; + int i; + char cmd[80]; + int err; + +/* + * Does path even exist? + */ + + if (stat(path, &finfo) < 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Can't get properties of %s.\n", path); + dw_printf ("This system is not configured with the GPIO user interface.\n"); + dw_printf ("Use a different method for PTT control.\n"); + exit (1); + } + + if (first_time) { + + // No need to fetch same information each time. Cache it. + my_uid = geteuid(); + my_gid = getegid(); + num_groups = getgroups (MAX_GROUPS, my_groups); + + if (num_groups < 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("getgroups() failed to get supplementary groups, errno=%d\n", errno); + num_groups = 0; + } + first_time = 0; + } + + if (ptt_debug_level >= 2) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("%s: uid=%d, gid=%d, mode=o%o\n", path, finfo.st_uid, finfo.st_gid, finfo.st_mode); + dw_printf ("my uid=%d, gid=%d, supplementary groups=", my_uid, my_gid); + for (i = 0; i < num_groups; i++) { + dw_printf (" %d", my_groups[i]); + } + dw_printf ("\n"); + } + +/* + * Do we have permission to access it? + * + * On Debian 7 (Wheezy) we see this: + * + * $ ls -l /sys/class/gpio/export + * --w------- 1 root root 4096 Feb 27 12:31 /sys/class/gpio/export + * + * + * Only root can write to it. + * Our work-around is change the protection so that everyone can write. + * This requires that the current user can use sudo without a password. + * This has been the case for the predefined "pi" user but can be a problem + * when people add new user names. + * Other operating systems could have different default configurations. + * + * A better solution is available in Debian 8 (Jessie). The group is now "gpio" + * so anyone in that group can now write to it. + * + * $ ls -l /sys/class/gpio/export + * -rwxrwx--- 1 root gpio 4096 Mar 4 21:12 /sys/class/gpio/export + * + * + * First see if we can access it by the usual file protection rules. + * If not, we will try the "sudo chmod go+rw ..." hack. + * + */ + + +/* + * Do I have access? + * We could just try to open for write but this gives us more debugging information. + */ + + if ((my_uid == finfo.st_uid) && (finfo.st_mode & S_IWUSR)) { // user write 00200 + if (ptt_debug_level >= 2) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("My uid matches and we have user write permission.\n"); + } + return; + } + + if ((my_gid == finfo.st_gid) && (finfo.st_mode & S_IWGRP)) { // group write 00020 + if (ptt_debug_level >= 2) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("My primary gid matches and we have group write permission.\n"); + } + return; + } + + for (i = 0; i < num_groups; i++) { + if ((my_groups[i] == finfo.st_gid) && (finfo.st_mode & S_IWGRP)) { // group write 00020 + if (ptt_debug_level >= 2) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("My supplemental group %d matches and we have group write permission.\n", my_groups[i]); + } + return; + } + } + + if (finfo.st_mode & S_IWOTH) { // other write 00002 + if (ptt_debug_level >= 2) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("We have other write permission.\n"); + } + return; + } + +/* + * We don't have permission. + * Try a hack which requires that the user be set up to use sudo without a password. + */ +// FIXME: I think this was a horrible work around for some early release that +// did not give gpio permission to the pi user. This should go. +// Provide recovery instructions when there is a permission failure. + + if (ptt_debug_level >= 2) { + text_color_set(DW_COLOR_ERROR); // debug message but different color so it stands out. + dw_printf ("Trying 'sudo chmod go+rw %s' hack.\n", path); + } + + snprintf (cmd, sizeof(cmd), "sudo chmod go+rw %s", path); + err = system (cmd); + (void)err; // suppress warning about not using result. + +/* + * I don't trust status coming back from system() so we will check the mode again. + */ + + if (stat(path, &finfo) < 0) { + /* Unexpected because we could do it before. */ + text_color_set(DW_COLOR_ERROR); + dw_printf ("This system is not configured with the GPIO user interface.\n"); + dw_printf ("Use a different method for PTT control.\n"); + exit (1); + } + + /* Did we succeed in changing the protection? */ + + if ( (finfo.st_mode & 0266) != 0266) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("You don't have the necessary permission to access GPIO.\n"); + dw_printf ("There are three different solutions: \n"); + dw_printf (" 1. Run as root. (not recommended)\n"); + dw_printf (" 2. If operating system has 'gpio' group, add your user id to it.\n"); + dw_printf (" 3. Configure your user id for sudo without a password.\n"); + dw_printf ("\n"); + dw_printf ("Read the documentation and try -doo command line option for debugging details.\n"); + exit (1); + } + +} + +#endif + + + +/*------------------------------------------------------------------- + * + * Name: export_gpio + * + * Purpose: Tell the GPIO subsystem to export a GPIO line for + * us to use, and set the initial state of the GPIO. + * + * Inputs: ch - Radio Channel. + * ot - Output type. + * invert: - Is the GPIO active low? + * direction: - 0 for input, 1 for output + * + * Outputs: out_gpio_name - in the audio configuration structure. + * in_gpio_name + * + *------------------------------------------------------------------*/ + +#ifndef __WIN32__ + + +void export_gpio(int ch, int ot, int invert, int direction) +{ + HANDLE fd; + const char gpio_export_path[] = "/sys/class/gpio/export"; + char gpio_direction_path[80]; + char gpio_value_path[80]; + char stemp[16]; + int gpio_num; + char *gpio_name; + +// Raspberry Pi was easy. GPIO 24 has the name gpio24. +// Others, such as the Cubieboard, take a little more effort. +// The name might be gpio24_ph11 meaning connector H, pin 11. +// When we "export" GPIO number, we will store the corresponding +// device name for future use when we want to access it. + + if (direction) { + gpio_num = save_audio_config_p->achan[ch].octrl[ot].out_gpio_num; + gpio_name = save_audio_config_p->achan[ch].octrl[ot].out_gpio_name; + } + else { + gpio_num = save_audio_config_p->achan[ch].ictrl[ot].in_gpio_num; + gpio_name = save_audio_config_p->achan[ch].ictrl[ot].in_gpio_name; + } + + + get_access_to_gpio (gpio_export_path); + + fd = open(gpio_export_path, O_WRONLY); + if (fd < 0) { + // Not expected. Above should have obtained permission or exited. + text_color_set(DW_COLOR_ERROR); + dw_printf ("Permissions do not allow access to GPIO.\n"); + exit (1); + } + + snprintf (stemp, sizeof(stemp), "%d", gpio_num); + if (write (fd, stemp, strlen(stemp)) != strlen(stemp)) { + int e = errno; + /* Ignore EBUSY error which seems to mean */ + /* the device node already exists. */ + if (e != EBUSY) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Error writing \"%s\" to %s, errno=%d\n", stemp, gpio_export_path, e); + dw_printf ("%s\n", strerror(e)); + exit (1); + } + } + /* Wait for udev to adjust permissions after enabling GPIO. */ + /* https://github.com/wb2osz/direwolf/issues/176 */ + SLEEP_MS(250); + close (fd); + +/* + * Added in release 1.4. + * + * On the RPi, the device path for GPIO number XX is simply /sys/class/gpio/gpioXX. + * + * There was a report that it is different for the CubieBoard. For instance + * GPIO 61 has gpio61_pi13 in the path. This indicates connector "i" pin 13. + * https://github.com/cubieplayer/Cubian/wiki/GPIO-Introduction + * + * For another similar single board computer, we find the same thing: + * https://www.olimex.com/wiki/A20-OLinuXino-LIME#GPIO_under_Linux + * + * How should we deal with this? Some possibilities: + * + * (1) The user might explicitly mention the name in direwolf.conf. + * (2) We might be able to find the names in some system device config file. + * (3) Get a directory listing of /sys/class/gpio then search for a + * matching name. Suppose we wanted GPIO 61. First look for an exact + * match to "gpio61". If that is not found, look for something + * matching the pattern "gpio61_*". + * + * We are finally implementing the third choice. + */ + +/* + * Then we have the Odroid board with GPIO numbers starting around 480. + * Can we simply use those numbers? + * Apparently, the export names look like GPIOX.17 + * https://wiki.odroid.com/odroid-c4/hardware/expansion_connectors#gpio_map_for_wiringpi_library + */ + + struct dirent **file_list; + int num_files; + int i; + int ok = 0; + + if (ptt_debug_level >= 2) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("Contents of /sys/class/gpio:\n"); + } + + num_files = scandir ("/sys/class/gpio", &file_list, NULL, alphasort); + + if (num_files < 0) { + // Something went wrong. Fill in the simple expected name and keep going. + + text_color_set(DW_COLOR_ERROR); + dw_printf ("ERROR! Could not get directory listing for /sys/class/gpio\n"); + + snprintf (gpio_name, MAX_GPIO_NAME_LEN, "gpio%d", gpio_num); + num_files = 0; + ok = 1; + } + else { + + if (ptt_debug_level >= 2) { + + text_color_set(DW_COLOR_DEBUG); + + for (i = 0; i < num_files; i++) { + dw_printf("\t%s\n", file_list[i]->d_name); + } + } + + // Look for exact name gpioNN + + char lookfor[16]; + snprintf (lookfor, sizeof(lookfor), "gpio%d", gpio_num); + + for (i = 0; i < num_files && ! ok; i++) { + if (strcmp(lookfor, file_list[i]->d_name) == 0) { + strlcpy (gpio_name, file_list[i]->d_name, MAX_GPIO_NAME_LEN); + ok = 1; + } + } + + // If not found, Look for gpioNN_* + + snprintf (lookfor, sizeof(lookfor), "gpio%d_", gpio_num); + + for (i = 0; i < num_files && ! ok; i++) { + if (strncmp(lookfor, file_list[i]->d_name, strlen(lookfor)) == 0) { + strlcpy (gpio_name, file_list[i]->d_name, MAX_GPIO_NAME_LEN); + ok = 1; + } + } + + // Free the storage allocated by scandir(). + + for (i = 0; i < num_files; i++) { + free (file_list[i]); + } + free (file_list); + } + +/* + * We should now have the corresponding node name. + */ + if (ok) { + + if (ptt_debug_level >= 2) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("Path for gpio number %d is /sys/class/gpio/%s\n", gpio_num, gpio_name); + } + } + else { + + text_color_set(DW_COLOR_ERROR); + dw_printf ("ERROR! Could not find Path for gpio number %d.n", gpio_num); + exit (1); + } + +/* + * Set output direction and initial state + */ + + snprintf (gpio_direction_path, sizeof(gpio_direction_path), "/sys/class/gpio/%s/direction", gpio_name); + get_access_to_gpio (gpio_direction_path); + + fd = open(gpio_direction_path, O_WRONLY); + if (fd < 0) { + int e = errno; + text_color_set(DW_COLOR_ERROR); + dw_printf ("Error opening %s\n", stemp); + dw_printf ("%s\n", strerror(e)); + exit (1); + } + + char gpio_val[8]; + if (direction) { + if (invert) { + strlcpy (gpio_val, "high", sizeof(gpio_val)); + } + else { + strlcpy (gpio_val, "low", sizeof(gpio_val)); + } + } + else { + strlcpy (gpio_val, "in", sizeof(gpio_val)); + } + if (write (fd, gpio_val, strlen(gpio_val)) != strlen(gpio_val)) { + int e = errno; + text_color_set(DW_COLOR_ERROR); + dw_printf ("Error writing initial state to %s\n", stemp); + dw_printf ("%s\n", strerror(e)); + exit (1); + } + close (fd); + +/* + * Make sure that we have access to 'value'. + * Do it once here, rather than each time we want to use it. + */ + + snprintf (gpio_value_path, sizeof(gpio_value_path), "/sys/class/gpio/%s/value", gpio_name); + get_access_to_gpio (gpio_value_path); +} + +#endif /* not __WIN32__ */ + + +/*------------------------------------------------------------------- + * + * Name: ptt_init + * + * Purpose: Open serial port(s) used for PTT signals and set to proper state. + * + * Inputs: audio_config_p - Structure with communication parameters. + * + * for each channel we have: + * + * ptt_method Method for PTT signal. + * PTT_METHOD_NONE - not configured. Could be using VOX. + * PTT_METHOD_SERIAL - serial (com) port. + * PTT_METHOD_GPIO - general purpose I/O. + * PTT_METHOD_LPT - Parallel printer port. + * PTT_METHOD_HAMLIB - HAMLib rig control. + * PTT_METHOD_CM108 - GPIO pins of CM108 etc. USB Audio. + * + * ptt_device Name of serial port device. + * e.g. COM1 or /dev/ttyS0. + * HAMLIB can also use hostaddr:port. + * Like /dev/hidraw1 for CM108. + * + * ptt_line RTS or DTR when using serial port. + * + * out_gpio_num GPIO number. Only used for Linux. + * Valid only when ptt_method is PTT_METHOD_GPIO. + * + * ptt_lpt_bit Bit number for parallel printer port. + * Bit 0 = pin 2, ..., bit 7 = pin 9. + * Valid only when ptt_method is PTT_METHOD_LPT. + * + * ptt_invert Invert the signal. + * Normally higher voltage means transmit or LED on. + * + * ptt_model Only for HAMLIB. + * 2 to communicate with rigctld. + * >= 3 for specific radio model. + * -1 guess at what is out there. (AUTO option in config file.) + * + * Outputs: Remember required information for future use. + * + * Description: + * + *--------------------------------------------------------------------*/ + + + + +static HANDLE ptt_fd[MAX_CHANS][NUM_OCTYPES]; + /* Serial port handle or fd. */ + /* Could be the same for two channels */ + /* if using both RTS and DTR. */ +#if USE_HAMLIB +static RIG *rig[MAX_CHANS][NUM_OCTYPES]; +#endif + +static char otnames[NUM_OCTYPES][8]; + +void ptt_init (struct audio_s *audio_config_p) +{ + int ch; + HANDLE fd = INVALID_HANDLE_VALUE; +#if __WIN32__ +#else + int using_gpio; +#endif + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("ptt_init ( ... )\n"); +#endif + + save_audio_config_p = audio_config_p; + + strlcpy (otnames[OCTYPE_PTT], "PTT", sizeof(otnames[OCTYPE_PTT])); + strlcpy (otnames[OCTYPE_DCD], "DCD", sizeof(otnames[OCTYPE_DCD])); + strlcpy (otnames[OCTYPE_CON], "CON", sizeof(otnames[OCTYPE_CON])); + + + for (ch = 0; ch < MAX_CHANS; ch++) { + int ot; + + for (ot = 0; ot < NUM_OCTYPES; ot++) { + + ptt_fd[ch][ot] = INVALID_HANDLE_VALUE; +#if USE_HAMLIB + rig[ch][ot] = NULL; +#endif + if (ptt_debug_level >= 2) { + + text_color_set(DW_COLOR_DEBUG); + dw_printf ("ch=%d, %s method=%d, device=%s, line=%d, gpio=%d, lpt_bit=%d, invert=%d\n", + ch, + otnames[ot], + audio_config_p->achan[ch].octrl[ot].ptt_method, + audio_config_p->achan[ch].octrl[ot].ptt_device, + audio_config_p->achan[ch].octrl[ot].ptt_line, + audio_config_p->achan[ch].octrl[ot].out_gpio_num, + audio_config_p->achan[ch].octrl[ot].ptt_lpt_bit, + audio_config_p->achan[ch].octrl[ot].ptt_invert); + } + } + } + +/* + * Set up serial ports. + */ + + for (ch = 0; ch < MAX_CHANS; ch++) { + + if (audio_config_p->chan_medium[ch] == MEDIUM_RADIO) { + int ot; + + for (ot = 0; ot < NUM_OCTYPES; ot++) { + + if (audio_config_p->achan[ch].octrl[ot].ptt_method == PTT_METHOD_SERIAL) { + +#if __WIN32__ +#else + /* Translate Windows device name into Linux name. */ + /* COM1 -> /dev/ttyS0, etc. */ + + if (strncasecmp(audio_config_p->achan[ch].octrl[ot].ptt_device, "COM", 3) == 0) { + int n = atoi (audio_config_p->achan[ch].octrl[ot].ptt_device + 3); + text_color_set(DW_COLOR_INFO); + dw_printf ("Converted %s device '%s'", audio_config_p->achan[ch].octrl[ot].ptt_device, otnames[ot]); + if (n < 1) n = 1; + snprintf (audio_config_p->achan[ch].octrl[ot].ptt_device, sizeof(audio_config_p->achan[ch].octrl[ot].ptt_device), "/dev/ttyS%d", n-1); + dw_printf (" to Linux equivalent '%s'\n", audio_config_p->achan[ch].octrl[ot].ptt_device); + } +#endif + /* Can't open the same device more than once so we */ + /* need more logic to look for the case of multiple radio */ + /* channels using different pins of the same COM port. */ + + /* Did some earlier channel use the same device name? */ + + int same_device_used = 0; + int j, k; + + for (j = ch; j >= 0; j--) { + if (audio_config_p->chan_medium[j] == MEDIUM_RADIO) { + for (k = ((j==ch) ? (ot - 1) : (NUM_OCTYPES-1)); k >= 0; k--) { + if (strcmp(audio_config_p->achan[ch].octrl[ot].ptt_device,audio_config_p->achan[j].octrl[k].ptt_device) == 0) { + fd = ptt_fd[j][k]; + same_device_used = 1; + } + } + } + } + + if ( ! same_device_used) { + +#if __WIN32__ + char bettername[50]; + // Bug fix in release 1.1 - Need to munge name for COM10 and up. + // http://support.microsoft.com/kb/115831 + + strlcpy (bettername, audio_config_p->achan[ch].octrl[ot].ptt_device, sizeof(bettername)); + if (strncasecmp(bettername, "COM", 3) == 0) { + int n; + n = atoi(bettername+3); + if (n >= 10) { + strlcpy (bettername, "\\\\.\\", sizeof(bettername)); + strlcat (bettername, audio_config_p->achan[ch].octrl[ot].ptt_device, sizeof(bettername)); + } + } + fd = CreateFile(bettername, + GENERIC_READ, 0, 0, OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, 0); +#else + + /* O_NONBLOCK added in version 0.9. */ + /* Was hanging with some USB-serial adapters. */ + /* https://bugs.launchpad.net/ubuntu/+source/linux/+bug/661321/comments/12 */ + + fd = open (audio_config_p->achan[ch].octrl[ot].ptt_device, O_RDONLY | O_NONBLOCK); +#endif + } + + if (fd != INVALID_HANDLE_VALUE) { + ptt_fd[ch][ot] = fd; + } + else { +#if __WIN32__ +#else + int e = errno; +#endif + text_color_set(DW_COLOR_ERROR); + dw_printf ("ERROR can't open device %s for channel %d PTT control.\n", + audio_config_p->achan[ch].octrl[ot].ptt_device, ch); +#if __WIN32__ +#else + dw_printf ("%s\n", strerror(e)); +#endif + /* Don't try using it later if device open failed. */ + + audio_config_p->achan[ch].octrl[ot].ptt_method = PTT_METHOD_NONE; + } + +/* + * Set initial state off. + * ptt_set will invert output signal if appropriate. + */ + ptt_set (ot, ch, 0); + + } /* if serial method. */ + } /* for each output type. */ + } /* if channel valid. */ + } /* For each channel. */ + + +/* + * Set up GPIO - for Linux only. + */ + +#if __WIN32__ +#else + +/* + * Does any of them use GPIO? + */ + + using_gpio = 0; + for (ch=0; chchan_medium[ch] == MEDIUM_RADIO) { + int ot; + for (ot = 0; ot < NUM_OCTYPES; ot++) { + if (audio_config_p->achan[ch].octrl[ot].ptt_method == PTT_METHOD_GPIO) { + using_gpio = 1; + } + } + for (ot = 0; ot < NUM_ICTYPES; ot++) { + if (audio_config_p->achan[ch].ictrl[ot].method == PTT_METHOD_GPIO) { + using_gpio = 1; + } + } + } + } + + if (using_gpio) { + get_access_to_gpio ("/sys/class/gpio/export"); + } + +/* + * We should now be able to create the device nodes for + * the pins we want to use. + */ + + for (ch = 0; ch < MAX_CHANS; ch++) { + if (save_audio_config_p->chan_medium[ch] == MEDIUM_RADIO) { + + int ot; // output control type, PTT, DCD, CON, ... + int it; // input control type + + for (ot = 0; ot < NUM_OCTYPES; ot++) { + if (audio_config_p->achan[ch].octrl[ot].ptt_method == PTT_METHOD_GPIO) { + export_gpio(ch, ot, audio_config_p->achan[ch].octrl[ot].ptt_invert, 1); + } + } + for (it = 0; it < NUM_ICTYPES; it++) { + if (audio_config_p->achan[ch].ictrl[it].method == PTT_METHOD_GPIO) { + export_gpio(ch, it, audio_config_p->achan[ch].ictrl[it].invert, 0); + } + } + } + } +#endif + + + +/* + * Set up parallel printer port. + * + * Restrictions: + * Only the primary printer port. + * For x86 Linux only. + */ + +#if ( defined(__i386__) || defined(__x86_64__) ) && ( defined(__linux__) || defined(__unix__) ) + + for (ch = 0; ch < MAX_CHANS; ch++) { + if (save_audio_config_p->chan_medium[ch] == MEDIUM_RADIO) { + int ot; + for (ot = 0; ot < NUM_OCTYPES; ot++) { + if (audio_config_p->achan[ch].octrl[ot].ptt_method == PTT_METHOD_LPT) { + + /* Can't open the same device more than once so we */ + /* need more logic to look for the case of multiple radio */ + /* channels using different pins of the LPT port. */ + + /* Did some earlier channel use the same ptt device name? */ + + int same_device_used = 0; + int j, k; + + for (j = ch; j >= 0; j--) { + if (audio_config_p->chan_medium[j] == MEDIUM_RADIO) { + for (k = ((j==ch) ? (ot - 1) : (NUM_OCTYPES-1)); k >= 0; k--) { + if (strcmp(audio_config_p->achan[ch].octrl[ot].ptt_device,audio_config_p->achan[j].octrl[k].ptt_device) == 0) { + fd = ptt_fd[j][k]; + same_device_used = 1; + } + } + } + } + + if ( ! same_device_used) { + fd = open ("/dev/port", O_RDWR | O_NDELAY); + } + + if (fd != INVALID_HANDLE_VALUE) { + ptt_fd[ch][ot] = fd; + } + else { + + int e = errno; + + text_color_set(DW_COLOR_ERROR); + dw_printf ("ERROR - Can't open /dev/port for parallel printer port PTT control.\n"); + dw_printf ("%s\n", strerror(e)); + dw_printf ("You probably don't have adequate permissions to access I/O ports.\n"); + dw_printf ("Either run direwolf as root or change these permissions:\n"); + dw_printf (" sudo chmod go+rw /dev/port\n"); + dw_printf (" sudo setcap cap_sys_rawio=ep `which direwolf`\n"); + + /* Don't try using it later if device open failed. */ + + audio_config_p->achan[ch].octrl[ot].ptt_method = PTT_METHOD_NONE; + } + + +/* + * Set initial state off. + * ptt_set will invert output signal if appropriate. + */ + ptt_set (ot, ch, 0); + + } /* if parallel printer port method. */ + } /* for each output type */ + } /* if valid channel. */ + } /* For each channel. */ + + + +#endif /* x86 Linux */ + +#ifdef USE_HAMLIB + for (ch = 0; ch < MAX_CHANS; ch++) { + if (save_audio_config_p->chan_medium[ch] == MEDIUM_RADIO) { + int ot; + for (ot = 0; ot < NUM_OCTYPES; ot++) { + if (audio_config_p->achan[ch].octrl[ot].ptt_method == PTT_METHOD_HAMLIB) { + if (ot == OCTYPE_PTT) { + int err = -1; + int tries = 0; + + /* For "AUTO" model, try to guess what is out there. */ + + if (audio_config_p->achan[ch].octrl[ot].ptt_model == -1) { + hamlib_port_t hport; // http://hamlib.sourceforge.net/manuals/1.2.15/structhamlib__port__t.html + + memset (&hport, 0, sizeof(hport)); + strlcpy (hport.pathname, audio_config_p->achan[ch].octrl[ot].ptt_device, sizeof(hport.pathname)); + + if (audio_config_p->achan[ch].octrl[ot].ptt_rate > 0) { + // Override the default serial port data rate. + hport.parm.serial.rate = audio_config_p->achan[ch].octrl[ot].ptt_rate; + hport.parm.serial.data_bits = 8; + hport.parm.serial.stop_bits = 1; + hport.parm.serial.parity = RIG_PARITY_NONE; + hport.parm.serial.handshake = RIG_HANDSHAKE_NONE; + } + + rig_load_all_backends(); + audio_config_p->achan[ch].octrl[ot].ptt_model = rig_probe(&hport); + + if (audio_config_p->achan[ch].octrl[ot].ptt_model == RIG_MODEL_NONE) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Hamlib Error: Couldn't guess rig model number for AUTO option. Run \"rigctl --list\" for a list of model numbers.\n"); + continue; + } + + text_color_set(DW_COLOR_INFO); + dw_printf ("Hamlib AUTO option detected rig model %d. Run \"rigctl --list\" for a list of model numbers.\n", + audio_config_p->achan[ch].octrl[ot].ptt_model); + } + + rig[ch][ot] = rig_init(audio_config_p->achan[ch].octrl[ot].ptt_model); + if (rig[ch][ot] == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Hamlib error: Unknown rig model %d. Run \"rigctl --list\" for a list of model numbers.\n", + audio_config_p->achan[ch].octrl[ot].ptt_model); + continue; + } + + strlcpy (rig[ch][ot]->state.rigport.pathname, audio_config_p->achan[ch].octrl[ot].ptt_device, sizeof(rig[ch][ot]->state.rigport.pathname)); + + // Issue 290. + // We had a case where hamlib defaulted to 9600 baud for a particular + // radio model but 38400 was needed. Add an option for the configuration + // file to override the hamlib default speed. + + text_color_set(DW_COLOR_INFO); + if (audio_config_p->achan[ch].octrl[ot].ptt_model != 2) { // 2 is network, not serial port. + dw_printf ("Hamlib determined CAT control serial port rate of %d.\n", rig[ch][ot]->state.rigport.parm.serial.rate); + } + + // Config file can optionally override the rate that hamlib came up with. + + if (audio_config_p->achan[ch].octrl[ot].ptt_rate > 0) { + dw_printf ("User configuration overriding hamlib CAT control speed to %d.\n", audio_config_p->achan[ch].octrl[ot].ptt_rate); + rig[ch][ot]->state.rigport.parm.serial.rate = audio_config_p->achan[ch].octrl[ot].ptt_rate; + + // Do we want to explicitly set all of these or let it default? + rig[ch][ot]->state.rigport.parm.serial.data_bits = 8; + rig[ch][ot]->state.rigport.parm.serial.stop_bits = 1; + rig[ch][ot]->state.rigport.parm.serial.parity = RIG_PARITY_NONE; + rig[ch][ot]->state.rigport.parm.serial.handshake = RIG_HANDSHAKE_NONE; + } + tries = 0; + do { + // Try up to 5 times, Hamlib can take a moment to finish init + err = rig_open(rig[ch][ot]); + if (++tries > 5) { + break; + } else if (err != RIG_OK) { + text_color_set(DW_COLOR_INFO); + dw_printf ("Retrying Hamlib Rig open...\n"); + sleep (5); + } + } while (err != RIG_OK); + if (err != RIG_OK) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Hamlib Rig open error %d: %s\n", err, rigerror(err)); + rig_cleanup (rig[ch][ot]); + rig[ch][ot] = NULL; + exit (1); + } + + /* Successful. Later code should check for rig[ch][ot] not NULL. */ + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("HAMLIB can only be used for PTT. Not DCD or other output.\n"); + } + } + } + } + } + +#endif + +/* + * Confirm what is going on with CM108 GPIO output. + * Could use some error checking for overlap. + */ + +#if USE_CM108 + + for (ch = 0; ch < MAX_CHANS; ch++) { + + if (audio_config_p->chan_medium[ch] == MEDIUM_RADIO) { + int ot; + for (ot = 0; ot < NUM_OCTYPES; ot++) { + if (audio_config_p->achan[ch].octrl[ot].ptt_method == PTT_METHOD_CM108) { + text_color_set(DW_COLOR_INFO); + dw_printf ("Using %s GPIO %d for channel %d %s control.\n", + audio_config_p->achan[ch].octrl[ot].ptt_device, + audio_config_p->achan[ch].octrl[ot].out_gpio_num, + ch, + otnames[ot]); + } + } + } + } + +#endif + + +/* Why doesn't it transmit? Probably forgot to specify PTT option. */ + + for (ch=0; chchan_medium[ch] == MEDIUM_RADIO) { + if(audio_config_p->achan[ch].octrl[OCTYPE_PTT].ptt_method == PTT_METHOD_NONE) { + text_color_set(DW_COLOR_INFO); + dw_printf ("Note: PTT not configured for channel %d. (Ignore this if using VOX.)\n", ch); + } + } + } + +} /* end ptt_init */ + + +/*------------------------------------------------------------------- + * + * Name: ptt_set + * + * Purpose: Turn output control line on or off. + * Originally this was just for PTT, hence the name. + * Now that it is more general purpose, it should + * probably be renamed something like octrl_set. + * + * Inputs: ot - Output control type: + * OCTYPE_PTT, OCTYPE_DCD, OCTYPE_FUTURE + * + * chan - channel, 0 .. (number of channels)-1 + * + * ptt_signal - 1 for transmit, 0 for receive. + * + * + * Assumption: ptt_init was called first. + * + * Description: Set the RTS or DTR line or GPIO pin. + * More positive output corresponds to 1 unless invert is set. + * + *--------------------------------------------------------------------*/ + +// JWL - save status and new get_ptt function. + + +void ptt_set (int ot, int chan, int ptt_signal) +{ + + int ptt = ptt_signal; + int ptt2 = ptt_signal; + + assert (ot >= 0 && ot < NUM_OCTYPES); + assert (chan >= 0 && chan < MAX_CHANS); + + if (ptt_debug_level >= 1) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("%s %d = %d\n", otnames[ot], chan, ptt_signal); + } + + assert (chan >= 0 && chan < MAX_CHANS); + + if ( save_audio_config_p->chan_medium[chan] != MEDIUM_RADIO) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Internal error, ptt_set ( %s, %d, %d ), did not expect invalid channel.\n", otnames[ot], chan, ptt); + return; + } + +// New in 1.7. +// A few people have a really bad audio cross talk situation where they receive their own transmissions. +// It usually doesn't cause a problem but it is confusing to look at. +// "half duplex" setting applied only to the transmit logic. i.e. wait for clear channel before sending. +// Receiving was still active. +// I think the simplest solution is to mute/unmute the audio input at this point if not full duplex. + +#ifndef TEST + if ( ot == OCTYPE_PTT && ! save_audio_config_p->achan[chan].fulldup) { + demod_mute_input (chan, ptt_signal); + } +#endif + +/* + * The data link state machine has an interest in activity on the radio channel. + * This is a very convenient place to get that information. + */ + +#ifndef TEST + dlq_channel_busy (chan, ot, ptt_signal); +#endif + +/* + * Inverted output? + */ + + if (save_audio_config_p->achan[chan].octrl[ot].ptt_invert) { + ptt = ! ptt; + } + if (save_audio_config_p->achan[chan].octrl[ot].ptt_invert2) { + ptt2 = ! ptt2; + } + +/* + * Using serial port? + */ + if (save_audio_config_p->achan[chan].octrl[ot].ptt_method == PTT_METHOD_SERIAL && + ptt_fd[chan][ot] != INVALID_HANDLE_VALUE) { + + if (save_audio_config_p->achan[chan].octrl[ot].ptt_line == PTT_LINE_RTS) { + + if (ptt) { + RTS_ON(ptt_fd[chan][ot]); + } + else { + RTS_OFF(ptt_fd[chan][ot]); + } + } + else if (save_audio_config_p->achan[chan].octrl[ot].ptt_line == PTT_LINE_DTR) { + + if (ptt) { + DTR_ON(ptt_fd[chan][ot]); + } + else { + DTR_OFF(ptt_fd[chan][ot]); + } + } + +/* + * Second serial port control line? Typically driven with opposite phase but could be in phase. + */ + + if (save_audio_config_p->achan[chan].octrl[ot].ptt_line2 == PTT_LINE_RTS) { + + if (ptt2) { + RTS_ON(ptt_fd[chan][ot]); + } + else { + RTS_OFF(ptt_fd[chan][ot]); + } + } + else if (save_audio_config_p->achan[chan].octrl[ot].ptt_line2 == PTT_LINE_DTR) { + + if (ptt2) { + DTR_ON(ptt_fd[chan][ot]); + } + else { + DTR_OFF(ptt_fd[chan][ot]); + } + } + /* else neither one */ + + } + +/* + * Using GPIO? + */ + +#if __WIN32__ +#else + + if (save_audio_config_p->achan[chan].octrl[ot].ptt_method == PTT_METHOD_GPIO) { + int fd; + char gpio_value_path[80]; + char stemp[16]; + + snprintf (gpio_value_path, sizeof(gpio_value_path), "/sys/class/gpio/%s/value", save_audio_config_p->achan[chan].octrl[ot].out_gpio_name); + + fd = open(gpio_value_path, O_WRONLY); + if (fd < 0) { + int e = errno; + text_color_set(DW_COLOR_ERROR); + dw_printf ("Error opening %s to set %s signal.\n", stemp, otnames[ot]); + dw_printf ("%s\n", strerror(e)); + return; + } + + snprintf (stemp, sizeof(stemp), "%d", ptt); + + if (write (fd, stemp, 1) != 1) { + int e = errno; + text_color_set(DW_COLOR_ERROR); + dw_printf ("Error setting GPIO %d for %s\n", save_audio_config_p->achan[chan].octrl[ot].out_gpio_num, otnames[ot]); + dw_printf ("%s\n", strerror(e)); + } + close (fd); + + } +#endif + +/* + * Using parallel printer port? + */ + +#if ( defined(__i386__) || defined(__x86_64__) ) && ( defined(__linux__) || defined(__unix__) ) + + if (save_audio_config_p->achan[chan].octrl[ot].ptt_method == PTT_METHOD_LPT && + ptt_fd[chan][ot] != INVALID_HANDLE_VALUE) { + + char lpt_data; + //ssize_t n; + + lseek (ptt_fd[chan][ot], (off_t)LPT_IO_ADDR, SEEK_SET); + if (read (ptt_fd[chan][ot], &lpt_data, (size_t)1) != 1) { + int e = errno; + text_color_set(DW_COLOR_ERROR); + dw_printf ("Error reading current state of LPT for channel %d %s\n", chan, otnames[ot]); + dw_printf ("%s\n", strerror(e)); + } + + if (ptt) { + lpt_data |= ( 1 << save_audio_config_p->achan[chan].octrl[ot].ptt_lpt_bit ); + } + else { + lpt_data &= ~ ( 1 << save_audio_config_p->achan[chan].octrl[ot].ptt_lpt_bit ); + } + + lseek (ptt_fd[chan][ot], (off_t)LPT_IO_ADDR, SEEK_SET); + if (write (ptt_fd[chan][ot], &lpt_data, (size_t)1) != 1) { + int e = errno; + text_color_set(DW_COLOR_ERROR); + dw_printf ("Error writing to LPT for channel %d %s\n", chan, otnames[ot]); + dw_printf ("%s\n", strerror(e)); + } + } + +#endif /* x86 Linux */ + +#ifdef USE_HAMLIB +/* + * Using hamlib? + */ + + if (save_audio_config_p->achan[chan].octrl[ot].ptt_method == PTT_METHOD_HAMLIB) { + + if (rig[chan][ot] != NULL) { + + int retcode = rig_set_ptt(rig[chan][ot], RIG_VFO_CURR, ptt ? RIG_PTT_ON : RIG_PTT_OFF); + + if (retcode != RIG_OK) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Hamlib Error: rig_set_ptt command for channel %d %s\n", chan, otnames[ot]); + dw_printf ("%s\n", rigerror(retcode)); + } + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Hamlib: Can't use rig_set_ptt for channel %d %s because rig_open failed.\n", chan, otnames[ot]); + } + } +#endif + +/* + * Using CM108 USB Audio adapter GPIO? + */ + +#ifdef USE_CM108 + + if (save_audio_config_p->achan[chan].octrl[ot].ptt_method == PTT_METHOD_CM108) { + + if (cm108_set_gpio_pin (save_audio_config_p->achan[chan].octrl[ot].ptt_device, + save_audio_config_p->achan[chan].octrl[ot].out_gpio_num, ptt) != 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("ERROR: %s for channel %d has failed. See User Guide for troubleshooting tips.\n", otnames[ot], chan); + } + } +#endif + +} /* end ptt_set */ + +/*------------------------------------------------------------------- + * + * Name: get_input + * + * Purpose: Read the value of an input line + * + * Inputs: it - Input type (ICTYPE_TCINH supported so far) + * chan - Audio channel number + * + * Outputs: 0 = inactive, 1 = active, -1 = error + * + * ------------------------------------------------------------------*/ + +int get_input (int it, int chan) +{ + assert (it >= 0 && it < NUM_ICTYPES); + assert (chan >= 0 && chan < MAX_CHANS); + + if ( save_audio_config_p->chan_medium[chan] != MEDIUM_RADIO) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Internal error, get_input ( %d, %d ), did not expect invalid channel.\n", it, chan); + return -1; + } + +#if __WIN32__ +#else + if (save_audio_config_p->achan[chan].ictrl[it].method == PTT_METHOD_GPIO) { + int fd; + char gpio_value_path[80]; + + snprintf (gpio_value_path, sizeof(gpio_value_path), "/sys/class/gpio/%s/value", save_audio_config_p->achan[chan].ictrl[it].in_gpio_name); + + get_access_to_gpio (gpio_value_path); + + fd = open(gpio_value_path, O_RDONLY); + if (fd < 0) { + int e = errno; + text_color_set(DW_COLOR_ERROR); + dw_printf ("Error opening %s to check input.\n", gpio_value_path); + dw_printf ("%s\n", strerror(e)); + return -1; + } + + char vtemp[2]; + if (read (fd, vtemp, 1) != 1) { + int e = errno; + text_color_set(DW_COLOR_ERROR); + dw_printf ("Error getting GPIO %d value\n", save_audio_config_p->achan[chan].ictrl[it].in_gpio_num); + dw_printf ("%s\n", strerror(e)); + } + close (fd); + + vtemp[1] = '\0'; + if (atoi(vtemp) != save_audio_config_p->achan[chan].ictrl[it].invert) { + return 1; + } + else { + return 0; + } + } +#endif + + return -1; /* Method was none, or something went wrong */ +} + +/*------------------------------------------------------------------- + * + * Name: ptt_term + * + * Purpose: Make sure PTT and others are turned off when we exit. + * + * Inputs: none + * + * Description: + * + *--------------------------------------------------------------------*/ + +void ptt_term (void) +{ + int n; + + for (n = 0; n < MAX_CHANS; n++) { + if (save_audio_config_p->chan_medium[n] == MEDIUM_RADIO) { + int ot; + for (ot = 0; ot < NUM_OCTYPES; ot++) { + ptt_set (ot, n, 0); + } + } + } + + for (n = 0; n < MAX_CHANS; n++) { + if (save_audio_config_p->chan_medium[n] == MEDIUM_RADIO) { + int ot; + for (ot = 0; ot < NUM_OCTYPES; ot++) { + if (ptt_fd[n][ot] != INVALID_HANDLE_VALUE) { +#if __WIN32__ + CloseHandle (ptt_fd[n][ot]); +#else + close(ptt_fd[n][ot]); +#endif + ptt_fd[n][ot] = INVALID_HANDLE_VALUE; + } + } + } + } + +#ifdef USE_HAMLIB + + for (n = 0; n < MAX_CHANS; n++) { + if (save_audio_config_p->chan_medium[n] == MEDIUM_RADIO) { + int ot; + for (ot = 0; ot < NUM_OCTYPES; ot++) { + if (rig[n][ot] != NULL) { + + rig_close(rig[n][ot]); + rig_cleanup(rig[n][ot]); + rig[n][ot] = NULL; + } + } + } + } +#endif +} + + + + +/* + * Quick stand-alone test for above. + * + * gcc -DTEST -o ptest ptt.c textcolor.o misc.a ; ./ptest + * + * TODO: Retest this, add CM108 GPIO to test. + */ + + +#if TEST + +int main () +{ + struct audio_s my_audio_config; + int n; + int chan; + + memset (&my_audio_config, 0, sizeof(my_audio_config)); + + my_audio_config.adev[0].num_channels = 2; + + my_audio_config.chan_medium[0] = MEDIUM_RADIO; + my_audio_config.achan[0].octrl[OCTYPE_PTT].ptt_method = PTT_METHOD_SERIAL; +// TODO: device should be command line argument. + strlcpy (my_audio_config.achan[0].octrl[OCTYPE_PTT].ptt_device, "COM3", sizeof(my_audio_config.achan[0].octrl[OCTYPE_PTT].ptt_device)); + //strlcpy (my_audio_config.achan[0].octrl[OCTYPE_PTT].ptt_device, "/dev/ttyUSB0", sizeof(my_audio_config.achan[0].octrl[OCTYPE_PTT].ptt_device)); + my_audio_config.achan[0].octrl[OCTYPE_PTT].ptt_line = PTT_LINE_RTS; + + my_audio_config.chan_medium[1] = MEDIUM_RADIO; + my_audio_config.achan[1].octrl[OCTYPE_PTT].ptt_method = PTT_METHOD_SERIAL; + strlcpy (my_audio_config.achan[1].octrl[OCTYPE_PTT].ptt_device, "COM3", sizeof(my_audio_config.achan[1].octrl[OCTYPE_PTT].ptt_device)); + //strlcpy (my_audio_config.achan[1].octrl[OCTYPE_PTT].ptt_device, "/dev/ttyUSB0", sizeof(my_audio_config.achan[1].octrl[OCTYPE_PTT].ptt_device)); + my_audio_config.achan[1].octrl[OCTYPE_PTT].ptt_line = PTT_LINE_DTR; + + +/* initialize - both off */ + + ptt_init (&my_audio_config); + + SLEEP_SEC(2); + +/* flash each a few times. */ + + dw_printf ("turn on RTS a few times...\n"); + + chan = 0; + for (n=0; n<3; n++) { + ptt_set (OCTYPE_PTT, chan, 1); + SLEEP_SEC(1); + ptt_set (OCTYPE_PTT, chan, 0); + SLEEP_SEC(1); + } + + dw_printf ("turn on DTR a few times...\n"); + + chan = 1; + for (n=0; n<3; n++) { + ptt_set (OCTYPE_PTT, chan, 1); + SLEEP_SEC(1); + ptt_set (OCTYPE_PTT, chan, 0); + SLEEP_SEC(1); + } + + ptt_term(); + +/* Same thing again but invert RTS. */ + + my_audio_config.achan[0].octrl[OCTYPE_PTT].ptt_invert = 1; + + ptt_init (&my_audio_config); + + SLEEP_SEC(2); + + dw_printf ("INVERTED - RTS a few times...\n"); + + chan = 0; + for (n=0; n<3; n++) { + ptt_set (OCTYPE_PTT, chan, 1); + SLEEP_SEC(1); + ptt_set (OCTYPE_PTT, chan, 0); + SLEEP_SEC(1); + } + + dw_printf ("turn on DTR a few times...\n"); + + chan = 1; + for (n=0; n<3; n++) { + ptt_set (OCTYPE_PTT, chan, 1); + SLEEP_SEC(1); + ptt_set (OCTYPE_PTT, chan, 0); + SLEEP_SEC(1); + } + + ptt_term (); + + +/* Test GPIO */ + +#if __arm__ + + memset (&my_audio_config, 0, sizeof(my_audio_config)); + my_audio_config.adev[0].num_channels = 1; + my_audio_config.chan_medium[0] = MEDIUM_RADIO; + my_audio_config.adev[0].octrl[OCTYPE_PTT].ptt_method = PTT_METHOD_GPIO; + my_audio_config.adev[0].octrl[OCTYPE_PTT].out_gpio_num = 25; + + dw_printf ("Try GPIO %d a few times...\n", my_audio_config.out_gpio_num[0]); + + ptt_init (&my_audio_config); + + SLEEP_SEC(2); + chan = 0; + for (n=0; n<3; n++) { + ptt_set (OCTYPE_PTT, chan, 1); + SLEEP_SEC(1); + ptt_set (OCTYPE_PTT, chan, 0); + SLEEP_SEC(1); + } + + ptt_term (); +#endif + + + +/* Parallel printer port. */ + +#if ( defined(__i386__) || defined(__x86_64__) ) && ( defined(__linux__) || defined(__unix__) ) + + // TODO + +#if 0 + memset (&my_audio_config, 0, sizeof(my_audio_config)); + my_audio_config.num_channels = 2; + my_audio_config.chan_medium[0] = MEDIUM_RADIO; + my_audio_config.adev[0].octrl[OCTYPE_PTT].ptt_method = PTT_METHOD_LPT; + my_audio_config.adev[0].octrl[OCTYPE_PTT].ptt_lpt_bit = 0; + my_audio_config.chan_medium[1] = MEDIUM_RADIO; + my_audio_config.adev[1].octrl[OCTYPE_PTT].ptt_method = PTT_METHOD_LPT; + my_audio_config.adev[1].octrl[OCTYPE_PTT].ptt_lpt_bit = 1; + + dw_printf ("Try LPT bits 0 & 1 a few times...\n"); + + ptt_init (&my_audio_config); + + for (n=0; n<8; n++) { + ptt_set (OCTYPE_PTT, 0, n & 1); + ptt_set (OCTYPE_PTT, 1, (n>>1) & 1); + SLEEP_SEC(1); + } + + ptt_term (); +#endif + +#endif + + return(0); +} + +#endif /* TEST */ + +/* end ptt.c */ + + + diff --git a/src/ptt.h b/src/ptt.h new file mode 100644 index 00000000..6e752532 --- /dev/null +++ b/src/ptt.h @@ -0,0 +1,26 @@ + + +#ifndef PTT_H +#define PTT_H 1 + + +#include "audio.h" /* for struct audio_s and definitions for octype values */ + + +void ptt_set_debug(int debug); + +void ptt_init (struct audio_s *p_modem); + +void ptt_set (int octype, int chan, int ptt); + +void ptt_term (void); + +int get_input (int it, int chan); + +#endif + + +/* end ptt.h */ + + + diff --git a/src/recv.c b/src/recv.c new file mode 100644 index 00000000..49040e55 --- /dev/null +++ b/src/recv.c @@ -0,0 +1,417 @@ + +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// +// Copyright (C) 2014, 2015, 2016 John Langner, WB2OSZ +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . +// + + +/*------------------------------------------------------------------ + * + * Module: recv.c + * + * Purpose: Process audio input for receiving. + * + * This is for all platforms. + * + * + * Description: In earlier versions, we supported a single audio device + * and the main program looped around processing the + * audio samples. The structure looked like this: + * + * main in direwolf.c: + * + * audio_init() + * various other *_init() + * + * loop forever: + * s = demod_get_sample. + * multi_modem_process_sample(s) + * + * + * When a packet is successfully decoded, somebody calls + * app_process_rec_frame, also in direwolf.c + * + * + * Starting in version 1.2, we support multiple audio + * devices at the same time. We now have a separate + * thread for each audio device. Decoded frames are + * sent to a single queue for serial processing. + * + * The new flow looks like this: + * + * main in direwolf.c: + * + * audio_init() + * various other *_init() + * recv_init() + * recv_process() -- does not return + * + * + * recv_init() This starts up a separate thread + * for each audio device. + * Each thread reads audio samples and + * passes them to multi_modem_process_sample. + * + * The difference is that app_process_rec_frame + * is no longer called directly. Instead + * the frame is appended to a queue with dlq_rec_frame. + * + * Received frames can now be processed one at + * a time and we don't need to worry about later + * processing being reentrant. + * + * recv_process() This simply waits for something to show up + * in the dlq queue and calls app_process_rec_frame + * for each. + * + *---------------------------------------------------------------*/ + +//#define DEBUG 1 + +#include "direwolf.h" + +#include +#include +#include +#include +#include +#include +//#include +//#include +//#include +#include + +#ifdef __FreeBSD__ +#include +#endif + +#include "audio.h" +#include "demod.h" +#include "multi_modem.h" +#include "textcolor.h" +#include "dlq.h" +#include "recv.h" +#include "dtmf.h" +#include "aprs_tt.h" +#include "ax25_link.h" + + +#if __WIN32__ +static unsigned __stdcall recv_adev_thread (void *arg); +#else +static void * recv_adev_thread (void *arg); +#endif + + +static struct audio_s *save_pa; /* Keep pointer to audio configuration */ + /* for later use. */ + +/*------------------------------------------------------------------ + * + * Name: recv_init + * + * Purpose: Start up a thread for each audio device. + * + * + * Inputs: pa - Address of structure of type audio_s. + * + * + * Returns: None. + * + * Errors: Exit if error. + * No point in going on if we can't get audio. + * + *----------------------------------------------------------------*/ + + + +void recv_init (struct audio_s *pa) +{ +#if __WIN32__ + HANDLE xmit_th[MAX_ADEVS]; +#else + pthread_t xmit_tid[MAX_ADEVS]; +#endif + int a; + + save_pa = pa; + + for (a=0; aadev[a].defined) { + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("recv_init: start up thread, a=%d\n", a); +#endif + +#if __WIN32__ + xmit_th[a] = (HANDLE)_beginthreadex (NULL, 0, recv_adev_thread, (void*)(ptrdiff_t)a, 0, NULL); + if (xmit_th[a] == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("FATAL: Could not create audio receive thread for device %d.\n", a); + exit(1); + } +#else + int e; + e = pthread_create (&xmit_tid[a], NULL, recv_adev_thread, (void *)(ptrdiff_t)a); + + if (e != 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("FATAL: Could not create audio receive thread for device %d.\n", a); + exit(1); + } +#endif + } + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("recv_init: all done\n"); +#endif + } + + +} /* end recv_init */ + + + + +/* Try using "hot" attribute for all functions */ +/* which are used for each audio sample. */ +/* Compiler & linker might gather */ +/* them together to improve memory cache performance. */ +/* Or maybe it won't make any difference. */ + +__attribute__((hot)) +#if __WIN32__ +static unsigned __stdcall recv_adev_thread (void *arg) +#else +static void * recv_adev_thread (void *arg) +#endif +{ + int a = (int)(ptrdiff_t)arg; // audio device number. + int eof; + + /* This audio device can have one (mono) or two (stereo) channels. */ + /* Find number of the first channel and number of channels. */ + + int first_chan = ADEVFIRSTCHAN(a); + int num_chan = save_pa->adev[a].num_channels; + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("recv_adev_thread is now running for a=%d\n", a); +#endif +/* + * Get sound samples and decode them. + */ + eof = 0; + while ( ! eof) + { + + int audio_sample; + int c; + char tt; + + for (c=0; c= 256 * 256) + eof = 1; + + // Future? provide more flexible mapping. + // i.e. for each valid channel where audio_source[] is first_chan+c. + multi_modem_process_sample(first_chan + c, audio_sample); + + + /* Originally, the DTMF decoder was always active. */ + /* It took very little CPU time and the thinking was that an */ + /* attached application might be interested in this even when */ + /* the APRStt gateway was not being used. */ + + /* Unfortunately it resulted in too many false detections of */ + /* touch tones when hearing other types of digital communications */ + /* on HF. Starting in version 1.0, the DTMF decoder is active */ + /* only when the APRStt gateway is configured. */ + + /* The test below allows us to listen to only a single channel for */ + /* for touch tone sequences. The DTMF decoder and the accumulation */ + /* of digits into a sequence maintain separate data for each channel. */ + /* We should be able to accept touch tone sequences concurrently on */ + /* all channels. The only issue is when a complete sequence is */ + /* sent to aprs_tt_sequence which doesn't have separate data for each */ + /* channel. This shouldn't be a problem unless we have multiple */ + /* sequences arriving at the same instant. */ + + if (save_pa->achan[first_chan + c].dtmf_decode != DTMF_DECODE_OFF) { + tt = dtmf_sample (first_chan + c, audio_sample/16384.); + if (tt != ' ') { + aprs_tt_button (first_chan + c, tt); + } + } + } // for c is just 0 or 0 then 1 + + /* When a complete frame is accumulated, */ + /* dlq_rec_frame, is called. */ + + /* recv_process, below, drains the queue. */ + + } // while !eof on audio stream + +// What should we do now? +// Seimply terminate the application? +// Try to re-init the audio device a couple times before giving up? + + text_color_set(DW_COLOR_ERROR); + dw_printf ("Terminating after audio input failure.\n"); + exit (1); +} + + + + + +void recv_process (void) +{ + + struct dlq_item_s *pitem; + + while (1) { + + int timed_out; + + double timeout_value = ax25_link_get_next_timer_expiry(); + + timed_out = dlq_wait_while_empty (timeout_value); + + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("recv_process: woke up, timed_out=%d\n", timed_out); +#endif + + if (timed_out) { + +#if DEBUG + text_color_set(DW_COLOR_ERROR); + dw_printf ("recv_process: time waiting on dlq. call dl_timer_expiry.\n"); +#endif + + dl_timer_expiry (); + } + else { + + pitem = dlq_remove (); + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("recv_process: dlq_remove() returned pitem=%p\n", pitem); +#endif + + if (pitem != NULL) { + switch (pitem->type) { + + case DLQ_REC_FRAME: +/* + * This is the traditional processing. + * For all frames: + * - Print in standard monitoring format. + * - Send to KISS client applications. + * - Send to AGw client applications in raw mode. + * For APRS frames: + * - Explain what it means. + * - Send to Igate. + * - Digipeater. + */ + + app_process_rec_packet (pitem->chan, pitem->subchan, pitem->slice, pitem->pp, pitem->alevel, pitem->fec_type, pitem->retries, pitem->spectrum); + + +/* + * Link processing. + */ + lm_data_indication(pitem); + + break; + + + case DLQ_CONNECT_REQUEST: + + dl_connect_request (pitem); + break; + + case DLQ_DISCONNECT_REQUEST: + + dl_disconnect_request (pitem); + break; + + case DLQ_XMIT_DATA_REQUEST: + + dl_data_request (pitem); + break; + + case DLQ_REGISTER_CALLSIGN: + + dl_register_callsign (pitem); + break; + + case DLQ_UNREGISTER_CALLSIGN: + + dl_unregister_callsign (pitem); + break; + + case DLQ_OUTSTANDING_FRAMES_REQUEST: + + dl_outstanding_frames_request (pitem); + break; + + case DLQ_CHANNEL_BUSY: + + lm_channel_busy (pitem); + break; + + case DLQ_SEIZE_CONFIRM: + + lm_seize_confirm (pitem); + break; + + case DLQ_CLIENT_CLEANUP: + + dl_client_cleanup (pitem); + break; + + } + + dlq_delete (pitem); + } +#if DEBUG + else { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("recv_process: spurious wakeup. (Temp debugging message - not a problem if only occasional.)\n"); + } +#endif + } + + } + +} /* end recv_process */ + + + +/* end recv.c */ + diff --git a/src/recv.h b/src/recv.h new file mode 100644 index 00000000..32019915 --- /dev/null +++ b/src/recv.h @@ -0,0 +1,6 @@ + +/* recv.h */ + +void recv_init (struct audio_s *pa); + +void recv_process (void); \ No newline at end of file diff --git a/redecode.h b/src/redecode.h similarity index 61% rename from redecode.h rename to src/redecode.h index 5d0df506..ffd9a956 100644 --- a/redecode.h +++ b/src/redecode.h @@ -6,7 +6,7 @@ #include "rrbb.h" -extern void redecode_init (void); +extern void redecode_init (struct audio_s *p_audio_config); #endif diff --git a/rpack.h b/src/rpack.h similarity index 100% rename from rpack.h rename to src/rpack.h diff --git a/rrbb.c b/src/rrbb.c similarity index 68% rename from rrbb.c rename to src/rrbb.c index 61e34661..e787dae5 100644 --- a/rrbb.c +++ b/src/rrbb.c @@ -1,7 +1,7 @@ // // This file is part of Dire Wolf, an amateur radio packet TNC. // -// Copyright (C) 2011, 2012, 2013 John Langner, WB2OSZ +// Copyright (C) 2011, 2012, 2013, 2014, 2015 John Langner, WB2OSZ // // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by @@ -23,72 +23,36 @@ * File: rrbb.c * * Purpose: Raw Received Bit Buffer. - * Implementation of an array of bits used to hold data out of + * An array of bits used to hold data out of * the demodulator before feeding it into the HLDC decoding. * - * Version 1.0: Let's try something new. - * Rather than storing a single bit from the demodulator - * output, let's store a value which we can try later - * comparing to threshold values besides 0. + * Version 1.2: Save initial state of 9600 baud descrambler so we can + * attempt bit fix up on G3RUH/K9NG scrambled data. + * + * Version 1.3: Store as bytes rather than packing 8 bits per byte. * *******************************************************************************/ #define RRBB_C +#include "direwolf.h" + #include #include #include #include -#include "direwolf.h" #include "textcolor.h" #include "ax25_pad.h" #include "rrbb.h" - - #define MAGIC1 0x12344321 #define MAGIC2 0x56788765 -#ifndef SLICENDICE -static const unsigned int masks[SOI] = { - 0x00000001, - 0x00000002, - 0x00000004, - 0x00000008, - 0x00000010, - 0x00000020, - 0x00000040, - 0x00000080, - 0x00000100, - 0x00000200, - 0x00000400, - 0x00000800, - 0x00001000, - 0x00002000, - 0x00004000, - 0x00008000, - 0x00010000, - 0x00020000, - 0x00040000, - 0x00080000, - 0x00100000, - 0x00200000, - 0x00400000, - 0x00800000, - 0x01000000, - 0x02000000, - 0x04000000, - 0x08000000, - 0x10000000, - 0x20000000, - 0x40000000, - 0x80000000 }; -#endif - -static int new_count = 0; -static int delete_count = 0; + +volatile static int new_count = 0; +volatile static int delete_count = 0; /*********************************************************************************** @@ -101,36 +65,48 @@ static int delete_count = 0; * * subchan - Which demodulator of the channel. * + * slice - multiple thresholds per demodulator. + * * is_scrambled - Is data scrambled? (true, false) * * descram_state - State of data descrambler. * + * prev_descram - Previous descrambled bit. + * * Returns: Handle to be used by other functions. * * Description: * ***********************************************************************************/ -rrbb_t rrbb_new (int chan, int subchan, int is_scrambled, int descram_state) +rrbb_t rrbb_new (int chan, int subchan, int slice, int is_scrambled, int descram_state, int prev_descram) { rrbb_t result; - assert (SOI == 8 * sizeof(unsigned int)); - assert (chan >= 0 && chan < MAX_CHANS); assert (subchan >= 0 && subchan < MAX_SUBCHANS); - + assert (slice >= 0 && slice < MAX_SLICERS); result = malloc(sizeof(struct rrbb_s)); - + if (result == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("FATAL ERROR: Out of memory.\n"); + exit (EXIT_FAILURE); + } result->magic1 = MAGIC1; result->chan = chan; result->subchan = subchan; + result->slice = slice; result->magic2 = MAGIC2; new_count++; - rrbb_clear (result, is_scrambled, descram_state); + if (new_count > delete_count + 100) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("MEMORY LEAK, rrbb_new, new_count=%d, delete_count=%d\n", new_count, delete_count); + } + + rrbb_clear (result, is_scrambled, descram_state, prev_descram); return (result); } @@ -141,27 +117,39 @@ rrbb_t rrbb_new (int chan, int subchan, int is_scrambled, int descram_state) * * Purpose: Clear by setting length to zero, etc. * - * Inputs: Handle for sample array. + * Inputs: b -Handle for sample array. + * + * is_scrambled - Is data scrambled? (true, false) + * + * descram_state - State of data descrambler. + * + * prev_descram - Previous descrambled bit. * ***********************************************************************************/ -void rrbb_clear (rrbb_t b, int is_scrambled, int descram_state) +void rrbb_clear (rrbb_t b, int is_scrambled, int descram_state, int prev_descram) { assert (b != NULL); assert (b->magic1 == MAGIC1); assert (b->magic2 == MAGIC2); assert (is_scrambled == 0 || is_scrambled == 1); + assert (prev_descram == 0 || prev_descram == 1); b->nextp = NULL; - b->audio_level = 9999; + + b->alevel.rec = 9999; // TODO: was there some reason for this instead of 0 or -1? + b->alevel.mark = 9999; + b->alevel.space = 9999; + b->len = 0; b->is_scrambled = is_scrambled; b->descram_state = descram_state; - + b->prev_descram = prev_descram; } + /*********************************************************************************** * * Name: rrbb_append_bit @@ -173,46 +161,8 @@ void rrbb_clear (rrbb_t b, int is_scrambled, int descram_state) * ***********************************************************************************/ -#if SLICENDICE -void rrbb2_append_bit (rrbb_t b, float val) -{ - assert (b != NULL); - assert (b->magic1 == MAGIC1); - assert (b->magic2 == MAGIC2); - assert (b->len >= 0); - - if (b->len >= MAX_NUM_BITS) { - return; /* Silently discard if full. */ - } +/* Definition in header file so it can be inlined. */ - b->data[b->len++] = (int)(val * 1000.); -} -#else -void rrbb_append_bit (rrbb_t b, int val) -{ - unsigned int di, mi; - - assert (b != NULL); - assert (b->magic1 == MAGIC1); - assert (b->magic2 == MAGIC2); - - if (b->len >= MAX_NUM_BITS) { - return; /* Silently discard if full. */ - } - - di = b->len / SOI; - mi = b->len % SOI; - - if (val) { - b->data[di] |= masks[mi]; - } - else { - b->data[di] &= ~ masks[mi]; - } - - b->len++; -} -#endif /*********************************************************************************** * @@ -258,92 +208,6 @@ int rrbb_get_len (rrbb_t b) } -/*********************************************************************************** - * - * Name: rrbb_set_slice_val - * - * Purpose: Set slicing value to determine whether a sample is bit 0 or 1. - * - * Inputs: Handle for sample array. - * Slicing point value. - * - ***********************************************************************************/ - -#if SLICENDICE - -static int cmp_slice (slice_t *a, slice_t *b) -{ - return ( *a - *b ); -} - -void rrbb_set_slice_val (rrbb_t b, slice_t slice_val) -{ - slice_t sorted[MAX_NUM_BITS]; - int n, i; - int sum, ave, median, izero; - - assert (b != NULL); - assert (b->magic1 == MAGIC1); - assert (b->magic2 == MAGIC2); - - b->slice_val = slice_val; - - memcpy (sorted, b->data, b->len * sizeof(slice_t)); - - /* Typically takes 14 milliseconds on a reasonable PC. */ - qsort (sorted, (size_t)(b->len), sizeof(slice_t), cmp_slice); - - text_color_set (DW_COLOR_DEBUG); - - n = 0; - dw_printf ("[%d..%d] ", n, n+9); - for (i=n; i<=n+9; i++) dw_printf (" %d", sorted[i]); - dw_printf ("\n"); - - n = ( b->len / 2 ) - 10; - dw_printf ("m[%d..%d] ", n, n+19); - for (i=n; i<=n+19; i++) dw_printf (" %d", sorted[i]); - dw_printf ("\n"); - - n = b->len - 1 - 9; - dw_printf ("[%d..%d] ", n, n+9); - for (i=n; i<=n+9; i++) dw_printf (" %d", sorted[i]); - dw_printf ("\n"); - - sum = 0; - for (i=0; ilen; i++) { - sum += sorted[i]; - } - ave = sum / b->len; - - //b->slice_val = ave; - //b->slice_val = sorted[b->len/2]; - - /* Find first one >= 0. */ - izero = -1; - for (i=0; ilen; i++) { - if (sorted[i] >= 0) { - izero = i; - break; - } - } - - if (izero >= 0) { - n = izero - 10; - dw_printf ("z[%d..%d] ", n, n+19); - for (i=n; i<=n+19; i++) dw_printf (" %d", sorted[i]); - dw_printf ("\n"); - - b->slice_val = sorted[izero-1]; - - } - - - -} - -#endif - /*********************************************************************************** * @@ -356,62 +220,9 @@ void rrbb_set_slice_val (rrbb_t b, slice_t slice_val) * ***********************************************************************************/ -#if SLICENDICE -int rrbb_get_bit (rrbb_t b, unsigned int ind) -{ - assert (b != NULL); - assert (b->magic1 == MAGIC1); - assert (b->magic2 == MAGIC2); - assert (ind >= 0 && ind < b->len); - - if (b->data[ind] > b->slice_val) { - return 1; - } - else { - return 0; - } -} -#else -int rrbb_get_bit (rrbb_t b, unsigned int ind) -{ - assert (b != NULL); - assert (b->magic1 == MAGIC1); - assert (b->magic2 == MAGIC2); - - assert (ind < b->len); - - if (b->data[ind / SOI] & masks[ind % SOI]) { - return 1; - } - else { - return 0; - } -} -#endif -unsigned int rrbb_get_computed_bit (rrbb_t b, unsigned int ind) -{ - return b->computed_data[ind]; -} +/* Definition in header file so it can be inlined. */ -int rrbb_compute_bits (rrbb_t b) -{ - unsigned int i,val; - - assert (b != NULL); - assert (b->magic1 == MAGIC1); - assert (b->magic2 == MAGIC2); - for (i=0;ilen;i++) { - if (b->data[i / SOI] & masks[i % SOI]) { - val = 1; - } - else { - val = 0; - } - b->computed_data[i] = val; - } - return 0; -} /*********************************************************************************** @@ -550,6 +361,28 @@ int rrbb_get_subchan (rrbb_t b) } +/*********************************************************************************** + * + * Name: rrbb_get_slice + * + * Purpose: Get slice number from which bit buffer was received. + * + * Inputs: b Handle for bit array. + * + ***********************************************************************************/ + +int rrbb_get_slice (rrbb_t b) +{ + assert (b != NULL); + assert (b->magic1 == MAGIC1); + assert (b->magic2 == MAGIC2); + + assert (b->slice >= 0 && b->slice < MAX_SLICERS); + + return (b->slice); +} + + /*********************************************************************************** * * Name: rrbb_set_audio_level @@ -557,17 +390,17 @@ int rrbb_get_subchan (rrbb_t b) * Purpose: Set audio level at time the frame was received. * * Inputs: b Handle for bit array. - * a Audio level. + * alevel Audio level. * ***********************************************************************************/ -void rrbb_set_audio_level (rrbb_t b, int a) +void rrbb_set_audio_level (rrbb_t b, alevel_t alevel) { assert (b != NULL); assert (b->magic1 == MAGIC1); assert (b->magic2 == MAGIC2); - b->audio_level = a; + b->alevel = alevel; } @@ -581,57 +414,61 @@ void rrbb_set_audio_level (rrbb_t b, int a) * ***********************************************************************************/ -int rrbb_get_audio_level (rrbb_t b) +alevel_t rrbb_get_audio_level (rrbb_t b) { assert (b != NULL); assert (b->magic1 == MAGIC1); assert (b->magic2 == MAGIC2); - return (b->audio_level); + return (b->alevel); } + /*********************************************************************************** * - * Name: rrbb_set_fix_bits + * Name: rrbb_set_speed_error * - * Purpose: Set fix bits at time the frame was received. + * Purpose: Set speed error of the received frame. + * + * Inputs: b Handle for bit array. + * speed_error In percentage. * - * Inputs: b Handle for bit array. - * a fix_bits. - * ***********************************************************************************/ -void rrbb_set_fix_bits (rrbb_t b, int a) +void rrbb_set_speed_error (rrbb_t b, float speed_error) { assert (b != NULL); assert (b->magic1 == MAGIC1); assert (b->magic2 == MAGIC2); - b->fix_bits = a; + b->speed_error = speed_error; } /*********************************************************************************** * - * Name: rrbb_get_fix_bits + * Name: rrbb_get_speed_error * - * Purpose: Get fix bits at time the frame was received. + * Purpose: Get speed error of the received frame. * * Inputs: b Handle for bit array. - * + * + * Returns: speed error in percentage. + * ***********************************************************************************/ -int rrbb_get_fix_bits (rrbb_t b) +float rrbb_get_speed_error (rrbb_t b) { assert (b != NULL); assert (b->magic1 == MAGIC1); assert (b->magic2 == MAGIC2); - return (b->fix_bits); + return (b->speed_error); } + /*********************************************************************************** * * Name: rrbb_get_is_scrambled @@ -675,6 +512,27 @@ int rrbb_get_descram_state (rrbb_t b) } +/*********************************************************************************** + * + * Name: rrbb_get_prev_descram + * + * Purpose: Get previous descrambled bit before first data bit of frame. + * + * Inputs: b Handle for bit array. + * + ***********************************************************************************/ + +int rrbb_get_prev_descram (rrbb_t b) +{ + assert (b != NULL); + assert (b->magic1 == MAGIC1); + assert (b->magic2 == MAGIC2); + + return (b->prev_descram); +} + + + /* end rrbb.c */ diff --git a/rrbb.h b/src/rrbb.h similarity index 50% rename from rrbb.h rename to src/rrbb.h index efb49a88..894a448f 100644 --- a/rrbb.h +++ b/src/rrbb.h @@ -4,16 +4,12 @@ #define RRBB_H -/* Try something new in version 1.0 */ -/* Get back to this later. Disable for now. */ +#define FASTER13 1 // Don't pack 8 samples per byte. -//#define SLICENDICE 1 -typedef short slice_t; +//typedef short slice_t; -#ifdef RRBB_C - /* * Maximum size (in bytes) of an AX.25 frame including the 2 octet FCS. */ @@ -28,84 +24,73 @@ typedef short slice_t; #define MAX_NUM_BITS (MAX_FRAME_LEN * 8 * 6 / 5) -#define SOI 32 - typedef struct rrbb_s { int magic1; struct rrbb_s* nextp; /* Next pointer to maintain a queue. */ + int chan; /* Radio channel from which it was received. */ int subchan; /* Which modem when more than one per channel. */ - int audio_level; /* Received audio level at time of frame capture. */ - unsigned int len; /* Current number of samples in array. */ - int fix_bits; /* Level of effort to recover from */ - /* a bad FCS on the frame. */ + int slice; /* Which slicer. */ + alevel_t alevel; /* Received audio level at time of frame capture. */ + float speed_error; /* Received data speed error as percentage. */ + unsigned int len; /* Current number of samples in array. */ int is_scrambled; /* Is data scrambled G3RUH / K9NG style? */ int descram_state; /* Descrambler state before first data bit of frame. */ + int prev_descram; /* Previous descrambled bit. */ + + unsigned char fdata[MAX_NUM_BITS]; -#if SLICENDICE - slice_t slice_val; - slice_t data[MAX_NUM_BITS]; -#else - unsigned int data[(MAX_NUM_BITS+SOI-1)/SOI]; - unsigned int computed_data[MAX_NUM_BITS]; -#endif int magic2; } *rrbb_t; -#else -/* Hide the implementation. */ -typedef void *rrbb_t; +rrbb_t rrbb_new (int chan, int subchan, int slice, int is_scrambled, int descram_state, int prev_descram); -#endif +void rrbb_clear (rrbb_t b, int is_scrambled, int descram_state, int prev_descram); +static inline /*__attribute__((always_inline))*/ void rrbb_append_bit (rrbb_t b, const unsigned char val) +{ + if (b->len >= MAX_NUM_BITS) { + return; /* Silently discard if full. */ + } + b->fdata[b->len] = val; + b->len++; +} -rrbb_t rrbb_new (int chan, int subchan, int is_scrambled, int descram_state); +static inline /*__attribute__((always_inline))*/ unsigned char rrbb_get_bit (const rrbb_t b, const int ind) +{ + return (b->fdata[ind]); +} -void rrbb_clear (rrbb_t b, int is_scrambled, int descram_state); - -#if SLICENDICE -void rrbb2_append_bit (rrbb_t b, float val); -#else -void rrbb_append_bit (rrbb_t b, int val); -#endif void rrbb_chop8 (rrbb_t b); int rrbb_get_len (rrbb_t b); -#if SLICENDICE -void rrbb_set_slice_val (rrbb_t b, slice_t slice_val); -#endif - -int rrbb_get_bit (rrbb_t b, unsigned int ind); -unsigned int rrbb_get_computed_bit (rrbb_t b, unsigned int ind); -int rrbb_compute_bits (rrbb_t b); - //void rrbb_flip_bit (rrbb_t b, unsigned int ind); void rrbb_delete (rrbb_t b); void rrbb_set_nextp (rrbb_t b, rrbb_t np); - rrbb_t rrbb_get_nextp (rrbb_t b); int rrbb_get_chan (rrbb_t b); int rrbb_get_subchan (rrbb_t b); +int rrbb_get_slice (rrbb_t b); -void rrbb_set_audio_level (rrbb_t b, int a); +void rrbb_set_audio_level (rrbb_t b, alevel_t alevel); +alevel_t rrbb_get_audio_level (rrbb_t b); -int rrbb_get_audio_level (rrbb_t b); +void rrbb_set_speed_error (rrbb_t b, float speed_error); +float rrbb_get_speed_error (rrbb_t b); int rrbb_get_is_scrambled (rrbb_t b); - int rrbb_get_descram_state (rrbb_t b); +int rrbb_get_prev_descram (rrbb_t b); -int rrbb_get_fix_bits(rrbb_t b); -void rrbb_set_fix_bits(rrbb_t b, int fix_bits); #endif diff --git a/src/serial_port.c b/src/serial_port.c new file mode 100644 index 00000000..c57ee202 --- /dev/null +++ b/src/serial_port.c @@ -0,0 +1,463 @@ +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// +// Copyright (C) 2014, 2015, 2017 John Langner, WB2OSZ +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . +// + + +//#define DEBUG 1 + +/*------------------------------------------------------------------ + * + * Module: serial.c + * + * Purpose: Interface to serial port, hiding operating system differences. + * + *---------------------------------------------------------------*/ + +#include "direwolf.h" // should be first + +#include + +#if __WIN32__ + +#include + +#else + +#include +#include +#include +#include +#include +#include +#include + +#endif + +#include +#include + + +#include "textcolor.h" +#include "serial_port.h" + + + + +/*------------------------------------------------------------------- + * + * Name: serial_port_open + * + * Purpose: Open serial port. + * + * Inputs: devicename - For Windows, usually like COM5. + * For Linux, usually /dev/tty... + * "COMn" also allowed and converted to /dev/ttyS(n-1) + * Could be /dev/rfcomm0 for Bluetooth. + * + * baud - Speed. 1200, 4800, 9600 bps, etc. + * If 0, leave it alone. + * + * Returns Handle for serial port or MYFDERROR for error. + * + *---------------------------------------------------------------*/ + + +MYFDTYPE serial_port_open (char *devicename, int baud) +{ + +#if __WIN32__ + + MYFDTYPE fd; + DCB dcb; + int ok; + char bettername[50]; + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("serial_port_open ( '%s', %d )\n", devicename, baud); +#endif + + +// Reference: http://www.robbayer.com/files/serial-win.pdf + +// Need to use FILE_FLAG_OVERLAPPED for full duplex operation. +// Without it, write blocks when waiting on read. + +// Read http://support.microsoft.com/kb/156932 + +// Bug fix in release 1.1 - Need to munge name for COM10 and up. +// http://support.microsoft.com/kb/115831 + + strlcpy (bettername, devicename, sizeof(bettername)); + if (strncasecmp(devicename, "COM", 3) == 0) { + int n; + n = atoi(devicename+3); + if (n >= 10) { + strlcpy (bettername, "\\\\.\\", sizeof(bettername)); + strlcat (bettername, devicename, sizeof(bettername)); + } + } + + fd = CreateFile(bettername, GENERIC_READ | GENERIC_WRITE, + 0, NULL, OPEN_EXISTING, FILE_FLAG_OVERLAPPED, NULL); + + if (fd == MYFDERROR) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("ERROR - Could not open serial port %s.\n", devicename); + return (MYFDERROR); + } + + /* Reference: http://msdn.microsoft.com/en-us/library/windows/desktop/aa363201(v=vs.85).aspx */ + + memset (&dcb, 0, sizeof(dcb)); + dcb.DCBlength = sizeof(DCB); + + ok = GetCommState (fd, &dcb); + if (! ok) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("serial_port_open: GetCommState failed.\n"); + } + + /* http://msdn.microsoft.com/en-us/library/windows/desktop/aa363214(v=vs.85).aspx */ + + dcb.DCBlength = sizeof(DCB); + + switch (baud) { + + case 0: /* Leave it alone. */ break; + case 1200: dcb.BaudRate = CBR_1200; break; + case 2400: dcb.BaudRate = CBR_2400; break; + case 4800: dcb.BaudRate = CBR_4800; break; + case 9600: dcb.BaudRate = CBR_9600; break; + case 19200: dcb.BaudRate = CBR_19200; break; + case 38400: dcb.BaudRate = CBR_38400; break; + case 57600: dcb.BaudRate = CBR_57600; break; + case 115200: dcb.BaudRate = CBR_115200; break; + + default: text_color_set(DW_COLOR_ERROR); + dw_printf ("serial_port_open: Unsupported speed %d. Using 4800.\n", baud); + dcb.BaudRate = CBR_4800; + break; + } + + dcb.fBinary = 1; + dcb.fParity = 0; + dcb.fOutxCtsFlow = 0; + dcb.fOutxDsrFlow = 0; + dcb.fDtrControl = DTR_CONTROL_DISABLE; + dcb.fDsrSensitivity = 0; + dcb.fOutX = 0; + dcb.fInX = 0; + dcb.fErrorChar = 0; + dcb.fNull = 0; /* Don't drop nul characters! */ + dcb.fRtsControl = 0; + dcb.ByteSize = 8; + dcb.Parity = NOPARITY; + dcb.StopBits = ONESTOPBIT; + + ok = SetCommState (fd, &dcb); + if (! ok) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("serial_port_open: SetCommState failed.\n"); + } + + //text_color_set(DW_COLOR_INFO); + //dw_printf("Successful serial port open on %s.\n", devicename); + + // Some devices, e.g. KPC-3+, can't turn off hardware flow control and need RTS. + + EscapeCommFunction(fd,SETRTS); + EscapeCommFunction(fd,SETDTR); +#else + +/* Linux version. */ + + int fd; + struct termios ts; + int e; + char linuxname[50]; + + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("serial_port_open ( '%s' )\n", devicename); +#endif + + /* Translate Windows device name into Linux name. */ + /* COM1 -> /dev/ttyS0, etc. */ + + strlcpy (linuxname, devicename, sizeof(linuxname)); + + if (strncasecmp(devicename, "COM", 3) == 0) { + int n = atoi (devicename + 3); + text_color_set(DW_COLOR_INFO); + dw_printf ("Converted serial port name '%s'", devicename); + if (n < 1) n = 1; + snprintf (linuxname, sizeof(linuxname), "/dev/ttyS%d", n-1); + dw_printf (" to Linux equivalent '%s'\n", linuxname); + } + + fd = open (linuxname, O_RDWR); + + if (fd == MYFDERROR) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("ERROR - Could not open serial port %s.\n", linuxname); + return (MYFDERROR); + } + + e = tcgetattr (fd, &ts); + if (e != 0) { perror ("tcgetattr"); } + + cfmakeraw (&ts); + + ts.c_cc[VMIN] = 1; /* wait for at least one character */ + ts.c_cc[VTIME] = 0; /* no fancy timing. */ + + switch (baud) { + + case 0: /* Leave it alone. */ break; + case 1200: cfsetispeed (&ts, B1200); cfsetospeed (&ts, B1200); break; + case 2400: cfsetispeed (&ts, B2400); cfsetospeed (&ts, B2400); break; + case 4800: cfsetispeed (&ts, B4800); cfsetospeed (&ts, B4800); break; + case 9600: cfsetispeed (&ts, B9600); cfsetospeed (&ts, B9600); break; + case 19200: cfsetispeed (&ts, B19200); cfsetospeed (&ts, B19200); break; + case 38400: cfsetispeed (&ts, B38400); cfsetospeed (&ts, B38400); break; +// This does not seem to be a problem anymore. +// Leaving traces behind, as clue, in case failure is encountered in some older version. +//#ifndef __APPLE__ + // Not defined for Mac OSX. + // https://groups.yahoo.com/neo/groups/direwolf_packet/conversations/messages/2072 + case 57600: cfsetispeed (&ts, B57600); cfsetospeed (&ts, B57600); break; + case 115200: cfsetispeed (&ts, B115200); cfsetospeed (&ts, B115200); break; +//#endif + default: text_color_set(DW_COLOR_ERROR); + dw_printf ("serial_port_open: Unsupported speed %d. Using 4800.\n", baud); + cfsetispeed (&ts, B4800); cfsetospeed (&ts, B4800); + break; + } + + e = tcsetattr (fd, TCSANOW, &ts); + if (e != 0) { perror ("tcsetattr"); } + + //text_color_set(DW_COLOR_INFO); + //dw_printf("Successfully opened serial port %s.\n", devicename); + +#endif + + return (fd); +} + + + + +/*------------------------------------------------------------------- + * + * Name: serial_port_write + * + * Purpose: Send characters to serial port. + * + * Inputs: fd - Handle from open. + * str - Pointer to array of bytes. + * len - Number of bytes to write. + * + * Returns Number of bytes written. Should be the same as len. + * -1 if error. + * + *---------------------------------------------------------------*/ + + +int serial_port_write (MYFDTYPE fd, char *str, int len) +{ + + if (fd == MYFDERROR) { + return (-1); + } + +#if __WIN32__ + + DWORD nwritten; + + /* Without this, write blocks while we are waiting on a read. */ + static OVERLAPPED ov_wr; + memset (&ov_wr, 0, sizeof(ov_wr)); + + if ( ! WriteFile (fd, str, len, &nwritten, &ov_wr)) + { + int err = GetLastError(); + + if (err != ERROR_IO_PENDING) + { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Error writing to serial port. Error %d.\n\n", err); + return (-1); + } + } + + // nwritten is 0 for asynchronous write, at this point, so just return the requested len. + return (len); + +#else + int written; + + written = write (fd, str, (size_t)len); + if (written != len) + { + // Do we want this message here? + // Or rely on caller to check and provide something more meaningful for the usage? + //text_color_set(DW_COLOR_ERROR); + //dw_printf ("Error writing to serial port. err=%d\n\n", written); + return (-1); + } + + return (written); +#endif + + +} /* serial_port_write */ + + + +/*------------------------------------------------------------------- + * + * Name: serial_port_get1 + * + * Purpose: Get one byte from the serial port. Wait if not ready. + * + * Inputs: fd - Handle from open. + * + * Returns: Value of byte in range of 0 to 255. + * -1 if error. + * + *--------------------------------------------------------------------*/ + +int serial_port_get1 (MYFDTYPE fd) +{ + unsigned char ch; + +#if __WIN32__ /* Native Windows version. */ + + DWORD n; + static OVERLAPPED ov_rd; + + memset (&ov_rd, 0, sizeof(ov_rd)); + ov_rd.hEvent = CreateEvent (NULL, TRUE, FALSE, NULL); + + + /* Overlapped I/O makes reading rather complicated. */ + /* See: http://msdn.microsoft.com/en-us/library/ms810467.aspx */ + + /* It seems that the read completes OK with a count */ + /* of 0 every time we send a message to the serial port. */ + + n = 0; /* Number of characters read. */ + + while (n == 0) { + + if ( ! ReadFile (fd, &ch, 1, &n, &ov_rd)) + { + int err1 = GetLastError(); + + if (err1 == ERROR_IO_PENDING) + { + /* Wait for completion. */ + + if (WaitForSingleObject (ov_rd.hEvent, INFINITE) == WAIT_OBJECT_0) + { + if ( ! GetOverlappedResult (fd, &ov_rd, &n, 1)) + { + int err3 = GetLastError(); + + text_color_set(DW_COLOR_ERROR); + dw_printf ("Serial Port GetOverlappedResult error %d.\n\n", err3); + } + else + { + /* Success! n should be 1 */ + } + } + } + else + { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Serial port read error %d.\n", err1); + return (-1); + } + } + + } /* end while n==0 */ + + CloseHandle(ov_rd.hEvent); + + if (n != 1) { + //text_color_set(DW_COLOR_ERROR); + //dw_printf ("Serial port failed to get one byte. n=%d.\n\n", (int)n); + return (-1); + } + + +#else /* Linux version */ + + int n; + + n = read(fd, &ch, (size_t)1); + + if (n != 1) { + //text_color_set(DW_COLOR_DEBUG); + //dw_printf ("serial_port_get1(%d) returns -1 for error.\n", fd); + return (-1); + } + +#endif + +#if DEBUGx + text_color_set(DW_COLOR_DEBUG); + if (isprint(ch)) { + dw_printf ("serial_port_get1(%d) returns 0x%02x = '%c'\n", fd, ch, ch); + } + else { + dw_printf ("serial_port_get1(%d) returns 0x%02x\n", fd, ch); + } +#endif + + return (ch); +} + + +/*------------------------------------------------------------------- + * + * Name: serial_port_close + * + * Purpose: Close the device. + * + * Inputs: fd - Handle from open. + * + * Returns: None. + * + *--------------------------------------------------------------------*/ + +void serial_port_close (MYFDTYPE fd) +{ +#if __WIN32__ + CloseHandle (fd); +#else + close (fd); +#endif +} + + +/* end serial_port.c */ diff --git a/src/serial_port.h b/src/serial_port.h new file mode 100644 index 00000000..8a65a0b4 --- /dev/null +++ b/src/serial_port.h @@ -0,0 +1,32 @@ +/* serial_port.h */ + + +#ifndef SERIAL_PORT_H +#define SERIAL_PORT_H 1 + + +#if __WIN32__ + +#include + +typedef HANDLE MYFDTYPE; +#define MYFDERROR INVALID_HANDLE_VALUE + +#else + +typedef int MYFDTYPE; +#define MYFDERROR (-1) + +#endif + + +extern MYFDTYPE serial_port_open (char *devicename, int baud); + +extern int serial_port_write (MYFDTYPE fd, char *str, int len); + +extern int serial_port_get1 (MYFDTYPE fd); + +extern void serial_port_close (MYFDTYPE fd); + + +#endif \ No newline at end of file diff --git a/src/server.c b/src/server.c new file mode 100644 index 00000000..6b41af25 --- /dev/null +++ b/src/server.c @@ -0,0 +1,2137 @@ +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// +// Copyright (C) 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2020 John Langner, WB2OSZ +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . +// + + +/*------------------------------------------------------------------ + * + * Module: server.c + * + * Purpose: Provide service to other applications via "AGW TCPIP Socket Interface". + * + * Input: + * + * Outputs: + * + * Description: This provides a TCP socket for communication with a client application. + * It implements a subset of the AGW socket interface. + * + * Commands from application recognized: + * + * 'R' Request for version number. + * (See below for response.) + * + * 'G' Ask about radio ports. + * (See below for response.) + * + * 'g' Capabilities of a port. (new in 0.8) + * (See below for response.) + * + * 'k' Ask to start receiving RAW AX25 frames. + * + * 'm' Ask to start receiving Monitor AX25 frames. + * Enables sending of U, I, S, and T messages to client app. + * + * 'V' Transmit UI data frame. + * + * 'H' Report recently heard stations. Not implemented yet. + * + * 'K' Transmit raw AX.25 frame. + * + * 'X' Register CallSign + * + * 'x' Unregister CallSign + * + * 'y' Ask Outstanding frames waiting on a Port (new in 1.2) + * + * 'Y' How many frames waiting for transmit for a particular station (new in 1.5) + * + * 'C' Connect, Start an AX.25 Connection (new in 1.4) + * + * 'v' Connect VIA, Start an AX.25 circuit thru digipeaters (new in 1.4) + * + * 'c' Connection with non-standard PID (new in 1.4) + * + * 'D' Send Connected Data (new in 1.4) + * + * 'd' Disconnect, Terminate an AX.25 Connection (new in 1.4) + * + * + * A message is printed if any others are received. + * + * TODO: Should others be implemented? + * + * + * Messages sent to client application: + * + * 'R' Reply to Request for version number. + * Currently responds with major 1, minor 0. + * + * 'G' Reply to Ask about radio ports. + * + * 'g' Reply to capabilities of a port. (new in 0.8) + * + * 'K' Received AX.25 frame in raw format. + * (Enabled with 'k' command.) + * + * 'U' Received AX.25 "UI" frames in monitor format. + * (Enabled with 'm' command.) + * + * 'I' Received AX.25 "I" frames in monitor format. (new in 1.6) + * (Enabled with 'm' command.) + * + * 'S' Received AX.25 "S" and "U" (other than UI) frames in monitor format. (new in 1.6) + * (Enabled with 'm' command.) + * + * 'T' Own Transmitted AX.25 frames in monitor format. (new in 1.6) + * (Enabled with 'm' command.) + * + * 'y' Outstanding frames waiting on a Port (new in 1.2) + * + * 'Y' How many frames waiting for transmit for a particular station (new in 1.5) + * + * 'C' AX.25 Connection Received (new in 1.4) + * + * 'D' Connected AX.25 Data (new in 1.4) + * + * 'd' Disconnected (new in 1.4) + * + * + * + * References: AGWPE TCP/IP API Tutorial + * http://uz7ho.org.ua/includes/agwpeapi.htm + * + * It has disappeared from the original location but you can find it here: + * https://web.archive.org/web/20130807113413/http:/uz7ho.org.ua/includes/agwpeapi.htm + * https://www.on7lds.net/42/sites/default/files/AGWPEAPI.HTM + * + * Getting Started with Winsock + * http://msdn.microsoft.com/en-us/library/windows/desktop/bb530742(v=vs.85).aspx + * + * + * Major change in 1.1: + * + * Formerly a single client was allowed. + * Now we can have multiple concurrent clients. + * + *---------------------------------------------------------------*/ + + +/* + * Native Windows: Use the Winsock interface. + * Linux: Use the BSD socket interface. + * Cygwin: Can use either one. + */ + +#include "direwolf.h" // Sets _WIN32_WINNT for XP API level needed by ws2tcpip.h + +#if __WIN32__ +#include +#include // _WIN32_WINNT must be set to 0x0501 before including this +#else +#include +#include +#include +#include +#include +#include +#endif + +#include +#include +#include +#include +#include +#include +#include + +#include "tq.h" +#include "ax25_pad.h" +#include "textcolor.h" +#include "audio.h" +#include "server.h" +#include "dlq.h" + + + +/* + * Previously, we allowed only one network connection at a time to each port. + * In version 1.1, we allow multiple concurrent client apps to attach with the AGW network protocol. + * The default is a limit of 3 client applications at the same time. + * You can increase the limit by changing the line below. + * A larger number consumes more resources so don't go crazy by making it larger than needed. + */ +// FIXME: Put in direwolf.h rather than in .c file. Change name to reflect AGW vs KISS. Update user guide 5.7. + +#define MAX_NET_CLIENTS 3 + +static int client_sock[MAX_NET_CLIENTS]; + /* File descriptor for socket for */ + /* communication with client application. */ + /* Set to -1 if not connected. */ + /* (Don't use SOCKET type because it is unsigned.) */ + +static int enable_send_raw_to_client[MAX_NET_CLIENTS]; + /* Should we send received packets to client app in raw form? */ + /* Note that it starts as false for a new connection. */ + /* the client app must send a command to enable this. */ + +static int enable_send_monitor_to_client[MAX_NET_CLIENTS]; + /* Should we send received packets to client app in monitor form? */ + /* Note that it starts as false for a new connection. */ + /* the client app must send a command to enable this. */ + + +// TODO: define in one place, use everywhere. +// TODO: Macro to terminate thread when no point to go on. + +#if __WIN32__ +#define THREAD_F unsigned __stdcall +#else +#define THREAD_F void * +#endif + +static THREAD_F connect_listen_thread (void *arg); +static THREAD_F cmd_listen_thread (void *arg); + +/* + * Message header for AGW protocol. + * Multibyte numeric values require rearranging for big endian cpu. + */ + +/* + * With MinGW version 4.6, obviously x86. + * or Linux gcc version 4.9, Linux ARM. + * + * $ gcc -E -dM - < /dev/null | grep END + * #define __ORDER_LITTLE_ENDIAN__ 1234 + * #define __FLOAT_WORD_ORDER__ __ORDER_LITTLE_ENDIAN__ + * #define __ORDER_PDP_ENDIAN__ 3412 + * #define __ORDER_BIG_ENDIAN__ 4321 + * #define __BYTE_ORDER__ __ORDER_LITTLE_ENDIAN__ + * + * This is for standard OpenWRT on MIPS. + * + * #define __ORDER_LITTLE_ENDIAN__ 1234 + * #define __FLOAT_WORD_ORDER__ __ORDER_BIG_ENDIAN__ + * #define __ORDER_PDP_ENDIAN__ 3412 + * #define __ORDER_BIG_ENDIAN__ 4321 + * #define __BYTE_ORDER__ __ORDER_BIG_ENDIAN__ + * + * This was reported for an old Mac with PowerPC processor. + * (Newer versions have x86.) + * + * $ gcc -E -dM - < /dev/null | grep END + * #define __BIG_ENDIAN__ 1 + * #define _BIG_ENDIAN 1 + */ + + +#if defined(__BIG_ENDIAN__) || (defined(__BYTE_ORDER__) && defined(__ORDER_BIG_ENDIAN__) && __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__) + +// gcc >= 4.2 has __builtin_swap32() but might not be compatible with older versions or other compilers. + +#define host2netle(x) ( (((x)>>24)&0x000000ff) | (((x)>>8)&0x0000ff00) | (((x)<<8)&0x00ff0000) | (((x)<<24)&0xff000000) ) +#define netle2host(x) ( (((x)>>24)&0x000000ff) | (((x)>>8)&0x0000ff00) | (((x)<<8)&0x00ff0000) | (((x)<<24)&0xff000000) ) + +#else + +#define host2netle(x) (x) +#define netle2host(x) (x) + +#endif + + +struct agwpe_s { + unsigned char portx; /* 0 for first, 1 for second, etc. */ + unsigned char reserved1; + unsigned char reserved2; + unsigned char reserved3; + + unsigned char datakind; /* message type, usually written as a letter. */ + unsigned char reserved4; + unsigned char pid; + unsigned char reserved5; + + char call_from[10]; + + char call_to[10]; + + int data_len_NETLE; /* Number of data bytes following. */ + /* _NETLE suffix is reminder to convert for network byte order. */ + + int user_reserved_NETLE; +}; + + +static void send_to_client (int client, void *reply_p); + + +/*------------------------------------------------------------------- + * + * Name: debug_print + * + * Purpose: Print message to/from client for debugging. + * + * Inputs: fromto - Direction of message. + * client - client number, 0 .. MAX_NET_CLIENTS-1 + * pmsg - Address of the message block. + * msg_len - Length of the message. + * + *--------------------------------------------------------------------*/ + +static int debug_client = 0; /* Debug option: Print information flowing from and to client. */ + +void server_set_debug (int n) +{ + debug_client = n; +} + +void hex_dump (unsigned char *p, int len) +{ + int n, i, offset; + + offset = 0; + while (len > 0) { + n = len < 16 ? len : 16; + dw_printf (" %03x: ", offset); + for (i=0; i>>" }; + + switch (fromto) { + + case FROM_CLIENT: + strlcpy (direction, "from", sizeof(direction)); /* from the client application */ + + switch (pmsg->datakind) { + case 'P': strlcpy (datakind, "Application Login", sizeof(datakind)); break; + case 'X': strlcpy (datakind, "Register CallSign", sizeof(datakind)); break; + case 'x': strlcpy (datakind, "Unregister CallSign", sizeof(datakind)); break; + case 'G': strlcpy (datakind, "Ask Port Information", sizeof(datakind)); break; + case 'm': strlcpy (datakind, "Enable Reception of Monitoring Frames", sizeof(datakind)); break; + case 'R': strlcpy (datakind, "AGWPE Version Info", sizeof(datakind)); break; + case 'g': strlcpy (datakind, "Ask Port Capabilities", sizeof(datakind)); break; + case 'H': strlcpy (datakind, "Callsign Heard on a Port", sizeof(datakind)); break; + case 'y': strlcpy (datakind, "Ask Outstanding frames waiting on a Port", sizeof(datakind)); break; + case 'Y': strlcpy (datakind, "Ask Outstanding frames waiting for a connection", sizeof(datakind)); break; + case 'M': strlcpy (datakind, "Send UNPROTO Information", sizeof(datakind)); break; + case 'C': strlcpy (datakind, "Connect, Start an AX.25 Connection", sizeof(datakind)); break; + case 'D': strlcpy (datakind, "Send Connected Data", sizeof(datakind)); break; + case 'd': strlcpy (datakind, "Disconnect, Terminate an AX.25 Connection", sizeof(datakind)); break; + case 'v': strlcpy (datakind, "Connect VIA, Start an AX.25 circuit thru digipeaters", sizeof(datakind)); break; + case 'V': strlcpy (datakind, "Send UNPROTO VIA", sizeof(datakind)); break; + case 'c': strlcpy (datakind, "Non-Standard Connections, Connection with PID", sizeof(datakind)); break; + case 'K': strlcpy (datakind, "Send data in raw AX.25 format", sizeof(datakind)); break; + case 'k': strlcpy (datakind, "Activate reception of Frames in raw format", sizeof(datakind)); break; + default: strlcpy (datakind, "**INVALID**", sizeof(datakind)); break; + } + break; + + case TO_CLIENT: + default: + strlcpy (direction, "to", sizeof(direction)); /* sent to the client application. */ + + switch (pmsg->datakind) { + case 'R': strlcpy (datakind, "Version Number", sizeof(datakind)); break; + case 'X': strlcpy (datakind, "Callsign Registration", sizeof(datakind)); break; + case 'G': strlcpy (datakind, "Port Information", sizeof(datakind)); break; + case 'g': strlcpy (datakind, "Capabilities of a Port", sizeof(datakind)); break; + case 'y': strlcpy (datakind, "Frames Outstanding on a Port", sizeof(datakind)); break; + case 'Y': strlcpy (datakind, "Frames Outstanding on a Connection", sizeof(datakind)); break; + case 'H': strlcpy (datakind, "Heard Stations on a Port", sizeof(datakind)); break; + case 'C': strlcpy (datakind, "AX.25 Connection Received", sizeof(datakind)); break; + case 'D': strlcpy (datakind, "Connected AX.25 Data", sizeof(datakind)); break; + case 'd': strlcpy (datakind, "Disconnected", sizeof(datakind)); break; + case 'M': strlcpy (datakind, "Monitored Connected Information", sizeof(datakind)); break; + case 'S': strlcpy (datakind, "Monitored Supervisory Information", sizeof(datakind)); break; + case 'U': strlcpy (datakind, "Monitored Unproto Information", sizeof(datakind)); break; + case 'T': strlcpy (datakind, "Monitoring Own Information", sizeof(datakind)); break; + case 'K': strlcpy (datakind, "Monitored Information in Raw Format", sizeof(datakind)); break; + default: strlcpy (datakind, "**INVALID**", sizeof(datakind)); break; + } + } + + text_color_set(DW_COLOR_DEBUG); + dw_printf ("\n"); + + dw_printf ("%s %s %s AGWPE client application %d, total length = %d\n", + prefix[(int)fromto], datakind, direction, client, msg_len); + + dw_printf ("\tportx = %d, datakind = '%c', pid = 0x%02x\n", pmsg->portx, pmsg->datakind, pmsg->pid); + dw_printf ("\tcall_from = \"%s\", call_to = \"%s\"\n", pmsg->call_from, pmsg->call_to); + dw_printf ("\tdata_len = %d, user_reserved = %d, data =\n", netle2host(pmsg->data_len_NETLE), netle2host(pmsg->user_reserved_NETLE)); + + hex_dump ((unsigned char*)pmsg + sizeof(struct agwpe_s), netle2host(pmsg->data_len_NETLE)); + + if (msg_len < 36) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("AGWPE message length, %d, is shorter than minimum 36.\n", msg_len); + } + if (msg_len != netle2host(pmsg->data_len_NETLE) + 36) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("AGWPE message length, %d, inconsistent with data length %d.\n", msg_len, netle2host(pmsg->data_len_NETLE)); + } + +} + +/*------------------------------------------------------------------- + * + * Name: server_init + * + * Purpose: Set up a server to listen for connection requests from + * an application such as Xastir. + * + * Inputs: mc->agwpe_port - TCP port for server. + * Main program has default of 8000 but allows + * an alternative to be specified on the command line + * + * 0 means disable. New in version 1.2. + * + * Outputs: + * + * Description: This starts at least two threads: + * * one to listen for a connection from client app. + * * one or more to listen for commands from client app. + * so the main application doesn't block while we wait for these. + * + *--------------------------------------------------------------------*/ + +static struct audio_s *save_audio_config_p; + + +void server_init (struct audio_s *audio_config_p, struct misc_config_s *mc) +{ + int client; + +#if __WIN32__ + HANDLE connect_listen_th; + HANDLE cmd_listen_th[MAX_NET_CLIENTS]; +#else + pthread_t connect_listen_tid; + pthread_t cmd_listen_tid[MAX_NET_CLIENTS]; + int e; +#endif + int server_port = mc->agwpe_port; /* Usually 8000 but can be changed. */ + + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("server_init ( %d )\n", server_port); + debug_a = 1; +#endif + + save_audio_config_p = audio_config_p; + + for (client=0; clientai_family, ai->ai_socktype, ai->ai_protocol); + if (listen_sock == INVALID_SOCKET) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("connect_listen_thread: Socket creation failed, err=%d", WSAGetLastError()); + return (0); + } + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf("Binding to port %s ... \n", server_port_str); +#endif + + err = bind( listen_sock, ai->ai_addr, (int)ai->ai_addrlen); + if (err == SOCKET_ERROR) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Bind failed with error: %d\n", WSAGetLastError()); // TODO: translate number to text? + dw_printf("Some other application is probably already using port %s.\n", server_port_str); + dw_printf("Try using a different port number with AGWPORT in the configuration file.\n"); + freeaddrinfo(ai); + closesocket(listen_sock); + WSACleanup(); + return (0); + } + + freeaddrinfo(ai); + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf("opened socket as fd (%d) on port (%s) for stream i/o\n", listen_sock, server_port_str ); +#endif + + while (1) { + + int client; + int c; + + client = -1; + for (c = 0; c < MAX_NET_CLIENTS && client < 0; c++) { + if (client_sock[c] <= 0) { + client = c; + } + } + +/* + * Listen for connection if we have not reached maximum. + */ + if (client >= 0) { + + if(listen(listen_sock, MAX_NET_CLIENTS) == SOCKET_ERROR) + { + text_color_set(DW_COLOR_ERROR); + dw_printf("Listen failed with error: %d\n", WSAGetLastError()); + return (0); + } + + text_color_set(DW_COLOR_INFO); + dw_printf("Ready to accept AGW client application %d on port %s ...\n", client, server_port_str); + + client_sock[client] = accept(listen_sock, NULL, NULL); + + if (client_sock[client] == -1) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Accept failed with error: %d\n", WSAGetLastError()); + closesocket(listen_sock); + WSACleanup(); + return (0); + } + + text_color_set(DW_COLOR_INFO); + dw_printf("\nAttached to AGW client application %d ...\n\n", client); + +/* + * The command to change this is actually a toggle, not explicit on or off. + * Make sure it has proper state when we get a new connection. + */ + enable_send_raw_to_client[client] = 0; + enable_send_monitor_to_client[client] = 0; + } + else { + SLEEP_SEC(1); /* wait then check again if more clients allowed. */ + } + } + +#else /* End of Windows case, now Linux */ + + + struct sockaddr_in sockaddr; /* Internet socket address struct */ + socklen_t sockaddr_size = sizeof(struct sockaddr_in); + int server_port = (int)(ptrdiff_t)arg; + int listen_sock; + int bcopt = 1; + + listen_sock= socket(AF_INET,SOCK_STREAM,0); + if (listen_sock == -1) { + text_color_set(DW_COLOR_ERROR); + perror ("connect_listen_thread: Socket creation failed"); + return (NULL); + } + + /* Version 1.3 - as suggested by G8BPQ. */ + /* Without this, if you kill the application then try to run it */ + /* again quickly the port number is unavailable for a while. */ + /* Don't try doing the same thing On Windows; It has a different meaning. */ + /* http://stackoverflow.com/questions/14388706/socket-options-so-reuseaddr-and-so-reuseport-how-do-they-differ-do-they-mean-t */ + + setsockopt (listen_sock, SOL_SOCKET, SO_REUSEADDR, (const char *)&bcopt, 4); + + + sockaddr.sin_addr.s_addr = INADDR_ANY; + sockaddr.sin_port = htons(server_port); + sockaddr.sin_family = AF_INET; + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf("Binding to port %d ... \n", server_port); +#endif + + if (bind(listen_sock,(struct sockaddr*)&sockaddr,sizeof(sockaddr)) == -1) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Bind failed with error: %d\n", errno); + dw_printf("%s\n", strerror(errno)); + dw_printf("Some other application is probably already using port %d.\n", server_port); + dw_printf("Try using a different port number with AGWPORT in the configuration file.\n"); + return (NULL); + } + + getsockname( listen_sock, (struct sockaddr *)(&sockaddr), &sockaddr_size); + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf("opened socket as fd (%d) on port (%d) for stream i/o\n", listen_sock, ntohs(sockaddr.sin_port) ); +#endif + + while (1) { + + int client; + int c; + + client = -1; + for (c = 0; c < MAX_NET_CLIENTS && client < 0; c++) { + if (client_sock[c] <= 0) { + client = c; + } + } + + if (client >= 0) { + + if(listen(listen_sock,MAX_NET_CLIENTS) == -1) + { + text_color_set(DW_COLOR_ERROR); + perror ("connect_listen_thread: Listen failed"); + return (NULL); + } + + text_color_set(DW_COLOR_INFO); + dw_printf("Ready to accept AGW client application %d on port %d ...\n", client, server_port); + + client_sock[client] = accept(listen_sock, (struct sockaddr*)(&sockaddr),&sockaddr_size); + + text_color_set(DW_COLOR_INFO); + dw_printf("\nAttached to AGW client application %d...\n\n", client); + +/* + * The command to change this is actually a toggle, not explicit on or off. + * Make sure it has proper state when we get a new connection. + */ + enable_send_raw_to_client[client] = 0; + enable_send_monitor_to_client[client] = 0; + } + else { + SLEEP_SEC(1); /* wait then check again if more clients allowed. */ + } + } +#endif +} + + +/*------------------------------------------------------------------- + * + * Name: server_send_rec_packet + * + * Purpose: Send a received packet to the client app. + * + * Inputs: chan - Channel number where packet was received. + * 0 = first, 1 = second if any. + * + * pp - Identifier for packet object. + * + * fbuf - Address of raw received frame buffer. + * flen - Length of raw received frame. + * + * + * Description: Send message to client if connected. + * Disconnect from client, and notify user, if any error. + * + * There are two different formats: + * RAW - the original received frame. + * MONITOR - human readable monitoring format. + * + *--------------------------------------------------------------------*/ + +static void mon_addrs (int chan, packet_t pp, char *result, int result_size); +static char mon_desc (packet_t pp, char *result, int result_size); + + +void server_send_rec_packet (int chan, packet_t pp, unsigned char *fbuf, int flen) +{ + struct { + struct agwpe_s hdr; + char data[1+AX25_MAX_PACKET_LEN]; + } agwpe_msg; + + int err; + +/* + * RAW format + */ + for (int client=0; client 0){ + + memset (&agwpe_msg.hdr, 0, sizeof(agwpe_msg.hdr)); + + agwpe_msg.hdr.portx = chan; + + agwpe_msg.hdr.datakind = 'K'; + + ax25_get_addr_with_ssid (pp, AX25_SOURCE, agwpe_msg.hdr.call_from); + + ax25_get_addr_with_ssid (pp, AX25_DESTINATION, agwpe_msg.hdr.call_to); + + agwpe_msg.hdr.data_len_NETLE = host2netle(flen + 1); + + /* Stick in extra byte for the "TNC" to use. */ + + agwpe_msg.data[0] = 0; + memcpy (agwpe_msg.data + 1, fbuf, (size_t)flen); + + if (debug_client) { + debug_print (TO_CLIENT, client, &agwpe_msg.hdr, sizeof(agwpe_msg.hdr) + netle2host(agwpe_msg.hdr.data_len_NETLE)); + } + +#if __WIN32__ + err = SOCK_SEND (client_sock[client], (char*)(&agwpe_msg), sizeof(agwpe_msg.hdr) + netle2host(agwpe_msg.hdr.data_len_NETLE)); + if (err == SOCKET_ERROR) + { + text_color_set(DW_COLOR_ERROR); + dw_printf ("\nError %d sending message to AGW client application. Closing connection.\n\n", WSAGetLastError()); + closesocket (client_sock[client]); + client_sock[client] = -1; + WSACleanup(); + dlq_client_cleanup (client); + } +#else + err = SOCK_SEND (client_sock[client], &agwpe_msg, sizeof(agwpe_msg.hdr) + netle2host(agwpe_msg.hdr.data_len_NETLE)); + if (err <= 0) + { + text_color_set(DW_COLOR_ERROR); + dw_printf ("\nError sending message to AGW client application. Closing connection.\n\n"); + close (client_sock[client]); + client_sock[client] = -1; + dlq_client_cleanup (client); + } +#endif + } + } + + // Application might want more human readable format. + + server_send_monitored (chan, pp, 0); + +} /* end server_send_rec_packet */ + + + +void server_send_monitored (int chan, packet_t pp, int own_xmit) +{ +/* + * MONITOR format - 'I' for information frames. + * 'U' for unnumbered information. + * 'S' for supervisory and other unnumbered. + */ + struct { + struct agwpe_s hdr; + char data[128+AX25_MAX_PACKET_LEN]; // Add plenty of room for header prefix. + } agwpe_msg; + + int err; + + for (int client=0; client 0) { + + memset (&agwpe_msg.hdr, 0, sizeof(agwpe_msg.hdr)); + + agwpe_msg.hdr.portx = chan; // datakind is added later. + ax25_get_addr_with_ssid (pp, AX25_SOURCE, agwpe_msg.hdr.call_from); + ax25_get_addr_with_ssid (pp, AX25_DESTINATION, agwpe_msg.hdr.call_to); + + /* http://uz7ho.org.ua/includes/agwpeapi.htm#_Toc500723812 */ + + /* Description mentions one CR character after timestamp but example has two. */ + /* Actual observed cases have only one. */ + /* Also need to add extra CR, CR, null at end. */ + /* The documentation example includes these 3 extra in the Len= value */ + /* but actual observed data uses only the packet info length. */ + + // Documentation doesn't mention anything about including the via path. + // In version 1.4, we add that to match observed behaviour. + + // This inconsistency was reported: + // Direwolf: + // [AGWE-IN] 1:Fm ZL4FOX-8 To Q7P2U2 [08:25:07]`I1*l V>/"9<}[:Barts Tracker 3.83V X + // AGWPE: + // [AGWE-IN] 1:Fm ZL4FOX-8 To Q7P2U2 Via WIDE3-3 [08:32:14]`I0*l V>/"98}[:Barts Tracker 3.83V X + + // Format the channel and addresses, with leading and trailing space. + + mon_addrs (chan, pp, (char*)(agwpe_msg.data), sizeof(agwpe_msg.data)); + + // Add the description with <... > + + char desc[120]; + agwpe_msg.hdr.datakind = mon_desc (pp, desc, sizeof(desc)); + if (own_xmit) { + agwpe_msg.hdr.datakind = 'T'; + } + strlcat ((char*)(agwpe_msg.data), desc, sizeof(agwpe_msg.data)); + + // Timestamp with [...]\r + + time_t clock = time(NULL); + struct tm *tm = localtime(&clock); // TODO: use localtime_r ? + char ts[32]; + snprintf (ts, sizeof(ts), "[%02d:%02d:%02d]\r", tm->tm_hour, tm->tm_min, tm->tm_sec); + strlcat ((char*)(agwpe_msg.data), ts, sizeof(agwpe_msg.data)); + + // Information if any with \r. + + unsigned char *pinfo = NULL; + int info_len = ax25_get_info (pp, &pinfo); + int msg_data_len = strlen((char*)(agwpe_msg.data)); // result length so far + + if (info_len > 0 && pinfo != NULL) { + // Issue 367: Use of strlcat truncated information part at any nul character. + // Use memcpy instead to preserve binary data, e.g. NET/ROM. + memcpy (agwpe_msg.data + msg_data_len, pinfo, info_len); + msg_data_len += info_len; + agwpe_msg.data[msg_data_len++] = '\r'; + } + + agwpe_msg.data[msg_data_len++] = '\0'; // add nul at end, included in length. + agwpe_msg.hdr.data_len_NETLE = host2netle(msg_data_len); + + if (debug_client) { + debug_print (TO_CLIENT, client, &agwpe_msg.hdr, sizeof(agwpe_msg.hdr) + netle2host(agwpe_msg.hdr.data_len_NETLE)); + } + +#if __WIN32__ + err = SOCK_SEND (client_sock[client], (char*)(&agwpe_msg), sizeof(agwpe_msg.hdr) + netle2host(agwpe_msg.hdr.data_len_NETLE)); + if (err == SOCKET_ERROR) + { + text_color_set(DW_COLOR_ERROR); + dw_printf ("\nError %d sending message to AGW client application %d. Closing connection.\n\n", WSAGetLastError(), client); + closesocket (client_sock[client]); + client_sock[client] = -1; + WSACleanup(); + dlq_client_cleanup (client); + } +#else + err = SOCK_SEND (client_sock[client], &agwpe_msg, sizeof(agwpe_msg.hdr) + netle2host(agwpe_msg.hdr.data_len_NETLE)); + if (err <= 0) + { + text_color_set(DW_COLOR_ERROR); + dw_printf ("\nError sending message to AGW client application %d. Closing connection.\n\n", client); + close (client_sock[client]); + client_sock[client] = -1; + dlq_client_cleanup (client); + } +#endif + } + } + +} /* server_send_monitored */ + + +// Next two are broken out in case they can be reused elsewhere. + +// Format addresses in AGWPR monitoring format such as: +// 1:Fm ZL4FOX-8 To Q7P2U2 Via WIDE3-3 + +static void mon_addrs (int chan, packet_t pp, char *result, int result_size) +{ + char src[AX25_MAX_ADDR_LEN]; + char dst[AX25_MAX_ADDR_LEN]; + + ax25_get_addr_with_ssid (pp, AX25_SOURCE, src); + ax25_get_addr_with_ssid (pp, AX25_DESTINATION, dst); + int num_digi = ax25_get_num_repeaters(pp); + + if (num_digi > 0) { + + char via[AX25_MAX_REPEATERS*(AX25_MAX_ADDR_LEN+1)]; + char stemp[AX25_MAX_ADDR_LEN+1]; + int j; + + ax25_get_addr_with_ssid (pp, AX25_REPEATER_1, via); + for (j = 1; j < num_digi; j++) { + ax25_get_addr_with_ssid (pp, AX25_REPEATER_1 + j, stemp); + strlcat (via, ",", sizeof(via)); + strlcat (via, stemp, sizeof(via)); + } + snprintf (result, result_size, " %d:Fm %s To %s Via %s ", + chan+1, src, dst, via); + } + else { + snprintf (result, result_size, " %d:Fm %s To %s ", + chan+1, src, dst); + } +} + + +// Generate frame description in AGWPE monitoring format such as +// +// +// +// +// Returns: +// 'I' for information frame. +// 'U' for unnumbered information frame. +// 'S' for supervisory and other unnumbered frames. + +static char mon_desc (packet_t pp, char *result, int result_size) +{ + cmdres_t cr; // command/response. + char ignore[80]; // direwolf description. not used here. + int pf; // poll/final bit. + int ns; // N(S) Send sequence number. + int nr; // N(R) Received sequence number. + char pf_text[4]; // P or F depending on whether command or response. + + ax25_frame_type_t ftype = ax25_frame_type (pp, &cr, ignore, &pf, &nr, &ns); + + switch (cr) { + case cr_cmd: strcpy(pf_text, "P"); break; // P only: I, SABME, SABM, DISC + case cr_res: strcpy(pf_text, "F"); break; // F only: DM, UA, FRMR + // Either: RR, RNR, REJ, SREJ, UI, XID, TEST + + default: strcpy(pf_text, "PF"); break; // Not AX.25 version >= 2.0 + // APRS is often sloppy about this but it + // is essential for connected mode. + } + + unsigned char *pinfo = NULL; // I, UI, XID, SREJ, TEST can have information part. + int info_len = ax25_get_info (pp, &pinfo); + + switch (ftype) { + + case frame_type_I: snprintf (result, result_size, "", ns, nr, ax25_get_pid(pp), info_len, pf_text, pf); return ('I'); + + case frame_type_U_UI: snprintf (result, result_size, "", ax25_get_pid(pp), info_len, pf_text, pf); return ('U'); break; + + case frame_type_S_RR: snprintf (result, result_size, "", nr, pf_text, pf); return ('S'); break; + case frame_type_S_RNR: snprintf (result, result_size, "", nr, pf_text, pf); return ('S'); break; + case frame_type_S_REJ: snprintf (result, result_size, "", nr, pf_text, pf); return ('S'); break; + case frame_type_S_SREJ: snprintf (result, result_size, "", nr, pf_text, pf, info_len); return ('S'); break; + + case frame_type_U_SABME: snprintf (result, result_size, "", pf_text, pf); return ('S'); break; + case frame_type_U_SABM: snprintf (result, result_size, "", pf_text, pf); return ('S'); break; + case frame_type_U_DISC: snprintf (result, result_size, "", pf_text, pf); return ('S'); break; + case frame_type_U_DM: snprintf (result, result_size, "", pf_text, pf); return ('S'); break; + case frame_type_U_UA: snprintf (result, result_size, "", pf_text, pf); return ('S'); break; + case frame_type_U_FRMR: snprintf (result, result_size, "", pf_text, pf); return ('S'); break; + case frame_type_U_XID: snprintf (result, result_size, "", pf_text, pf, info_len); return ('S'); break; + case frame_type_U_TEST: snprintf (result, result_size, "", pf_text, pf, info_len); return ('S'); break; + default: + case frame_type_U: snprintf (result, result_size, ""); return ('S'); break; + } +} + + +/*------------------------------------------------------------------- + * + * Name: server_link_established + * + * Purpose: Send notification to client app when a link has + * been established with another station. + * + * DL-CONNECT Confirm or DL-CONNECT Indication in the protocol spec. + * + * Inputs: chan - Which radio channel. + * + * client - Which one of potentially several clients. + * + * remote_call - Callsign[-ssid] of remote station. + * + * own_call - Callsign[-ssid] of my end. + * + * incoming - true if connection was initiated from other end. + * false if this end started it. + * + *--------------------------------------------------------------------*/ + +void server_link_established (int chan, int client, char *remote_call, char *own_call, int incoming) +{ + + struct { + struct agwpe_s hdr; + char info[100]; + } reply; + + + memset (&reply, 0, sizeof(reply)); + reply.hdr.portx = chan; + reply.hdr.datakind = 'C'; + + strlcpy (reply.hdr.call_from, remote_call, sizeof(reply.hdr.call_from)); + strlcpy (reply.hdr.call_to, own_call, sizeof(reply.hdr.call_to)); + + // Question: Should the via path be provided too? + + if (incoming) { + // Other end initiated the connection. + snprintf (reply.info, sizeof(reply.info), "*** CONNECTED To Station %s\r", remote_call); + } + else { + // We started the connection. + snprintf (reply.info, sizeof(reply.info), "*** CONNECTED With Station %s\r", remote_call); + } + reply.hdr.data_len_NETLE = host2netle(strlen(reply.info) + 1); + + send_to_client (client, &reply); + +} /* end server_link_established */ + + + +/*------------------------------------------------------------------- + * + * Name: server_link_terminated + * + * Purpose: Send notification to client app when a link with + * another station has been terminated or a connection + * attempt failed. + * + * DL-DISCONNECT Confirm or DL-DISCONNECT Indication in the protocol spec. + * + * Inputs: chan - Which radio channel. + * + * client - Which one of potentially several clients. + * + * remote_call - Callsign[-ssid] of remote station. + * + * own_call - Callsign[-ssid] of my end. + * + * timeout - true when no answer from other station. + * How do we distinguish who asked for the + * termination of an existing link? + * + *--------------------------------------------------------------------*/ + +void server_link_terminated (int chan, int client, char *remote_call, char *own_call, int timeout) +{ + + struct { + struct agwpe_s hdr; + char info[100]; + } reply; + + + memset (&reply, 0, sizeof(reply)); + reply.hdr.portx = chan; + reply.hdr.datakind = 'd'; + strlcpy (reply.hdr.call_from, remote_call, sizeof(reply.hdr.call_from)); /* right order */ + strlcpy (reply.hdr.call_to, own_call, sizeof(reply.hdr.call_to)); + + if (timeout) { + snprintf (reply.info, sizeof(reply.info), "*** DISCONNECTED RETRYOUT With %s\r", remote_call); + } + else { + snprintf (reply.info, sizeof(reply.info), "*** DISCONNECTED From Station %s\r", remote_call); + } + reply.hdr.data_len_NETLE = host2netle(strlen(reply.info) + 1); + + send_to_client (client, &reply); + + +} /* end server_link_terminated */ + + +/*------------------------------------------------------------------- + * + * Name: server_rec_conn_data + * + * Purpose: Send received connected data to the application. + * + * DL-DATA Indication in the protocol spec. + * + * Inputs: chan - Which radio channel. + * + * client - Which one of potentially several clients. + * + * remote_call - Callsign[-ssid] of remote station. + * + * own_call - Callsign[-ssid] of my end. + * + * pid - Protocol ID from I frame. + * + * data_ptr - Pointer to a block of bytes. + * + * data_len - Number of bytes. Could be zero. + * + *--------------------------------------------------------------------*/ + +void server_rec_conn_data (int chan, int client, char *remote_call, char *own_call, int pid, char *data_ptr, int data_len) +{ + + struct { + struct agwpe_s hdr; + char info[AX25_MAX_INFO_LEN]; // I suppose there is potential for something larger. + // We'll cross that bridge if we ever come to it. + } reply; + + + memset (&reply.hdr, 0, sizeof(reply.hdr)); + reply.hdr.portx = chan; + reply.hdr.datakind = 'D'; + reply.hdr.pid = pid; + + strlcpy (reply.hdr.call_from, remote_call, sizeof(reply.hdr.call_from)); + strlcpy (reply.hdr.call_to, own_call, sizeof(reply.hdr.call_to)); + + if (data_len < 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Invalid length %d for connected data to client %d.\n", data_len, client); + data_len = 0; + } + else if (data_len > AX25_MAX_INFO_LEN) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Invalid length %d for connected data to client %d.\n", data_len, client); + data_len = AX25_MAX_INFO_LEN; + } + + memcpy (reply.info, data_ptr, data_len); + reply.hdr.data_len_NETLE = host2netle(data_len); + + send_to_client (client, &reply); + +} /* end server_rec_conn_data */ + + +/*------------------------------------------------------------------- + * + * Name: server_outstanding_frames_reply + * + * Purpose: Send 'Y' Outstanding frames for connected data to the application. + * + * Inputs: chan - Which radio channel. + * + * client - Which one of potentially several clients. + * + * own_call - Callsign[-ssid] of my end. + * + * remote_call - Callsign[-ssid] of remote station. + * + * count - Number of frames sent from the application but + * not yet received by the other station. + * + *--------------------------------------------------------------------*/ + +void server_outstanding_frames_reply (int chan, int client, char *own_call, char *remote_call, int count) +{ + + struct { + struct agwpe_s hdr; + int count_NETLE; + } reply; + + + memset (&reply.hdr, 0, sizeof(reply.hdr)); + + reply.hdr.portx = chan; + reply.hdr.datakind = 'Y'; + + strlcpy (reply.hdr.call_from, own_call, sizeof(reply.hdr.call_from)); + strlcpy (reply.hdr.call_to, remote_call, sizeof(reply.hdr.call_to)); + + reply.hdr.data_len_NETLE = host2netle(4); + reply.count_NETLE = host2netle(count); + + send_to_client (client, &reply); + +} /* end server_outstanding_frames_reply */ + + +/*------------------------------------------------------------------- + * + * Name: read_from_socket + * + * Purpose: Read from socket until we have desired number of bytes. + * + * Inputs: fd - file descriptor. + * ptr - address where data should be placed. + * len - desired number of bytes. + * + * Description: Just a wrapper for the "read" system call but it should + * never return fewer than the desired number of bytes. + * + *--------------------------------------------------------------------*/ + +static int read_from_socket (int fd, char *ptr, int len) +{ + int got_bytes = 0; + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("read_from_socket (%d, %p, %d)\n", fd, ptr, len); +#endif + while (got_bytes < len) { + int n; + + n = SOCK_RECV (fd, ptr + got_bytes, len - got_bytes); + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("read_from_socket: n = %d\n", n); +#endif + if (n <= 0) { + return (n); + } + + got_bytes += n; + } + assert (got_bytes >= 0 && got_bytes <= len); + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("read_from_socket: return %d\n", got_bytes); +#endif + return (got_bytes); +} + + +/*------------------------------------------------------------------- + * + * Name: cmd_listen_thread + * + * Purpose: Wait for command messages from an application. + * + * Inputs: arg - client number, 0 .. MAX_NET_CLIENTS-1 + * + * Outputs: client_sock[n] - File descriptor for communicating with client app. + * + * Description: Process messages from the client application. + * Note that the client can go away and come back again and + * re-establish communication without restarting this application. + * + *--------------------------------------------------------------------*/ + + +static void send_to_client (int client, void *reply_p) +{ + struct agwpe_s *ph; + int len; + int err; + + ph = (struct agwpe_s *) reply_p; // Replies are often hdr + other stuff. + + len = sizeof(struct agwpe_s) + netle2host(ph->data_len_NETLE); + + /* Not sure what max data length might be. */ + + if (netle2host(ph->data_len_NETLE) < 0 || netle2host(ph->data_len_NETLE) > 4096) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Invalid data length %d for AGW protocol message to client %d.\n", netle2host(ph->data_len_NETLE), client); + debug_print (TO_CLIENT, client, ph, len); + } + + if (debug_client) { + debug_print (TO_CLIENT, client, ph, len); + } + + err = SOCK_SEND (client_sock[client], (char*)(ph), len); + (void)err; +} + + +static THREAD_F cmd_listen_thread (void *arg) +{ + int n; + + struct { + struct agwpe_s hdr; /* Command header. */ + + char data[AX25_MAX_PACKET_LEN]; /* Additional data used by some commands. */ + /* Maximum for 'V': 1 + 8*10 + 256 */ + /* Maximum for 'D': Info part length + 1 */ + } cmd; + + int client = (int)(ptrdiff_t)arg; + + assert (client >= 0 && client < MAX_NET_CLIENTS); + + while (1) { + + while (client_sock[client] <= 0) { + SLEEP_SEC(1); /* Not connected. Try again later. */ + } + + n = read_from_socket (client_sock[client], (char *)(&cmd.hdr), sizeof(cmd.hdr)); + if (n != sizeof(cmd.hdr)) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("\nError getting message header from AGW client application %d.\n", client); + dw_printf ("Tried to read %d bytes but got only %d.\n", (int)sizeof(cmd.hdr), n); + dw_printf ("Closing connection.\n\n"); +#if __WIN32__ + closesocket (client_sock[client]); +#else + close (client_sock[client]); +#endif + client_sock[client] = -1; + dlq_client_cleanup (client); + continue; + } + +/* + * Take some precautions to guard against bad data which could cause problems later. + */ + if (cmd.hdr.portx < 0 || cmd.hdr.portx >= MAX_CHANS) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("\nInvalid port number, %d, in command '%c', from AGW client application %d.\n", + cmd.hdr.portx, cmd.hdr.datakind, client); + cmd.hdr.portx = 0; // avoid subscript out of bounds, try to keep going. + } + +/* + * Call to/from fields are 10 bytes but contents must not exceed 9 characters. + * It's not guaranteed that unused bytes will contain 0 so we + * don't issue error message in this case. + */ + cmd.hdr.call_from[sizeof(cmd.hdr.call_from)-1] = '\0'; + cmd.hdr.call_to[sizeof(cmd.hdr.call_to)-1] = '\0'; + +/* + * Following data must fit in available buffer. + * Leave room for an extra nul byte terminator at end later. + */ + + int data_len = netle2host(cmd.hdr.data_len_NETLE); + + if (data_len < 0 || data_len > (int)(sizeof(cmd.data) - 1)) { + + text_color_set(DW_COLOR_ERROR); + dw_printf ("\nInvalid message from AGW client application %d.\n", client); + dw_printf ("Data Length of %d is out of range.\n", data_len); + + /* This is a bad situation. */ + /* If we tried to read again, the header probably won't be there. */ + /* No point in trying to continue reading. */ + + dw_printf ("Closing connection.\n\n"); +#if __WIN32__ + closesocket (client_sock[client]); +#else + close (client_sock[client]); +#endif + client_sock[client] = -1; + dlq_client_cleanup (client); + return (0); + } + + cmd.data[0] = '\0'; + + if (data_len > 0) { + n = read_from_socket (client_sock[client], cmd.data, data_len); + if (n != data_len) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("\nError getting message data from AGW client application %d.\n", client); + dw_printf ("Tried to read %d bytes but got only %d.\n", data_len, n); + dw_printf ("Closing connection.\n\n"); +#if __WIN32__ + closesocket (client_sock[client]); +#else + close (client_sock[client]); +#endif + client_sock[client] = -1; + dlq_client_cleanup (client); + return (0); + } + if (n >= 0) { + cmd.data[n] = '\0'; // Tidy if we print for debug. + } + } + +/* + * print & process message from client. + */ + + if (debug_client) { + debug_print (FROM_CLIENT, client, &cmd.hdr, sizeof(cmd.hdr) + data_len); + } + + switch (cmd.hdr.datakind) { + + case 'R': /* Request for version number */ + { + struct { + struct agwpe_s hdr; + int major_version_NETLE; + int minor_version_NETLE; + } reply; + + + memset (&reply, 0, sizeof(reply)); + reply.hdr.datakind = 'R'; + reply.hdr.data_len_NETLE = host2netle(sizeof(reply.major_version_NETLE) + sizeof(reply.minor_version_NETLE)); + assert (netle2host(reply.hdr.data_len_NETLE) == 8); + + // Xastir only prints this and doesn't care otherwise. + // APRSIS32 doesn't seem to care. + // UI-View32 wants on 2000.15 or later. + + reply.major_version_NETLE = host2netle(2005); + reply.minor_version_NETLE = host2netle(127); + + assert (sizeof(reply) == 44); + + send_to_client (client, &reply); + + } + break; + + case 'G': /* Ask about radio ports */ + + { + struct { + struct agwpe_s hdr; + char info[200]; + } reply; + + + int j, count; + + + memset (&reply, 0, sizeof(reply)); + reply.hdr.datakind = 'G'; + + + // Xastir only prints this and doesn't care otherwise. + // YAAC uses this to identify available channels. + + // The interface manual wants the first to be "Port1" + // so channel 0 corresponds to "Port1." + // We can have gaps in the numbering. + // I wonder what applications will think about that. + + // No other place cares about total number. + + count = 0; + for (j=0; jchan_medium[j] == MEDIUM_RADIO || + save_audio_config_p->chan_medium[j] == MEDIUM_IGATE || + save_audio_config_p->chan_medium[j] == MEDIUM_NETTNC) { + count++; + } + } + snprintf (reply.info, sizeof(reply.info), "%d;", count); + + for (j=0; jchan_medium[j]) { + + case MEDIUM_RADIO: + { + char stemp[100]; + int a = ACHAN2ADEV(j); + // If I was really ambitious, some description could be provided. + static const char *names[8] = { "first", "second", "third", "fourth", "fifth", "sixth", "seventh", "eighth" }; + + if (save_audio_config_p->adev[a].num_channels == 1) { + snprintf (stemp, sizeof(stemp), "Port%d %s soundcard mono;", j+1, names[a]); + strlcat (reply.info, stemp, sizeof(reply.info)); + } + else { + snprintf (stemp, sizeof(stemp), "Port%d %s soundcard %s;", j+1, names[a], j&1 ? "right" : "left"); + strlcat (reply.info, stemp, sizeof(reply.info)); + } + } + break; + + case MEDIUM_IGATE: + { + char stemp[100]; + snprintf (stemp, sizeof(stemp), "Port%d Internet Gateway;", j+1); + strlcat (reply.info, stemp, sizeof(reply.info)); + } + break; + + case MEDIUM_NETTNC: + { + // could elaborate with hostname, etc. + char stemp[100]; + snprintf (stemp, sizeof(stemp), "Port%d Network TNC;", j+1); + strlcat (reply.info, stemp, sizeof(reply.info)); + } + break; + + default: + { + // could elaborate with hostname, etc. + char stemp[100]; + snprintf (stemp, sizeof(stemp), "Port%d INVALID CHANNEL;", j+1); + strlcat (reply.info, stemp, sizeof(reply.info)); + } + break; + + } // switch + } // for each channel + + reply.hdr.data_len_NETLE = host2netle(strlen(reply.info) + 1); + + send_to_client (client, &reply); + } + break; + + + case 'g': /* Ask about capabilities of a port. */ + + { + struct { + struct agwpe_s hdr; + unsigned char on_air_baud_rate; /* 0=1200, 1=2400, 2=4800, 3=9600, ... */ + unsigned char traffic_level; /* 0xff if not in autoupdate mode */ + unsigned char tx_delay; + unsigned char tx_tail; + unsigned char persist; + unsigned char slottime; + unsigned char maxframe; + unsigned char active_connections; + int how_many_bytes_NETLE; + } reply; + + + memset (&reply, 0, sizeof(reply)); + + reply.hdr.portx = cmd.hdr.portx; /* Reply with same port number ! */ + reply.hdr.datakind = 'g'; + reply.hdr.data_len_NETLE = host2netle(12); + + // YAAC asks for this. + // Fake it to keep application happy. + // TODO: Supply real values instead of just faking it. + + reply.on_air_baud_rate = 0; + reply.traffic_level = 1; + reply.tx_delay = 0x19; + reply.tx_tail = 4; + reply.persist = 0xc8; + reply.slottime = 4; + reply.maxframe = 7; + reply.active_connections = 0; + reply.how_many_bytes_NETLE = host2netle(1); + + assert (sizeof(reply) == 48); + + send_to_client (client, &reply); + + } + break; + + + case 'H': /* Ask about recently heard stations on given port. */ + + /* This should send back 20 'H' frames for the most recently heard stations. */ + /* If there are less available, empty frames are sent to make a total of 20. */ + /* Each contains the first and last heard times. */ + + { +#if 0 /* Currently, this information is not being collected. */ + struct { + struct agwpe_s hdr; + char info[100]; + } reply; + + + memset (&reply.hdr, 0, sizeof(reply.hdr)); + reply.hdr.datakind = 'H'; + + // TODO: Implement properly. + + reply.hdr.portx = cmd.hdr.portx + + strlcpy (reply.hdr.call_from, "WB2OSZ-15 Mon,01Jan2000 01:02:03 Tue,31Dec2099 23:45:56", sizeof(reply.hdr.call_from)); + // or 00:00:00 00:00:00 + + strlcpy (agwpe_msg.data, ..., sizeof(agwpe_msg.data)); + + reply.hdr.data_len_NETLE = host2netle(strlen(reply.info)); + + send_to_client (client, &reply); +#endif + } + break; + + + + + case 'k': /* Ask to start receiving RAW AX25 frames */ + + // Actually it is a toggle so we must be sure to clear it for a new connection. + + enable_send_raw_to_client[client] = ! enable_send_raw_to_client[client]; + break; + + case 'm': /* Ask to start receiving Monitor frames */ + + // Actually it is a toggle so we must be sure to clear it for a new connection. + + enable_send_monitor_to_client[client] = ! enable_send_monitor_to_client[client]; + break; + + + case 'V': /* Transmit UI data frame (with digipeater path) */ + { + // Data format is: + // 1 byte for number of digipeaters. + // 10 bytes for each digipeater. + // data part of message. + + char stemp[AX25_MAX_PACKET_LEN+2]; + char *p; + int ndigi; + int k; + + packet_t pp; + + strlcpy (stemp, cmd.hdr.call_from, sizeof(stemp)); + strlcat (stemp, ">", sizeof(stemp)); + strlcat (stemp, cmd.hdr.call_to, sizeof(stemp)); + + cmd.data[data_len] = '\0'; + ndigi = cmd.data[0]; + p = cmd.data + 1; + + for (k=0; k= 1 && + ax25_get_h(pp,AX25_REPEATER_1)) { + tq_append (cmd.hdr.portx, TQ_PRIO_0_HI, pp); + } + else { + tq_append (cmd.hdr.portx, TQ_PRIO_1_LO, pp); + } + } + } + + break; + + case 'P': /* Application Login */ + + // Silently ignore it. + break; + + case 'X': /* Register CallSign */ + + { + struct { + struct agwpe_s hdr; + char data; /* 1 = success, 0 = failure */ + } reply; + + int ok = 1; + + // The protocol spec says it is an error to register the same one more than once. + // Too much trouble. Report success if the channel is valid. + + + int chan = cmd.hdr.portx; + + // Connected mode can only be used with internal modems. + + if (chan >= 0 && chan < MAX_CHANS && save_audio_config_p->chan_medium[chan] == MEDIUM_RADIO) { + ok = 1; + dlq_register_callsign (cmd.hdr.call_from, chan, client); + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("AGW protocol error. Register callsign for invalid channel %d.\n", chan); + ok = 0; + } + + + memset (&reply, 0, sizeof(reply)); + reply.hdr.datakind = 'X'; + reply.hdr.portx = cmd.hdr.portx; + memcpy (reply.hdr.call_from, cmd.hdr.call_from, sizeof(reply.hdr.call_from)); + reply.hdr.data_len_NETLE = host2netle(1); + reply.data = ok; + send_to_client (client, &reply); + } + break; + + case 'x': /* Unregister CallSign */ + + { + + int chan = cmd.hdr.portx; + + // Connected mode can only be used with internal modems. + + if (chan >= 0 && chan < MAX_CHANS && save_audio_config_p->chan_medium[chan] == MEDIUM_RADIO) { + dlq_unregister_callsign (cmd.hdr.call_from, chan, client); + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("AGW protocol error. Unregister callsign for invalid channel %d.\n", chan); + } + } + /* No response is expected. */ + break; + + case 'C': /* Connect, Start an AX.25 Connection */ + case 'v': /* Connect VIA, Start an AX.25 circuit thru digipeaters */ + case 'c': /* Connection with non-standard PID */ + + { + struct via_info { + unsigned char num_digi; /* Expect to be in range 1 to 7. Why not up to 8? */ + char dcall[7][10]; + } +#if 1 + // October 2017. gcc ??? complained: + // warning: dereferencing pointer 'v' does break strict-aliasing rules + // Try adding this attribute to get rid of the warning. + // If this upsets your compiler, take it out. + // Let me know. Maybe we could put in a compiler version check here. + + __attribute__((__may_alias__)) +#endif + *v = (struct via_info *)cmd.data; + + char callsigns[AX25_MAX_ADDRS][AX25_MAX_ADDR_LEN]; + int num_calls = 2; /* 2 plus any digipeaters. */ + int pid = 0xf0; /* normal for AX.25 I frames. */ + int j; + + strlcpy (callsigns[AX25_SOURCE], cmd.hdr.call_from, sizeof(callsigns[AX25_SOURCE])); + strlcpy (callsigns[AX25_DESTINATION], cmd.hdr.call_to, sizeof(callsigns[AX25_DESTINATION])); + + if (cmd.hdr.datakind == 'c') { + pid = cmd.hdr.pid; /* non standard for NETROM, TCP/IP, etc. */ + } + + if (cmd.hdr.datakind == 'v') { + if (v->num_digi >= 1 && v->num_digi <= 7) { + + if (data_len != v->num_digi * 10 + 1 && data_len != v->num_digi * 10 + 2) { + // I'm getting 1 more than expected from AGWterminal. + text_color_set(DW_COLOR_ERROR); + dw_printf ("AGW client, connect via, has data len, %d when %d expected.\n", data_len, v->num_digi * 10 + 1); + } + + for (j = 0; j < v->num_digi; j++) { + strlcpy (callsigns[AX25_REPEATER_1 + j], v->dcall[j], sizeof(callsigns[AX25_REPEATER_1 + j])); + num_calls++; + } + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("\n"); + dw_printf ("AGW client, connect via, has invalid number of digipeaters = %d\n", v->num_digi); + } + } + + + dlq_connect_request (callsigns, num_calls, cmd.hdr.portx, client, pid); + + } + break; + + + case 'D': /* Send Connected Data */ + + { + char callsigns[AX25_MAX_ADDRS][AX25_MAX_ADDR_LEN]; + memset (callsigns, 0, sizeof(callsigns)); + const int num_calls = 2; // only first 2 used. Digipeater path + // must be remembered from connect request. + + strlcpy (callsigns[AX25_SOURCE], cmd.hdr.call_from, sizeof(callsigns[AX25_SOURCE])); + strlcpy (callsigns[AX25_DESTINATION], cmd.hdr.call_to, sizeof(callsigns[AX25_SOURCE])); + + dlq_xmit_data_request (callsigns, num_calls, cmd.hdr.portx, client, cmd.hdr.pid, cmd.data, netle2host(cmd.hdr.data_len_NETLE)); + + } + break; + + case 'd': /* Disconnect, Terminate an AX.25 Connection */ + + { + char callsigns[AX25_MAX_ADDRS][AX25_MAX_ADDR_LEN]; + memset (callsigns, 0, sizeof(callsigns)); + const int num_calls = 2; // only first 2 used. + + strlcpy (callsigns[AX25_SOURCE], cmd.hdr.call_from, sizeof(callsigns[AX25_SOURCE])); + strlcpy (callsigns[AX25_DESTINATION], cmd.hdr.call_to, sizeof(callsigns[AX25_SOURCE])); + + dlq_disconnect_request (callsigns, num_calls, cmd.hdr.portx, client); + + } + break; + + + case 'M': /* Send UNPROTO Information (no digipeater path) */ + + /* + Added in version 1.3. + This is the same as 'V' except there is no provision for digipeaters. + TODO: combine 'V' and 'M' into one case. + AGWterminal sends this for beacon or ask QRA. + + <<< Send UNPROTO Information from AGWPE client application 0, total length = 253 + portx = 0, datakind = 'M', pid = 0x00 + call_from = "WB2OSZ-15", call_to = "BEACON" + data_len = 217, user_reserved = 556, data = + 000: 54 68 69 73 20 76 65 72 73 69 6f 6e 20 75 73 65 This version use + ... + + <<< Send UNPROTO Information from AGWPE client application 0, total length = 37 + portx = 0, datakind = 'M', pid = 0x00 + call_from = "WB2OSZ-15", call_to = "QRA" + data_len = 1, user_reserved = 31759424, data = + 000: 0d . + . + + There is also a report of it coming from UISS. + + <<< Send UNPROTO Information from AGWPE client application 0, total length = 50 + portx = 0, port_hi_reserved = 0 + datakind = 77 = 'M', kind_hi = 0 + call_from = "JH4XSY", call_to = "APRS" + data_len = 14, user_reserved = 0, data = + 000: 21 22 3c 43 2e 74 71 6c 48 72 71 21 21 5f !"", sizeof(stemp)); + strlcat (stemp, cmd.hdr.call_to, sizeof(stemp)); + + cmd.data[data_len] = '\0'; + + strlcat (stemp, ":", sizeof(stemp)); + strlcat (stemp, cmd.data, sizeof(stemp)); + + //text_color_set(DW_COLOR_DEBUG); + //dw_printf ("Transmit '%s'\n", stemp); + + pp = ax25_from_text (stemp, 1); + + if (pp == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Failed to create frame from AGW 'M' message.\n"); + } + else { + tq_append (cmd.hdr.portx, TQ_PRIO_1_LO, pp); + } + } + break; + + + case 'y': /* Ask Outstanding frames waiting on a Port */ + + /* Number of frames sitting in transmit queue for specified channel. */ + { + struct { + struct agwpe_s hdr; + int data_NETLE; // Little endian order. + } reply; + + + memset (&reply, 0, sizeof(reply)); + reply.hdr.portx = cmd.hdr.portx; /* Reply with same port number */ + reply.hdr.datakind = 'y'; + reply.hdr.data_len_NETLE = host2netle(4); + + int n = 0; + if (cmd.hdr.portx >= 0 && cmd.hdr.portx < MAX_CHANS) { + // Count both normal and expedited in transmit queue for given channel. + n = tq_count (cmd.hdr.portx, -1, "", "", 0); + } + reply.data_NETLE = host2netle(n); + + send_to_client (client, &reply); + } + break; + + case 'Y': /* How Many Outstanding frames wait for tx for a particular station */ + + // This is different than the above 'y' because this refers to a specific + // link in connected mode. + + // This would be useful for a couple different purposes. + + // When sending bulk data, we want to keep a fair amount queued up to take + // advantage of large window sizes (MAXFRAME, EMAXFRAME). On the other + // hand we don't want to get TOO far ahead when transferring a large file. + + // Before disconnecting from another station, it would be good to know + // that it actually received the last message we sent. For this reason, + // I think it would be good for this to include information frames that were + // transmitted but not yet acknowledged. + // You could say that a particular frame is still waiting to be sent even + // if was already sent because it could be sent again if lost previously. + + // The documentation is inconsistent about the address order. + // One place says "callfrom" is my callsign and "callto" is the other guy. + // That would make sense. We are asking about frames going to the other guy. + + // But another place says it depends on who initiated the connection. + // + // "If we started the connection CallFrom=US and CallTo=THEM + // If the other end started the connection CallFrom=THEM and CallTo=US" + // + // The response description says nothing about the order; it just mentions two addresses. + // If you are writing a client or server application, the order would + // be clear but right here it could be either case. + // + // Another version of the documentation mentioned the source address being optional. + // + + // The only way to get this information is from inside the data link state machine. + // We will send a request to it and the result coming out will be used to + // send the reply back to the client application. + + { + + char callsigns[AX25_MAX_ADDRS][AX25_MAX_ADDR_LEN]; + memset (callsigns, 0, sizeof(callsigns)); + const int num_calls = 2; // only first 2 used. + + strlcpy (callsigns[AX25_SOURCE], cmd.hdr.call_from, sizeof(callsigns[AX25_SOURCE])); + strlcpy (callsigns[AX25_DESTINATION], cmd.hdr.call_to, sizeof(callsigns[AX25_SOURCE])); + + dlq_outstanding_frames_request (callsigns, num_calls, cmd.hdr.portx, client); + } + break; + + default: + + text_color_set(DW_COLOR_ERROR); + dw_printf ("--- Unexpected Command from application %d using AGW protocol:\n", client); + debug_print (FROM_CLIENT, client, &cmd.hdr, sizeof(cmd.hdr) + data_len); + + break; + } + } + +} /* end send_to_client */ + + +/* end server.c */ diff --git a/src/server.h b/src/server.h new file mode 100644 index 00000000..4cc2ea0a --- /dev/null +++ b/src/server.h @@ -0,0 +1,32 @@ + +/* + * Name: server.h + */ + + +#include "ax25_pad.h" /* for packet_t */ + +#include "config.h" + + +void server_set_debug (int n); + +void server_init (struct audio_s *audio_config_p, struct misc_config_s *misc_config); + +void server_send_rec_packet (int chan, packet_t pp, unsigned char *fbuf, int flen); + +void server_send_monitored (int chan, packet_t pp, int own_xmit); + +int server_callsign_registered_by_client (char *callsign); + + +void server_link_established (int chan, int client, char *remote_call, char *own_call, int incoming); + +void server_link_terminated (int chan, int client, char *remote_call, char *own_call, int timeout); + +void server_rec_conn_data (int chan, int client, char *remote_call, char *own_call, int pid, char *data_ptr, int data_len); + +void server_outstanding_frames_reply (int chan, int client, char *own_call, char *remote_call, int count); + + +/* end server.h */ diff --git a/symbols.c b/src/symbols.c similarity index 77% rename from symbols.c rename to src/symbols.c index c9a8c786..c9f07e6e 100644 --- a/symbols.c +++ b/src/symbols.c @@ -1,7 +1,7 @@ // // This file is part of Dire Wolf, an amateur radio packet TNC. // -// Copyright (C) 2011,2012,2013,2014 John Langner, WB2OSZ +// Copyright (C) 2011, 2012, 2013, 2014, 2015, 2022 John Langner, WB2OSZ // // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by @@ -26,17 +26,18 @@ * *------------------------------------------------------------------*/ +#include "direwolf.h" + #include #include #include #include #include + #include "textcolor.h" #include "symbols.h" +#include "tt_text.h" -//#if __WIN32__ - char *strcasestr(const char *S, const char *FIND); -//#endif /* * APRS symbol tables. @@ -192,9 +193,9 @@ static const struct { /* ; 27 */ { "NS", "Park/Picnic area" }, /* < 28 */ { "NT", "ADVISORY (one WX flag)" }, /* = 29 */ { "NU", "APRStt Touchtone (DTMF users)" }, - /* > 30 */ { "NV", "OVERLAYED CAR" }, + /* > 30 */ { "NV", "OVERLAID CAR" }, /* ? 31 */ { "NW", "INFO Kiosk (Blue box with ?)" }, - /* @ 32 */ { "NX", "HURICANE/Trop-Storm" }, + /* @ 32 */ { "NX", "HURRICANE/Trop-Storm" }, /* A 33 */ { "AA", "overlayBOX DTMF & RFID & XO" }, /* B 34 */ { "AB", "Blwng Snow (& future codes)" }, /* C 35 */ { "AC", "Coast Guard" }, @@ -204,7 +205,7 @@ static const struct { /* G 39 */ { "AG", "Snow Shwr (& future ovrlys)" }, /* H 40 */ { "AH", "Haze (& Overlay Hazards)" }, /* I 41 */ { "AI", "Rain Shower" }, - /* J 42 */ { "AJ", "Lightening (& future ovrlys)" }, + /* J 42 */ { "AJ", "Lightning (& future ovrlys)" }, /* K 43 */ { "AK", "Kenwood HT (W)" }, /* L 44 */ { "AL", "Lighthouse" }, /* M 45 */ { "AM", "MARS (A=Army,N=Navy,F=AF)" }, @@ -247,18 +248,40 @@ static const struct { /* r 82 */ { "SR", "Restrooms" }, /* s 83 */ { "SS", "OVERLAY SHIP/boat (top view)" }, /* t 84 */ { "ST", "Tornado" }, - /* u 85 */ { "SU", "OVERLAYED TRUCK" }, - /* v 86 */ { "SV", "OVERLAYED Van" }, + /* u 85 */ { "SU", "OVERLAID TRUCK" }, + /* v 86 */ { "SV", "OVERLAID Van" }, /* w 87 */ { "SW", "Flooding" }, /* x 88 */ { "SX", "Wreck or Obstruction ->X<-" }, /* y 89 */ { "SY", "Skywarn" }, - /* z 90 */ { "SZ", "OVERLAYED Shelter" }, + /* z 90 */ { "SZ", "OVERLAID Shelter" }, /* { 91 */ { "Q1", "Fog (& future ovrly codes)" }, /* | 92 */ { "Q2", "TNC Stream Switch" }, /* } 93 */ { "Q3", "" }, /* ~ 94 */ { "Q4", "TNC Stream Switch" } }; +// Make sure the array is null terminated. +// If search order is changed, do the same in decode_aprs.c for consistency. + +static const char *search_locations[] = { + (const char *) "symbols-new.txt", // CWD + (const char *) "data/symbols-new.txt", // Windows with Cmake + (const char *) "../data/symbols-new.txt", // ? +#ifndef __WIN32__ + (const char *) "/usr/local/share/direwolf/symbols-new.txt", + (const char *) "/usr/share/direwolf/symbols-new.txt", +#endif +#if __APPLE__ + // https://groups.yahoo.com/neo/groups/direwolf_packet/conversations/messages/2458 + // Adding the /opt/local tree since macports typically installs there. Users might want their + // INSTALLDIR (see Makefile.macosx) to mirror that. If so, then we need to search the /opt/local + // path as well. + (const char *) "/opt/local/share/direwolf/symbols-new.txt", +#endif + (const char *) NULL // Important - Indicates end of list. +}; + + /*------------------------------------------------------------------ * * Function: symbols_init @@ -275,7 +298,7 @@ static const struct { * Description: The primary and alternate symbol tables are constant * so they are hardcoded. * However the "new" sysmbols, which give new meanings to - * overlayed symbols, are always evolving. + * OVERLAID symbols, are always evolving. * For maximum flexibility, we will read the * data file at run time rather than compiling it in. * @@ -296,7 +319,7 @@ static const struct { typedef struct new_sym_s { char overlay; char symbol; - char description[NEW_SYM_DESC_LEN+1]; + char *description; } new_sym_t; static new_sym_t *new_sym_ptr = NULL; /* Dynamically allocated array. */ @@ -306,7 +329,7 @@ static int new_sym_len = 0; /* Number of elements used. */ void symbols_init (void) { - FILE *fp; + FILE *fp = NULL; /* * We only care about lines with this format: @@ -329,10 +352,22 @@ void symbols_init (void) char stuff[200]; int j; +// Feb. 2022 - Noticed that some lines have - rather than =. + +// LD = LIght Rail or Subway (new Aug 2014) +// SD = Seaport Depot (new Aug 2014) +// DIGIPEATERS +// /# - Generic digipeater +// 1# - WIDE1-1 digipeater + + #define GOOD_LINE(x) (strlen(x) > 6 && \ (x[COL1_OVERLAY] == '/' || x[COL1_OVERLAY] == '\\' || isupper(x[COL1_OVERLAY]) || isdigit(x[COL1_OVERLAY])) \ && x[COL2_SYMBOL] >= '!' && x[COL2_SYMBOL] <= '~' \ - && x[COL3_SP] == ' ' && x[COL4_EQUAL] == '=' && x[COL5_SP] == ' ' && x[COL6_DESC] != ' ') + && x[COL3_SP] == ' ' \ + && (x[COL4_EQUAL] == '=' || x[COL4_EQUAL] == '-') \ + && x[COL5_SP] == ' ' \ + && x[COL6_DESC] != ' ') if (new_sym_ptr != NULL) { return; /* was called already. */ @@ -340,18 +375,18 @@ void symbols_init (void) // If search strategy changes, be sure to keep decode_tocall in sync. + fp = NULL; + j = 0; + do { + if (search_locations[j] == NULL) break; + fp = fopen(search_locations[j++], "r"); + } while (fp == NULL); - fp = fopen("symbols-new.txt", "r"); -#ifndef __WIN32__ - if (fp == NULL) { - fp = fopen("/usr/share/direwolf/symbols-new.txt", "r"); - } -#endif if (fp == NULL) { text_color_set(DW_COLOR_ERROR); dw_printf ("Warning: Could not open 'symbols-new.txt'.\n"); - dw_printf ("The \"new\" overlayed character information will not be available.\n"); + dw_printf ("The \"new\" OVERLAID character information will not be available.\n"); new_sym_size = 1; new_sym_ptr = calloc(new_sym_size, sizeof(new_sym_t)); /* Don't try again. */ @@ -383,7 +418,7 @@ void symbols_init (void) } new_sym_ptr[new_sym_len].overlay = stuff[COL1_OVERLAY]; new_sym_ptr[new_sym_len].symbol = stuff[COL2_SYMBOL]; - strncpy(new_sym_ptr[new_sym_len].description, stuff+COL6_DESC, NEW_SYM_DESC_LEN); + new_sym_ptr[new_sym_len].description = strdup(stuff+COL6_DESC); new_sym_len++; } } @@ -401,6 +436,83 @@ void symbols_init (void) } /* end symbols_init */ +/*------------------------------------------------------------------ + * + * Function: symbols_list + * + * Purpose: Print a list of all the symbols. + * + * Inputs: none + * + *------------------------------------------------------------------*/ + +void symbols_list (void) +{ + int n; + + dw_printf ("\n"); + + dw_printf ("\tPRIMARY SYMBOL TABLE\n"); + dw_printf ("\n"); + dw_printf ("sym GPSxy GPSCnn APRStt Icon\n"); + dw_printf ("--- ----- ------ ------ ----\n"); + for (n = 1; n < SYMTAB_SIZE; n++) { + dw_printf (" /%c %s %02d AB1%02d %s\n", n + ' ', primary_symtab[n].xy, n, n, primary_symtab[n].description); + } + + dw_printf ("\n"); + dw_printf ("\tALTERNATE SYMBOL TABLE\n"); + dw_printf ("\n"); + dw_printf ("sym GPSxy GPSEnn APRStt Icon\n"); + dw_printf ("--- ----- ------ ------ ----\n"); + for (n = 1; n < SYMTAB_SIZE; n++) { + dw_printf (" \\%c %s %02d AB2%02d %s\n", n + ' ', alternate_symtab[n].xy, n, n, alternate_symtab[n].description); + } + + dw_printf ("\n"); + dw_printf ("\tNEW SYMBOLS from symbols-new.txt\n"); + dw_printf ("\n"); + dw_printf ("sym GPSxyz GPSxnn APRStt Icon\n"); + dw_printf ("--- ------ ------ ------ ----\n"); + + + for (n = 0; n < new_sym_len; n++) { + + int overlay = new_sym_ptr[n].overlay; + int symbol = new_sym_ptr[n].symbol; + char tones[12]; + + symbols_to_tones (overlay, symbol, tones, sizeof(tones)); + + if (overlay == '/') { + + dw_printf (" %c%c %s%c C%02d %-7s %s\n", overlay, symbol, + primary_symtab[symbol - ' '].xy, ' ', + symbol - ' ', tones, + new_sym_ptr[n].description); + } + else if (isupper(overlay) || isdigit(overlay)) { + + dw_printf (" %c%c %s%c %-7s %s\n", overlay, symbol, + alternate_symtab[symbol - ' '].xy, overlay, + tones, + new_sym_ptr[n].description); + } + else { + + dw_printf (" %c%c %s%c E%02d %-7s %s\n", overlay, symbol, + alternate_symtab[symbol - ' '].xy, ' ', + symbol - ' ', tones, + new_sym_ptr[n].description); + } + } + dw_printf ("\n"); + dw_printf ("More information here: http://www.aprs.org/symbols.html\n"); + +} /* end symbols_list */ + + + /*------------------------------------------------------------------ * * Function: symbols_from_dest_or_src @@ -437,7 +549,7 @@ void symbols_init (void) * *------------------------------------------------------------------*/ -const static char ssid_to_sym[16] = { +static const char ssid_to_sym[16] = { ' ', /* 0 - No icon. */ 'a', /* 1 - Ambulance */ 'U', /* 2 - Bus */ @@ -456,6 +568,7 @@ const static char ssid_to_sym[16] = { 'v' /* 15 - Van */ }; + void symbols_from_dest_or_src (char dti, char *src, char *dest, char *symtab, char *symbol) { char *p; @@ -559,18 +672,34 @@ void symbols_from_dest_or_src (char dti, char *src, char *dest, char *symtab, ch /* * When all else fails, use source SSID. + * This is totally non-obvious and confusing, but it is in the APRS protocol spec. + * Chapter 20, "Symbol in the Source Address SSID" */ - p = strchr (src, '-'); - if (p != NULL) - { - int ssid; +// January 2022 - Every time this shows up, it confuses people terribly. +// e.g. An APRS "message" shows up with Bus or Motorcycle in the description. - ssid = atoi(p+1); - if (ssid >= 1 && ssid <= 15) { - *symtab = '/'; /* All in Primary table. */ - *symbol = ssid_to_sym[ssid]; - return; +// The position and object formats all contain a proper symbol and table. +// There doesn't seem to be much reason to have a symbol for something without +// a position because it would not show up on a map. +// This just seems to be a remnant of something used long ago and no longer needed. +// The protocol spec mentions a "MIM tracker" but I can't find any references to it. + +// If this was completely removed, no one would probably ever notice. +// The only possible useful case I can think of would be someone sending a +// NMEA string directly from a GPS receiver and wanting to keep the destination field +// for the system type. + + if (dti == '$') { + + p = strchr (src, '-'); + if (p != NULL) { + int ssid = atoi(p+1); + if (ssid >= 1 && ssid <= 15) { + *symtab = '/'; /* All in Primary table. */ + *symbol = ssid_to_sym[ssid]; + return; + } } } @@ -602,19 +731,19 @@ int symbols_into_dest (char symtab, char symbol, char *dest) if (symbol >= '!' && symbol <= '~' && symtab == '/') { /* Primary Symbol table. */ - sprintf (dest, "GPSC%02d", symbol - ' '); + snprintf (dest, 7, "GPSC%02d", symbol - ' '); return (0); } else if (symbol >= '!' && symbol <= '~' && symtab == '\\') { /* Alternate Symbol table. */ - sprintf (dest, "GPSE%02d", symbol - ' '); + snprintf (dest, 7, "GPSE%02d", symbol - ' '); return (0); } else if (symbol >= '!' && symbol <= '~' && (isupper(symtab) || isdigit(symtab))) { /* Alternate Symbol table with overlay. */ - sprintf (dest, "GPS%s%c", alternate_symtab[symbol - ' '].xy, symtab); + snprintf (dest, 7, "GPS%s%c", alternate_symtab[symbol - ' '].xy, symtab); return (0); } @@ -623,7 +752,7 @@ int symbols_into_dest (char symtab, char symbol, char *dest) dw_printf ("Could not convert symbol \"%c%c\" to GPSxyz destination format.\n", symtab, symbol); - strcpy (dest, "GPS???"); /* Error. */ + strlcpy (dest, "GPS???", sizeof(dest)); /* Error. */ return (1); } @@ -637,16 +766,19 @@ int symbols_into_dest (char symtab, char symbol, char *dest) * Inputs: symtab /, \, 0-9, A-Z * symbol any printable character ! to ~ * + * desc_size Size of description provided by caller + * so we can avoid buffer overflow. + * * Outputs: description Text description. * "--no-symbol--" if error. * - * + * * Description: This is used for the monitoring and the * decode_aprs utility. * *------------------------------------------------------------------*/ -void symbols_get_description (char symtab, char symbol, char *description) +void symbols_get_description (char symtab, char symbol, char *description, size_t desc_size) { char tmp2[2]; int j; @@ -672,7 +804,7 @@ void symbols_get_description (char symtab, char symbol, char *description) /* We do the latter. */ symbol = ' '; - strcpy (description, primary_symtab[symbol-' '].description); + strlcpy (description, primary_symtab[symbol-' '].description, desc_size); return; } @@ -688,7 +820,7 @@ void symbols_get_description (char symtab, char symbol, char *description) for (j=0; j #include #include @@ -48,11 +59,6 @@ #include #include -#if __WIN32__ -char *strsep(char **stringp, const char *delim); -#endif - -#include "direwolf.h" #include "ax25_pad.h" // for packet_t, AX25_MAX_ADDR_LEN #include "decode_aprs.h" // for decode_aprs_t, G_UNKNOWN #include "textcolor.h" @@ -63,13 +69,13 @@ char *strsep(char **stringp, const char *delim); #define T_NUM_ANALOG 5 /* Number of analog channels. */ -#define T_NUM_DIGITAL 8 /* Number of digital channnels. */ +#define T_NUM_DIGITAL 8 /* Number of digital channels. */ #define T_STR_LEN 16 /* Max len for labels and units. */ -#define MAGIC1 0xa51111a5 /* For checking storage allocation problems. */ -#define MAGIC2 0xa52222a5 +#define MAGIC1 0x5a1111a5 /* For checking storage allocation problems. */ +#define MAGIC2 0x5a2222a5 #define C_A 0 /* Scaling coefficient positions. */ #define C_B 1 @@ -108,7 +114,7 @@ struct t_metadata_s { static struct t_metadata_s * md_list_head = NULL; -static void t_data_process (struct t_metadata_s *pm, int seq, float araw[T_NUM_ANALOG], int ndp[T_NUM_ANALOG], int draw[T_NUM_DIGITAL], char *output); +static void t_data_process (struct t_metadata_s *pm, int seq, float araw[T_NUM_ANALOG], int ndp[T_NUM_ANALOG], int draw[T_NUM_DIGITAL], char *output, size_t outputsize); /*------------------------------------------------------------------- @@ -120,14 +126,14 @@ static void t_data_process (struct t_metadata_s *pm, int seq, float araw[T_NUM_A * * Inputs: station - Station name with optional SSID. * - * REturns: Pointer to metadata. + * Returns: Pointer to metadata. * *--------------------------------------------------------------------*/ static struct t_metadata_s * t_get_metadata (char *station) { struct t_metadata_s *p; - int n, j; + int n; #if DEBUG3 text_color_set(DW_COLOR_DEBUG); @@ -136,6 +142,11 @@ static struct t_metadata_s * t_get_metadata (char *station) for (p = md_list_head; p != NULL; p = p->pnext) { if (strcmp(station, p->station) == 0) { + + if (p->magic1 != MAGIC1 || p->magic2 != MAGIC2) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Internal error: REPORT THIS! Bad magic values %s %d\n", __func__, __LINE__); + } return (p); } } @@ -144,13 +155,14 @@ static struct t_metadata_s * t_get_metadata (char *station) memset (p, 0, sizeof (struct t_metadata_s)); p->magic1 = MAGIC1; - strncpy (p->station, station, sizeof(p->station)-1); + + strlcpy (p->station, station, sizeof(p->station)); for (n = 0; n < T_NUM_ANALOG; n++) { - sprintf (p->name[n], "A%d", n+1); + snprintf (p->name[n], sizeof(p->name[n]), "A%d", n+1); } for (n = 0; n < T_NUM_DIGITAL; n++) { - sprintf (p->name[T_NUM_ANALOG+n], "D%d", n+1); + snprintf (p->name[T_NUM_ANALOG+n], sizeof(p->name[T_NUM_ANALOG+n]), "D%d", n+1); } for (n = 0; n < T_NUM_ANALOG; n++) { @@ -220,8 +232,10 @@ static int t_ndp (char *str) * * Inputs: station - Name of station reporting telemetry. * info - Pointer to packet Information field. + * quiet - suppress error messages. * * Outputs: output - Decoded telemetry in human readable format. + * TODO: How big does it need to be? (buffer overflow?) * comment - Any comment after the data. * * Description: The first character, after the "T" data type indicator, must be "#" @@ -239,11 +253,14 @@ static int t_ndp (char *str) * KB1GKN-10>APRX27,UNCAN,WIDE1*:T#491,4.9,0.3,25.0,0.0,1.0,00000000 * * Not integers. Not fixed width fields. - * We will accept these but issue a warning that others might not. + * + * Originally I printed a warning if values were not in range of 000 to 255 + * but later took it out because no one pays attention to that original + * restriction anymore. * *--------------------------------------------------------------------*/ -void telemetry_data_original (char *station, char *info, char *output, char *comment) +void telemetry_data_original (char *station, char *info, int quiet, char *output, size_t outputsize, char *comment, size_t commentsize) { int n; int seq; @@ -264,7 +281,16 @@ void telemetry_data_original (char *station, char *info, char *output, char *com dw_printf ("\n%s\n\n", info); #endif + strlcpy (output, "", outputsize); + strlcpy (comment, "", commentsize); + pm = t_get_metadata(station); + + if (pm->magic1 != MAGIC1 || pm->magic2 != MAGIC2) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Internal error: REPORT THIS! Bad magic values %s %d\n", __func__, __LINE__); + } + seq = 0; for (n = 0; n < T_NUM_ANALOG; n++) { araw[n] = G_UNKNOWN; @@ -275,20 +301,35 @@ void telemetry_data_original (char *station, char *info, char *output, char *com } if (strncmp(info, "T#", 2) != 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf("Error: Information part of telemetry packet must begin with \"#\"\n"); + if ( ! quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Error: Information part of telemetry packet must begin with \"T#\"\n"); + } return; } /* - * Make a copy of the input string because this will alter it. + * Make a copy of the input string (excluding T#) because this will alter it. + * Remove any trailing CR/LF. */ - strncpy (stemp, info+2, sizeof(stemp)); - stemp[sizeof(stemp)-1] = '\0'; + strlcpy (stemp, info+2, sizeof(stemp)); + + for (p = stemp + strlen(stemp) - 1; p >= stemp && (*p == '\r' || *p == '\n') ; p--) { + *p = '\0'; + } next = stemp; p = strsep(&next,","); + + if (p == NULL) { + if ( ! quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Nothing after \"T#\" for telemetry data.\n"); + } + return; + } + seq = atoi(p); n = 0; while ((p = strsep(&next,",")) != NULL) { @@ -297,11 +338,16 @@ void telemetry_data_original (char *station, char *info, char *output, char *com araw[n] = atof(p); ndp[n] = t_ndp(p); } - if (strlen(p) != 3 || araw[n] < 0 || araw[n] > 255 || araw[n] != (int)(araw[n])) { - text_color_set(DW_COLOR_ERROR); - dw_printf("Telemetry analog values should be 3 digit integer values in range of 000 to 255.\n"); - dw_printf("Some applications might not interpret \"%s\" properly.\n", p); - } + // Version 1.3: Suppress this message. + // No one pays attention to the original 000 to 255 range. + // BTW, this doesn't trap values like 0.0 or 1.0 + //if (strlen(p) != 3 || araw[n] < 0 || araw[n] > 255 || araw[n] != (int)(araw[n])) { + // if ( ! quiet) { + // text_color_set(DW_COLOR_ERROR); + // dw_printf("Telemetry analog values should be 3 digit integer values in range of 000 to 255.\n"); + // dw_printf("Some applications might not interpret \"%s\" properly.\n", p); + // } + //} n++; } @@ -312,14 +358,18 @@ void telemetry_data_original (char *station, char *info, char *output, char *com int k; if (strlen(next) < 8) { - text_color_set(DW_COLOR_ERROR); - dw_printf("Expected to find 8 binary digits after \"%s\" for the digital values.\n", p); + if ( ! quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Expected to find 8 binary digits after \"%s\" for the digital values.\n", p); + } } + + // TODO: test this! if (strlen(next) > 8) { - strcpy (comment, next+8); + strlcpy (comment, next+8, commentsize); next[8] = '\0'; } - for (k = 0; k < strlen(next); k++) { + for (k = 0; k < (int)(strlen(next)); k++) { if (next[k] == '0') { draw[k] = 0; } @@ -327,16 +377,20 @@ void telemetry_data_original (char *station, char *info, char *output, char *com draw[k] = 1; } else { - text_color_set(DW_COLOR_ERROR); - dw_printf("Found \"%c\" when expecting 0 or 1 for digital value %d.\n", next[k], k+1); + if ( ! quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Found \"%c\" when expecting 0 or 1 for digital value %d.\n", next[k], k+1); + } } } n++; } } if (n < T_NUM_ANALOG+1) { - text_color_set(DW_COLOR_ERROR); - dw_printf("Found fewer than expected number of telemetry data values.\n"); + if ( ! quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Found fewer than expected number of telemetry data values.\n"); + } } /* @@ -354,7 +408,7 @@ void telemetry_data_original (char *station, char *info, char *output, char *com #endif - t_data_process (pm, seq, araw, ndp, draw, output); + t_data_process (pm, seq, araw, ndp, draw, output, outputsize); } /* end telemtry_data_original */ @@ -373,7 +427,7 @@ void telemetry_data_original (char *station, char *info, char *output, char *com * Description: We are expecting from 2 to 7 pairs of base 91 digits. * The first pair is the sequence number. * Next we have 1 to 5 analog values. - * If digital values are present, all 5 analog values must be present. + * If digital values are present, all 5 analog values must be present. * *--------------------------------------------------------------------*/ @@ -396,6 +450,7 @@ static int two_base91_to_i (char *c) else { text_color_set(DW_COLOR_DEBUG); dw_printf ("\"%c\" is not a valid character for base 91 telemetry data.\n", c[0]); + return (G_UNKNOWN); } if (isdigit91(c[1])) { @@ -404,11 +459,12 @@ static int two_base91_to_i (char *c) else { text_color_set(DW_COLOR_DEBUG); dw_printf ("\"%c\" is not a valid character for base 91 telemetry data.\n", c[1]); + return (G_UNKNOWN); } return (result); } -void telemetry_data_base91 (char *station, char *cdata, char *output) +void telemetry_data_base91 (char *station, char *cdata, char *output, size_t outputsize) { int n; int seq; @@ -425,8 +481,15 @@ void telemetry_data_base91 (char *station, char *cdata, char *output) dw_printf ("\n%s\n\n", cdata); #endif + strlcpy (output, "", outputsize); + pm = t_get_metadata(station); + if (pm->magic1 != MAGIC1 || pm->magic2 != MAGIC2) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Internal error: REPORT THIS! Bad magic values %s %d\n", __func__, __LINE__); + } + seq = 0; for (n = 0; n < T_NUM_ANALOG; n++) { araw[n] = G_UNKNOWN; @@ -473,7 +536,7 @@ void telemetry_data_base91 (char *station, char *cdata, char *output) #endif - t_data_process (pm, seq, araw, ndp, draw, output); + t_data_process (pm, seq, araw, ndp, draw, output, outputsize); } /* end telemtry_data_base91 */ @@ -493,7 +556,7 @@ void telemetry_data_base91 (char *station, char *cdata, char *output) * Outputs: Stored for future use when data values are received. * * Description: The first 5 characters of the message are "PARM." and the - * rest is a variable length list of comma separated names. + * rest is a variable length list of comma separated names. * * The original spec has different maximum lengths for different * fields which we will ignore. @@ -520,20 +583,29 @@ void telemetry_name_message (char *station, char *msg) /* * Make a copy of the input string because this will alter it. + * Remove any trailing CR LF. */ - strncpy (stemp, msg, sizeof(stemp)); - stemp[sizeof(stemp)-1] = '\0'; + strlcpy (stemp, msg, sizeof(stemp)); + + for (p = stemp + strlen(stemp) - 1; p >= stemp && (*p == '\r' || *p == '\n') ; p--) { + *p = '\0'; + } pm = t_get_metadata(station); + if (pm->magic1 != MAGIC1 || pm->magic2 != MAGIC2) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Internal error: REPORT THIS! Bad magic values %s %d\n", __func__, __LINE__); + } + next = stemp; n = 0; while ((p = strsep(&next,",")) != NULL) { if (n < T_NUM_ANALOG + T_NUM_DIGITAL) { if (strlen(p) > 0 && strcmp(p,"-") != 0) { - strncpy (pm->name[n], p, T_STR_LEN-1); + strlcpy (pm->name[n], p, sizeof(pm->name[n])); } n++; } @@ -566,7 +638,7 @@ void telemetry_name_message (char *station, char *msg) * Outputs: Stored for future use when data values are received. * * Description: The first 5 characters of the message are "UNIT." and the - * rest is a variable length list of comma separated units/labels. + * rest is a variable length list of comma separated units/labels. * * The original spec has different maximum lengths for different * fields which we will ignore. @@ -590,20 +662,29 @@ void telemetry_unit_label_message (char *station, char *msg) /* * Make a copy of the input string because this will alter it. + * Remove any trailing CR LF. */ + + strlcpy (stemp, msg, sizeof(stemp)); - strncpy (stemp, msg, sizeof(stemp)); - stemp[sizeof(stemp)-1] = '\0'; + for (p = stemp + strlen(stemp) - 1; p >= stemp && (*p == '\r' || *p == '\n') ; p--) { + *p = '\0'; + } pm = t_get_metadata(station); + if (pm->magic1 != MAGIC1 || pm->magic2 != MAGIC2) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Internal error: REPORT THIS! Bad magic values %s %d\n", __func__, __LINE__); + } + next = stemp; n = 0; while ((p = strsep(&next,",")) != NULL) { if (n < T_NUM_ANALOG + T_NUM_DIGITAL) { if (strlen(p) > 0) { - strncpy (pm->unit[n], p, T_STR_LEN-1); + strlcpy (pm->unit[n], p, sizeof(pm->unit[n])); } n++; } @@ -626,24 +707,25 @@ void telemetry_unit_label_message (char *station, char *msg) * * Name: telemetry_coefficents_message * - * Purpose: Interpret message with scaling coefficents for analog channels. + * Purpose: Interpret message with scaling coefficients for analog channels. * * Inputs: station - Name of station reporting telemetry. * In this case it is the destination for the message, * not the sender. * msg - Rest of message after "EQNS." + * quiet - suppress error messages. * * Outputs: Stored for future use when data values are received. * * Description: The first 5 characters of the message are "EQNS." and the - * rest is a comma separated list of 15 floating point values. + * rest is a comma separated list of 15 floating point values. * * The spec appears to require all 15 so we will issue an * error if fewer found. * *--------------------------------------------------------------------*/ -void telemetry_coefficents_message (char *station, char *msg) +void telemetry_coefficents_message (char *station, char *msg, int quiet) { int n; char stemp[256]; @@ -660,13 +742,22 @@ void telemetry_coefficents_message (char *station, char *msg) /* * Make a copy of the input string because this will alter it. + * Remove any trailing CR LF. */ - strncpy (stemp, msg, sizeof(stemp)); - stemp[sizeof(stemp)-1] = '\0'; + strlcpy (stemp, msg, sizeof(stemp)); + + for (p = stemp + strlen(stemp) - 1; p >= stemp && (*p == '\r' || *p == '\n') ; p--) { + *p = '\0'; + } pm = t_get_metadata(station); + if (pm->magic1 != MAGIC1 || pm->magic2 != MAGIC2) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Internal error: REPORT THIS! Bad magic values %s %d\n", __func__, __LINE__); + } + next = stemp; n = 0; @@ -678,18 +769,22 @@ void telemetry_coefficents_message (char *station, char *msg) pm->coeff_ndp[n/3][n%3] = t_ndp (p); } else { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Equation coefficent position A%d%c is empty.\n", n/3+1, n%3+'a'); - dw_printf ("Some applications might not handle this correctly.\n"); + if ( ! quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Equation coefficient position A%d%c is empty.\n", n/3+1, n%3+'a'); + dw_printf ("Some applications might not handle this correctly.\n"); + } } } n++; } if (n != T_NUM_ANALOG * 3) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Found %d equation coefficents when 15 were expected.\n", n); - dw_printf ("Some applications might not handle this correctly.\n"); + if ( ! quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Found %d equation coefficients when 15 were expected.\n", n); + dw_printf ("Some applications might not handle this correctly.\n"); + } } #if DEBUG3 @@ -712,12 +807,13 @@ void telemetry_coefficents_message (char *station, char *msg) * * Name: telemetry_bit_sense_message * - * Purpose: Interpret message with scaling coefficents for analog channels. + * Purpose: Interpret message with scaling coefficients for analog channels. * * Inputs: station - Name of station reporting telemetry. * In this case it is the destination for the message, * not the sender. * msg - Rest of message after "BITS." + * quiet - suppress error messages. * * Outputs: Stored for future use when data values are received. * @@ -727,7 +823,7 @@ void telemetry_coefficents_message (char *station, char *msg) * *--------------------------------------------------------------------*/ -void telemetry_bit_sense_message (char *station, char *msg) +void telemetry_bit_sense_message (char *station, char *msg, int quiet) { int n; struct t_metadata_s *pm; @@ -740,12 +836,19 @@ void telemetry_bit_sense_message (char *station, char *msg) pm = t_get_metadata(station); - if (strlen(msg) < 8) { + if (pm->magic1 != MAGIC1 || pm->magic2 != MAGIC2) { text_color_set(DW_COLOR_ERROR); - dw_printf ("The telemetry bit sense message should have at least 8 characters.\n"); + dw_printf("Internal error: REPORT THIS! Bad magic values %s %d\n", __func__, __LINE__); + } + + if (strlen(msg) < 8) { + if ( ! quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("The telemetry bit sense message should have at least 8 characters.\n"); + } } - for (n = 0; n < T_NUM_DIGITAL && n < strlen(msg); n++) { + for (n = 0; n < T_NUM_DIGITAL && n < (int)(strlen(msg)); n++) { if (msg[n] == '1') { pm->sense[n] = 1; @@ -754,16 +857,27 @@ void telemetry_bit_sense_message (char *station, char *msg) pm->sense[n] = 0; } else { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Bit position %d sense value was \"%c\" when 0 or 1 was expected.\n", n+1, msg[n]); + if ( ! quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Bit position %d sense value was \"%c\" when 0 or 1 was expected.\n", n+1, msg[n]); + } } } -/* Skip comma if first character of comment field. */ +/* + * Skip comma if first character of comment field. + * + * The protocol spec is inconsistent here. + * The definition shows the Project Title immediately after a fixed width field of 8 binary digits. + * The example has a comma in there. + * + * The toolkit telem-bits.pl script does insert the comma because it seems more sensible. + * Here we accept it either way. i.e. Discard first character after data values if it is comma. + */ if (msg[n] == ',') n++; - strncpy (pm->project, msg+n, sizeof(pm->project)-1); + strlcpy (pm->project, msg+n, sizeof(pm->project)); #if DEBUG3 text_color_set(DW_COLOR_DEBUG); @@ -796,55 +910,60 @@ void telemetry_bit_sense_message (char *station, char *msg) * seq - Sequence number. * araw - 5 analog raw values. * ndp - Number of decimal points for each. - * draw - 8 digial raw vales. + * draw - 8 digital raw vales. * * Outputs: output - Decoded telemetry in human readable format. * * Description: Process raw data according to any metadata available - * and put into human readable form. + * and put into human readable form. * *--------------------------------------------------------------------*/ -static void fval_to_str (float x, int ndp, char *str) +#define VAL_STR_SIZE 64 + +static void fval_to_str (float x, int ndp, char str[VAL_STR_SIZE]) { if (x == G_UNKNOWN) { - strcpy (str, "?"); + strlcpy (str, "?", VAL_STR_SIZE); } else { - sprintf (str, "%.*f", ndp, x); + snprintf (str, VAL_STR_SIZE, "%.*f", ndp, x); } } -static void ival_to_str (int x, char *str) +static void ival_to_str (int x, char str[VAL_STR_SIZE]) { if (x == G_UNKNOWN) { - strcpy (str, "?"); + strlcpy (str, "?", VAL_STR_SIZE); } else { - sprintf (str, "%d", x); + snprintf (str, VAL_STR_SIZE, "%d", x); } } -static void t_data_process (struct t_metadata_s *pm, int seq, float araw[T_NUM_ANALOG], int ndp[T_NUM_ANALOG], int draw[T_NUM_DIGITAL], char *output) +static void t_data_process (struct t_metadata_s *pm, int seq, float araw[T_NUM_ANALOG], int ndp[T_NUM_ANALOG], int draw[T_NUM_DIGITAL], char *output, size_t outputsize) { int n; - char stemp[50]; + char val_str[VAL_STR_SIZE]; assert (pm != NULL); - assert (pm->magic1 == MAGIC1); - assert (pm->magic2 == MAGIC2); - strcpy (output, ""); + if (pm->magic1 != MAGIC1 || pm->magic2 != MAGIC2) { + text_color_set(DW_COLOR_ERROR); + dw_printf("Internal error: REPORT THIS! Bad magic values %s %d\n", __func__, __LINE__); + } + + strlcpy (output, "", outputsize); if (strlen(pm->project) > 0) { - strcpy (output, pm->project); - strcat (output, ": "); + strlcpy (output, pm->project, outputsize); + strlcat (output, ": ", outputsize); } - ival_to_str (seq, stemp); - strcat (output, "Seq="); - strcat (output, stemp); + ival_to_str (seq, val_str); + strlcat (output, "Seq=", outputsize); + strlcat (output, val_str, outputsize); for (n = 0; n < T_NUM_ANALOG; n++) { @@ -854,10 +973,10 @@ static void t_data_process (struct t_metadata_s *pm, int seq, float araw[T_NUM_A float fval; int fndp; - strcat (output, ", "); + strlcat (output, ", ", outputsize); - strcat (output, pm->name[n]); - strcat (output, "="); + strlcat (output, pm->name[n], outputsize); + strlcat (output, "=", outputsize); // Scaling and suitable number of decimal places for display. @@ -875,11 +994,11 @@ static void t_data_process (struct t_metadata_s *pm, int seq, float araw[T_NUM_A z = pm->coeff_ndp[n][C_A] == 0 ? 0 : pm->coeff_ndp[n][C_A] + ndp[n] + ndp[n]; fndp = MAX (z, MAX(pm->coeff_ndp[n][C_B] + ndp[n], pm->coeff_ndp[n][C_C])); } - fval_to_str (fval, fndp, stemp); - strcat (output, stemp); + fval_to_str (fval, fndp, val_str); + strlcat (output, val_str, outputsize); if (strlen(pm->unit[n]) > 0) { - strcat (output, " "); - strcat (output, pm->unit[n]); + strlcat (output, " ", outputsize); + strlcat (output, pm->unit[n], outputsize); } } @@ -892,10 +1011,10 @@ static void t_data_process (struct t_metadata_s *pm, int seq, float araw[T_NUM_A if (draw[n] != G_UNKNOWN) { int dval; - strcat (output, ", "); + strlcat (output, ", ", outputsize); - strcat (output, pm->name[T_NUM_ANALOG+n]); - strcat (output, "="); + strlcat (output, pm->name[T_NUM_ANALOG+n], outputsize); + strlcat (output, "=", outputsize); // Possible inverting for bit sense. @@ -906,13 +1025,13 @@ static void t_data_process (struct t_metadata_s *pm, int seq, float araw[T_NUM_A dval = draw[n] ^ ! pm->sense[n]; } - ival_to_str (dval , stemp); + ival_to_str (dval, val_str); if (strlen(pm->unit[T_NUM_ANALOG+n]) > 0) { - strcat (output, " "); - strcat (output, pm->unit[T_NUM_ANALOG+n]); + strlcat (output, " ", outputsize); + strlcat (output, pm->unit[T_NUM_ANALOG+n], outputsize); } - strcat (output, stemp); + strlcat (output, val_str, outputsize); } } @@ -927,94 +1046,343 @@ static void t_data_process (struct t_metadata_s *pm, int seq, float araw[T_NUM_A } /* end t_data_process */ +/*------------------------------------------------------------------- + * + * Unit test. Run with: + * + * make etest + * + * + *--------------------------------------------------------------------*/ + + #if TEST + int main ( ) { - char result[256]; - char comment[256]; + char result[120]; + char comment[40]; + int errors = 0; - strcpy (result, ""); - strcpy (comment, ""); + strlcpy (result, "", sizeof(result)); + strlcpy (comment, "", sizeof(comment)); + text_color_set(DW_COLOR_INFO); + dw_printf ("Unit test for telemetry decoding functions...\n"); + #if DEBUG1 + text_color_set(DW_COLOR_INFO); + dw_printf ("part 1\n"); + // From protocol spec. - telemetry_data_original ("WB2OSZ", "T#005,199,000,255,073,123,01101001", result, comment); + telemetry_data_original ("WB2OSZ", "T#005,199,000,255,073,123,01101001", 0, result, sizeof(result), comment, sizeof(comment)); + + if (strcmp(result, "Seq=5, A1=199, A2=0, A3=255, A4=73, A5=123, D1=0, D2=1, D3=1, D4=0, D5=1, D6=0, D7=0, D8=1") != 0 || + strcmp(comment, "") != 0) { + errors++; text_color_set(DW_COLOR_ERROR); dw_printf ("Wrong result, test 101\n"); + } // Try adding a comment. - telemetry_data_original ("WB2OSZ", "T#005,199,000,255,073,123,01101001Comment,with,commas", result, comment); - strcpy (comment, ""); + telemetry_data_original ("WB2OSZ", "T#005,199,000,255,073,123,01101001Comment,with,commas", 0, result, sizeof(result), comment, sizeof(comment)); + + if (strcmp(result, "Seq=5, A1=199, A2=0, A3=255, A4=73, A5=123, D1=0, D2=1, D3=1, D4=0, D5=1, D6=0, D7=0, D8=1") != 0 || + strcmp(comment, "Comment,with,commas") != 0) { + errors++; text_color_set(DW_COLOR_ERROR); dw_printf ("Wrong result, test 102\n"); + } + + + // Error handling - Try shortening or omitting parts. + + telemetry_data_original ("WB2OSZ", "T005,199,000,255,073,123,0110", 0, result, sizeof(result), comment, sizeof(comment)); + + if (strcmp(result, "") != 0 || + strcmp(comment, "") != 0) { + errors++; text_color_set(DW_COLOR_ERROR); dw_printf ("Wrong result, test 103\n"); + } + + telemetry_data_original ("WB2OSZ", "T#005,199,000,255,073,123,0110", 0, result, sizeof(result), comment, sizeof(comment)); + + if (strcmp(result, "Seq=5, A1=199, A2=0, A3=255, A4=73, A5=123, D1=0, D2=1, D3=1, D4=0") != 0 || + strcmp(comment, "") != 0) { + errors++; text_color_set(DW_COLOR_ERROR); dw_printf ("Wrong result, test 104\n"); + } + + telemetry_data_original ("WB2OSZ", "T#005,199,000,255,073,123", 0, result, sizeof(result), comment, sizeof(comment)); + + if (strcmp(result, "Seq=5, A1=199, A2=0, A3=255, A4=73, A5=123") != 0 || + strcmp(comment, "") != 0) { + errors++; text_color_set(DW_COLOR_ERROR); dw_printf ("Wrong result, test 105\n"); + } - // Try shortening or omitting parts. + telemetry_data_original ("WB2OSZ", "T#005,199,000,255,,123,01101001", 0, result, sizeof(result), comment, sizeof(comment)); + + if (strcmp(result, "Seq=5, A1=199, A2=0, A3=255, A5=123, D1=0, D2=1, D3=1, D4=0, D5=1, D6=0, D7=0, D8=1") != 0 || + strcmp(comment, "") != 0) { + errors++; text_color_set(DW_COLOR_ERROR); dw_printf ("Wrong result, test 106\n"); + } + + telemetry_data_original ("WB2OSZ", "T#005,199,000,255,073,123,01101009", 0, result, sizeof(result), comment, sizeof(comment)); + + if (strcmp(result, "Seq=5, A1=199, A2=0, A3=255, A4=73, A5=123, D1=0, D2=1, D3=1, D4=0, D5=1, D6=0, D7=0") != 0 || + strcmp(comment, "") != 0) { + errors++; text_color_set(DW_COLOR_ERROR); dw_printf ("Wrong result, test 107\n"); + } - telemetry_data_original ("WB2OSZ", "T005,199,000,255,073,123,0110", result, comment); - telemetry_data_original ("WB2OSZ", "T#005,199,000,255,073,123,0110", result, comment); - telemetry_data_original ("WB2OSZ", "T#005,199,000,255,073,123", result, comment); - telemetry_data_original ("WB2OSZ", "T#005,199,000,255,,123,01101001", result, comment); - telemetry_data_original ("WB2OSZ", "T#005,199,000,255,073,123,01101009", result, comment); // Local observation. - telemetry_data_original ("WB2OSZ", "T#491,4.9,0.3,25.0,0.0,1.0,00000000", result, comment); + telemetry_data_original ("WB2OSZ", "T#491,4.9,0.3,25.0,0.0,1.0,00000000", 0, result, sizeof(result), comment, sizeof(comment)); + + if (strcmp(result, "Seq=491, A1=4.9, A2=0.3, A3=25.0, A4=0.0, A5=1.0, D1=0, D2=0, D3=0, D4=0, D5=0, D6=0, D7=0, D8=0") != 0 || + strcmp(comment, "") != 0) { + errors++; text_color_set(DW_COLOR_ERROR); dw_printf ("Wrong result, test 108\n"); + } #endif #if DEBUG2 + text_color_set(DW_COLOR_INFO); + dw_printf ("part 2\n"); + // From protocol spec. - telemetry_data_base91 ("WB2OSZ", "ss11", result); - dw_printf ("expect 7544: 1472 above.\n"); + telemetry_data_base91 ("WB2OSZ", "ss11", result, sizeof(result)); - telemetry_data_base91 ("WB2OSZ", "ss11223344{{!\"", result); - dw_printf ("expect 7544: 1472, 1564, 1656, 1748, 8280, 10000000 above.\n"); + if (strcmp(result, "Seq=7544, A1=1472") != 0) { + errors++; text_color_set(DW_COLOR_ERROR); dw_printf ("Wrong result, test 201\n"); + } + + telemetry_data_base91 ("WB2OSZ", "ss11223344{{!\"", result, sizeof(result)); + + if (strcmp(result, "Seq=7544, A1=1472, A2=1564, A3=1656, A4=1748, A5=8280, D1=1, D2=0, D3=0, D4=0, D5=0, D6=0, D7=0, D8=0") != 0) { + errors++; text_color_set(DW_COLOR_ERROR); dw_printf ("Wrong result, test 202\n"); + } // Error cases. Should not happen in practice because function // should be called only with valid data that matches the pattern. - telemetry_data_base91 ("WB2OSZ", "ss11223344{{!\"x", result); - telemetry_data_base91 ("WB2OSZ", "ss1", result); - telemetry_data_base91 ("WB2OSZ", "ss11223344{{!", result); - telemetry_data_base91 ("WB2OSZ", "s |1", result); + telemetry_data_base91 ("WB2OSZ", "ss11223344{{!\"x", result, sizeof(result)); + + if (strcmp(result, "") != 0) { + errors++; text_color_set(DW_COLOR_ERROR); dw_printf ("Wrong result, test 203\n"); + } + + telemetry_data_base91 ("WB2OSZ", "ss1", result, sizeof(result)); + + if (strcmp(result, "") != 0) { + errors++; text_color_set(DW_COLOR_ERROR); dw_printf ("Wrong result, test 204\n"); + } + + telemetry_data_base91 ("WB2OSZ", "ss11223344{{!", result, sizeof(result)); + + if (strcmp(result, "") != 0) { + errors++; text_color_set(DW_COLOR_ERROR); dw_printf ("Wrong result, test 205\n"); + } + + telemetry_data_base91 ("WB2OSZ", "s |1", result, sizeof(result)); + + if (strcmp(result, "Seq=?") != 0) { + errors++; text_color_set(DW_COLOR_ERROR); dw_printf ("Wrong result, test 206\n"); + } #endif #if DEBUG3 + + text_color_set(DW_COLOR_INFO); + dw_printf ("part 3\n"); + telemetry_name_message ("N0QBF-11", "Battery,Btemp,ATemp,Pres,Alt,Camra,Chut,Sun,10m,ATV"); + struct t_metadata_s *pm; + pm = t_get_metadata("N0QBF-11"); + + if (strcmp(pm->name[0], "Battery") != 0 || + strcmp(pm->name[1], "Btemp") != 0 || + strcmp(pm->name[2], "ATemp") != 0 || + strcmp(pm->name[3], "Pres") != 0 || + strcmp(pm->name[4], "Alt") != 0 || + strcmp(pm->name[5], "Camra") != 0 || + strcmp(pm->name[6], "Chut") != 0 || + strcmp(pm->name[7], "Sun") != 0 || + strcmp(pm->name[8], "10m") != 0 || + strcmp(pm->name[9], "ATV") != 0 || + strcmp(pm->name[10], "D6") != 0 || + strcmp(pm->name[11], "D7") != 0 || + strcmp(pm->name[12], "D8") != 0 ) { + errors++; text_color_set(DW_COLOR_ERROR); dw_printf ("Wrong result, test 301\n"); + } + telemetry_unit_label_message ("N0QBF-11", "v/100,deg.F,deg.F,Mbar,Kft,Click,OPEN,on,on,hi"); - telemetry_coefficents_message ("N0QBF-11", "0,5.2,0,0,.53,-32,3,4.39,49,-32,3,18,1,2,3"); + pm = t_get_metadata("N0QBF-11"); + + if (strcmp(pm->unit[0], "v/100") != 0 || + strcmp(pm->unit[1], "deg.F") != 0 || + strcmp(pm->unit[2], "deg.F") != 0 || + strcmp(pm->unit[3], "Mbar") != 0 || + strcmp(pm->unit[4], "Kft") != 0 || + strcmp(pm->unit[5], "Click") != 0 || + strcmp(pm->unit[6], "OPEN") != 0 || + strcmp(pm->unit[7], "on") != 0 || + strcmp(pm->unit[8], "on") != 0 || + strcmp(pm->unit[9], "hi") != 0 || + strcmp(pm->unit[10], "") != 0 || + strcmp(pm->unit[11], "") != 0 || + strcmp(pm->unit[12], "") != 0 ) { + errors++; text_color_set(DW_COLOR_ERROR); dw_printf ("Wrong result, test 302\n"); + } + + telemetry_coefficents_message ("N0QBF-11", "0,5.2,0,0,.53,-32,3,4.39,49,-32,3,18,1,2,3", 0); + + pm = t_get_metadata("N0QBF-11"); + + if (pm->coeff[0][0] != 0 || pm->coeff[0][1] < 5.1999 || pm->coeff[0][1] > 5.2001 || pm->coeff[0][2] != 0 || + pm->coeff[1][0] != 0 || pm->coeff[1][1] < .52999 || pm->coeff[1][1] > .53001 || pm->coeff[1][2] != -32 || + pm->coeff[2][0] != 3 || pm->coeff[2][1] < 4.3899 || pm->coeff[2][1] > 4.3901 || pm->coeff[2][2] != 49 || + pm->coeff[3][0] != -32 || pm->coeff[3][1] != 3 || pm->coeff[3][2] != 18 || + pm->coeff[4][0] != 1 || pm->coeff[4][1] != 2 || pm->coeff[4][2] != 3) { + errors++; text_color_set(DW_COLOR_ERROR); dw_printf ("Wrong result, test 303c\n"); + } + + if (pm->coeff_ndp[0][0] != 0 || pm->coeff_ndp[0][1] != 1 || pm->coeff_ndp[0][2] != 0 || + pm->coeff_ndp[1][0] != 0 || pm->coeff_ndp[1][1] != 2 || pm->coeff_ndp[1][2] != 0 || + pm->coeff_ndp[2][0] != 0 || pm->coeff_ndp[2][1] != 2 || pm->coeff_ndp[2][2] != 0 || + pm->coeff_ndp[3][0] != 0 || pm->coeff_ndp[3][1] != 0 || pm->coeff_ndp[3][2] != 0 || + pm->coeff_ndp[4][0] != 0 || pm->coeff_ndp[4][1] != 0 || pm->coeff_ndp[4][2] != 0 ) { + errors++; text_color_set(DW_COLOR_ERROR); dw_printf ("Wrong result, test 303n\n"); + } // Error if less than 15 or empty field. - telemetry_coefficents_message ("N0QBF-11", "0,5.2,0,0,.53,-32,3,4.39,49,-32,3,18,1,2"); - telemetry_coefficents_message ("N0QBF-11", "0,5.2,0,0,.53,-32,3,4.39,49,-32,3,18,1,,3"); + // Notice that we keep the previous value in this case. + + telemetry_coefficents_message ("N0QBF-11", "0,5.2,0,0,.53,-32,3,4.39,49,-32,3,18,1,2", 0); + + pm = t_get_metadata("N0QBF-11"); + + if (pm->coeff[0][0] != 0 || pm->coeff[0][1] < 5.1999 || pm->coeff[0][1] > 5.2001 || pm->coeff[0][2] != 0 || + pm->coeff[1][0] != 0 || pm->coeff[1][1] < .52999 || pm->coeff[1][1] > .53001 || pm->coeff[1][2] != -32 || + pm->coeff[2][0] != 3 || pm->coeff[2][1] < 4.3899 || pm->coeff[2][1] > 4.3901 || pm->coeff[2][2] != 49 || + pm->coeff[3][0] != -32 || pm->coeff[3][1] != 3 || pm->coeff[3][2] != 18 || + pm->coeff[4][0] != 1 || pm->coeff[4][1] != 2 || pm->coeff[4][2] != 3) { + errors++; text_color_set(DW_COLOR_ERROR); dw_printf ("Wrong result, test 304c\n"); + } + + if (pm->coeff_ndp[0][0] != 0 || pm->coeff_ndp[0][1] != 1 || pm->coeff_ndp[0][2] != 0 || + pm->coeff_ndp[1][0] != 0 || pm->coeff_ndp[1][1] != 2 || pm->coeff_ndp[1][2] != 0 || + pm->coeff_ndp[2][0] != 0 || pm->coeff_ndp[2][1] != 2 || pm->coeff_ndp[2][2] != 0 || + pm->coeff_ndp[3][0] != 0 || pm->coeff_ndp[3][1] != 0 || pm->coeff_ndp[3][2] != 0 || + pm->coeff_ndp[4][0] != 0 || pm->coeff_ndp[4][1] != 0 || pm->coeff_ndp[4][2] != 0 ) { + errors++; text_color_set(DW_COLOR_ERROR); dw_printf ("Wrong result, test 304n\n"); + } + + telemetry_coefficents_message ("N0QBF-11", "0,5.2,0,0,.53,-32,3,4.39,49,-32,3,18,1,,3", 0); + + pm = t_get_metadata("N0QBF-11"); + + if (pm->coeff[0][0] != 0 || pm->coeff[0][1] < 5.1999 || pm->coeff[0][1] > 5.2001 || pm->coeff[0][2] != 0 || + pm->coeff[1][0] != 0 || pm->coeff[1][1] < .52999 || pm->coeff[1][1] > .53001 || pm->coeff[1][2] != -32 || + pm->coeff[2][0] != 3 || pm->coeff[2][1] < 4.3899 || pm->coeff[2][1] > 4.3901 || pm->coeff[2][2] != 49 || + pm->coeff[3][0] != -32 || pm->coeff[3][1] != 3 || pm->coeff[3][2] != 18 || + pm->coeff[4][0] != 1 || pm->coeff[4][1] != 2 || pm->coeff[4][2] != 3) { + errors++; text_color_set(DW_COLOR_ERROR); dw_printf ("Wrong result, test 305c\n"); + } + + if (pm->coeff_ndp[0][0] != 0 || pm->coeff_ndp[0][1] != 1 || pm->coeff_ndp[0][2] != 0 || + pm->coeff_ndp[1][0] != 0 || pm->coeff_ndp[1][1] != 2 || pm->coeff_ndp[1][2] != 0 || + pm->coeff_ndp[2][0] != 0 || pm->coeff_ndp[2][1] != 2 || pm->coeff_ndp[2][2] != 0 || + pm->coeff_ndp[3][0] != 0 || pm->coeff_ndp[3][1] != 0 || pm->coeff_ndp[3][2] != 0 || + pm->coeff_ndp[4][0] != 0 || pm->coeff_ndp[4][1] != 0 || pm->coeff_ndp[4][2] != 0 ) { + errors++; text_color_set(DW_COLOR_ERROR); dw_printf ("Wrong result, test 305n\n"); + } + + + telemetry_bit_sense_message ("N0QBF-11", "10110000,N0QBF's Big Balloon", 0); - telemetry_bit_sense_message ("N0QBF-11", "10110000,N0QBF's Big Balloon"); + pm = t_get_metadata("N0QBF-11"); + if (pm->sense[0] != 1 || pm->sense[1] != 0 || pm->sense[2] != 1 || pm->sense[3] != 1 || + pm->sense[4] != 0 || pm->sense[5] != 0 || pm->sense[6] != 0 || pm->sense[7] != 0 || + strcmp(pm->project, "N0QBF's Big Balloon") != 0) { + errors++; text_color_set(DW_COLOR_ERROR); dw_printf ("Wrong result, test 306\n"); + } // Too few and invalid digits. - telemetry_bit_sense_message ("N0QBF-11", "1011000"); - telemetry_bit_sense_message ("N0QBF-11", "10110008"); + telemetry_bit_sense_message ("N0QBF-11", "1011000", 0); + + pm = t_get_metadata("N0QBF-11"); + if (pm->sense[0] != 1 || pm->sense[1] != 0 || pm->sense[2] != 1 || pm->sense[3] != 1 || + pm->sense[4] != 0 || pm->sense[5] != 0 || pm->sense[6] != 0 || pm->sense[7] != 0 || + strcmp(pm->project, "") != 0) { + errors++; text_color_set(DW_COLOR_ERROR); dw_printf ("Wrong result, test 307\n"); + } + + telemetry_bit_sense_message ("N0QBF-11", "10110008", 0); + + pm = t_get_metadata("N0QBF-11"); + if (pm->sense[0] != 1 || pm->sense[1] != 0 || pm->sense[2] != 1 || pm->sense[3] != 1 || + pm->sense[4] != 0 || pm->sense[5] != 0 || pm->sense[6] != 0 || pm->sense[7] != 0 || + strcmp(pm->project, "") != 0) { + errors++; text_color_set(DW_COLOR_ERROR); dw_printf ("Wrong result, test 308\n"); + } + #endif - telemetry_coefficents_message ("M0XER-3", "0,0.001,0,0,0.001,0,0,0.1,-273.2,0,1,0,0,1,0"); - telemetry_bit_sense_message ("M0XER-3", "11111111,10mW research balloon"); + text_color_set(DW_COLOR_INFO); + dw_printf ("part 4\n"); + + telemetry_coefficents_message ("M0XER-3", "0,0.001,0,0,0.001,0,0,0.1,-273.2,0,1,0,0,1,0", 0); + telemetry_bit_sense_message ("M0XER-3", "11111111,10mW research balloon", 0); telemetry_name_message ("M0XER-3", "Vbat,Vsolar,Temp,Sat"); telemetry_unit_label_message ("M0XER-3", "V,V,C,,m"); - telemetry_data_base91 ("M0XER-3", "DyR.&^b!+", result); - telemetry_data_base91 ("M0XER-3", "x&G=!(8s!,", result); + telemetry_data_base91 ("M0XER-3", "DyR.&^b!+", result, sizeof(result)); + + if (strcmp(result, "10mW research balloon: Seq=7022, Vbat=4.509 V, Vsolar=0.662 V, Temp=-2.8 C, Sat=10") != 0 || + strcmp(comment, "") != 0) { + errors++; text_color_set(DW_COLOR_ERROR); dw_printf ("Wrong result, test 403\n"); + } + + telemetry_data_base91 ("M0XER-3", "x&G=!(8s!,", result, sizeof(result)); + + if (strcmp(result, "10mW research balloon: Seq=7922, Vbat=3.486 V, Vsolar=0.007 V, Temp=-55.7 C, Sat=11") != 0 || + strcmp(comment, "") != 0) { + errors++; text_color_set(DW_COLOR_ERROR); dw_printf ("Wrong result, test 404\n"); + } + + +/* final score. */ + + if (errors != 0) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("\nTEST FAILED with %d errors.\n", errors); + exit (EXIT_FAILURE); + } - exit (0); + text_color_set (DW_COLOR_REC); + dw_printf ("\nTEST WAS SUCCESSFUL.\n"); + exit (EXIT_SUCCESS); } /* diff --git a/src/telemetry.h b/src/telemetry.h new file mode 100644 index 00000000..4ef9b622 --- /dev/null +++ b/src/telemetry.h @@ -0,0 +1,15 @@ + + +/* telemetry.h */ + +void telemetry_data_original (char *station, char *info, int quiet, char *output, size_t outputsize, char *comment, size_t commentsize); + +void telemetry_data_base91 (char *station, char *cdata, char *output, size_t outputsize); + +void telemetry_name_message (char *station, char *msg); + +void telemetry_unit_label_message (char *station, char *msg); + +void telemetry_coefficents_message (char *station, char *msg, int quiet); + +void telemetry_bit_sense_message (char *station, char *msg, int quiet); diff --git a/src/textcolor.c b/src/textcolor.c new file mode 100644 index 00000000..dea90f09 --- /dev/null +++ b/src/textcolor.c @@ -0,0 +1,401 @@ + +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// +// Copyright (C) 2011, 2012, 2013, 2014, 2019 John Langner, WB2OSZ +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . +// + + +/*------------------------------------------------------------------- + * + * Name: textcolor.c + * + * Purpose: Originally this would only set color of text + * and we used printf everywhere. + * Now we also have a printf replacement that can + * be used to redirect all output to the desired place. + * This opens the door to using ncurses, a GUI, or + * running as a daemon. + * + * Description: For Linux and Cygwin use the ANSI escape sequences. + * In earlier versions of Windows, the cmd window and ANSI.SYS + * could interpret this but it doesn't seem to be available + * anymore so we use a different interface. + * + * Reference: + * http://en.wikipedia.org/wiki/ANSI_escape_code + * + * + +>>>> READ THIS PART!!! <<<< + + * + * + * Problem: Years ago, when I started on this... + * + * The ANSI escape sequences, used for text colors, allowed 8 basic colors. + * Unfortunately, white is not one of them. We only have dark + * white, also known as light gray. To get brighter colors, + * we need to apply an attribute. On some systems, the bold + * attribute produces a brighter color rather than a bold font. + * On other systems, we need to use the blink attribute to get + * bright colors, including white. However on others, blink + * does actually produce blinking characters. + * + * Previously, the only option was to put "-t 0" on the command + * line to disable all text color. This is more readable but + * makes it harder to distinguish different types of + * information, e.g. received packets vs. error messages. + * + * A few people have suggested ncurses. + * I looked at ncurses, and it doesn't seem to be the solution. + * It always sends the same color control codes rather than + * detecting the terminal type and adjusting its behavior. + * + * Version 1.6: + * + * For a long time, there was a compile time distinction between + * ARM (e.g. Raspberry Pi) and other platforms. With the arrival + * of Raspbian Buster, we get flashing and the general Linux settings + * work better. + * + * Since there doesn't seem to be a single universal solution, + * the text color option will now be allowed to have multiple values. + * Several people have also complained that bright green is + * very hard to read against a light background so only dark green will be used. + * + *--------------------------------------------------------------------*/ + + +#include "direwolf.h" // Should be first. includes windows.h + +#include +#include +#include + + +#if __WIN32__ + +#define BACKGROUND_WHITE (BACKGROUND_RED | BACKGROUND_GREEN | BACKGROUND_BLUE | BACKGROUND_INTENSITY) + +#else /* Linux, BSD, Mac OSX */ + +// Alternative 1: + +// Using RGB colors - New in version 1.6. +// Since version 1.2, we've been using RGB to set the background to white. +// From this we can deduce that pretty much everyone recognizes RGB colors by now. +// The only known exception was PuTTY 0.70 and this has been rectified in 0.71. +// Instead of picking 1 of 8 colors, and using some attribute to get bright, just specify it directly. +// This should eliminate the need to reset the background after messing with the bright/bold/blink +// attributes to get more than 8 colors. + + +// Alternative 2: + +// Was new in version 1.2, as suggested by IW2DHW. +// Tested with gnome-terminal and xterm. +// Raspbian Buster LXTerminal also likes this. +// There was probably an issue with an earlier release because I intentionally made ARM different at one time. + +// Here we are using the RGB color format to set the background. +// PuTTY 0.70 doesn't recognize the RGB format so the background is not set. +// Instead of complaining about it, just upgrade to PuTTY 0.71. + + +// Alternative 3: + +// For some terminals we needed "blink" (5) rather than the expected bright/bold (1) +// attribute to get bright white background. +// Makes no sense but I stumbled across that somewhere. + +// In some cases, you might find background (around text but not rest of line) is set to white. +// On GNOME Terminal and LXTerminal, this produces blinking text with a gray background. + + +// Alternative 4: + +// This is using the bright/bold attribute, as you would expect from the documentation. +// Whenever a dark color is used, the background is reset and needs to be set again. +// In recent tests, background is always gray, not white like it should be. + + +#define MAX_T 4 + +static const char *t_background_white[MAX_T+1] = { "", "\e[48;2;255;255;255m", "\e[48;2;255;255;255m", "\e[5;47m", "\e[1;47m" }; + +static const char *t_black[MAX_T+1] = { "", "\e[38;2;0;0;0m", "\e[0;30m" "\e[48;2;255;255;255m", "\e[0;30m" "\e[5;47m", "\e[0;30m" "\e[1;47m" }; +static const char *t_red[MAX_T+1] = { "", "\e[38;2;255;0;0m", "\e[1;31m" "\e[48;2;255;255;255m", "\e[1;31m" "\e[5;47m", "\e[1;31m" "\e[1;47m" }; +static const char *t_green[MAX_T+1] = { "", "\e[38;2;0;255;0m", "\e[1;32m" "\e[48;2;255;255;255m", "\e[1;32m" "\e[5;47m", "\e[1;32m" "\e[1;47m" }; +static const char *t_dark_green[MAX_T+1]= { "", "\e[38;2;0;192;0m", "\e[0;32m" "\e[48;2;255;255;255m", "\e[0;32m" "\e[5;47m", "\e[0;32m" "\e[1;47m" }; +static const char *t_yellow[MAX_T+1] = { "", "\e[38;2;255;255;0m", "\e[1;33m" "\e[48;2;255;255;255m", "\e[1;33m" "\e[5;47m", "\e[1;33m" "\e[1;47m" }; +static const char *t_blue[MAX_T+1] = { "", "\e[38;2;0;0;255m", "\e[1;34m" "\e[48;2;255;255;255m", "\e[1;34m" "\e[5;47m", "\e[1;34m" "\e[1;47m" }; +static const char *t_magenta[MAX_T+1] = { "", "\e[38;2;255;0;255m", "\e[1;35m" "\e[48;2;255;255;255m", "\e[1;35m" "\e[5;47m", "\e[1;35m" "\e[1;47m" }; +static const char *t_cyan[MAX_T+1] = { "", "\e[38;2;0;255;255m", "\e[0;36m" "\e[48;2;255;255;255m", "\e[0;36m" "\e[5;47m", "\e[0;36m" "\e[1;47m" }; + + +/* Clear from cursor to end of screen. */ + +static const char clear_eos[] = "\e[0J"; + +#endif /* end Linux */ + + +#include "textcolor.h" + + +/* + * g_enable_color: + * 0 = disable text colors. + * 1 = default, should be good for LXTerminal >= 0.3.2, GNOME Terminal, xterm, PuTTY >= 0.71. + * 2 = what we had for a few earlier versions. Should be good for LXTerminal, GNOME Terminal, xterm. + * 3 = use 8 basic colors, blinking attribute to get brighter color. Best for older PuTTY. + * 4 = use 8 basic colors, bold attribute to get brighter color. + * + * others... future possibility - tell me if none of these work properly for your terminal type. + * + * 9 (more accurately any invalid value) = try all of them and exit. + */ + +static int g_enable_color = 1; + + +void text_color_init (int enable_color) +{ + + +#if __WIN32__ + + + if (g_enable_color != 0) { + + HANDLE h; + CONSOLE_SCREEN_BUFFER_INFO csbi; + WORD attr = BACKGROUND_WHITE; + DWORD length; + COORD coord; + DWORD nwritten; + + h = GetStdHandle(STD_OUTPUT_HANDLE); + if (h != NULL && h != INVALID_HANDLE_VALUE) { + + GetConsoleScreenBufferInfo (h, &csbi); + + length = csbi.dwSize.X * csbi.dwSize.Y; + coord.X = 0; + coord.Y = 0; + FillConsoleOutputAttribute (h, attr, length, coord, &nwritten); + } + } + +#else + +// Run a test if outside of acceptable range. + + if (enable_color < 0 || enable_color > MAX_T) { + int t; + for (t = 0; t <= MAX_T; t++) { + text_color_init (t); + printf ("-t %d", t); + if (t) printf (" [white background] "); + printf ("\n"); + printf ("%sBlack ", t_black[t]); + printf ("%sRed ", t_red[t]); + printf ("%sGreen ", t_green[t]); + printf ("%sDark-Green ", t_dark_green[t]); + printf ("%sYellow ", t_yellow[t]); + printf ("%sBlue ", t_blue[t]); + printf ("%sMagenta ", t_magenta[t]); + printf ("%sCyan \n", t_cyan[t]); + } + exit (EXIT_SUCCESS); + } + + g_enable_color = enable_color; + + if (g_enable_color != 0) { + int t = g_enable_color; + + if (t < 0) t = 0; + if (t > MAX_T) t = MAX_T; + + printf ("%s", t_background_white[t]); + printf ("%s", clear_eos); + printf ("%s", t_black[t]); + } +#endif +} + + +#if __WIN32__ + +/* Seems that ANSI.SYS is no longer available. */ + + +void text_color_set ( enum dw_color_e c ) +{ + WORD attr; + HANDLE h; + + if (g_enable_color == 0) { + return; + } + + switch (c) { + + default: + case DW_COLOR_INFO: + attr = BACKGROUND_WHITE; + break; + + case DW_COLOR_ERROR: + attr = FOREGROUND_RED | FOREGROUND_INTENSITY | BACKGROUND_WHITE; + break; + + case DW_COLOR_REC: + // Release 1.6. Dark green, same as for debug. + // Bright green is too hard to see with white background, + // attr = FOREGROUND_GREEN | FOREGROUND_INTENSITY | BACKGROUND_WHITE; + attr = FOREGROUND_GREEN | BACKGROUND_WHITE; + break; + + case DW_COLOR_DECODED: + attr = FOREGROUND_BLUE | FOREGROUND_INTENSITY | BACKGROUND_WHITE; + break; + + case DW_COLOR_XMIT: + attr = FOREGROUND_RED | FOREGROUND_BLUE | FOREGROUND_INTENSITY | BACKGROUND_WHITE; + break; + + case DW_COLOR_DEBUG: + attr = FOREGROUND_GREEN | BACKGROUND_WHITE; + break; + } + + h = GetStdHandle(STD_OUTPUT_HANDLE); + + if (h != NULL && h != INVALID_HANDLE_VALUE) { + SetConsoleTextAttribute (h, attr); + } +} + +#else + +void text_color_set ( enum dw_color_e c ) +{ + + if (g_enable_color == 0) { + return; + } + + int t = g_enable_color; + + if (t < 0) t = 0; + if (t > MAX_T) t = MAX_T; + + switch (c) { + + default: + case DW_COLOR_INFO: + printf ("%s", t_black[t]); + break; + + case DW_COLOR_ERROR: + printf ("%s", t_red[t]); + break; + + case DW_COLOR_REC: + // Bright green is very difficult to read against a while background. + // Let's use dark green instead. release 1.6. + //printf ("%s", t_green[t]); + printf ("%s", t_dark_green[t]); + break; + + case DW_COLOR_DECODED: + printf ("%s", t_blue[t]); + break; + + case DW_COLOR_XMIT: + printf ("%s", t_magenta[t]); + break; + + case DW_COLOR_DEBUG: + printf ("%s", t_dark_green[t]); + break; + } +} + +#endif + + +/*------------------------------------------------------------------- + * + * Name: dw_printf + * + * Purpose: printf replacement that allows us to send all text + * output to stdout or other desired destination. + * + * Inputs: fmt - C language format. + * ... - Additional arguments, just like printf. + * + * + * Returns: Number of characters in result. + * + * Bug: Fixed size buffer. + * I'd rather not do a malloc for each print. + * + *--------------------------------------------------------------------*/ + + +// TODO: replace all printf, look for stderr, perror +// TODO: $ grep printf *.c | grep -v dw_printf | grep -v fprintf | gawk '{ print $1 }' | sort -u + + +int dw_printf (const char *fmt, ...) +{ +#define BSIZE 1000 + va_list args; + char buffer[BSIZE]; + int len; + + va_start (args, fmt); + len = vsnprintf (buffer, BSIZE, fmt, args); + va_end (args); + +// TODO: other possible destinations... + + fputs (buffer, stdout); + return (len); +} + + + +#if TESTC +main () +{ + printf ("Initial condition\n"); + text_color_init (1); + printf ("After text_color_init\n"); + text_color_set(DW_COLOR_INFO); printf ("Info\n"); + text_color_set(DW_COLOR_ERROR); printf ("Error\n"); + text_color_set(DW_COLOR_REC); printf ("Rec\n"); + text_color_set(DW_COLOR_DECODED); printf ("Decoded\n"); + text_color_set(DW_COLOR_XMIT); printf ("Xmit\n"); + text_color_set(DW_COLOR_DEBUG); printf ("Debug\n"); +} +#endif + +/* end textcolor.c */ diff --git a/textcolor.h b/src/textcolor.h similarity index 95% rename from textcolor.h rename to src/textcolor.h index 33f568e4..4e38c83e 100644 --- a/textcolor.h +++ b/src/textcolor.h @@ -7,6 +7,10 @@ * *--------------------------------------------------------------------*/ + +#ifndef TEXTCOLOR_H +#define TEXTCOLOR_H 1 + enum dw_color_e { DW_COLOR_INFO, /* black */ DW_COLOR_ERROR, /* red */ DW_COLOR_REC, /* green */ @@ -51,3 +55,4 @@ int dw_printf (const char *fmt, ...) __attribute__((format(printf,1,2))); /* gnu C lib. */ #endif +#endif diff --git a/src/tnctest.c b/src/tnctest.c new file mode 100644 index 00000000..0d4c26b4 --- /dev/null +++ b/src/tnctest.c @@ -0,0 +1,1284 @@ +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// +// Copyright (C) 2016 John Langner, WB2OSZ +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . +// + + +/*------------------------------------------------------------------ + * + * Module: tnctest.c + * + * Purpose: Test AX.25 connected mode between two TNCs. + * + * Description: The first TNC will connect to the second TNC and send a bunch of data. + * Proper transfer of data will be verified. + * + * Usage: tnctest [options] port0=name0 port1=name1 + * + * Example: tnctest localhost:8000=direwolf COM1=KPC-3+ + * + * Each port can have the following forms: + * + * * host-name:tcp-port + * * ip-addr:tcp-port + * * tcp-port + * * serial port name (e.g. COM1, /dev/ttyS0) + * + *---------------------------------------------------------------*/ + + + +/* + * Native Windows: Use the Winsock interface. + * Linux: Use the BSD socket interface. + */ + +#include "direwolf.h" // Sets _WIN32_WINNT for XP API level needed by ws2tcpip.h + +#if __WIN32__ + +#include +#include // _WIN32_WINNT must be set to 0x0501 before including this + +#else + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +//#include +#include +#endif + +#include +#include +#include +#include +#include +#include + + +//#include "ax25_pad.h" +#include "textcolor.h" +#include "dtime_now.h" +#include "serial_port.h" + + +/* We don't deal with big-endian processors here. */ +/* TODO: Use agwlib (which did not exist when this was written) */ +/* rather than duplicating the effort here. */ + +struct agwpe_s { + +#if 1 + + unsigned char portx; /* 0 for first, 1 for second, etc. */ + unsigned char reserved1; + unsigned char reserved2; + unsigned char reserved3; + + unsigned char datakind; /* message type, usually written as a letter. */ + unsigned char reserved4; + unsigned char pid; + unsigned char reserved5; + +#else + short portx; /* 0 for first, 1 for second, etc. */ + short port_hi_reserved; + short kind_lo; /* message type */ + short kind_hi; +#endif + char call_from[10]; + char call_to[10]; + int data_len; /* Number of data bytes following. */ + int user_reserved; +}; + + +#if __WIN32__ +static unsigned __stdcall tnc_thread_net (void *arg); +static unsigned __stdcall tnc_thread_serial (void *arg); +#else +static void * tnc_thread_net (void *arg); +static void * tnc_thread_serial (void *arg); +#endif + + +static void tnc_connect (int from, int to); +static void tnc_disconnect (int from, int to); +static void tnc_send_data (int from, int to, char * data); +static void tnc_reset (int from, int to); + +/* + * Convert Internet address to text. + * Can't use InetNtop because it is supported only on Windows Vista and later. + */ + +static char * ia_to_text (int Family, void * pAddr, char * pStringBuf, size_t StringBufSize) +{ + struct sockaddr_in *sa4; + struct sockaddr_in6 *sa6; + + switch (Family) { + case AF_INET: + sa4 = (struct sockaddr_in *)pAddr; +#if __WIN32__ + snprintf (pStringBuf, StringBufSize, "%d.%d.%d.%d", sa4->sin_addr.S_un.S_un_b.s_b1, + sa4->sin_addr.S_un.S_un_b.s_b2, + sa4->sin_addr.S_un.S_un_b.s_b3, + sa4->sin_addr.S_un.S_un_b.s_b4); +#else + inet_ntop (AF_INET, &(sa4->sin_addr), pStringBuf, StringBufSize); +#endif + break; + case AF_INET6: + sa6 = (struct sockaddr_in6 *)pAddr; +#if __WIN32__ + snprintf (pStringBuf, StringBufSize, "%x:%x:%x:%x:%x:%x:%x:%x", + ntohs(((unsigned short *)(&(sa6->sin6_addr)))[0]), + ntohs(((unsigned short *)(&(sa6->sin6_addr)))[1]), + ntohs(((unsigned short *)(&(sa6->sin6_addr)))[2]), + ntohs(((unsigned short *)(&(sa6->sin6_addr)))[3]), + ntohs(((unsigned short *)(&(sa6->sin6_addr)))[4]), + ntohs(((unsigned short *)(&(sa6->sin6_addr)))[5]), + ntohs(((unsigned short *)(&(sa6->sin6_addr)))[6]), + ntohs(((unsigned short *)(&(sa6->sin6_addr)))[7])); +#else + inet_ntop (AF_INET6, &(sa6->sin6_addr), pStringBuf, StringBufSize); +#endif + break; + default: + snprintf (pStringBuf, StringBufSize, "Invalid address family!"); + } + assert (strlen(pStringBuf) < StringBufSize); + return pStringBuf; +} + + + +/*------------------------------------------------------------------ + * + * Name: main + * + * Purpose: Basic test for connected AX.25 data mode between TNCs. + * + * Usage: Described above. + * + *---------------------------------------------------------------*/ + +#define MAX_TNC 2 // Just 2 for now. + // Could be more later for multiple concurrent connections. + +/* Obtained from the command line. */ + +static int num_tnc; /* How many TNCs for this test? */ + /* Initially only 2 but long term we might */ + /* enhance it to allow multiple concurrent connections. */ + +static char hostname[MAX_TNC][50]; /* DNS host name or IPv4 address. */ + /* Some of the code is there for IPv6 but */ + /* needs more work. */ + /* Defaults to "localhost" if not specified. */ + +static char port[MAX_TNC][30]; /* If it begins with a digit, it is considered */ + /* a TCP port number at the hostname. */ + /* Otherwise, we treat it as a serial port name. */ + +static char description[MAX_TNC][50]; /* Name used in the output. */ + +static int using_tcp[MAX_TNC]; /* Are we using TCP or serial port for each TNC? */ + /* Use corresponding one of the next two. */ + +static int server_sock[MAX_TNC]; /* File descriptor for AGW socket interface. */ + /* Set to -1 if not used. */ + /* (Don't use SOCKET type because it is unsigned.) */ + +static MYFDTYPE serial_fd[MAX_TNC]; /* Serial port handle. */ + +static volatile int busy[MAX_TNC]; /* True when TNC busy and can't accept more data. */ + /* For serial port, this is set by XON / XOFF characters. */ + +#define XOFF 0x13 +#define XON 0x11 + +static char tnc_address[MAX_TNC][12]; /* Name of the TNC used in the frames. Originally, this */ + /* was simply TNC0 and TNC1 but that can get hard to read */ + /* and confusing. Later used DW0, DW1, for direwolf */ + /* so the direction of flow is easier to grasp. */ + +#if __WIN32__ + static HANDLE tnc_th[MAX_TNC]; +#else + static pthread_t tnc_tid[MAX_TNC]; +#endif + +#define LINE_WIDTH 80 +//#define LINE_WIDTH 120 /* If I was more ambitious I might try to get */ + /* this from the terminal properties. */ + +static int column_width; /* Line width divided by number of TNCs. */ + + +/* + * Current state for each TNC. + */ + +static int is_connected[MAX_TNC]; /* -1 = not yet available. */ + /* 0 = not connected. */ + /* 1 = not connected. */ + +static int have_cmd_prompt[MAX_TNC]; /* Set if "cmd:" was the last thing seen. */ + +static int last_rec_seq[MAX_TNC]; /* Each data packet will contain a sequence number. */ + /* This is used to verify that all have been */ + /* received in the correct order. */ + + + +/* + * Start time so we can print relative elapsed time. + */ + +static double start_dtime; + + +static int max_count; + +int main (int argc, char *argv[]) +{ + int j; + int timeout; + int send_count = 0; + int burst_size = 1; + int errors = 0; + + //max_count = 20; + max_count = 200; + //max_count = 6; + max_count = 1000; + max_count = 9999; + +#if __WIN32__ +#else + int e; + + setlinebuf (stdout); +#endif + + start_dtime = dtime_now(); + +/* + * Extract command line args. + */ + num_tnc = argc - 1; + + if (num_tnc < 2 || num_tnc > MAX_TNC) { + printf ("Specify minimum 2, maximum %d TNCs on the command line.\n", MAX_TNC); + exit (EXIT_FAILURE); + } + + column_width = LINE_WIDTH / num_tnc; + + for (j=0; j 0) { + + SLEEP_MS(100); + timeout--; + ready = 1; + for (j=0; j last0) { + last0 = last_rec_seq[0]; + no_activity = 0; + } + if (last_rec_seq[1] > last1) { + last1 = last_rec_seq[1]; + no_activity = 0; + } + } + + if (last_rec_seq[0] == max_count) { + printf ("Got last expected reply.\n"); + } + else { + printf ("ERROR: Timeout - No incoming activity for %d seconds.\n", no_activity); + errors++; + } + +/* + * Did we get all expected replies? + */ + if (last_rec_seq[0] != max_count) { + printf ("ERROR: Last received reply was %d when we were expecting %d.\n", last_rec_seq[0], max_count); + errors++; + } + +/* + * Ask for disconnect. Wait until complete. + */ + + tnc_disconnect (0, 1); + + timeout = 200; // 20 sec should be generous. + ready = 0; + while ( ! ready && timeout > 0) { + + SLEEP_MS(100); + timeout--; + ready = 1; + for (j=0; j1 for the other end which answers. + * + * data - Should look something like this: + * 9999 send data + * 9999 reply + * + * Global In/Out: last_rec_seq[my_index] + * + * Description: Look for expected format. + * Extract the sequence number. + * Verify that it is the next expected one. + * Update it. + * + *--------------------------------------------------------------------*/ + +void process_rec_data (int my_index, char *data) +{ + int n; + + if (isdigit(*data) && strncmp(data+4, " send", 5) == 0) { + if (my_index > 0) { + last_rec_seq[my_index]++; + + n = atoi(data); + if (n != last_rec_seq[my_index]) { + printf ("%*s%s: Received %d when %d was expected.\n", my_index*column_width, "", tnc_address[my_index], n, last_rec_seq[my_index]); + SLEEP_MS(10000); + printf ("TEST FAILED!\n"); + exit (EXIT_FAILURE); + } + } + } + + else if (isdigit(*data) && strncmp(data+4, " reply", 6) == 0) { + if (my_index == 0) { + last_rec_seq[my_index]++; + n = atoi(data); + if (n != last_rec_seq[my_index]) { + printf ("%*s%s: Received %d when %d was expected.\n", my_index*column_width, "", tnc_address[my_index], n, last_rec_seq[my_index]); + SLEEP_MS(10000); + printf ("TEST FAILED!\n"); + exit (EXIT_FAILURE); + } + } + } + + else if (data[0] == 'A') { + + if (strncmp(data, "ABCDEFGHIJKLMNOPQRSTUVWXYZ", strlen(data)-1) != 0) { + printf ("%*s%s: Segmentation is broken.\n", my_index*column_width, "", tnc_address[my_index]); + SLEEP_MS(10000); + printf ("TEST FAILED!\n"); + exit (EXIT_FAILURE); + } + } +} + + + +/*------------------------------------------------------------------- + * + * Name: tnc_thread_net + * + * Purpose: Establish connection with a TNC via network. + * + * Inputs: arg - My instance index, 0 thru MAX_TNC-1. + * + * Outputs: packets - Received packets are put in the corresponding column + * and sent to a common function to check that they + * all arrived in order. + * + * Global Out: is_connected - Updated when connected/disconnected notifications are received. + * + * Description: Perform any necessary configuration for the TNC then wait + * for responses and process them. + * + *--------------------------------------------------------------------*/ + +#define MAX_HOSTS 30 + +#if __WIN32__ +static unsigned __stdcall tnc_thread_net (void *arg) +#else +static void * tnc_thread_net (void *arg) +#endif +{ + int my_index; + struct addrinfo hints; + struct addrinfo *ai_head = NULL; + struct addrinfo *ai; + struct addrinfo *hosts[MAX_HOSTS]; + int num_hosts, n; + int err; + char ipaddr_str[46]; /* text form of IP address */ +#if __WIN32__ + WSADATA wsadata; +#endif + + struct agwpe_s mon_cmd; + char data[4096]; + double dnow; + + + my_index = (int)(ptrdiff_t)arg; + +#if DEBUGx + printf ("DEBUG: tnc_thread_net %d start, port = '%s'\n", my_index, port[my_index]); +#endif + +#if __WIN32__ + err = WSAStartup (MAKEWORD(2,2), &wsadata); + if (err != 0) { + printf("WSAStartup failed: %d\n", err); + return (0); + } + + if (LOBYTE(wsadata.wVersion) != 2 || HIBYTE(wsadata.wVersion) != 2) { + printf("Could not find a usable version of Winsock.dll\n"); + WSACleanup(); + //sleep (1); + return (0); + } +#endif + + memset (&hints, 0, sizeof(hints)); + + hints.ai_family = AF_UNSPEC; /* Allow either IPv4 or IPv6. */ + // hints.ai_family = AF_INET; /* IPv4 only. */ + hints.ai_socktype = SOCK_STREAM; + hints.ai_protocol = IPPROTO_TCP; + +/* + * Connect to TNC server. + */ + + ai_head = NULL; + err = getaddrinfo(hostname[my_index], port[my_index], &hints, &ai_head); + if (err != 0) { +#if __WIN32__ + printf ("Can't get address for server %s, err=%d\n", + hostname[my_index], WSAGetLastError()); +#else + printf ("Can't get address for server %s, %s\n", + hostname[my_index], gai_strerror(err)); +#endif + freeaddrinfo(ai_head); + exit (1); + } + +#if DEBUG_DNS + printf ("getaddrinfo returns:\n"); +#endif + num_hosts = 0; + for (ai = ai_head; ai != NULL; ai = ai->ai_next) { +#if DEBUG_DNS + ia_to_text (ai->ai_family, ai->ai_addr, ipaddr_str, sizeof(ipaddr_str)); + printf (" %s\n", ipaddr_str); +#endif + hosts[num_hosts] = ai; + if (num_hosts < MAX_HOSTS) num_hosts++; + } + +#if DEBUG_DNS + printf ("addresses for hostname:\n"); + for (n=0; nai_family, hosts[n]->ai_addr, ipaddr_str, sizeof(ipaddr_str)); + printf (" %s\n", ipaddr_str); + } +#endif + + // Try each address until we find one that is successful. + + for (n=0; nai_family, ai->ai_addr, ipaddr_str, sizeof(ipaddr_str)); + is = socket(ai->ai_family, ai->ai_socktype, ai->ai_protocol); +#if __WIN32__ + if (is == INVALID_SOCKET) { + printf ("Socket creation failed, err=%d", WSAGetLastError()); + WSACleanup(); + is = -1; + continue; + } +#else + if (err != 0) { + printf ("Socket creation failed, err=%s", gai_strerror(err)); + (void) close (is); + is = -1; + continue; + } +#endif + +#ifndef DEBUG_DNS + err = connect(is, ai->ai_addr, (int)ai->ai_addrlen); +#if __WIN32__ + if (err == SOCKET_ERROR) { +#if DEBUGx + printf("Connect to %s on %s (%s), port %s failed.\n", + description[my_index], hostname[my_index], ipaddr_str, port[my_index]); +#endif + closesocket (is); + is = -1; + continue; + } +#else + if (err != 0) { +#if DEBUGx + printf("Connect to %s on %s (%s), port %s failed.\n", + description[my_index], hostname[my_index], ipaddr_str, port[my_index]); +#endif + (void) close (is); + is = -1; + continue; + } + int flag = 1; + err = setsockopt (is, IPPROTO_TCP, TCP_NODELAY, (void*)(long)(&flag), (socklen_t)sizeof(flag)); + if (err < 0) { + printf("setsockopt TCP_NODELAY failed.\n"); + } +#endif + +/* Success. */ + + + server_sock[my_index] = is; +#endif + break; + } + + freeaddrinfo(ai_head); + + if (server_sock[my_index] == -1) { + + printf("TNC %d unable to connect to %s on %s (%s), port %s\n", + my_index, description[my_index], hostname[my_index], ipaddr_str, port[my_index] ); + exit (1); + } + + +#if 1 // Temp test just to get something. + +/* + * Send command to toggle reception of frames in raw format. + */ + memset (&mon_cmd, 0, sizeof(mon_cmd)); + + mon_cmd.datakind = 'k'; + + SOCK_SEND(server_sock[my_index], (char*)(&mon_cmd), sizeof(mon_cmd)); + +#endif + +/* + * Send command to register my callsign for incoming connect request. + * Not really needed when we initiate the connection. + */ + + memset (&mon_cmd, 0, sizeof(mon_cmd)); + + mon_cmd.datakind = 'X'; + strlcpy (mon_cmd.call_from, tnc_address[my_index], sizeof(mon_cmd.call_from)); + + SOCK_SEND(server_sock[my_index], (char*)(&mon_cmd), sizeof(mon_cmd)); + + + +/* + * Inform main program and observer that we are ready to go. + */ + printf("TNC %d now available. %s on %s (%s), port %s\n", + my_index, description[my_index], hostname[my_index], ipaddr_str, port[my_index] ); + is_connected[my_index] = 0; + +/* + * Print what we get from TNC. + */ + + while (1) { + int n; + + n = SOCK_RECV (server_sock[my_index], (char*)(&mon_cmd), sizeof(mon_cmd)); + + if (n != sizeof(mon_cmd)) { + printf ("Read error, TNC %d received %d command bytes.\n", my_index, n); + exit (1); + } + + +#if DEBUGx + printf ("TNC %d received '%c' data, data_len = %d\n", + my_index, mon_cmd.datakind, mon_cmd.data_len); +#endif + assert (mon_cmd.data_len >= 0 && mon_cmd.data_len < (int)(sizeof(data))); + + if (mon_cmd.data_len > 0) { + + n = SOCK_RECV (server_sock[my_index], data, mon_cmd.data_len); + + if (n != mon_cmd.data_len) { + printf ("Read error, TNC %d received %d data bytes.\n", my_index, n); + exit (1); + } + data[mon_cmd.data_len] = '\0'; + } + +/* + * What did we get? + */ + + dnow = dtime_now(); + + switch (mon_cmd.datakind) { + + case 'C': // AX.25 Connection Received + + printf("%*s[R %.3f] *** Connected to %s ***\n", my_index*column_width, "", dnow-start_dtime, mon_cmd.call_from); + is_connected[my_index] = 1; + + break; + + case 'D': // Connected AX.25 Data + + printf("%*s[R %.3f] %s\n", my_index*column_width, "", dnow-start_dtime, data); + + process_rec_data (my_index, data); + + + if (isdigit(data[0]) && isdigit(data[1]) && isdigit(data[2]) && isdigit(data[3]) && + strncmp(data+4, " send", 5) == 0) { + // Expected message. Make sure it is expected sequence and send reply. + int n = atoi(data); + char reply[80]; + snprintf (reply, sizeof(reply), "%04d reply\r", n); + tnc_send_data (my_index, 1 - my_index, reply); + + // HACK! + // It gets very confusing because N(S) and N(R) are very close. + // Send a couple dozen I frames so they will be easier to distinguish visually. + // Currently don't have the same in serial port version. + + // We change the length each time to test segmentation. + // Set PACLEN to some very small number like 5. + + if (n == 1 && max_count > 1) { + int j; + for (j = 1; j <= 26; j++) { + snprintf (reply, sizeof(reply), "%.*s\r", j, "ABCDEFGHIJKLMNOPQRSTUVWXYZ"); + tnc_send_data (my_index, 1 - my_index, reply); + } + } + } + + break; + + case 'd': // Disconnected + + printf("%*s[R %.3f] *** Disconnected from %s ***\n", my_index*column_width, "", dnow-start_dtime, mon_cmd.call_from); + is_connected[my_index] = 0; + + break; + + case 'y': // Outstanding frames waiting on a Port + + printf("%*s[R %.3f] *** Outstanding frames waiting %d ***\n", my_index*column_width, "", dnow-start_dtime, 123); // TODO + + break; + + default: + + //printf("%*s[R %.3f] --- Ignoring cmd kind '%c' ---\n", my_index*column_width, "", dnow-start_dtime, mon_cmd.datakind); + + break; + } + } + +} /* end tnc_thread_net */ + + + + + +/*------------------------------------------------------------------- + * + * Name: tnc_thread_serial + * + * Purpose: Establish connection with a TNC via serial port. + * + * Inputs: arg - My instance index, 0 thru MAX_TNC-1. + * + * Outputs: packets - Received packets are put in the corresponding column + * and sent to a common function to check that they + * all arrived in order. + * + * Global Out: is_connected - Updated when connected/disconnected notifications are received. + * + * Description: Perform any necessary configuration for the TNC then wait + * for responses and process them. + * + *--------------------------------------------------------------------*/ + + +#if __WIN32__ +typedef HANDLE MYFDTYPE; +#define MYFDERROR INVALID_HANDLE_VALUE +#else +typedef int MYFDTYPE; +#define MYFDERROR (-1) +#endif + + +#if __WIN32__ +static unsigned __stdcall tnc_thread_serial (void *arg) +#else +static void * tnc_thread_serial (void *arg) +#endif +{ + int my_index = (int)(ptrdiff_t)arg; + char cmd[80]; + + serial_fd[my_index] = serial_port_open (port[my_index], 9600); + + if (serial_fd[my_index] == MYFDERROR) { + printf("TNC %d unable to connect to %s on %s.\n", + my_index, description[my_index], port[my_index] ); + exit (1); + } + + +/* + * Make sure we are in command mode. + */ + + strcpy (cmd, "\003\rreset\r"); + serial_port_write (serial_fd[my_index], cmd, strlen(cmd)); + SLEEP_MS (3000); + + strcpy (cmd, "echo on\r"); + serial_port_write (serial_fd[my_index], cmd, strlen(cmd)); + SLEEP_MS (200); + +// do any necessary set up here. such as setting mycall + + snprintf (cmd, sizeof(cmd), "mycall %s\r", tnc_address[my_index]); + serial_port_write (serial_fd[my_index], cmd, strlen(cmd)); + SLEEP_MS (200); + +// Don't want to stop tty output when typing begins. + + strcpy (cmd, "flow off\r"); + serial_port_write (serial_fd[my_index], cmd, strlen(cmd)); + + strcpy (cmd, "echo off\r"); + serial_port_write (serial_fd[my_index], cmd, strlen(cmd)); + +/* Success. */ + + printf("TNC %d now available. %s on %s\n", + my_index, description[my_index], port[my_index] ); + is_connected[my_index] = 0; + + +/* + * Read and print. + */ + + while (1) { + int ch; + char result[500]; + int len; + int done; + + len = 0; + result[len] = '\0'; + done = 0; + + while ( ! done) { + + ch = serial_port_get1(serial_fd[my_index]); + + if (ch < 0) { + printf("TNC %d fatal read error.\n", my_index); + exit (1); + } + + if (ch == '\r' || ch == '\n') { + done = 1; + } + else if (ch == XOFF) { + double dnow = dtime_now(); + printf("%*s[R %.3f] \n", my_index*column_width, "", dnow-start_dtime); + busy[my_index] = 1; + } + else if (ch == XON) { + double dnow = dtime_now(); + printf("%*s[R %.3f] \n", my_index*column_width, "", dnow-start_dtime); + busy[my_index] = 0; + } + else if (isprint(ch)) { + result[len] = ch; + len++; + result[len] = '\0'; + } + else { + char hex[12]; + + snprintf (hex, sizeof(hex), "", ch); + strlcat (result, hex, sizeof(result)); + len = strlen(result); + } + if (strcmp(result, "cmd:") == 0) { + done = 1; + have_cmd_prompt[my_index] = 1; + } + else { + have_cmd_prompt[my_index] = 0; + } + } + + if (len > 0) { + + double dnow = dtime_now(); + + printf("%*s[R %.3f] %s\n", my_index*column_width, "", dnow-start_dtime, result); + + if (strncmp(result, "*** CONNECTED", 13) == 0) { + is_connected[my_index] = 1; + } + + if (strncmp(result, "*** DISCONNECTED", 16) == 0) { + is_connected[my_index] = 0; + } + + if (strncmp(result, "Not while connected", 19) == 0) { + // Not expecting this. + // What to do? + } + + process_rec_data (my_index, result); + + if (isdigit(result[0]) && isdigit(result[1]) && isdigit(result[2]) && isdigit(result[3]) && + strncmp(result+4, " send", 5) == 0) { + // Expected message. Make sure it is expected sequence and send reply. + int n = atoi(result); + char reply[80]; + snprintf (reply, sizeof(reply), "%04d reply\r", n); + tnc_send_data (my_index, 1 - my_index, reply); + } + + } + } + +} /* end tnc_thread_serial */ + + + + +static void tnc_connect (int from, int to) +{ + + double dnow = dtime_now(); + + printf("%*s[T %.3f] *** Send connect request ***\n", from*column_width, "", dnow-start_dtime); + + if (using_tcp[from]) { + +//struct agwpe_s { +// short portx; /* 0 for first, 1 for second, etc. */ +// short port_hi_reserved; +// short datakind; /* message type */ +// short kind_hi; +// char call_from[10]; +// char call_to[10]; +// int data_len; /* Number of data bytes following. */ +// int user_reserved; +//}; + struct agwpe_s cmd; + + memset (&cmd, 0, sizeof(cmd)); + + cmd.datakind = 'C'; + strlcpy (cmd.call_from, tnc_address[from], sizeof(cmd.call_from)); + strlcpy (cmd.call_to, tnc_address[to], sizeof(cmd.call_to)); + + SOCK_SEND(server_sock[from], (char*)(&cmd), sizeof(cmd)); + } + else { + + char cmd[80]; + + if (! have_cmd_prompt[from]) { + + SLEEP_MS (1500); + strcpy (cmd, "\003\003\003"); + serial_port_write (serial_fd[from], cmd, strlen(cmd)); + SLEEP_MS (1500); + + strcpy (cmd, "\r"); + serial_port_write (serial_fd[from], cmd, strlen(cmd)); + SLEEP_MS (200); + } + + snprintf (cmd, sizeof(cmd), "connect %s\r", tnc_address[to]); + serial_port_write (serial_fd[from], cmd, strlen(cmd)); + } + +} /* end tnc_connect */ + + +static void tnc_disconnect (int from, int to) +{ + double dnow = dtime_now(); + + printf("%*s[T %.3f] *** Send disconnect request ***\n", from*column_width, "", dnow-start_dtime); + + if (using_tcp[from]) { + + struct agwpe_s cmd; + + memset (&cmd, 0, sizeof(cmd)); + + cmd.datakind = 'd'; + strlcpy (cmd.call_from, tnc_address[from], sizeof(cmd.call_from)); + strlcpy (cmd.call_to, tnc_address[to], sizeof(cmd.call_to)); + + SOCK_SEND(server_sock[from], (char*)(&cmd), sizeof(cmd)); + } + else { + + char cmd[80]; + + if (! have_cmd_prompt[from]) { + + SLEEP_MS (1500); + strcpy (cmd, "\003\003\003"); + serial_port_write (serial_fd[from], cmd, strlen(cmd)); + SLEEP_MS (1500); + + strcpy (cmd, "\r"); + serial_port_write (serial_fd[from], cmd, strlen(cmd)); + SLEEP_MS (200); + } + + strcpy (cmd, "disconnect\r"); + serial_port_write (serial_fd[from], cmd, strlen(cmd)); + } + +} /* end tnc_disconnect */ + + +static void tnc_reset (int from, int to) +{ + double dnow = dtime_now(); + + printf("%*s[T %.3f] *** Send reset ***\n", from*column_width, "", dnow-start_dtime); + + if (using_tcp[from]) { + + + } + else { + + char cmd[80]; + + SLEEP_MS (1500); + strcpy (cmd, "\003\003\003"); + serial_port_write (serial_fd[from], cmd, strlen(cmd)); + SLEEP_MS (1500); + + strcpy (cmd, "\r"); + serial_port_write (serial_fd[from], cmd, strlen(cmd)); + SLEEP_MS (200); + + strcpy (cmd, "reset\r"); + serial_port_write (serial_fd[from], cmd, strlen(cmd)); + } + +} /* end tnc_disconnect */ + + + +static void tnc_send_data (int from, int to, char * data) +{ + double dnow = dtime_now(); + + printf("%*s[T %.3f] %s\n", from*column_width, "", dnow-start_dtime, data); + + if (using_tcp[from]) { + + struct { + struct agwpe_s hdr; + char data[256]; + } cmd; + + memset (&cmd.hdr, 0, sizeof(cmd.hdr)); + + cmd.hdr.datakind = 'D'; + cmd.hdr.pid = 0xf0; + snprintf (cmd.hdr.call_from, sizeof(cmd.hdr.call_from), "%s", tnc_address[from]); + snprintf (cmd.hdr.call_to, sizeof(cmd.hdr.call_to), "%s", tnc_address[to]); + cmd.hdr.data_len = strlen(data); + strlcpy (cmd.data, data, sizeof(cmd.data)); + + SOCK_SEND(server_sock[from], (char*)(&cmd), sizeof(cmd.hdr) + strlen(data)); + } + else { + + // The assumption is that we are in CONVERS mode. + // The data should be terminated by carriage return. + + int timeout = 600; // 60 sec. I've seen it take more than 20. + while (timeout > 0 && busy[from]) { + SLEEP_MS(100); + timeout--; + } + if (timeout == 0) { + printf ("ERROR: Gave up waiting while TNC busy.\n"); + tnc_disconnect (0,1); + SLEEP_MS(5000); + printf ("TEST FAILED!\n"); + exit (EXIT_FAILURE); + } + else { + serial_port_write (serial_fd[from], data, strlen(data)); + } + } + +} /* end tnc_disconnect */ + + + + +/* end tnctest.c */ diff --git a/src/tq.c b/src/tq.c new file mode 100644 index 00000000..c656af54 --- /dev/null +++ b/src/tq.c @@ -0,0 +1,1075 @@ +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// +// Copyright (C) 2011, 2012, 2014, 2015, 2016, 2023 John Langner, WB2OSZ +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . +// + + +/*------------------------------------------------------------------ + * + * Module: tq.c + * + * Purpose: Transmit queue - hold packets for transmission until the channel is clear. + * + * Description: Producers of packets to be transmitted call tq_append and then + * go merrily on their way, unconcerned about when the packet might + * actually get transmitted. + * + * Another thread waits until the channel is clear and then removes + * packets from the queue and transmits them. + * + * Revisions: 1.2 - Enhance for multiple audio devices. + * + *---------------------------------------------------------------*/ + +#define TQ_C 1 + +#include "direwolf.h" + +#include +#include +#include +#include +#include + +#include "ax25_pad.h" +#include "textcolor.h" +#include "audio.h" +#include "tq.h" +#include "dedupe.h" +#include "igate.h" +#include "dtime_now.h" + + + +static packet_t queue_head[MAX_CHANS][TQ_NUM_PRIO]; /* Head of linked list for each queue. */ + + +static dw_mutex_t tq_mutex; /* Critical section for updating queues. */ + /* Just one for all queues. */ + +#if __WIN32__ + +static HANDLE wake_up_event[MAX_CHANS]; /* Notify transmit thread when queue not empty. */ + +#else + +static pthread_cond_t wake_up_cond[MAX_CHANS]; /* Notify transmit thread when queue not empty. */ + +static pthread_mutex_t wake_up_mutex[MAX_CHANS]; /* Required by cond_wait. */ + +static int xmit_thread_is_waiting[MAX_CHANS]; + +#endif + +static int tq_is_empty (int chan); + + +/*------------------------------------------------------------------- + * + * Name: tq_init + * + * Purpose: Initialize the transmit queue. + * + * Inputs: audio_config_p - Audio device configuration. + * + * Outputs: + * + * Description: Initialize the queue to be empty and set up other + * mechanisms for sharing it between different threads. + * + * We have different timing rules for different types of + * packets so they are put into different queues. + * + * High Priority - + * + * Packets which are being digipeated go out first. + * Latest recommendations are to retransmit these + * immdediately (after no one else is heard, of course) + * rather than waiting random times to avoid collisions. + * The KPC-3 configuration option for this is "UIDWAIT OFF". + * + * Low Priority - + * + * Other packets are sent after a random wait time + * (determined by PERSIST & SLOTTIME) to help avoid + * collisions. + * + * Each audio channel has its own queue. + * + *--------------------------------------------------------------------*/ + + +static struct audio_s *save_audio_config_p; + + + +void tq_init (struct audio_s *audio_config_p) +{ + int c, p; + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("tq_init ( )\n"); +#endif + + save_audio_config_p = audio_config_p; + + for (c=0; cchan_medium[c] == MEDIUM_RADIO) { + + wake_up_event[c] = CreateEvent (NULL, 0, 0, NULL); + + if (wake_up_event[c] == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("tq_init: CreateEvent: can't create transmit wake up event, c=%d", c); + exit (1); + } + } + } + +#else + int err; + + for (c = 0; c < MAX_CHANS; c++) { + + xmit_thread_is_waiting[c] = 0; + + if (audio_config_p->chan_medium[c] == MEDIUM_RADIO) { + err = pthread_cond_init (&(wake_up_cond[c]), NULL); + if (err != 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("tq_init: pthread_cond_init c=%d err=%d", c, err); + perror (""); + exit (1); + } + + dw_mutex_init(&(wake_up_mutex[c])); + } + } + +#endif + +} /* end tq_init */ + + +/*------------------------------------------------------------------- + * + * Name: tq_append + * + * Purpose: Add an APRS packet to the end of the specified transmit queue. + * + * Connected mode is a little different. Use lm_data_request instead. + * + * Inputs: chan - Channel, 0 is first. + * + * New in 1.7: + * Channel can be assigned to IGate rather than a radio. + * + * prio - Priority, use TQ_PRIO_0_HI for digipeated or + * TQ_PRIO_1_LO for normal. + * + * pp - Address of packet object. + * Caller should NOT make any references to + * it after this point because it could + * be deleted at any time. + * + * Outputs: + * + * Description: Add packet to end of linked list. + * Signal the transmit thread if the queue was formerly empty. + * + * Note that we have a transmit thread each audio channel. + * Two channels can share one audio output device. + * + * IMPORTANT! Don't make an further references to the packet object after + * giving it to tq_append. + * + *--------------------------------------------------------------------*/ + +void tq_append (int chan, int prio, packet_t pp) +{ + packet_t plast; + packet_t pnext; + + +#if DEBUG + unsigned char *pinfo; + int info_len = ax25_get_info (pp, &pinfo); + if (info_len > 10) info_len = 10; + text_color_set(DW_COLOR_DEBUG); + dw_printf ("tq_append (chan=%d, prio=%d, pp=%p) \"%*s\"\n", chan, prio, pp, info_len, (char*)pinfo); +#endif + + + assert (prio >= 0 && prio < TQ_NUM_PRIO); + + if (pp == NULL) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("INTERNAL ERROR: tq_append NULL packet pointer. Please report this!\n"); + return; + } + +#if AX25MEMDEBUG + + if (ax25memdebug_get()) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("tq_append (chan=%d, prio=%d, seq=%d)\n", chan, prio, ax25memdebug_seq(pp)); + } +#endif + +// New in 1.7 - A channel can be assigned to the IGate rather than a radio. + +#ifndef DIGITEST // avoid dtest link error + + if (save_audio_config_p->chan_medium[chan] == MEDIUM_IGATE) { + + char ts[100]; // optional time stamp. + + if (strlen(save_audio_config_p->timestamp_format) > 0) { + char tstmp[100]; + timestamp_user_format (tstmp, sizeof(tstmp), save_audio_config_p->timestamp_format); + strlcpy (ts, " ", sizeof(ts)); // space after channel. + strlcat (ts, tstmp, sizeof(ts)); + } + else { + strlcpy (ts, "", sizeof(ts)); + } + + char stemp[256]; // Formated addresses. + ax25_format_addrs (pp, stemp); + unsigned char *pinfo; + int info_len = ax25_get_info (pp, &pinfo); + text_color_set(DW_COLOR_XMIT); + dw_printf ("[%d>is%s] ", chan, ts); + dw_printf ("%s", stemp); /* stations followed by : */ + ax25_safe_print ((char *)pinfo, info_len, ! ax25_is_aprs(pp)); + dw_printf ("\n"); + + igate_send_rec_packet (chan, pp); + ax25_delete(pp); + return; + } +#endif + +// Normal case - put in queue for radio transmission. +// Error if trying to transmit to a radio channel which was not configured. + + if (chan < 0 || chan >= MAX_CHANS || save_audio_config_p->chan_medium[chan] == MEDIUM_NONE) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("ERROR - Request to transmit on invalid radio channel %d.\n", chan); + dw_printf ("This is probably a client application error, not a problem with direwolf.\n"); + dw_printf ("Are you using AX.25 for Linux? It might be trying to use a modified\n"); + dw_printf ("version of KISS which uses the port field differently than the\n"); + dw_printf ("original KISS protocol specification. The solution might be to use\n"); + dw_printf ("a command like \"kissparms -c 1 -p radio\" to set CRC none mode.\n"); + dw_printf ("\n"); + ax25_delete(pp); + return; + } + +/* + * Is transmit queue out of control? + * + * There is no technical reason to limit the transmit packet queue length, it just seemed like a good + * warning that something wasn't right. + * When this was written, I was mostly concerned about APRS where packets would only be sent + * occasionally and they can be discarded if they can't be sent out in a reasonable amount of time. + * + * If a large file is being sent, with TCP/IP, it is perfectly reasonable to have a large number + * of packets waiting for transmission. + * + * Ideally, the application should be able to throttle the transmissions so the queue doesn't get too long. + * If using the KISS interface, there is no way to get this information from the TNC back to the client app. + * The AGW network interface does have a command 'y' to query about the number of frames waiting for transmission. + * This was implemented in version 1.2. + * + * I'd rather not take out the queue length check because it is a useful sanity check for something going wrong. + * Maybe the check should be performed only for APRS packets. + * The check would allow an unlimited number of other types. + * + * Limit was 20. Changed to 100 in version 1.2 as a workaround. + */ + + if (ax25_is_aprs(pp) && tq_count(chan,prio,"","",0) > 100) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Transmit packet queue for channel %d is too long. Discarding packet.\n", chan); + dw_printf ("Perhaps the channel is so busy there is no opportunity to send.\n"); + ax25_delete(pp); + return; + } + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("tq_append: enter critical section\n"); +#endif + + dw_mutex_lock (&tq_mutex); + + if (queue_head[chan][prio] == NULL) { + queue_head[chan][prio] = pp; + } + else { + plast = queue_head[chan][prio]; + while ((pnext = ax25_get_nextp(plast)) != NULL) { + plast = pnext; + } + ax25_set_nextp (plast, pp); + } + + dw_mutex_unlock (&tq_mutex); + + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("tq_append: left critical section\n"); + dw_printf ("tq_append (): about to wake up xmit thread.\n"); +#endif + +#if __WIN32__ + SetEvent (wake_up_event[chan]); +#else + if (xmit_thread_is_waiting[chan]) { + int err; + + dw_mutex_lock (&(wake_up_mutex[chan])); + + err = pthread_cond_signal (&(wake_up_cond[chan])); + if (err != 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("tq_append: pthread_cond_signal err=%d", err); + perror (""); + exit (1); + } + + dw_mutex_unlock (&(wake_up_mutex[chan])); + } +#endif + +} /* end tq_append */ + + + +/*------------------------------------------------------------------- + * + * Name: lm_data_request + * + * Purpose: Add an AX.25 frame to the end of the specified transmit queue. + * + * Use tq_append instead for APRS. + * + * Inputs: chan - Channel, 0 is first. + * + * prio - Priority, use TQ_PRIO_0_HI for priority (expedited) + * or TQ_PRIO_1_LO for normal. + * + * pp - Address of packet object. + * Caller should NOT make any references to + * it after this point because it could + * be deleted at any time. + * + * Outputs: A packet object is added to transmit queue. + * + * Description: 5.4. + * + * LM-DATA Request. The Data-link State Machine uses this primitive to pass + * frames of any type (SABM, RR, UI, etc.) to the Link Multiplexer State Machine. + * + * LM-EXPEDITED-DATA Request. The data-link machine uses this primitive to + * request transmission of each digipeat or expedite data frame. + * + * C2a.1 + * + * PH-DATA Request. This primitive from the Link Multiplexer State Machine + * provides an AX.25 frame of any type (UI, SABM, I, etc.) that is to be transmitted. An + * unlimited number of frames may be provided. If the transmission exceeds the 10- + * minute limit or the anti-hogging time limit, the half-duplex Physical State Machine + * automatically relinquishes the channel for use by the other stations. The + * transmission is automatically resumed at the next transmission opportunity + * indicated by the CSMA/p-persistence contention algorithm. + * + * PH-EXPEDITED-DATA Request. This primitive from the Link Multiplexer State + * Machine provides the AX.25 frame that is to be transmitted immediately. The + * simplex Physical State Machine gives preference to priority frames over normal + * frames, and will take advantage of the PRIACK window. Priority frames can be + * provided by the link multiplexer at any time; a PH-SEIZE Request and subsequent + * PH Release Request are not employed for priority frames. + * + * C3.1 + * + * LM-DATA Request. This primitive from the Data-link State Machine provides a + * AX.25 frame of any type (UI, SABM, I, etc.) that is to be transmitted. An unlimited + * number of frames may be provided. The Link Multiplexer State Machine + * accumulates the frames in a first-in, first-out queue until it is time to transmit them. + * + * C4.2 + * + * LM-DATA Request. This primitive is used by the Data link State Machines to pass + * frames of any type (SABM, RR, UI, etc.) to the Link Multiplexer State Machine. + * + * LM-EXPEDITED-DATA Request. This primitive is used by the Data link State + * Machine to pass expedited data to the link multiplexer. + * + * + * Implementation: Add packet to end of linked list. + * Signal the transmit thread if the queue was formerly empty. + * + * Note that we have a transmit thread each audio channel. + * Two channels can share one audio output device. + * + * IMPORTANT! Don't make an further references to the packet object after + * giving it to lm_data_request. + * + *--------------------------------------------------------------------*/ + + +// TODO: FIXME: this is a copy of tq_append. Need to fine tune and explain why. + + +void lm_data_request (int chan, int prio, packet_t pp) +{ + packet_t plast; + packet_t pnext; + + +#if DEBUG + unsigned char *pinfo; + int info_len = ax25_get_info (pp, &pinfo); + if (info_len > 10) info_len = 10; + text_color_set(DW_COLOR_DEBUG); + dw_printf ("lm_data_request (chan=%d, prio=%d, pp=%p) \"%*s\"\n", chan, prio, pp, info_len, (char*)pinfo); +#endif + + + assert (prio >= 0 && prio < TQ_NUM_PRIO); + + if (pp == NULL) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("INTERNAL ERROR: lm_data_request NULL packet pointer. Please report this!\n"); + return; + } + +#if AX25MEMDEBUG + + if (ax25memdebug_get()) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("lm_data_request (chan=%d, prio=%d, seq=%d)\n", chan, prio, ax25memdebug_seq(pp)); + } +#endif + + if (chan < 0 || chan >= MAX_CHANS || save_audio_config_p->chan_medium[chan] != MEDIUM_RADIO) { + // Connected mode is allowed only with internal modems. + text_color_set(DW_COLOR_ERROR); + dw_printf ("ERROR - Request to transmit on invalid radio channel %d.\n", chan); + dw_printf ("Connected packet mode is allowed only with internal modems.\n"); + dw_printf ("Why aren't external KISS modems allowed? See\n"); + dw_printf ("Why-is-9600-only-twice-as-fast-as-1200.pdf for explanation.\n"); + ax25_delete(pp); + return; + } + +/* + * Is transmit queue out of control? + */ + + if (tq_count(chan,prio,"","",0) > 250) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Warning: Transmit packet queue for channel %d is extremely long.\n", chan); + dw_printf ("Perhaps the channel is so busy there is no opportunity to send.\n"); + } + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("lm_data_request: enter critical section\n"); +#endif + + dw_mutex_lock (&tq_mutex); + + + if (queue_head[chan][prio] == NULL) { + queue_head[chan][prio] = pp; + } + else { + plast = queue_head[chan][prio]; + while ((pnext = ax25_get_nextp(plast)) != NULL) { + plast = pnext; + } + ax25_set_nextp (plast, pp); + } + + dw_mutex_unlock (&tq_mutex); + + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("lm_data_request: left critical section\n"); +#endif + + // Appendix C2a, from the Ax.25 protocol spec, says that a priority frame + // will start transmission. If not already transmitting, normal frames + // will pile up until LM-SEIZE Request starts transmission. + + +// Erratum: It doesn't take long for that to fail. +// We send SABM(e) frames to the transmit queue and the transmitter doesn't get activated. + + +//NO! if (prio == TQ_PRIO_0_HI) { + +#if DEBUG + dw_printf ("lm_data_request (): about to wake up xmit thread.\n"); +#endif +#if __WIN32__ + SetEvent (wake_up_event[chan]); +#else + if (xmit_thread_is_waiting[chan]) { + int err; + + dw_mutex_lock (&(wake_up_mutex[chan])); + + err = pthread_cond_signal (&(wake_up_cond[chan])); + if (err != 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("lm_data_request: pthread_cond_signal err=%d", err); + perror (""); + exit (1); + } + + dw_mutex_unlock (&(wake_up_mutex[chan])); + } +#endif +//NO! } + +} /* end lm_data_request */ + + + + +/*------------------------------------------------------------------- + * + * Name: lm_seize_request + * + * Purpose: Force start of transmit even if transmit queue is empty. + * + * Inputs: chan - Channel, 0 is first. + * + * Description: 5.4. + * + * LM-SEIZE Request. The Data-link State Machine uses this primitive to request the + * Link Multiplexer State Machine to arrange for transmission at the next available + * opportunity. The Data-link State Machine uses this primitive when an + * acknowledgement must be made; the exact frame in which the acknowledgement + * is sent will be chosen when the actual time for transmission arrives. + * + * C2a.1 + * + * PH-SEIZE Request. This primitive requests the simplex state machine to begin + * transmitting at the next available opportunity. When that opportunity has been + * identified (according to the CSMA/p-persistence algorithm included within), the + * transmitter started, a parameterized window provided for the startup of a + * conventional repeater (if required), and a parameterized time allowed for the + * synchronization of the remote station's receiver (known as TXDELAY in most + * implementations), then a PH-SEIZE Confirm primitive is returned to the link + * multiplexer. + * + * C3.1 + * + * LM-SEIZE Request. This primitive requests the Link Multiplexer State Machine to + * arrange for transmission at the next available opportunity. The Data-link State + * Machine uses this primitive when an acknowledgment must be made, but the exact + * frame in which the acknowledgment will be sent will be chosen when the actual + * time for transmission arrives. The Link Multiplexer State Machine uses the LMSEIZE + * Confirm primitive to indicate that the transmission opportunity has arrived. + * After the Data-link State Machine has provided the acknowledgment, the Data-link + * State Machine gives permission to stop transmission with the LM Release Request + * primitive. + * + * C4.2 + * + * LM-SEIZE Request. This primitive is used by the Data link State Machine to + * request the Link Multiplexer State Machine to arrange for transmission at the next + * available opportunity. The Data link State Machine uses this primitive when an + * acknowledgment must be made, but the exact frame in which the acknowledgment + * is sent will be chosen when the actual time for transmission arrives. + * + * + * Implementation: Add a null frame (i.e. length of 0) to give the process a kick. + * xmit.c needs to be smart enough to discard it. + * + *--------------------------------------------------------------------*/ + + +void lm_seize_request (int chan) +{ + packet_t pp; + int prio = TQ_PRIO_1_LO; + + packet_t plast; + packet_t pnext; + + +#if DEBUG + unsigned char *pinfo; + text_color_set(DW_COLOR_DEBUG); + dw_printf ("lm_seize_request (chan=%d)\n", chan); +#endif + + + if (chan < 0 || chan >= MAX_CHANS || save_audio_config_p->chan_medium[chan] != MEDIUM_RADIO) { + // Connected mode is allowed only with internal modems. + text_color_set(DW_COLOR_ERROR); + dw_printf ("ERROR - Request to transmit on invalid radio channel %d.\n", chan); + dw_printf ("Connected packet mode is allowed only with internal modems.\n"); + dw_printf ("Why aren't external KISS modems allowed? See\n"); + dw_printf ("Why-is-9600-only-twice-as-fast-as-1200.pdf for explanation.\n"); + return; + } + + pp = ax25_new(); + +#if AX25MEMDEBUG + + if (ax25memdebug_get()) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("lm_seize_request (chan=%d, seq=%d)\n", chan, ax25memdebug_seq(pp)); + } +#endif + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("lm_seize_request: enter critical section\n"); +#endif + + dw_mutex_lock (&tq_mutex); + + + if (queue_head[chan][prio] == NULL) { + queue_head[chan][prio] = pp; + } + else { + plast = queue_head[chan][prio]; + while ((pnext = ax25_get_nextp(plast)) != NULL) { + plast = pnext; + } + ax25_set_nextp (plast, pp); + } + + dw_mutex_unlock (&tq_mutex); + + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("lm_seize_request: left critical section\n"); +#endif + + +#if DEBUG + dw_printf ("lm_seize_request (): about to wake up xmit thread.\n"); +#endif +#if __WIN32__ + SetEvent (wake_up_event[chan]); +#else + if (xmit_thread_is_waiting[chan]) { + int err; + + dw_mutex_lock (&(wake_up_mutex[chan])); + + err = pthread_cond_signal (&(wake_up_cond[chan])); + if (err != 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("lm_seize_request: pthread_cond_signal err=%d", err); + perror (""); + exit (1); + } + + dw_mutex_unlock (&(wake_up_mutex[chan])); + } +#endif + +} /* end lm_seize_request */ + + + + +/*------------------------------------------------------------------- + * + * Name: tq_wait_while_empty + * + * Purpose: Sleep while the transmit queue is empty rather than + * polling periodically. + * + * Inputs: chan - Audio device number. + * + * Description: We have one transmit thread for each audio device. + * This handles 1 or 2 channels. + * + *--------------------------------------------------------------------*/ + + +void tq_wait_while_empty (int chan) +{ + int is_empty; + + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("tq_wait_while_empty (%d) : enter critical section\n", chan); +#endif + assert (chan >= 0 && chan < MAX_CHANS); + + dw_mutex_lock (&tq_mutex); + +#if DEBUG + //text_color_set(DW_COLOR_DEBUG); + //dw_printf ("tq_wait_while_empty (%d): after pthread_mutex_lock\n", chan); +#endif + is_empty = tq_is_empty(chan); + + dw_mutex_unlock (&tq_mutex); + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("tq_wait_while_empty (%d) : left critical section\n", chan); +#endif + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("tq_wait_while_empty (%d): is_empty = %d\n", chan, is_empty); +#endif + + if (is_empty) { +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("tq_wait_while_empty (%d): SLEEP - about to call cond wait\n", chan); +#endif + + +#if __WIN32__ + WaitForSingleObject (wake_up_event[chan], INFINITE); + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("tq_wait_while_empty (): returned from wait\n"); +#endif + +#else + dw_mutex_lock (&(wake_up_mutex[chan])); + + xmit_thread_is_waiting[chan] = 1; + int err; + err = pthread_cond_wait (&(wake_up_cond[chan]), &(wake_up_mutex[chan])); + xmit_thread_is_waiting[chan] = 0; + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("tq_wait_while_empty (%d): WOKE UP - returned from cond wait, err = %d\n", chan, err); +#endif + + if (err != 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("tq_wait_while_empty (%d): pthread_cond_wait err=%d", chan, err); + perror (""); + exit (1); + } + + dw_mutex_unlock (&(wake_up_mutex[chan])); +#endif + } + + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("tq_wait_while_empty (%d) returns\n", chan); +#endif + +} + + +/*------------------------------------------------------------------- + * + * Name: tq_remove + * + * Purpose: Remove a packet from the head of the specified transmit queue. + * + * Inputs: chan - Channel, 0 is first. + * + * prio - Priority, use TQ_PRIO_0_HI or TQ_PRIO_1_LO. + * + * Returns: Pointer to packet object. + * Caller should destroy it with ax25_delete when finished with it. + * + *--------------------------------------------------------------------*/ + +packet_t tq_remove (int chan, int prio) +{ + + packet_t result_p; + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("tq_remove(%d,%d) enter critical section\n", chan, prio); +#endif + + dw_mutex_lock (&tq_mutex); + + if (queue_head[chan][prio] == NULL) { + + result_p = NULL; + } + else { + + result_p = queue_head[chan][prio]; + queue_head[chan][prio] = ax25_get_nextp(result_p); + ax25_set_nextp (result_p, NULL); + } + + dw_mutex_unlock (&tq_mutex); + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("tq_remove(%d,%d) leave critical section, returns %p\n", chan, prio, result_p); +#endif + +#if AX25MEMDEBUG + + if (ax25memdebug_get() && result_p != NULL) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("tq_remove (chan=%d, prio=%d) seq=%d\n", chan, prio, ax25memdebug_seq(result_p)); + } +#endif + return (result_p); + +} /* end tq_remove */ + + + +/*------------------------------------------------------------------- + * + * Name: tq_peek + * + * Purpose: Take a peek at the next frame in the queue but don't remove it. + * + * Inputs: chan - Channel, 0 is first. + * + * prio - Priority, use TQ_PRIO_0_HI or TQ_PRIO_1_LO. + * + * Returns: Pointer to packet object or NULL. + * + * Caller should NOT destroy it because it is still in the queue. + * + *--------------------------------------------------------------------*/ + +packet_t tq_peek (int chan, int prio) +{ + + packet_t result_p; + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("tq_peek(%d,%d) enter critical section\n", chan, prio); +#endif + + // I don't think we need critical region here. + //dw_mutex_lock (&tq_mutex); + + result_p = queue_head[chan][prio]; + // Just take a peek at the head. Don't remove it. + + //dw_mutex_unlock (&tq_mutex); + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("tq_remove(%d,%d) leave critical section, returns %p\n", chan, prio, result_p); +#endif + +#if AX25MEMDEBUG + + if (ax25memdebug_get() && result_p != NULL) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("tq_remove (chan=%d, prio=%d) seq=%d\n", chan, prio, ax25memdebug_seq(result_p)); + } +#endif + return (result_p); + +} /* end tq_peek */ + + + +/*------------------------------------------------------------------- + * + * Name: tq_is_empty + * + * Purpose: Test if queues for specified channel are empty. + * + * Inputs: chan Channel + * + * Returns: True if nothing in the queue. + * + *--------------------------------------------------------------------*/ + +static int tq_is_empty (int chan) +{ + int p; + + assert (chan >= 0 && chan < MAX_CHANS); + + + for (p=0; p= 0 && p < TQ_NUM_PRIO); + + if (queue_head[chan][p] != NULL) + return (0); + } + + return (1); + +} /* end tq_is_empty */ + + +/*------------------------------------------------------------------- + * + * Name: tq_count + * + * Purpose: Return count of the number of packets (or bytes) in the specified transmit queue. + * This is used only for queries from KISS or AWG client applications. + * + * Inputs: chan - Channel, 0 is first. + * + * prio - Priority, use TQ_PRIO_0_HI or TQ_PRIO_1_LO. + * Specify -1 for total of both. + * + * source - If specified, count only those with this source address. + * + * dest - If specified, count only those with this destination address. + * + * bytes - If true, return number of bytes rather than packets. + * + * Returns: Number of items in specified queue. + * + *--------------------------------------------------------------------*/ + +//#define DEBUG2 1 + + +int tq_count (int chan, int prio, char *source, char *dest, int bytes) +{ + + +#if DEBUG2 + text_color_set(DW_COLOR_DEBUG); + dw_printf ("tq_count(chan=%d, prio=%d, source=\"%s\", dest=\"%s\", bytes=%d)\n", chan, prio, source, dest, bytes); +#endif + + if (prio == -1) { + return (tq_count(chan, TQ_PRIO_0_HI, source, dest, bytes) + + tq_count(chan, TQ_PRIO_1_LO, source, dest, bytes)); + } + + // Array bounds check. FIXME: TODO: should have internal error instead of dying. + + if (chan < 0 || chan >= MAX_CHANS || prio < 0 || prio >= TQ_NUM_PRIO) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("INTERNAL ERROR - tq_count(%d, %d, \"%s\", \"%s\", %d)\n", chan, prio, source, dest, bytes); + return (0); + } + + if (queue_head[chan][prio] == 0) { +#if DEBUG2 + text_color_set(DW_COLOR_DEBUG); + dw_printf ("tq_count: queue chan %d, prio %d is empty, returning 0.\n", chan, prio); +#endif + return (0); + } + + // Don't want lists being rearranged while we are traversing them. + + dw_mutex_lock (&tq_mutex); + + int n = 0; // Result. Number of bytes or packets. + packet_t pp = queue_head[chan][prio];; + + while (pp != NULL) { + if (ax25_get_num_addr(pp) >= AX25_MIN_ADDRS) { + // Consider only real packets. + + int count_it = 1; + + if (source != NULL && *source != '\0') { + char frame_source[AX25_MAX_ADDR_LEN]; + ax25_get_addr_with_ssid (pp, AX25_SOURCE, frame_source); +#if DEBUG2 + // I'm cringing at the thought of printing while in a critical region. But it's only for temp debug. :-( + text_color_set(DW_COLOR_DEBUG); + dw_printf ("tq_count: compare to frame source %s\n", frame_source); +#endif + if (strcmp(source,frame_source) != 0) count_it = 0; + } + if (count_it && dest != NULL && *dest != '\0') { + char frame_dest[AX25_MAX_ADDR_LEN]; + ax25_get_addr_with_ssid (pp, AX25_DESTINATION, frame_dest); +#if DEBUG2 + // I'm cringing at the thought of printing while in a critical region. But it's only for debug debug. :-( + text_color_set(DW_COLOR_DEBUG); + dw_printf ("tq_count: compare to frame destination %s\n", frame_dest); +#endif + if (strcmp(dest,frame_dest) != 0) count_it = 0; + } + + if (count_it) { + if (bytes) { + n += ax25_get_frame_len(pp); + } + else { + n++; + } + } + } + pp = ax25_get_nextp(pp); + } + + dw_mutex_unlock (&tq_mutex); + +#if DEBUG2 + text_color_set(DW_COLOR_DEBUG); + dw_printf ("tq_count(%d, %d, \"%s\", \"%s\", %d) returns %d\n", chan, prio, source, dest, bytes, n); +#endif + + return (n); + +} /* end tq_count */ + +/* end tq.c */ diff --git a/tq.h b/src/tq.h similarity index 65% rename from tq.h rename to src/tq.h index ff1d73f7..37599d59 100644 --- a/tq.h +++ b/src/tq.h @@ -20,15 +20,21 @@ -void tq_init (int nchan); +void tq_init (struct audio_s *audio_config_p); void tq_append (int chan, int prio, packet_t pp); -void tq_wait_while_empty (void); +void lm_data_request (int chan, int prio, packet_t pp); + +void lm_seize_request (int chan); + +void tq_wait_while_empty (int chan); packet_t tq_remove (int chan, int prio); -int tq_count (int chan, int prio); +packet_t tq_peek (int chan, int prio); + +int tq_count (int chan, int prio, char *source, char *dest, int bytes); #endif diff --git a/src/tt_text.c b/src/tt_text.c new file mode 100644 index 00000000..112adfe5 --- /dev/null +++ b/src/tt_text.c @@ -0,0 +1,1830 @@ +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// +// Copyright (C) 2013, 2015 John Langner, WB2OSZ +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . +// + +/*------------------------------------------------------------------ + * + * Module: tt_text.c + * + * Purpose: Translate between text and touch tone representation. + * + * Description: Letters can be represented by different touch tone + * keypad sequences. + * + * References: This is based upon APRStt (TM) documents but not 100% + * compliant due to ambiguities and inconsistencies in + * the specifications. + * + * http://www.aprs.org/aprstt.html + * + *---------------------------------------------------------------*/ + +/* + * There are two different encodings called: + * + * * Two-key + * + * Digits are represented by a single key press. + * Letters (or space) are represented by the corresponding + * key followed by A, B, C, or D depending on the position + * of the letter. + * + * * Multi-press + * + * Letters are represented by one or more key presses + * depending on their position. + * e.g. on 5/JKL key, J = 1 press, K = 2, etc. + * The digit is the number of letters plus 1. + * In this case, press 5 key four times to get digit 5. + * When two characters in a row use the same key, + * use the "A" key as a separator. + * + * Examples: + * + * Character Multipress Two Key Comments + * --------- ---------- ------- -------- + * 0 00 0 Space is handled like a letter. + * 1 1 1 No letters on 1 button. + * 2 2222 2 3 letters -> 4 key presses + * 9 99999 9 + * W 9 9A + * X 99 9B + * Y 999 9C + * Z 9999 9D + * space 0 0A 0A was used in an APRStt comment example. + * + * + * Note that letters can occur in callsigns and comments. + * Everywhere else they are simply digits. + * + * + * * New fixed length callsign format + * + * + * The "QIKcom-2" project adds a new format where callsigns are represented by + * a fixed length string of only digits. The first 6 digits are the buttons corresponding + * to the letters. The last 4 take a little calculation. Example: + * + * W B 4 A P R original. + * 9 2 4 2 7 7 corresponding button. + * 1 2 0 1 1 2 character position on key. 0 for the digit. + * + * Treat the last line as a base 4 number. + * Convert it to base 10 and we get 1558 for the last four digits. + */ + +/* + * Everything is based on this table. + * Changing it will change everything. + * In other words, don't mess with it. + * The world will come crumbling down. + */ + +static const char translate[10][4] = { + /* A B C D */ + /* --- --- --- --- */ + /* 0 */ { ' ', 0, 0, 0 }, + /* 1 */ { 0, 0, 0, 0 }, + /* 2 */ { 'A', 'B', 'C', 0 }, + /* 3 */ { 'D', 'E', 'F', 0 }, + /* 4 */ { 'G', 'H', 'I', 0 }, + /* 5 */ { 'J', 'K', 'L', 0 }, + /* 6 */ { 'M', 'N', 'O', 0 }, + /* 7 */ { 'P', 'Q', 'R', 'S' }, + /* 8 */ { 'T', 'U', 'V', 0 }, + /* 9 */ { 'W', 'X', 'Y', 'Z' } }; + + +/* + * This is for the new 10 character fixed length callsigns for APRStt 3. + * Notice that it uses an old keypad layout with Q & Z on the 1 button. + * The TH-D72A and all telephones that I could find all have + * four letters each on the 7 and 9 buttons. + * This inconsistency is sure to cause confusion but the 6+4 scheme won't + * be possible with more than 4 characters assigned to one button. + * 4**6-1 = 4096 which fits in 4 decimal digits. + * 5**6-1 = 15624 would not fit. + * + * The column is a two bit code packed into the last 4 digits. + */ + +static const char call10encoding[10][4] = { + /* 0 1 2 3 */ + /* --- --- --- --- */ + /* 0 */ { '0', ' ', 0, 0 }, + /* 1 */ { '1', 'Q', 'Z', 0 }, + /* 2 */ { '2', 'A', 'B', 'C' }, + /* 3 */ { '3', 'D', 'E', 'F' }, + /* 4 */ { '4', 'G', 'H', 'I' }, + /* 5 */ { '5', 'J', 'K', 'L' }, + /* 6 */ { '6', 'M', 'N', 'O' }, + /* 7 */ { '7', 'P', 'R', 'S' }, + /* 8 */ { '8', 'T', 'U', 'V' }, + /* 9 */ { '9', 'W', 'X', 'Y' } }; + + +/* + * Special satellite 4 digit gridsquares to cover "99.99% of the world's population." + */ + +static const char grid[10][10][3] = + { { "AP", "BP", "AO", "BO", "CO", "DO", "EO", "FO", "GO", "OJ" }, // 0 - Canada + { "CN", "DN", "EN", "FN", "GN", "CM", "DM", "EM", "FM", "OI" }, // 1 - USA + { "DL", "EL", "FL", "DK", "EK", "FK", "EJ", "FJ", "GJ", "PI" }, // 2 - C. America + { "FI", "GI", "HI", "FH", "GH", "HH", "FG", "GG", "FF", "GF" }, // 3 - S. America + { "JP", "IO", "JO", "KO", "IN", "JN", "KN", "IM", "JM", "KM" }, // 4 - Europe + { "LO", "MO", "NO", "OO", "PO", "QO", "RO", "LN", "MN", "NN" }, // 5 - Russia + { "ON", "PN", "QN", "OM", "PM", "QM", "OL", "PL", "OK", "PK" }, // 6 - Japan, China + { "LM", "MM", "NM", "LL", "ML", "NL", "LK", "MK", "NK", "LJ" }, // 7 - India + { "PH", "QH", "OG", "PG", "QG", "OF", "PF", "QF", "RF", "RE" }, // 8 - Aus / NZ + { "IL", "IK", "IJ", "JJ", "JI", "JH", "JG", "KG", "JF", "KF" } }; // 9 - Africa + +#include "direwolf.h" + +#include +#include +#include +#include +#include +#include + +#include "textcolor.h" +#include "tt_text.h" + + +#if defined(ENC_MAIN) || defined(DEC_MAIN) + +void text_color_set (dw_color_t c) { return; } + +int dw_printf (const char *fmt, ...) +{ + va_list args; + int len; + + va_start (args, fmt); + len = vprintf (fmt, args); + va_end (args); + return (len); +} + +#endif + + +/*------------------------------------------------------------------ + * + * Name: tt_text_to_multipress + * + * Purpose: Convert text to the multi-press representation. + * + * Inputs: text - Input string. + * Should contain only digits, letters, or space. + * All other punctuation is treated as space. + * + * quiet - True to suppress error messages. + * + * Outputs: buttons - Sequence of buttons to press. + * + * Returns: Number of errors detected. + * + *----------------------------------------------------------------*/ + +int tt_text_to_multipress (const char *text, int quiet, char *buttons) +{ + const char *t = text; + char *b = buttons; + char c; + int row, col; + int errors = 0; + int found; + int n; + + *b = '\0'; + + while ((c = *t++) != '\0') { + + if (isdigit(c)) { + +/* Count number of other characters assigned to this button. */ +/* Press that number plus one more. */ + + n = 1; + row = c - '0'; + for (col=0; col<4; col++) { + if (translate[row][col] != 0) { + n++; + } + } + if (buttons[0] != '\0' && *(b-1) == row + '0') { + *b++ = 'A'; + } + while (n--) { + *b++ = row + '0'; + *b = '\0'; + } + } + else { + if (isupper(c)) { + ; + } + else if (islower(c)) { + c = toupper(c); + } + else if (c != ' ') { + errors++; + if (! quiet) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("Text to multi-press: Only letters, digits, and space allowed.\n"); + } + c = ' '; + } + +/* Search for everything else in the translation table. */ +/* Press number of times depending on column where found. */ + + found = 0; + + for (row=0; row<10 && ! found; row++) { + for (col=0; col<4 && ! found; col++) { + if (c == translate[row][col]) { + +/* Stick in 'A' if previous character used same button. */ + + if (buttons[0] != '\0' && *(b-1) == row + '0') { + *b++ = 'A'; + } + n = col + 1; + while (n--) { + *b++ = row + '0'; + *b = '\0'; + found = 1; + } + } + } + } + if (! found) { + errors++; + text_color_set (DW_COLOR_ERROR); + dw_printf ("Text to multi-press: INTERNAL ERROR. Should not be here.\n"); + } + } + } + return (errors); + +} /* end tt_text_to_multipress */ + + +/*------------------------------------------------------------------ + * + * Name: tt_text_to_two_key + * + * Purpose: Convert text to the two-key representation. + * + * Inputs: text - Input string. + * Should contain only digits, letters, or space. + * All other punctuation is treated as space. + * + * quiet - True to suppress error messages. + * + * Outputs: buttons - Sequence of buttons to press. + * + * Returns: Number of errors detected. + * + *----------------------------------------------------------------*/ + +int tt_text_to_two_key (const char *text, int quiet, char *buttons) +{ + const char *t = text; + char *b = buttons; + char c; + int row, col; + int errors = 0; + int found; + + + *b = '\0'; + + while ((c = *t++) != '\0') { + + if (isdigit(c)) { + +/* Digit is single key press. */ + + *b++ = c; + *b = '\0'; + } + else { + if (isupper(c)) { + ; + } + else if (islower(c)) { + c = toupper(c); + } + else if (c != ' ') { + errors++; + if (! quiet) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("Text to two key: Only letters, digits, and space allowed.\n"); + } + c = ' '; + } + +/* Search for everything else in the translation table. */ + + found = 0; + + for (row=0; row<10 && ! found; row++) { + for (col=0; col<4 && ! found; col++) { + if (c == translate[row][col]) { + *b++ = '0' + row; + *b++ = 'A' + col; + *b = '\0'; + found = 1; + } + } + } + if (! found) { + errors++; + text_color_set (DW_COLOR_ERROR); + dw_printf ("Text to two-key: INTERNAL ERROR. Should not be here.\n"); + } + } + } + return (errors); + +} /* end tt_text_to_two_key */ + + +/*------------------------------------------------------------------ + * + * Name: tt_letter_to_two_digits + * + * Purpose: Convert one letter to 2 digit representation. + * + * Inputs: c - One letter. + * + * quiet - True to suppress error messages. + * + * Outputs: buttons - Sequence of two buttons to press. + * "00" for error because this is probably + * being used to build up a fixed length + * string where positions are significant. + * Must be at least 3 bytes. + * + * Returns: Number of errors detected. + * + *----------------------------------------------------------------*/ + + +// TODO: need to test this. + +int tt_letter_to_two_digits (char c, int quiet, char buttons[3]) +{ + int row, col; + int errors = 0; + int found; + + strlcpy(buttons, "", 3); + + if (islower(c)) { + c = toupper(c); + } + + if ( ! isupper(c)) { + errors++; + if (! quiet) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("Letter to two digits: \"%c\" found where a letter is required.\n", c); + } + strlcpy (buttons, "00", 3); + return (errors); + } + +/* Search in the translation table. */ + + found = 0; + + for (row=0; row<10 && ! found; row++) { + for (col=0; col<4 && ! found; col++) { + if (c == translate[row][col]) { + buttons[0] = '0' + row; + buttons[1] = '1' + col; + buttons[2] = '\0'; + found = 1; + } + } + } + if (! found) { + errors++; + text_color_set (DW_COLOR_ERROR); + dw_printf ("Letter to two digits: INTERNAL ERROR. Should not be here.\n"); + strlcpy (buttons, "00", 3); + } + + return (errors); + +} /* end tt_letter_to_two_digits */ + + +/*------------------------------------------------------------------ + * + * Name: tt_text_to_call10 + * + * Purpose: Convert text to the 10 character callsign format. + * + * Inputs: text - Input string. + * Should contain from 1 to 6 letters and digits. + * + * quiet - True to suppress error messages. + * + * Outputs: buttons - Sequence of buttons to press. + * Should be exactly 10 unless error. + * + * Returns: Number of errors detected. + * + *----------------------------------------------------------------*/ + +int tt_text_to_call10 (const char *text, int quiet, char *buttons) +{ + const char *t; + char *b; + char c; + int packed; /* two bits per character */ + int row, col; + int errors = 0; + int found; + char padded[8]; + char stemp[11]; + + // FIXME: Add parameter for sizeof buttons and use strlcpy + strcpy (buttons, ""); + +/* Quick validity check. */ + + if (strlen(text) < 1 || strlen(text) > 6) { + + if (! quiet) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("Text to callsign 6+4: Callsign \"%s\" not between 1 and 6 characters.\n", text); + } + errors++; + return (errors); + } + + for (t = text; *t != '\0'; t++) { + + if (! isalnum(*t)) { + if (! quiet) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("Text to callsign 6+4: Callsign \"%s\" can contain only letters and digits.\n", text); + } + errors++; + return (errors); + } + } + +/* Append spaces if less than 6 characters. */ + + strcpy (padded, text); + while (strlen(padded) < 6) { + strcat (padded, " "); + } + + b = buttons; + packed = 0; + + for (t = padded; *t != '\0'; t++) { + + c = *t; + if (islower(c)) { + c = toupper(c); + } + +/* Search in the translation table. */ + + found = 0; + + for (row=0; row<10 && ! found; row++) { + for (col=0; col<4 && ! found; col++) { + if (c == call10encoding[row][col]) { + *b++ = '0' + row; + *b = '\0'; + packed = packed * 4 + col; /* base 4 to binary */ + found = 1; + } + } + } + + if (! found) { + /* Earlier check should have caught any character not in translation table. */ + errors++; + text_color_set (DW_COLOR_ERROR); + dw_printf ("Text to callsign 6+4: INTERNAL ERROR 0x%02x. Should not be here.\n", c); + } + } + +/* Binary to decimal for the columns. */ + + snprintf (stemp, sizeof(stemp), "%04d", packed); + // FIXME: add parameter for sizeof buttons and use strlcat + strcat (buttons, stemp); + + return (errors); + +} /* end tt_text_to_call10 */ + + + +/*------------------------------------------------------------------ + * + * Name: tt_text_to_satsq + * + * Purpose: Convert Special Satellite Gridsquare to 4 digit DTMF representation. + * + * Inputs: text - Input string. + * Should be two letters (A thru R) and two digits. + * + * quiet - True to suppress error messages. + * + * Outputs: buttons - Sequence of buttons to press. + * Should be 4 digits unless error. + * + * Returns: Number of errors detected. + * + * Example: "FM19" is converted to "1819." + * "AA00" is converted to empty string and error return code. + * + *----------------------------------------------------------------*/ + +int tt_text_to_satsq (const char *text, int quiet, char *buttons, size_t buttonsize) +{ + + int row, col; + int errors = 0; + int found; + char uc[3]; + + + strlcpy (buttons, "", buttonsize); + +/* Quick validity check. */ + + if (strlen(text) < 1 || strlen(text) > 4) { + + if (! quiet) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("Satellite Gridsquare to DTMF: Gridsquare \"%s\" must be 4 characters.\n", text); + } + errors++; + return (errors); + } + +/* Changing to upper case makes things easier later. */ + + uc[0] = islower(text[0]) ? toupper(text[0]) : text[0]; + uc[1] = islower(text[1]) ? toupper(text[1]) : text[1]; + uc[2] = '\0'; + + if (uc[0] < 'A' || uc[0] > 'R' || uc[1] < 'A' || uc[1] > 'R') { + + if (! quiet) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("Satellite Gridsquare to DTMF: First two characters \"%s\" must be letters in range of A to R.\n", text); + } + errors++; + return (errors); + } + + if (! isdigit(text[2]) || ! isdigit(text[3])) { + + if (! quiet) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("Satellite Gridsquare to DTMF: Last two characters \"%s\" must digits.\n", text); + } + errors++; + return (errors); + } + + +/* Search in the translation table. */ + + found = 0; + + for (row=0; row<10 && ! found; row++) { + for (col=0; col<10 && ! found; col++) { + if (strcmp(uc,grid[row][col]) == 0) { + + char btemp[8]; + + btemp[0] = row + '0'; + btemp[1] = col + '0'; + btemp[2] = text[2]; + btemp[3] = text[3]; + btemp[4] = '\0'; + + strlcpy (buttons, btemp, buttonsize); + found = 1; + } + } + } + + if (! found) { + /* Sorry, Greenland, and half of Africa, and ... */ + errors++; + if (! quiet) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("Satellite Gridsquare to DTMF: Sorry, your location can't be converted to DTMF.\n"); + } + } + + return (errors); + +} /* end tt_text_to_satsq */ + + + +/*------------------------------------------------------------------ + * + * Name: tt_text_to_ascii2d + * + * Purpose: Convert text to the two digit per ascii character representation. + * + * Inputs: text - Input string. + * Any printable ASCII characters. + * + * quiet - True to suppress error messages. + * + * Outputs: buttons - Sequence of buttons to press. + * + * Returns: Number of errors detected. + * + * Description: The standard comment format uses the multipress + * encoding which allows only single case letters, digits, + * and the space character. + * This is a more flexible format that can handle all + * printable ASCII characters. We take the character code, + * subtract 32 and convert to two decimal digits. i.e. + * space = 00 + * ! = 01 + * " = 02 + * ... + * ~ = 94 + * + * This is mostly for internal use, so macros can generate + * comments with all characters. + * + *----------------------------------------------------------------*/ + +int tt_text_to_ascii2d (const char *text, int quiet, char *buttons) +{ + const char *t = text; + char *b = buttons; + char c; + int errors = 0; + + + *b = '\0'; + + while ((c = *t++) != '\0') { + + int n; + + /* "isprint()" might depend on locale so use brute force. */ + + if (c < ' ' || c > '~') c = '?'; + + n = c - 32; + + *b++ = (n / 10) + '0'; + *b++ = (n % 10) + '0'; + *b = '\0'; + } + return (errors); + +} /* end tt_text_to_ascii2d */ + + + + + + +/*------------------------------------------------------------------ + * + * Name: tt_multipress_to_text + * + * Purpose: Convert the multi-press representation to text. + * + * Inputs: buttons - Input string. + * Should contain only 0123456789A. + * + * quiet - True to suppress error messages. + * + * Outputs: text - Converted to letters, digits, space. + * + * Returns: Number of errors detected. + * + *----------------------------------------------------------------*/ + +int tt_multipress_to_text (const char *buttons, int quiet, char *text) +{ + const char *b = buttons; + char *t = text; + char c; + int row, col; + int errors = 0; + int maxspan; + int n; + + *t = '\0'; + + while ((c = *b++) != '\0') { + + if (isdigit(c)) { + +/* Determine max that can occur in a row. */ +/* = number of other characters assigned to this button + 1. */ + + maxspan = 1; + row = c - '0'; + for (col=0; col<4; col++) { + if (translate[row][col] != 0) { + maxspan++; + } + } + +/* Count number of consecutive same digits. */ + + n = 1; + while (c == *b) { + b++; + n++; + } + + if (n < maxspan) { + *t++ = translate[row][n-1]; + *t = '\0'; + } + else if (n == maxspan) { + *t++ = c; + *t = '\0'; + } + else { + errors++; + if (! quiet) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("Multi-press to text: Maximum of %d \"%c\" can occur in a row.\n", maxspan, c); + } + /* Treat like the maximum length. */ + *t++ = c; + *t = '\0'; + } + } + else if (c == 'A' || c == 'a') { + +/* Separator should occur only if digit before and after are the same. */ + + if (b == buttons + 1 || *b == '\0' || *(b-2) != *b) { + errors++; + if (! quiet) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("Multi-press to text: \"A\" can occur only between two same digits.\n"); + } + } + } + else { + +/* Completely unexpected character. */ + + errors++; + if (! quiet) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("Multi-press to text: \"%c\" not allowed.\n", c); + } + } + } + return (errors); + +} /* end tt_multipress_to_text */ + + +/*------------------------------------------------------------------ + * + * Name: tt_two_key_to_text + * + * Purpose: Convert the two key representation to text. + * + * Inputs: buttons - Input string. + * Should contain only 0123456789ABCD. + * + * quiet - True to suppress error messages. + * + * Outputs: text - Converted to letters, digits, space. + * + * Returns: Number of errors detected. + * + *----------------------------------------------------------------*/ + +int tt_two_key_to_text (const char *buttons, int quiet, char *text) +{ + const char *b = buttons; + char *t = text; + char c; + int row, col; + int errors = 0; + + *t = '\0'; + + while ((c = *b++) != '\0') { + + if (isdigit(c)) { + +/* Letter (or space) if followed by ABCD. */ + + row = c - '0'; + col = -1; + + if (*b >= 'A' && *b <= 'D') { + col = *b++ - 'A'; + } + else if (*b >= 'a' && *b <= 'd') { + col = *b++ - 'a'; + } + + if (col >= 0) { + if (translate[row][col] != 0) { + *t++ = translate[row][col]; + *t = '\0'; + } + else { + errors++; + if (! quiet) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("Two key to text: Invalid combination \"%c%c\".\n", c, col+'A'); + } + } + } + else { + *t++ = c; + *t = '\0'; + } + } + else if ((c >= 'A' && c <= 'D') || (c >= 'a' && c <= 'd')) { + +/* ABCD not expected here. */ + + errors++; + if (! quiet) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("Two-key to text: A, B, C, or D in unexpected location.\n"); + } + } + else { + +/* Completely unexpected character. */ + + errors++; + if (! quiet) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("Two-key to text: Invalid character \"%c\".\n", c); + } + } + } + return (errors); + +} /* end tt_two_key_to_text */ + + +/*------------------------------------------------------------------ + * + * Name: tt_two_digits_to_letter + * + * Purpose: Convert the two digit representation to one letter. + * + * Inputs: buttons - Input string. + * Should contain exactly two digits. + * + * quiet - True to suppress error messages. + * + * textsiz - Size of result storage. Typically 2. + * + * Outputs: text - Converted to string which should contain one upper case letter. + * Empty string on error. + * + * Returns: Number of errors detected. + * + *----------------------------------------------------------------*/ + +int tt_two_digits_to_letter (const char *buttons, int quiet, char *text, size_t textsiz) +{ + char c1 = buttons[0]; + char c2 = buttons[1]; + int row, col; + int errors = 0; + char stemp2[2]; + + strlcpy (text, "", textsiz); + + if (c1 >= '2' && c1 <= '9') { + + if (c2 >= '1' && c2 <= '4') { + + row = c1 - '0'; + col = c2 - '1'; + + if (translate[row][col] != 0) { + + stemp2[0] = translate[row][col]; + stemp2[1] = '\0'; + strlcpy (text, stemp2, textsiz); + } + else { + errors++; + strlcpy (text, "", textsiz); + if (! quiet) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("Two digits to letter: Invalid combination \"%c%c\".\n", c1, c2); + } + } + } + else { + errors++; + strlcpy (text, "", textsiz); + if (! quiet) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("Two digits to letter: Second character \"%c\" must be in range of 1 through 4.\n", c2); + } + } + } + else { + errors++; + strlcpy (text, "", textsiz); + if (! quiet) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("Two digits to letter: First character \"%c\" must be in range of 2 through 9.\n", c1); + } + } + + return (errors); + +} /* end tt_two_digits_to_letter */ + + +/*------------------------------------------------------------------ + * + * Name: tt_call10_to_text + * + * Purpose: Convert the 10 digit callsign representation to text. + * + * Inputs: buttons - Input string. + * Should contain only ten digits. + * + * quiet - True to suppress error messages. + * + * Outputs: text - Converted to callsign with upper case letters and digits. + * + * Returns: Number of errors detected. + * + *----------------------------------------------------------------*/ + +int tt_call10_to_text (const char *buttons, int quiet, char *text) +{ + const char *b; + char *t; + char c; + int packed; /* from last 4 digits */ + int row, col; + int errors = 0; + int k; + + t = text; + *t = '\0'; /* result */ + +/* Validity check. */ + + if (strlen(buttons) != 10) { + + if (! quiet) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("Callsign 6+4 to text: Encoded Callsign \"%s\" must be exactly 10 digits.\n", buttons); + } + errors++; + return (errors); + } + + for (b = buttons; *b != '\0'; b++) { + + if (! isdigit(*b)) { + if (! quiet) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("Callsign 6+4 to text: Encoded Callsign \"%s\" can contain only digits.\n", buttons); + } + errors++; + return (errors); + } + } + + packed = atoi(buttons+6); + + for (k = 0; k < 6; k++) { + c = buttons[k]; + + row = c - '0'; + col = (packed >> ((5 - k) *2)) & 3; + + if (row < 0 || row > 9 || col < 0 || col > 3) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("Callsign 6+4 to text: INTERNAL ERROR %d %d. Should not be here.\n", row, col); + errors++; + row = 0; + col = 1; + } + + if (call10encoding[row][col] != 0) { + *t++ = call10encoding[row][col]; + *t = '\0'; + } + else { + errors++; + if (! quiet) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("Callsign 6+4 to text: Invalid combination: button %d, position %d.\n", row, col); + } + } + } + +/* Trim any trailing spaces. */ + + k = strlen(text) - 1; /* should be 6 - 1 = 5 */ + + while (k >= 0 && text[k] == ' ') { + text[k] = '\0'; + k--; + } + + return (errors); + +} /* end tt_call10_to_text */ + + + +/*------------------------------------------------------------------ + * + * Name: tt_call5_suffix_to_text + * + * Purpose: Convert the 5 digit APRStt 3 style callsign suffix + * representation to text. + * + * Inputs: buttons - Input string. + * Should contain exactly 5 digits. + * + * quiet - True to suppress error messages. + * + * Outputs: text - Converted to 3 upper case letters and/or digits. + * + * Returns: Number of errors detected. + * + *----------------------------------------------------------------*/ + +int tt_call5_suffix_to_text (const char *buttons, int quiet, char *text) +{ + const char *b; + char *t; + char c; + int packed; /* from last 4 digits */ + int row, col; + int errors = 0; + int k; + + t = text; + *t = '\0'; /* result */ + +/* Validity check. */ + + if (strlen(buttons) != 5) { + + if (! quiet) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("Callsign 3+2 suffix to text: Encoded Callsign \"%s\" must be exactly 5 digits.\n", buttons); + } + errors++; + return (errors); + } + + for (b = buttons; *b != '\0'; b++) { + + if (! isdigit(*b)) { + if (! quiet) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("Callsign 3+2 suffix to text: Encoded Callsign \"%s\" can contain only digits.\n", buttons); + } + errors++; + return (errors); + } + } + + packed = atoi(buttons+3); + + for (k = 0; k < 3; k++) { + c = buttons[k]; + + row = c - '0'; + col = (packed >> ((2 - k) * 2)) & 3; + + if (row < 0 || row > 9 || col < 0 || col > 3) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("Callsign 3+2 suffix to text: INTERNAL ERROR %d %d. Should not be here.\n", row, col); + errors++; + row = 0; + col = 1; + } + + if (call10encoding[row][col] != 0) { + *t++ = call10encoding[row][col]; + *t = '\0'; + } + else { + errors++; + if (! quiet) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("Callsign 3+2 suffix to text: Invalid combination: button %d, position %d.\n", row, col); + } + } + } + + if (errors > 0) { + strcpy (text, ""); + return (errors); + } + + return (errors); + +} /* end tt_call5_suffix_to_text */ + + + +/*------------------------------------------------------------------ + * + * Name: tt_mhead_to_text + * + * Purpose: Convert the DTMF representation of + * Maidenhead Grid Square Locator to normal text representation. + * + * Inputs: buttons - Input string. + * Must contain 4, 6, 10, or 12, 16, or 18 digits. + * + * quiet - True to suppress error messages. + * + * Outputs: text - Converted to gridsquare with upper case letters and digits. + * Length should be 2, 4, 6, or 8 with alternating letter or digit pairs. + * Zero length if any error. + * + * Returns: Number of errors detected. + * + *----------------------------------------------------------------*/ + +#define MAXMHPAIRS 6 + +static const struct { + char *position; + char min_ch; + char max_ch; +} mhpair[MAXMHPAIRS] = { + { "first", 'A', 'R' }, + { "second", '0', '9' }, + { "third", 'A', 'X' }, + { "fourth", '0', '9' }, + { "fifth", 'A', 'X' }, + { "sixth", '0', '9' } +}; + + +int tt_mhead_to_text (const char *buttons, int quiet, char *text, size_t textsiz) +{ + const char *b; + int errors = 0; + + strlcpy (text, "", textsiz); + +/* Validity check. */ + + if (strlen(buttons) != 4 && strlen(buttons) != 6 && + strlen(buttons) != 10 && strlen(buttons) != 12 && + strlen(buttons) != 16 && strlen(buttons) != 18) { + + if (! quiet) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("DTMF to Maidenhead Gridsquare Locator: Input \"%s\" must be exactly 4, 6, 10, or 12 digits.\n", buttons); + } + errors++; + strlcpy (text, "", textsiz); + return (errors); + } + + for (b = buttons; *b != '\0'; b++) { + + if (! isdigit(*b)) { + if (! quiet) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("DTMF to Maidenhead Gridsquare Locator: Input \"%s\" can contain only digits.\n", buttons); + } + errors++; + strlcpy (text, "", textsiz); + return (errors); + } + } + + +/* Convert DTMF to normal representation. */ + + b = buttons; + + int n; + + for (n = 0; n < 6 && b < buttons+strlen(buttons); n++) { + if ((n % 2) == 0) { + + /* Convert pairs of digits to letter. */ + + char t2[2]; + + errors += tt_two_digits_to_letter (b, quiet, t2, sizeof(t2)); + strlcat (text, t2, textsiz); + b += 2; + + errors += tt_two_digits_to_letter (b, quiet, t2, sizeof(t2)); + strlcat (text, t2, textsiz); + b += 2; + } + else { + + /* Copy the digits. */ + + char d3[3]; + d3[0] = *b++; + d3[1] = *b++; + d3[2] = '\0'; + strlcat (text, d3, textsiz); + } + } + + if (errors != 0) { + strlcpy (text, "", textsiz); + } + return (errors); + +} /* end tt_mhead_to_text */ + + +/*------------------------------------------------------------------ + * + * Name: tt_text_to_mhead + * + * Purpose: Convert normal text Maidenhead Grid Square Locator to DTMF representation. + * + * Inputs: text - Maidenhead Grid Square locator in usual format. + * Length should be 1 to 6 pairs with alternating letter or digit pairs. + * + * quiet - True to suppress error messages. + * + * buttonsize - space available for 'buttons' result. + * + * Outputs: buttons - Result with 4, 6, 10, 12, 16, 18 digits. + * Each letter is replaced by two digits. + * Digits are simply copied. + * + * Returns: Number of errors detected. + * + *----------------------------------------------------------------*/ + +int tt_text_to_mhead (const char *text, int quiet, char *buttons, size_t buttonsize) +{ + int errors = 0; + int np, i; + + strlcpy (buttons, "", buttonsize); + + np = strlen(text) / 2; + + if ((strlen(text) % 2) != 0) { + + if (! quiet) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("Maidenhead Gridsquare Locator to DTMF: Input \"%s\" must be even number of characters.\n", text); + } + errors++; + return (errors); + } + + if (np < 1 || np > MAXMHPAIRS) { + + if (! quiet) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("Maidenhead Gridsquare Locator to DTMF: Input \"%s\" must be 1 to %d pairs of characters.\n", text, np); + } + errors++; + return (errors); + } + + for (i = 0; i < np; i++) { + + char t0 = text[i*2]; + char t1 = text[i*2+1]; + + if (toupper(t0) < mhpair[i].min_ch || toupper(t0) > mhpair[i].max_ch || + toupper(t1) < mhpair[i].min_ch || toupper(t1) > mhpair[i].max_ch) { + if (! quiet) { + text_color_set(DW_COLOR_ERROR); + dw_printf("The %s pair of characters in Maidenhead locator \"%s\" must be in range of %c thru %c.\n", + mhpair[i].position, text, mhpair[i].min_ch, mhpair[i].max_ch); + } + strlcpy (buttons, "", buttonsize); + errors++; + return(errors); + } + + if (mhpair[i].min_ch == 'A') { /* Should be letters */ + + char b3[3]; + + errors += tt_letter_to_two_digits (t0, quiet, b3); + strlcat (buttons, b3, buttonsize); + + errors += tt_letter_to_two_digits (t1, quiet, b3); + strlcat (buttons, b3, buttonsize); + } + else { /* Should be digits */ + + char b3[3]; + + b3[0] = t0; + b3[1] = t1; + b3[2] = '\0'; + strlcat (buttons, b3, buttonsize); + } + } + + if (errors != 0) strlcpy (buttons, "", buttonsize); + + return (errors); + +} /* tt_text_to_mhead */ + + +/*------------------------------------------------------------------ + * + * Name: tt_satsq_to_text + * + * Purpose: Convert the 4 digit DTMF special Satellite gridsquare to normal 2 letters and 2 digits. + * + * Inputs: buttons - Input string. + * Should contain 4 digits. + * + * quiet - True to suppress error messages. + * + * Outputs: text - Converted to gridsquare with upper case letters and digits. + * + * Returns: Number of errors detected. + * + *----------------------------------------------------------------*/ + +int tt_satsq_to_text (const char *buttons, int quiet, char *text) +{ + const char *b; + int row, col; + int errors = 0; + + strcpy (text, ""); + +/* Validity check. */ + + if (strlen(buttons) != 4) { + + if (! quiet) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("DTMF to Satellite Gridsquare: Input \"%s\" must be exactly 4 digits.\n", buttons); + } + errors++; + return (errors); + } + + for (b = buttons; *b != '\0'; b++) { + + if (! isdigit(*b)) { + if (! quiet) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("DTMF to Satellite Gridsquare: Input \"%s\" can contain only digits.\n", buttons); + } + errors++; + return (errors); + } + } + + row = buttons[0] - '0'; + col = buttons[1] - '0'; + + // FIXME: Add parameter for sizeof text and use strlcpy, strlcat. + strcpy (text, grid[row][col]); + strcat (text, buttons+2); + + return (errors); + +} /* end tt_satsq_to_text */ + + + +/*------------------------------------------------------------------ + * + * Name: tt_ascii2d_to_text + * + * Purpose: Convert the two digit ascii representation back to normal text. + * + * Inputs: buttons - Input string. + * Should contain pairs of digits in range 00 to 94. + * + * quiet - True to suppress error messages. + * + * Outputs: text - Converted to any printable ascii characters. + * + * Returns: Number of errors detected. + * + *----------------------------------------------------------------*/ + +int tt_ascii2d_to_text (const char *buttons, int quiet, char *text) +{ + const char *b = buttons; + char *t = text; + char c1, c2; + int errors = 0; + + + *t = '\0'; + + while (*b != '\0') { + + c1 = *b++; + if (*b != '\0') { + c2 = *b++; + } + else { + c2 = ' '; + } + + if (isdigit(c1) && isdigit(c2)) { + int n; + + n = (c1 - '0') * 10 + (c2 - '0'); + + *t++ = n + 32; + *t = '\0'; + } + else { + +/* Unexpected character. */ + + errors++; + if (! quiet) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("ASCII2D to text: Invalid character pair \"%c%c\".\n", c1, c2); + } + } + } + return (errors); + +} /* end tt_ascii2d_to_text */ + + + +/*------------------------------------------------------------------ + * + * Name: tt_guess_type + * + * Purpose: Try to guess which encoding we have. + * + * Inputs: buttons - Input string. + * Should contain only 0123456789ABCD. + * + * Returns: TT_MULTIPRESS - Looks like multipress. + * TT_TWO_KEY - Looks like two key. + * TT_EITHER - Could be either one. + * + *----------------------------------------------------------------*/ + +typedef enum { TT_EITHER, TT_MULTIPRESS, TT_TWO_KEY } tt_enc_t; + +tt_enc_t tt_guess_type (char *buttons) +{ + char text[256]; + int err_mp; + int err_tk; + +/* If it contains B, C, or D, it can't be multipress. */ + + if (strchr (buttons, 'B') != NULL || strchr (buttons, 'b') != NULL || + strchr (buttons, 'C') != NULL || strchr (buttons, 'c') != NULL || + strchr (buttons, 'D') != NULL || strchr (buttons, 'd') != NULL) { + return (TT_TWO_KEY); + } + +/* Try parsing quietly and see if one gets errors and the other doesn't. */ + + err_mp = tt_multipress_to_text (buttons, 1, text); + err_tk = tt_two_key_to_text (buttons, 1, text); + + if (err_mp == 0 && err_tk > 0) { + return (TT_MULTIPRESS); + } + else if (err_tk == 0 && err_mp > 0) { + return (TT_TWO_KEY); + } + +/* Could be either one. */ + + return (TT_EITHER); + +} /* end tt_guess_type */ + + + +/*------------------------------------------------------------------ + * + * Name: main + * + * Purpose: Utility program for testing the encoding. + * + *----------------------------------------------------------------*/ + + +#if ENC_MAIN + +int checksum (char *tt) +{ + int cs = 10; /* Assume leading 'A'. */ + /* Doesn't matter due to mod 10 at the end. */ + char *p; + + for (p = tt; *p != '\0'; p++) { + if (isdigit(*p)) { + cs += *p - '0'; + } + else if (isupper(*p)) { + cs += *p - 'A' + 10; + } + else if (islower(*p)) { + cs += *p - 'a' + 10; + } + } + + return (cs % 10); +} + +int main (int argc, char *argv[]) +{ + char text[1000], buttons[2000]; + int n; + int cs; + + text_color_set (DW_COLOR_INFO); + + if (argc < 2) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("Supply text string on command line.\n"); + exit (1); + } + + strlcpy (text, argv[1], sizeof(text)); + + for (n = 2; n < argc; n++) { + strlcat (text, " ", sizeof(text)); + strlcat (text, argv[n], sizeof(text)); + } + + dw_printf ("Push buttons for multi-press method:\n"); + n = tt_text_to_multipress (text, 0, buttons); + cs = checksum (buttons); + dw_printf ("\"%s\" checksum for call = %d\n", buttons, cs); + + dw_printf ("Push buttons for two-key method:\n"); + n = tt_text_to_two_key (text, 0, buttons); + cs = checksum (buttons); + dw_printf ("\"%s\" checksum for call = %d\n", buttons, cs); + + n = tt_text_to_call10 (text, 1, buttons); + if (n == 0) { + dw_printf ("Push buttons for fixed length 10 digit callsign:\n"); + dw_printf ("\"%s\"\n", buttons); + } + + n = tt_text_to_mhead (text, 1, buttons, sizeof(buttons)); + if (n == 0) { + dw_printf ("Push buttons for Maidenhead Grid Square Locator:\n"); + dw_printf ("\"%s\"\n", buttons); + } + + n = tt_text_to_satsq (text, 1, buttons, sizeof(buttons)); + if (n == 0) { + dw_printf ("Push buttons for satellite gridsquare:\n"); + dw_printf ("\"%s\"\n", buttons); + } + + return(0); + +} /* end main */ + +#endif /* encoding */ + + +/*------------------------------------------------------------------ + * + * Name: main + * + * Purpose: Utility program for testing the decoding. + * + *----------------------------------------------------------------*/ + + +#if DEC_MAIN + + +int main (int argc, char *argv[]) +{ + char buttons[2000], text[1000]; + int n; + + text_color_set (DW_COLOR_INFO); + + if (argc < 2) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("Supply button sequence on command line.\n"); + exit (1); + } + + strlcpy (buttons, argv[1], sizeof(buttons)); + + for (n = 2; n < argc; n++) { + strlcat (buttons, argv[n], sizeof(buttons)); + } + + switch (tt_guess_type(buttons)) { + case TT_MULTIPRESS: + dw_printf ("Looks like multi-press encoding.\n"); + break; + case TT_TWO_KEY: + dw_printf ("Looks like two-key encoding.\n"); + break; + default: + dw_printf ("Could be either type of encoding.\n"); + break; + } + + dw_printf ("Decoded text from multi-press method:\n"); + n = tt_multipress_to_text (buttons, 0, text); + dw_printf ("\"%s\"\n", text); + + dw_printf ("Decoded text from two-key method:\n"); + n = tt_two_key_to_text (buttons, 0, text); + dw_printf ("\"%s\"\n", text); + + n = tt_call10_to_text (buttons, 1, text); + if (n == 0) { + dw_printf ("Decoded callsign from 10 digit method:\n"); + dw_printf ("\"%s\"\n", text); + } + + n = tt_mhead_to_text (buttons, 1, text, sizeof(text)); + if (n == 0) { + dw_printf ("Decoded Maidenhead Locator from DTMF digits:\n"); + dw_printf ("\"%s\"\n", text); + } + + n = tt_satsq_to_text (buttons, 1, text); + if (n == 0) { + dw_printf ("Decoded satellite gridsquare from 4 DTMF digits:\n"); + dw_printf ("\"%s\"\n", text); + } + + return(0); + +} /* end main */ + +#endif /* decoding */ + + +#if TTT_TEST + +/* gcc -g -DTTT_TEST tt_text.c textcolor.o misc.a && ./a.exe */ + + +/* Quick unit test. */ + +static int error_count; + +static void test_text2tt (char *text, char *expect_mp, char *expect_2k, char *expect_c10, char *expect_loc, char *expect_sat) +{ + char buttons[100]; + + text_color_set(DW_COLOR_INFO); + dw_printf ("\nConvert from text \"%s\" to tone sequence.\n", text); + + tt_text_to_multipress (text, 0, buttons); + if (strcmp(buttons, expect_mp) != 0) { error_count++; text_color_set(DW_COLOR_ERROR); dw_printf ("Expected multi-press \"%s\" but got \"%s\"\n", expect_mp, buttons); } + + tt_text_to_two_key (text, 0, buttons); + if (strcmp(buttons, expect_2k) != 0) { error_count++; text_color_set(DW_COLOR_ERROR); dw_printf ("Expected two-key \"%s\" but got \"%s\"\n", expect_2k, buttons); } + + tt_text_to_call10 (text, 0, buttons); + if (strcmp(buttons, expect_c10) != 0) { error_count++; text_color_set(DW_COLOR_ERROR); dw_printf ("Expected call 6+4 \"%s\" but got \"%s\"\n", expect_c10, buttons); } + + tt_text_to_mhead (text, 0, buttons, sizeof(buttons)); + if (strcmp(buttons, expect_loc) != 0) { error_count++; text_color_set(DW_COLOR_ERROR); dw_printf ("Expected Maidenhead \"%s\" but got \"%s\"\n", expect_loc, buttons); } + + tt_text_to_satsq (text, 0, buttons, sizeof(buttons)); + if (strcmp(buttons, expect_sat) != 0) { error_count++; text_color_set(DW_COLOR_ERROR); dw_printf ("Expected Sat Sq \"%s\" but got \"%s\"\n", expect_sat, buttons); } +} + +static void test_tt2text (char *buttons, char *expect_mp, char *expect_2k, char *expect_c10, char *expect_loc, char *expect_sat) +{ + char text[100]; + + text_color_set(DW_COLOR_INFO); + dw_printf ("\nConvert tone sequence \"%s\" to text.\n", buttons); + + tt_multipress_to_text (buttons, 0, text); + if (strcmp(text, expect_mp) != 0) { error_count++; text_color_set(DW_COLOR_ERROR); dw_printf ("Expected multi-press \"%s\" but got \"%s\"\n", expect_mp, text); } + + tt_two_key_to_text (buttons, 0, text); + if (strcmp(text, expect_2k) != 0) { error_count++; text_color_set(DW_COLOR_ERROR); dw_printf ("Expected two-key \"%s\" but got \"%s\"\n", expect_2k, text); } + + tt_call10_to_text (buttons, 0, text); + if (strcmp(text, expect_c10) != 0) { error_count++; text_color_set(DW_COLOR_ERROR); dw_printf ("Expected call 6+4 \"%s\" but got \"%s\"\n", expect_c10, text); } + + tt_mhead_to_text (buttons, 0, text, sizeof(text)); + if (strcmp(text, expect_loc) != 0) { error_count++; text_color_set(DW_COLOR_ERROR); dw_printf ("Expected Maidenhead \"%s\" but got \"%s\"\n", expect_loc, text); } + + tt_satsq_to_text (buttons, 0, text); + if (strcmp(text, expect_sat) != 0) { error_count++; text_color_set(DW_COLOR_ERROR); dw_printf ("Expected Sat Sq \"%s\" but got \"%s\"\n", expect_sat, text); } +} + + +int main (int argc, char *argv[]) +{ + + text_color_set (DW_COLOR_INFO); + dw_printf ("Test conversions between normal text and DTMF representation.\n"); + dw_printf ("Some error messages are normal. Just look for number of errors at end.\n"); + + error_count = 0; + + /* original text multipress two-key call10 mhead satsq */ + + test_text2tt ("abcdefg 0123", "2A22A2223A33A33340A00122223333", "2A2B2C3A3B3C4A0A0123", "", "", ""); + + test_text2tt ("WB4APR", "922444427A777", "9A2B42A7A7C", "9242771558", "", ""); + + test_text2tt ("EM29QE78", "3362222999997733777778888", "3B6A297B3B78", "", "326129723278", ""); + + test_text2tt ("FM19", "3336199999", "3C6A19", "3619003333", "336119", "1819"); + + + /* tone_seq multipress two-key call10 mhead satsq */ + + test_tt2text ("2A22A2223A33A33340A00122223333", "ABCDEFG 0123", "A2A222D3D3334 00122223333", "", "", ""); + + test_tt2text ("9242771558", "WAGAQ1KT", "9242771558", "WB4APR", "", ""); + + test_tt2text ("326129723278", "DAM1AWPADAPT", "326129723278", "", "EM29QE78", ""); + + test_tt2text ("1819", "1T1W", "1819", "", "", "FM19"); + + + if (error_count > 0) { + + text_color_set (DW_COLOR_ERROR); + dw_printf ("\nERROR: %d tests failed.\n", error_count); + exit (EXIT_FAILURE); + } + + text_color_set (DW_COLOR_REC); + dw_printf ("\nSUCCESS! All tests passed.\n"); + exit (EXIT_SUCCESS); + + +} /* end main */ + +#endif + +/* end tt_text.c */ + diff --git a/src/tt_text.h b/src/tt_text.h new file mode 100644 index 00000000..7cab3b88 --- /dev/null +++ b/src/tt_text.h @@ -0,0 +1,38 @@ + +/* tt_text.h */ + + +/* Encode normal human readable to DTMF representation. */ + +int tt_text_to_multipress (const char *text, int quiet, char *buttons); + +int tt_text_to_two_key (const char *text, int quiet, char *buttons); + +int tt_text_to_call10 (const char *text, int quiet, char *buttons); + +int tt_text_to_mhead (const char *text, int quiet, char *buttons, size_t buttonsiz); + +int tt_text_to_satsq (const char *text, int quiet, char *buttons, size_t buttonsiz); + +int tt_text_to_ascii2d (const char *text, int quiet, char *buttons); + + +/* Decode DTMF to normal human readable form. */ + +int tt_multipress_to_text (const char *buttons, int quiet, char *text); + +int tt_two_key_to_text (const char *buttons, int quiet, char *text); + +int tt_call10_to_text (const char *buttons, int quiet, char *text); + +int tt_call5_suffix_to_text (const char *buttons, int quiet, char *text); + +int tt_mhead_to_text (const char *buttons, int quiet, char *text, size_t textsiz); + +int tt_satsq_to_text (const char *buttons, int quiet, char *text); + +int tt_ascii2d_to_text (const char *buttons, int quiet, char *text); + + + +/* end tt_text.h */ \ No newline at end of file diff --git a/src/tt_user.c b/src/tt_user.c new file mode 100644 index 00000000..a73d6a46 --- /dev/null +++ b/src/tt_user.c @@ -0,0 +1,1194 @@ +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// +// Copyright (C) 2013, 2014, 2015 John Langner, WB2OSZ +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . +// + +/*------------------------------------------------------------------ + * + * Module: tt-user.c + * + * Purpose: Keep track of the APRStt users. + * + * Description: This maintains a list of recently heard APRStt users + * and prepares "object" format packets for transmission. + * + * References: This is based upon APRStt (TM) documents but not 100% + * compliant due to ambiguities and inconsistencies in + * the specifications. + * + * http://www.aprs.org/aprstt.html + * + *---------------------------------------------------------------*/ + +#include "direwolf.h" + +#include +#include +#include +#include +#include +#include +#include + +#include "version.h" +#include "ax25_pad.h" +#include "textcolor.h" +#include "aprs_tt.h" +#include "tt_text.h" +#include "dedupe.h" +#include "tq.h" +#include "igate.h" +#include "tt_user.h" +#include "encode_aprs.h" +#include "latlong.h" + +#include "server.h" +#include "kiss.h" +#include "kissserial.h" +#include "kissnet.h" +#include "kiss_frame.h" + +/* + * Information kept about local APRStt users. + * + * For now, just use a fixed size array for simplicity. + */ + +#if TT_MAIN +#define MAX_TT_USERS 3 +#else +#define MAX_TT_USERS 100 +#endif + +#define MAX_CALLSIGN_LEN 9 /* "Object Report" names can be up to 9 characters. */ + +#define MAX_COMMENT_LEN 43 /* Max length of comment in "Object Report." */ + +//#define G_UNKNOWN -999999 /* Should be in one place. */ + +#define NUM_XMITS 3 +#define XMIT_DELAY_1 5 +#define XMIT_DELAY_2 8 +#define XMIT_DELAY_3 13 + + +static struct tt_user_s { + + char callsign[MAX_CALLSIGN_LEN+1]; /* Callsign of station heard. */ + /* Does not include the "-12" SSID added later. */ + /* Possibly other tactical call / object label. */ + /* Null string indicates table position is not used. */ + + int count; /* Number of times we received information for this object. */ + /* Value 1 means first time and could be used to send */ + /* a welcome greeting. */ + + int ssid; /* SSID to add. */ + /* Default of 12 but not always. */ + + char overlay; /* Overlay character. Should be 0-9, A-Z. */ + /* Could be / or \ for general object. */ + + char symbol; /* 'A' for traditional. */ + /* Can be any symbol for extended objects. */ + + char digit_suffix[3+1]; /* Suffix abbreviation as 3 digits. */ + + time_t last_heard; /* Timestamp when last heard. */ + /* User information will be deleted at some */ + /* point after last time being heard. */ + + int xmits; /* Number of remaining times to transmit info */ + /* about the user. This is set to 3 when */ + /* a station is heard and decremented each time */ + /* an object packet is sent. The idea is to send */ + /* 3 within 30 seconds to improve chances of */ + /* being heard while using digipeater duplicate */ + /* removal. */ + // TODO: I think implementation is different. + + time_t next_xmit; /* Time for next transmit. Meaningful only */ + /* if xmits > 0. */ + + int corral_slot; /* If location is known, set this to 0. */ + /* Otherwise, this is a display offset position */ + /* from the gateway. */ + + char loc_text[24]; /* Text representation of location when a single */ + /* lat/lon point would be deceptive. e.g. */ + /* 32TPP8049 */ + /* 32TPP8179549363 */ + /* 32T 681795 4849363 */ + /* EM29QE78 */ + + double latitude, longitude; /* Location either from user or generated */ + /* position in the corral. */ + + int ambiguity; /* Number of digits to omit from location. */ + /* Default 0, max. 4. */ + + char freq[12]; /* Frequency in format 999.999MHz */ + + char ctcss[5]; /* CTCSS tone. Exactly 3 digits for integer part. */ + /* For example 74.4 Hz becomes "074". */ + + char comment[MAX_COMMENT_LEN+1]; /* Free form comment from user. */ + /* Comment sent in final object report includes */ + /* other information besides this. */ + + char mic_e; /* Position status. */ + /* Should be a character in range of '1' to '9' for */ + /* the predefined status strings or '0' for none. */ + + char dao[8]; /* Enhanced position information. */ + + +} tt_user[MAX_TT_USERS]; + + +static void clear_user(int i); + +static void xmit_object_report (int i, int first_time); + +static void tt_setenv (int i); + + +#if __WIN32__ + +// setenv is missing on Windows! + +int setenv(const char *name, const char *value, int overwrite) +{ + char etemp[1000]; + + snprintf (etemp, sizeof(etemp), "%s=%s", name, value); + putenv (etemp); + return (0); +} + +#endif + + +/*------------------------------------------------------------------ + * + * Name: tt_user_init + * + * Purpose: Initialize the APRStt gateway at system startup time. + * + * Inputs: Configuration options gathered by config.c. + * + * Global out: Make our own local copy of the structure here. + * + * Returns: None + * + * Description: The main program needs to call this at application + * start up time after reading the configuration file. + * + * TT_MAIN is defined for unit testing. + * + *----------------------------------------------------------------*/ + +static struct audio_s *save_audio_config_p; + +static struct tt_config_s *save_tt_config_p; + + +void tt_user_init (struct audio_s *p_audio_config, struct tt_config_s *p_tt_config) +{ + int i; + + save_audio_config_p = p_audio_config; + + save_tt_config_p = p_tt_config; + + for (i=0; i= 0) or -1 if not found. + * This happens to be an index into an array but + * the implementation could change so the caller should + * not make any assumptions. + * + *----------------------------------------------------------------*/ + +int tt_3char_suffix_search (char *suffix, char *callsign) +{ + int i; + + +/* + * Look for suffix in list of known calls. + */ + for (i=0; i= 3 && len <= 6 && strcmp(tt_user[i].callsign + len - 3, suffix) == 0) { + strlcpy (callsign, tt_user[i].callsign, MAX_CALLSIGN_LEN+1); + return (i); + } + } + +/* + * Not found. + */ + strlcpy (callsign, "", MAX_CALLSIGN_LEN+1); + return (-1); + +} /* end tt_3char_suffix_search */ + + + +/*------------------------------------------------------------------ + * + * Name: clear_user + * + * Purpose: Clear specified user table entry. + * + * Inputs: handle for user table entry. + * + *----------------------------------------------------------------*/ + +static void clear_user(int i) +{ + assert (i >= 0 && i < MAX_TT_USERS); + + memset (&(tt_user[i]), 0, sizeof (struct tt_user_s)); + +} /* end clear_user */ + + +/*------------------------------------------------------------------ + * + * Name: find_avail + * + * Purpose: Find an available user table location. + * + * Inputs: none + * + * Returns: Handle for referring to table position. + * + * Description: If table is already full, this should delete the + * least recently heard user to make room. + * + *----------------------------------------------------------------*/ + +static int find_avail (void) +{ + int i; + int i_oldest; + + for (i=0; i= 1 not already in use. + * + *----------------------------------------------------------------*/ + +static int corral_slot (void) +{ + int slot, i, used; + + for (slot=1; ; slot++) { + used = 0;; + for (i=0; i= 0 && i < MAX_TT_USERS); + strlcpy (tt_user[i].callsign, callsign, sizeof(tt_user[i].callsign)); + tt_user[i].count = 1; + tt_user[i].ssid = ssid; + tt_user[i].overlay = overlay; + tt_user[i].symbol = symbol; + digit_suffix(tt_user[i].callsign, tt_user[i].digit_suffix); + strlcpy (tt_user[i].loc_text, loc_text, sizeof(tt_user[i].loc_text)); + + if (latitude != G_UNKNOWN && longitude != G_UNKNOWN) { + /* We have specific location. */ + tt_user[i].corral_slot = 0; + tt_user[i].latitude = latitude; + tt_user[i].longitude = longitude; + } + else { + /* Unknown location, put it in the corral. */ + tt_user[i].corral_slot = corral_slot(); + } + + tt_user[i].ambiguity = ambiguity; + + strlcpy (tt_user[i].freq, freq, sizeof(tt_user[i].freq)); + strlcpy (tt_user[i].ctcss, ctcss, sizeof(tt_user[i].ctcss)); + strlcpy (tt_user[i].comment, comment, sizeof(tt_user[i].comment)); + tt_user[i].mic_e = mic_e; + strlcpy(tt_user[i].dao, dao, sizeof(tt_user[i].dao)); + } + else { +/* + * Known user. Update with any new information. + * Keep any old values where not being updated. + */ + assert (i >= 0 && i < MAX_TT_USERS); + + tt_user[i].count++; + + /* Any reason to look at ssid here? */ + + /* Update the symbol if not the default. */ + + if (overlay != APRSTT_DEFAULT_SYMTAB || symbol != APRSTT_DEFAULT_SYMBOL) { + tt_user[i].overlay = overlay; + tt_user[i].symbol = symbol; + } + + if (strlen(loc_text) > 0) { + strlcpy (tt_user[i].loc_text, loc_text, sizeof(tt_user[i].loc_text)); + } + + if (latitude != G_UNKNOWN && longitude != G_UNKNOWN) { + /* We have specific location. */ + tt_user[i].corral_slot = 0; + tt_user[i].latitude = latitude; + tt_user[i].longitude = longitude; + } + + if (ambiguity != G_UNKNOWN) { + tt_user[i].ambiguity = ambiguity; + } + + if (freq[0] != '\0') { + strlcpy (tt_user[i].freq, freq, sizeof(tt_user[i].freq)); + } + + if (ctcss[0] != '\0') { + strlcpy (tt_user[i].ctcss, ctcss, sizeof(tt_user[i].ctcss)); + } + + if (comment[0] != '\0') { + strlcpy (tt_user[i].comment, comment, MAX_COMMENT_LEN); + tt_user[i].comment[MAX_COMMENT_LEN] = '\0'; + } + + if (mic_e != ' ') { + tt_user[i].mic_e = mic_e; + } + + if (strlen(dao) > 0) { + strlcpy(tt_user[i].dao, dao, sizeof(tt_user[i].dao)); + } + } + +/* + * In both cases, note last time heard and schedule object report transmission. + */ + tt_user[i].last_heard = time(NULL); + tt_user[i].xmits = 0; + tt_user[i].next_xmit = tt_user[i].last_heard + save_tt_config_p->xmit_delay[0]; + +/* + * Send to applications and IGate immediately. + */ + + xmit_object_report (i, 1); + +/* + * Put properties into environment variables in preparation + * for calling a user-specified script. + */ + + tt_setenv (i); + + return (0); /* Success! */ + +} /* end tt_user_heard */ + + +/*------------------------------------------------------------------ + * + * Name: tt_user_background + * + * Purpose: + * + * Inputs: + * + * Outputs: Append to transmit queue. + * + * Returns: None + * + * Description: ...... TBD + * + *----------------------------------------------------------------*/ + +void tt_user_background (void) +{ + time_t now = time(NULL); + int i; + + //text_color_set(DW_COLOR_DEBUG); + //dw_printf ("tt_user_background() now = %d\n", (int)now); + + + for (i=0; i= 0 && i < MAX_TT_USERS); + + if (tt_user[i].callsign[0] != '\0') { + if (tt_user[i].xmits < save_tt_config_p->num_xmits && tt_user[i].next_xmit <= now) { + + + //text_color_set(DW_COLOR_DEBUG); + //dw_printf ("tt_user_background() now = %d\n", (int)now); + //tt_user_dump (); + + xmit_object_report (i, 0); + + /* Increase count of number times this one was sent. */ + tt_user[i].xmits++; + if (tt_user[i].xmits < save_tt_config_p->num_xmits) { + /* Schedule next one. */ + tt_user[i].next_xmit += save_tt_config_p->xmit_delay[tt_user[i].xmits]; + } + + //tt_user_dump (); + } + } + } + +/* + * Purge if too old. + */ + for (i=0; iretain_time < now) { + + //dw_printf ("debug: purging expired user %d\n", i); + + clear_user (i); + } + } + } +} + + +/*------------------------------------------------------------------ + * + * Name: xmit_object_report + * + * Purpose: Create object report packet and put into transmit queue. + * + * Inputs: i - Index into user table. + * + * first_time - Is this being called immediately after the tone sequence + * was received or after some delay? + * For the former, we send to any attached applications + * and the IGate. + * For the latter, we transmit over radio. + * + * Outputs: Append to transmit queue. + * + * Returns: None + * + * Description: Details for specified user are converted to + * "Object Report Format" and added to the transmit queue. + * + * If the user did not report a position, we have to make + * up something so the corresponding object will show up on + * the map or other list of nearby stations. + * + * The traditional approach is to put them in different + * positions in the "corral" by applying increments of an + * offset from the starting position. This has two + * unfortunate properties. It gives the illusion we know + * where the person is located. Being in the ,,, + * + *----------------------------------------------------------------*/ + +static void xmit_object_report (int i, int first_time) +{ + char object_name[20]; // xxxxxxxxx or xxxxxx-nn + char info_comment[200]; // usercomment [locationtext] /status !DAO! + char object_info[250]; // info part of Object Report packet + char stemp[300]; // src>dest,path:object_info + + double olat, olong; + int oambig; // Position ambiguity. + packet_t pp; + char c4[4]; + + //text_color_set(DW_COLOR_DEBUG); + //printf ("xmit_object_report (index = %d, first_time = %d) rx = %d, tx = %d\n", i, first_time, + // save_tt_config_p->obj_recv_chan, save_tt_config_p->obj_xmit_chan); + + assert (i >= 0 && i < MAX_TT_USERS); + +/* + * Prepare the object name. + * Tack on "-12" if it is a callsign. + */ + strlcpy (object_name, tt_user[i].callsign, sizeof(object_name)); + + if (strlen(object_name) <= 6 && tt_user[i].ssid != 0) { + char stemp8[8]; + snprintf (stemp8, sizeof(stemp8), "-%d", tt_user[i].ssid); + strlcat (object_name, stemp8, sizeof(object_name)); + } + + if (tt_user[i].corral_slot == 0) { +/* + * Known location. + */ + olat = tt_user[i].latitude; + olong = tt_user[i].longitude; + oambig = tt_user[i].ambiguity; + if (oambig == G_UNKNOWN) oambig = 0; + } + else { +/* + * Use made up position in the corral. + */ + double c_lat = save_tt_config_p->corral_lat; // Corral latitude. + double c_long = save_tt_config_p->corral_lon; // Corral longitude. + double c_offs = save_tt_config_p->corral_offset; // Corral (latitude) offset. + + olat = c_lat - (tt_user[i].corral_slot - 1) * c_offs; + olong = c_long; + oambig = 0; + } + +/* + * Build comment field from various information. + * + * usercomment [locationtext] /status !DAO! + * + * Any frequency is inserted at beginning later. + */ + strlcpy (info_comment, "", sizeof(info_comment)); + + if (strlen(tt_user[i].comment) != 0) { + strlcat (info_comment, tt_user[i].comment, sizeof(info_comment)); + } + + if (strlen(tt_user[i].loc_text) > 0) { + if (strlen(info_comment) > 0) { + strlcat (info_comment, " ", sizeof(info_comment)); + } + strlcat (info_comment, "[", sizeof(info_comment)); + strlcat (info_comment, tt_user[i].loc_text, sizeof(info_comment)); + strlcat (info_comment, "]", sizeof(info_comment)); + } + + if (tt_user[i].mic_e >= '1' && tt_user[i].mic_e <= '9') { + + if (strlen(info_comment) > 0) { + strlcat (info_comment, " ", sizeof(info_comment)); + } + + // Insert "/" if status does not already begin with it. + if (save_tt_config_p->status[tt_user[i].mic_e - '0'][0] != '/') { + strlcat (info_comment, "/", sizeof(info_comment)); + } + strlcat (info_comment, save_tt_config_p->status[tt_user[i].mic_e - '0'], sizeof(info_comment)); + } + + if (strlen(tt_user[i].dao) > 0) { + if (strlen(info_comment) > 0) { + strlcat (info_comment, " ", sizeof(info_comment)); + } + strlcat (info_comment, tt_user[i].dao, sizeof(info_comment)); + } + + /* Official limit is 43 characters. */ + //info_comment[MAX_COMMENT_LEN] = '\0'; + +/* + * Packet header is built from mycall (of transmit channel) and software version. + */ + + if (save_tt_config_p->obj_xmit_chan >= 0) { + strlcpy (stemp, save_audio_config_p->achan[save_tt_config_p->obj_xmit_chan].mycall, sizeof(stemp)); + } + else { + strlcpy (stemp, save_audio_config_p->achan[save_tt_config_p->obj_recv_chan].mycall, sizeof(stemp)); + } + strlcat (stemp, ">", sizeof(stemp)); + strlcat (stemp, APP_TOCALL, sizeof(stemp)); + c4[0] = '0' + MAJOR_VERSION; + c4[1] = '0' + MINOR_VERSION; + c4[2] = '\0'; + strlcat (stemp, c4, sizeof(stemp)); + +/* + * Append via path, for transmission, if specified. + */ + + if ( ! first_time && save_tt_config_p->obj_xmit_via[0] != '\0') { + strlcat (stemp, ",", sizeof(stemp)); + strlcat (stemp, save_tt_config_p->obj_xmit_via, sizeof(stemp)); + } + + strlcat (stemp, ":", sizeof(stemp)); + + encode_object (object_name, 0, tt_user[i].last_heard, olat, olong, oambig, + tt_user[i].overlay, tt_user[i].symbol, + 0,0,0,NULL, G_UNKNOWN, G_UNKNOWN, /* PHGD, Course/Speed */ + strlen(tt_user[i].freq) > 0 ? atof(tt_user[i].freq) : G_UNKNOWN, + strlen(tt_user[i].ctcss) > 0 ? atof(tt_user[i].ctcss) : G_UNKNOWN, + G_UNKNOWN, /* CTCSS */ + info_comment, object_info, sizeof(object_info)); + + strlcat (stemp, object_info, sizeof(stemp)); + +#if TT_MAIN + + printf ("---> %s\n\n", stemp); + +#else + + if (first_time) { + text_color_set(DW_COLOR_DEBUG); + dw_printf ("[APRStt] %s\n", stemp); + } + +/* + * Convert text to packet. + */ + pp = ax25_from_text (stemp, 1); + + if (pp == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("\"%s\"\n", stemp); + return; + } + + +/* + * Send to one or more of the following depending on configuration: + * Transmit queue. + * Any attached application(s). + * IGate. + * + * When transmitting over the radio, it gets sent multiple times, to help + * probability of being heard, with increasing delays between. + * + * The other methods are reliable so we only want to send it once. + */ + + if (first_time && save_tt_config_p->obj_send_to_app) { + unsigned char fbuf[AX25_MAX_PACKET_LEN]; + int flen; + + // TODO1.3: Put a wrapper around this so we only call one function to send by all methods. + // We see the same sequence in direwolf.c. + + flen = ax25_pack(pp, fbuf); + + server_send_rec_packet (save_tt_config_p->obj_recv_chan, pp, fbuf, flen); + kissnet_send_rec_packet (save_tt_config_p->obj_recv_chan, KISS_CMD_DATA_FRAME, fbuf, flen, NULL, -1); + kissserial_send_rec_packet (save_tt_config_p->obj_recv_chan, KISS_CMD_DATA_FRAME, fbuf, flen, NULL, -1); + kisspt_send_rec_packet (save_tt_config_p->obj_recv_chan, KISS_CMD_DATA_FRAME, fbuf, flen, NULL, -1); + } + + if (first_time && save_tt_config_p->obj_send_to_ig) { + + //text_color_set(DW_COLOR_DEBUG); + //dw_printf ("xmit_object_report (): send to IGate\n"); + + igate_send_rec_packet (save_tt_config_p->obj_recv_chan, pp); + + } + + if ( ! first_time && save_tt_config_p->obj_xmit_chan >= 0) { + + /* Remember it so we don't digipeat our own. */ + + dedupe_remember (pp, save_tt_config_p->obj_xmit_chan); + + tq_append (save_tt_config_p->obj_xmit_chan, TQ_PRIO_1_LO, pp); + } + else { + ax25_delete (pp); + } + +#endif + + +} + +static const char *letters[26] = { + "Alpha", + "Bravo", + "Charlie", + "Delta", + "Echo", + "Foxtrot", + "Golf", + "Hotel", + "India", + "Juliet", + "Kilo", + "Lima", + "Mike", + "November", + "Oscar", + "Papa", + "Quebec", + "Romeo", + "Sierra", + "Tango", + "Uniform", + "Victor", + "Whiskey", + "X-ray", + "Yankee", + "Zulu" +}; + +static const char *digits[10] = { + "Zero", + "One", + "Two", + "Three", + "Four", + "Five", + "Six", + "Seven", + "Eight", + "Nine" +}; + + +/*------------------------------------------------------------------ + * + * Name: tt_setenv + * + * Purpose: Put information in environment variables in preparation + * for calling a user-supplied script for custom processing. + * + * Inputs: i - Index into tt_user table. + * + * Description: Timestamps displayed relative to current time. + * + *----------------------------------------------------------------*/ + + +static void tt_setenv (int i) +{ + char stemp[256]; + char t2[2]; + char *p; + + assert (i >= 0 && i < MAX_TT_USERS); + + setenv ("TTCALL", tt_user[i].callsign, 1); + + strlcpy (stemp, "", sizeof(stemp)); + t2[1] = '\0'; + for (p = tt_user[i].callsign; *p != '\0'; p++) { + t2[0] = *p; + strlcat (stemp, t2, sizeof(stemp)); + if (p[1] != '\0') strlcat (stemp, " ", sizeof(stemp)); + } + setenv ("TTCALLSP", stemp, 1); + + strlcpy (stemp, "", sizeof(stemp)); + for (p = tt_user[i].callsign; *p != '\0'; p++) { + if (isupper(*p)) { + strlcat (stemp, letters[*p - 'A'], sizeof(stemp)); + } + else if (islower(*p)) { + strlcat (stemp, letters[*p - 'a'], sizeof(stemp)); + } + else if (isdigit(*p)) { + strlcat (stemp, digits[*p - '0'], sizeof(stemp)); + } + else { + t2[0] = *p; + strlcat (stemp, t2, sizeof(stemp)); + } + if (p[1] != '\0') strlcat (stemp, " ", sizeof(stemp)); + } + setenv ("TTCALLPH", stemp, 1); + + snprintf (stemp, sizeof(stemp), "%d", tt_user[i].ssid); + setenv ("TTSSID",stemp , 1); + + snprintf (stemp, sizeof(stemp), "%d", tt_user[i].count); + setenv ("TTCOUNT",stemp , 1); + + snprintf (stemp, sizeof(stemp), "%c%c", tt_user[i].overlay, tt_user[i].symbol); + setenv ("TTSYMBOL",stemp , 1); + + snprintf (stemp, sizeof(stemp), "%.6f", tt_user[i].latitude); + setenv ("TTLAT",stemp , 1); + + snprintf (stemp, sizeof(stemp), "%.6f", tt_user[i].longitude); + setenv ("TTLON",stemp , 1); + + setenv ("TTFREQ", tt_user[i].freq, 1); + + // TODO: Should convert to actual frequency. e.g. 074 becomes 74.4 + // There is some code for this in decode_aprs.c but not broken out + // into a function that we could use from here. + // TODO: Document this environment variable after converting. + + setenv ("TTCTCSS", tt_user[i].ctcss, 1); + + setenv ("TTCOMMENT", tt_user[i].comment, 1); + + setenv ("TTLOC", tt_user[i].loc_text, 1); + + if (tt_user[i].mic_e >= '1' && tt_user[i].mic_e <= '9') { + setenv ("TTSTATUS", save_tt_config_p->status[tt_user[i].mic_e - '0'], 1); + } + else { + setenv ("TTSTATUS", "", 1); + } + + setenv ("TTDAO", tt_user[i].dao, 1); + +} /* end tt_setenv */ + + + +/*------------------------------------------------------------------ + * + * Name: tt_user_dump + * + * Purpose: Print information about known users for debugging. + * + * Inputs: None. + * + * Description: Timestamps displayed relative to current time. + * + *----------------------------------------------------------------*/ + +void tt_user_dump (void) +{ + int i; + time_t now = time(NULL); + + printf ("call ov suf lsthrd xmit nxt cor lat long freq ctcss m comment\n"); + for (i=0; i. +// + + +/*------------------------------------------------------------------ + * + * Module: ttcalc.c + * + * Purpose: Simple Touch Tone to Speech calculator. + * + * Description: Demonstration of how Dire Wolf can be used + * as a DTMF / Speech interface for ham radio applications. + * + * Usage: Start up direwolf with configuration: + * - DTMF decoder enabled. + * - Text-to-speech enabled. + * - Listening to standard port 8000 for a client application. + * + * Run this in a different window. + * + * User sends formulas such as: + * + * 2 * 3 * 4 # + * + * with the touch tone pad. + * The result is sent back with speech, e.g. "Twenty Four." + * + *---------------------------------------------------------------*/ + + +#include "direwolf.h" // Sets _WIN32_WINNT for XP API level needed by ws2tcpip.h + +#if __WIN32__ + +#include +#include // _WIN32_WINNT must be set to 0x0501 before including this +#else +#include +#include +#include +#include +#include +#include +#include +#include +#include +#endif + +#include +#include +#include +#include +#include + +#include "direwolf.h" +#include "ax25_pad.h" +#include "textcolor.h" + + +struct agwpe_s { + short portx; /* 0 for first, 1 for second, etc. */ + short port_hi_reserved; + short kind_lo; /* message type */ + short kind_hi; + char call_from[10]; + char call_to[10]; + int data_len; /* Number of data bytes following. */ + int user_reserved; +}; + + +static int calculator (char *str); +static int connect_to_server (char *hostname, char *port); +static char * ia_to_text (int Family, void * pAddr, char * pStringBuf, size_t StringBufSize); + + + +/*------------------------------------------------------------------ + * + * Name: main + * + *---------------------------------------------------------------*/ + + + +int main (int argc, char *argv[]) +{ + + int server_sock = -1; + struct agwpe_s mon_cmd; + char data[1024]; + char hostname[30] = "localhost"; + char port[10] = "8000"; + int err; + +#if __WIN32__ +#else + setlinebuf (stdout); +#endif + + assert (calculator("12a34#") == 46); + assert (calculator("2*3A4#") == 10); + assert (calculator("5*100A3#") == 503); + assert (calculator("6a4*5#") == 50); + +/* + * Try to attach to Dire Wolf. + */ + + server_sock = connect_to_server (hostname, port); + + + if (server_sock == -1) { + exit (1); + } + +/* + * Send command to toggle reception of frames in raw format. + * + * Note: Monitor format is only for UI frames. + */ + + memset (&mon_cmd, 0, sizeof(mon_cmd)); + + mon_cmd.kind_lo = 'k'; + + err = SOCK_SEND (server_sock, (char*)(&mon_cmd), sizeof(mon_cmd)); + (void)err; + +/* + * Print all of the monitored packets. + */ + + while (1) { + int n; + + n = SOCK_RECV (server_sock, (char*)(&mon_cmd), sizeof(mon_cmd)); + + if (n != sizeof(mon_cmd)) { + printf ("Read error, received %d command bytes.\n", n); + exit (1); + } + + assert (mon_cmd.data_len >= 0 && mon_cmd.data_len < (int)(sizeof(data))); + + if (mon_cmd.data_len > 0) { + n = SOCK_RECV (server_sock, data, mon_cmd.data_len); + + if (n != mon_cmd.data_len) { + printf ("Read error, client received %d data bytes when %d expected. Terminating.\n", n, mon_cmd.data_len); + exit (1); + } + } + +/* + * Print it. + */ + + if (mon_cmd.kind_lo == 'K') { + packet_t pp; + char *pinfo; + int info_len; + char result[400]; + char *p; + alevel_t alevel; + int chan; + + chan = mon_cmd.portx; + memset (&alevel, 0, sizeof(alevel)); + pp = ax25_from_frame ((unsigned char *)(data+1), mon_cmd.data_len-1, alevel); + ax25_format_addrs (pp, result); + info_len = ax25_get_info (pp, (unsigned char **)(&pinfo)); + pinfo[info_len] = '\0'; + strlcat (result, pinfo, sizeof(result)); + for (p=result; *p!='\0'; p++) { + if (! isprint(*p)) *p = ' '; + } + + printf ("[%d] %s\n", chan, result); + + +/* + * Look for Special touch tone packet with "t" in first position of the Information part. + */ + + if (*pinfo == 't') { + + int n; + char reply_text[200]; + packet_t reply_pp; + struct { + struct agwpe_s hdr; + char extra; + unsigned char frame[AX25_MAX_PACKET_LEN]; + } xmit_raw; + +/* + * Send touch tone sequence to calculator and get the answer. + * + * Put your own application here instead. Here are some ideas: + * + * http://www.tapr.org/pipermail/aprssig/2015-January/044069.html + */ + n = calculator (pinfo+1); + printf ("\nCalculator returns %d\n\n", n); + +/* + * Convert to AX.25 frame. + * Notice that the special destination will cause it to be spoken. + */ + snprintf (reply_text, sizeof(reply_text), "N0CALL>SPEECH:%d", n); + reply_pp = ax25_from_text(reply_text, 1); + +/* + * Send it to the TNC. + * In this example we are transmitting speech on the same channel + * where the tones were heard. We could also send AX.25 frames to + * other radio channels. + */ + memset (&xmit_raw, 0, sizeof(xmit_raw)); + + xmit_raw.hdr.portx = chan; + xmit_raw.hdr.kind_lo = 'K'; + xmit_raw.hdr.data_len = 1 + ax25_pack (reply_pp, xmit_raw.frame); + + err = SOCK_SEND (server_sock, (char*)(&xmit_raw), sizeof(xmit_raw.hdr)+xmit_raw.hdr.data_len); + ax25_delete (reply_pp); + } + + + ax25_delete (pp); + + } + } + +} /* main */ + + +/*------------------------------------------------------------------ + * + * Name: calculator + * + * Purpose: Simple calculator to demonstrate Touch Tone to Speech + * application tool kit. + * + * Inputs: str - Sequence of touch tone characters: 0-9 A-D * # + * It should be terminated with #. + * + * Returns: Numeric result of calculation. + * + * Description: This is a simple calculator that recognizes + * numbers, + * * for multiply + * A for add + * # for equals result + * + * Adding functions to B, C, and D is left as an + * exercise for the reader. + * + * Examples: 2 * 3 A 4 # Ten + * 5 * 1 0 0 A 3 # Five Hundred Three + * + *---------------------------------------------------------------*/ + +#define DO_LAST_OP \ + switch (lastop) { \ + case NONE: result = num; num = 0; break; \ + case ADD: result += num; num = 0; break; \ + case SUB: result -= num; num = 0; break; \ + case MUL: result *= num; num = 0; break; \ + case DIV: result /= num; num = 0; break; \ + } + +static int calculator (char *str) +{ + int result; + int num; + enum { NONE, ADD, SUB, MUL, DIV } lastop; + char *p; + + result = 0; + num = 0; + lastop = NONE; + + for (p = str; *p != '\0'; p++) { + if (isdigit(*p)) { + num = num * 10 + *p - '0'; + } + else if (*p == '*') { + DO_LAST_OP; + lastop = MUL; + } + else if (*p == 'A' || *p == 'a') { + DO_LAST_OP; + lastop = ADD; + } + else if (*p == '#') { + DO_LAST_OP; + return (result); + } + } + return (result); // not expected. +} + + +/*------------------------------------------------------------------ + * + * Name: connect_to_server + * + * Purpose: Connect to Dire Wolf TNC server. + * + * Inputs: hostname + * port + * + * Returns: File descriptor or -1 for error. + * + *---------------------------------------------------------------*/ + +static int connect_to_server (char *hostname, char *port) +{ + + +#if __WIN32__ +#else + //int e; +#endif + +#define MAX_HOSTS 30 + + struct addrinfo hints; + struct addrinfo *ai_head = NULL; + struct addrinfo *ai; + struct addrinfo *hosts[MAX_HOSTS]; + int num_hosts, n; + int err; + char ipaddr_str[46]; /* text form of IP address */ +#if __WIN32__ + WSADATA wsadata; +#endif +/* + * File descriptor for socket to server. + * Set to -1 if not connected. + * (Don't use SOCKET type because it is unsigned.) +*/ + int server_sock = -1; + +#if __WIN32__ + err = WSAStartup (MAKEWORD(2,2), &wsadata); + if (err != 0) { + printf("WSAStartup failed: %d\n", err); + exit (1); + } + + if (LOBYTE(wsadata.wVersion) != 2 || HIBYTE(wsadata.wVersion) != 2) { + printf("Could not find a usable version of Winsock.dll\n"); + WSACleanup(); + exit (1); + } +#endif + + memset (&hints, 0, sizeof(hints)); + + hints.ai_family = AF_UNSPEC; /* Allow either IPv4 or IPv6. */ + // hints.ai_family = AF_INET; /* IPv4 only. */ + hints.ai_socktype = SOCK_STREAM; + hints.ai_protocol = IPPROTO_TCP; + +/* + * Connect to specified hostname & port. + */ + + ai_head = NULL; + err = getaddrinfo(hostname, port, &hints, &ai_head); + if (err != 0) { +#if __WIN32__ + printf ("Can't get address for server %s, err=%d\n", hostname, WSAGetLastError()); +#else + printf ("Can't get address for server %s, %s\n", hostname, gai_strerror(err)); +#endif + freeaddrinfo(ai_head); + exit (1); + } + + + num_hosts = 0; + for (ai = ai_head; ai != NULL; ai = ai->ai_next) { + + hosts[num_hosts] = ai; + if (num_hosts < MAX_HOSTS) num_hosts++; + } + + // Try each address until we find one that is successful. + + for (n=0; nai_family, ai->ai_addr, ipaddr_str, sizeof(ipaddr_str)); + is = socket(ai->ai_family, ai->ai_socktype, ai->ai_protocol); +#if __WIN32__ + if (is == INVALID_SOCKET) { + printf ("Socket creation failed, err=%d", WSAGetLastError()); + WSACleanup(); + is = -1; + continue; + } +#else + if (err != 0) { + printf ("Socket creation failed, err=%s", gai_strerror(err)); + (void) close (is); + is = -1; + continue; + } +#endif + + err = connect(is, ai->ai_addr, (int)ai->ai_addrlen); +#if __WIN32__ + if (err == SOCKET_ERROR) { + closesocket (is); + is = -1; + continue; + } +#else + if (err != 0) { + (void) close (is); + is = -1; + continue; + } + int flag = 1; + err = setsockopt (is, IPPROTO_TCP, TCP_NODELAY, (void*)(long)(&flag), (socklen_t)sizeof(flag)); + if (err < 0) { + printf("setsockopt TCP_NODELAY failed.\n"); + } +#endif + +/* + * Success. + */ + + printf("Client app now connected to %s (%s), port %s\n", hostname, ipaddr_str, port); + server_sock = is; + break; + } + + freeaddrinfo(ai_head); + + if (server_sock == -1) { + printf("Unnable to connect to %s (%s), port %s\n", hostname, ipaddr_str, port); + + } + + return (server_sock); + +} /* end connect_to_server */ + + +/*------------------------------------------------------------------ + * + * Name: ia_to_text + * + * Purpose: Convert Internet address to text. + * Can't use InetNtop because it is supported only + * on Windows Vista and later. + * + *---------------------------------------------------------------*/ + + +static char * ia_to_text (int Family, void * pAddr, char * pStringBuf, size_t StringBufSize) +{ + struct sockaddr_in *sa4; + struct sockaddr_in6 *sa6; + + switch (Family) { + case AF_INET: + sa4 = (struct sockaddr_in *)pAddr; +#if __WIN32__ + snprintf (pStringBuf, StringBufSize, "%d.%d.%d.%d", sa4->sin_addr.S_un.S_un_b.s_b1, + sa4->sin_addr.S_un.S_un_b.s_b2, + sa4->sin_addr.S_un.S_un_b.s_b3, + sa4->sin_addr.S_un.S_un_b.s_b4); +#else + inet_ntop (AF_INET, &(sa4->sin_addr), pStringBuf, StringBufSize); +#endif + break; + case AF_INET6: + sa6 = (struct sockaddr_in6 *)pAddr; +#if __WIN32__ + snprintf (pStringBuf, StringBufSize, "%x:%x:%x:%x:%x:%x:%x:%x", + ntohs(((unsigned short *)(&(sa6->sin6_addr)))[0]), + ntohs(((unsigned short *)(&(sa6->sin6_addr)))[1]), + ntohs(((unsigned short *)(&(sa6->sin6_addr)))[2]), + ntohs(((unsigned short *)(&(sa6->sin6_addr)))[3]), + ntohs(((unsigned short *)(&(sa6->sin6_addr)))[4]), + ntohs(((unsigned short *)(&(sa6->sin6_addr)))[5]), + ntohs(((unsigned short *)(&(sa6->sin6_addr)))[6]), + ntohs(((unsigned short *)(&(sa6->sin6_addr)))[7])); +#else + inet_ntop (AF_INET6, &(sa6->sin6_addr), pStringBuf, StringBufSize); +#endif + break; + default: + snprintf (pStringBuf, StringBufSize, "Invalid address family!"); + } + + return pStringBuf; + +} /* end ia_to_text */ + + +/* end ttcalc.c */ diff --git a/tune.h b/src/tune.h similarity index 100% rename from tune.h rename to src/tune.h diff --git a/src/utm2ll.c b/src/utm2ll.c new file mode 100644 index 00000000..89dc55e5 --- /dev/null +++ b/src/utm2ll.c @@ -0,0 +1,145 @@ +/* UTM to Latitude / Longitude conversion */ + +#include "direwolf.h" + +#include +#include +#include +#include +#include + +#include "utm.h" +#include "mgrs.h" +#include "usng.h" +#include "error_string.h" + + +#define D2R(d) ((d) * M_PI / 180.) +#define R2D(r) ((r) * 180. / M_PI) + + + + +static void usage(); + + +int main (int argc, char *argv[]) +{ + double easting; + double northing; + double lat, lon; + char szone[100]; + long lzone; + char *zlet; + char hemi; + long err; + char message[300]; + + + if (argc == 4) { + +// 3 command line arguments for UTM + + strlcpy (szone, argv[1], sizeof(szone)); + lzone = strtoul(szone, &zlet, 10); + + if (*zlet == '\0') { + hemi = 'N'; + } + else { + + if (islower(*zlet)) { + *zlet = toupper(*zlet); + } + if (strchr ("CDEFGHJKLMNPQRSTUVWX", *zlet) == NULL) { + fprintf (stderr, "Latitudinal band must be one of CDEFGHJKLMNPQRSTUVWX.\n\n"); + usage(); + } + if (*zlet >= 'N') { + hemi = 'N'; + } + else { + hemi = 'S'; + } + } + + easting = atof(argv[2]); + + northing = atof(argv[3]); + + err = Convert_UTM_To_Geodetic(lzone, hemi, easting, northing, &lat, &lon); + if (err == 0) { + lat = R2D(lat); + lon = R2D(lon); + + printf ("from UTM, latitude = %.6f, longitude = %.6f\n", lat, lon); + } + else { + + utm_error_string (err, message); + fprintf (stderr, "Conversion from UTM failed:\n%s\n\n", message); + + } + } + else if (argc == 2) { + +// One command line argument, USNG or MGRS. + +// TODO: continue here. + + + err = Convert_USNG_To_Geodetic (argv[1], &lat, &lon); + if (err == 0) { + lat = R2D(lat); + lon = R2D(lon); + printf ("from USNG, latitude = %.6f, longitude = %.6f\n", lat, lon); + } + else { + usng_error_string (err, message); + fprintf (stderr, "Conversion from USNG failed:\n%s\n\n", message); + } + + err = Convert_MGRS_To_Geodetic (argv[1], &lat, &lon); + if (err == 0) { + lat = R2D(lat); + lon = R2D(lon); + printf ("from MGRS, latitude = %.6f, longitude = %.6f\n", lat, lon); + } + else { + mgrs_error_string (err, message); + fprintf (stderr, "Conversion from MGRS failed:\n%s\n\n", message); + } + + } + else { + usage(); + } + + exit (0); +} + + +static void usage (void) +{ + fprintf (stderr, "UTM to Latitude / Longitude conversion\n"); + fprintf (stderr, "\n"); + fprintf (stderr, "Usage:\n"); + fprintf (stderr, "\tutm2ll zone easting northing\n"); + fprintf (stderr, "\n"); + fprintf (stderr, "where,\n"); + fprintf (stderr, "\tzone is UTM zone 1 thru 60 with optional latitudinal band.\n"); + fprintf (stderr, "\teasting is x coordinate in meters\n"); + fprintf (stderr, "\tnorthing is y coordinate in meters\n"); + fprintf (stderr, "\n"); + fprintf (stderr, "or:\n"); + fprintf (stderr, "\tutm2ll x\n"); + fprintf (stderr, "\n"); + fprintf (stderr, "where,\n"); + fprintf (stderr, "\tx is USNG or MGRS location.\n"); + fprintf (stderr, "\n"); + fprintf (stderr, "Examples:\n"); + fprintf (stderr, "\tutm2ll 19T 306130 4726010\n"); + fprintf (stderr, "\tutm2ll 19TCH06132600\n"); + + exit (1); +} \ No newline at end of file diff --git a/src/version.h b/src/version.h new file mode 100644 index 00000000..a09490cc --- /dev/null +++ b/src/version.h @@ -0,0 +1,21 @@ + +/* Dire Wolf version 1.6 */ + +// Put in destination field to identify the equipment used. + +#define APP_TOCALL "APDW" // Assigned by WB4APR in tocalls.txt + +// This now comes from compile command line options. + +//#define MAJOR_VERSION 1 +//#define MINOR_VERSION 6 +//#define EXTRA_VERSION "Beta Test" + + +// For user-defined data format. +// APRS protocol spec Chapter 18 and http://www.aprs.org/aprs11/expfmts.txt + +#define USER_DEF_USER_ID 'D' // user id D for direwolf + +#define USER_DEF_TYPE_AIS 'A' // data type A for AIS NMEA sentence +#define USER_DEF_TYPE_EAS 'E' // data type E for EAS broadcasts diff --git a/src/walk96.c b/src/walk96.c new file mode 100644 index 00000000..9fc791f8 --- /dev/null +++ b/src/walk96.c @@ -0,0 +1,206 @@ +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// +// Copyright (C) 2015 John Langner, WB2OSZ +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . +// + + +//#define DEBUG 1 + +/*------------------------------------------------------------------ + * + * Module: walk96.c + * + * Purpose: Quick hack to read GPS location and send very frequent + * position reports frames to a KISS TNC. + * + * + *---------------------------------------------------------------*/ + +#include "direwolf.h" + +#include +#include +#include +#include +#include +#include + +#include "config.h" +#include "ax25_pad.h" +#include "textcolor.h" +#include "latlong.h" +#include "dwgps.h" +#include "encode_aprs.h" +#include "serial_port.h" +#include "kiss_frame.h" + + +#define MYCALL "WB2OSZ" /************ Change this if you use it!!! ***************/ + +#define HOWLONG 20 /* Run for 20 seconds then quit. */ + + + +static MYFDTYPE tnc; + +static void walk96 (int fix, double lat, double lon, float knots, float course, float alt); + + + +int main (int argc, char *argv[]) +{ + struct misc_config_s config; + char cmd[100]; + int debug_gps = 0; + int n; + + + // TD-D72A USB - Look for Silicon Labs CP210x. + // Just happens to be same on desktop & laptop. + + tnc = serial_port_open ("COM5", 9600); + if (tnc == MYFDERROR) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("Can't open serial port to KISS TNC.\n"); + exit (EXIT_FAILURE); // defined in stdlib.h + } + + strlcpy (cmd, "\r\rhbaud 9600\rkiss on\rrestart\r", sizeof(cmd)); + serial_port_write (tnc, cmd, strlen(cmd)); + + + // USB GPS happens to be COM22 + + memset (&config, 0, sizeof(config)); + strlcpy (config.gpsnmea_port, "COM22", sizeof(config.gpsnmea_port)); + + dwgps_init (&config, debug_gps); + + SLEEP_SEC(1); /* Wait for sample before reading. */ + + for (n=0; n DWFIX_2D) { + walk96 (fix, info.dlat, info.dlon, info.speed_knots, info.track, info.altitude); + } + else if (fix < 0) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("Can't communicate with GPS receiver.\n"); + exit (EXIT_FAILURE); + } + else { + text_color_set (DW_COLOR_ERROR); + dw_printf ("GPS fix not available.\n"); + } + SLEEP_SEC(1); + } + + + // Exit out of KISS mode. + + serial_port_write (tnc, "\xc0\xff\xc0", 3); + + SLEEP_MS(100); + exit (EXIT_SUCCESS); +} + + +/* Should be called once per second. */ + +static void walk96 (int fix, double lat, double lon, float knots, float course, float alt) +{ + static int sequence = 0; + char comment[50]; + + sequence++; + snprintf (comment, sizeof(comment), "Sequence number %04d", sequence); + + +/* + * Construct the packet in normal monitoring format. + */ + + int messaging = 0; + int compressed = 0; + + char info[AX25_MAX_INFO_LEN]; + int info_len; + + char position_report[AX25_MAX_PACKET_LEN]; + + +// TODO (high, bug): Why do we see !4237.13N/07120.84W=PHG0000... when all values set to unknown. + + + info_len = encode_position (messaging, compressed, + lat, lon, 0, (int)(DW_METERS_TO_FEET(alt)), + '/', '=', + G_UNKNOWN, G_UNKNOWN, G_UNKNOWN, "", // PHGd + (int)roundf(course), (int)roundf(knots), + 445.925, 0, 0, + comment, + info, sizeof(info)); + + snprintf (position_report, sizeof(position_report), "%s>WALK96:%s", MYCALL, info); + + text_color_set (DW_COLOR_XMIT); + dw_printf ("%s\n", position_report); + +/* + * Convert it into AX.25 frame. + */ + packet_t pp; + unsigned char ax25_frame[AX25_MAX_PACKET_LEN]; + int frame_len; + + pp = ax25_from_text (position_report, 1); + + if (pp == NULL) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("Unexpected error in ax25_from_text. Quitting.\n"); + exit (EXIT_FAILURE); // defined in stdlib.h + } + + ax25_frame[0] = 0; // Insert channel before KISS encapsulation. + + frame_len = ax25_pack (pp, ax25_frame+1); + ax25_delete (pp); + +/* + * Encapsulate as KISS and send to TNC. + */ + + unsigned char kiss_frame[AX25_MAX_PACKET_LEN*2]; + int kiss_len; + + kiss_len = kiss_encapsulate (ax25_frame, frame_len+1, (unsigned char *)kiss_frame); + + //text_color_set (DW_COLOR_DEBUG); + //dw_printf ("AX.25 frame length = %d, KISS frame length = %d\n", frame_len, kiss_len); + + //kiss_debug_print (1, NULL, kiss_frame, kiss_len); + + serial_port_write (tnc, kiss_frame, kiss_len); + +} + +/* end walk96.c */ diff --git a/src/waypoint.c b/src/waypoint.c new file mode 100644 index 00000000..20c1cdbc --- /dev/null +++ b/src/waypoint.c @@ -0,0 +1,709 @@ +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// +// Copyright (C) 2014, 2015, 2016, 2020 John Langner, WB2OSZ +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . +// + + +//#define DEBUG 1 + + +/*------------------------------------------------------------------ + * + * Module: waypoint.c + * + * Purpose: Send NMEA waypoint sentences to GPS display or mapping application. + * + *---------------------------------------------------------------*/ + + +#include "direwolf.h" // should be first + +#include +#include +#include + +#if __WIN32__ +#include +#include // _WIN32_WINNT must be set to 0x0501 before including this +#else +#include +#include +#include +#include +#include +//#include +#include // gethostbyname +#endif + +#include +#include +#include + + +#include "config.h" +#include "textcolor.h" +#include "latlong.h" +#include "waypoint.h" +#include "grm_sym.h" /* Garmin symbols */ +#include "mgn_icon.h" /* Magellan icons */ +#include "dwgpsnmea.h" +#include "serial_port.h" +#include "dwsock.h" + + +static MYFDTYPE s_waypoint_serial_port_fd = MYFDERROR; +static int s_waypoint_udp_sock_fd = -1; // ideally INVALID_SOCKET for Windows. +static struct sockaddr_in s_udp_dest_addr; + +static int s_waypoint_formats = 0; /* which formats should we generate? */ + +static int s_waypoint_debug = 0; /* Print information flowing to attached device. */ + + + +static void append_checksum (char *sentence); +static void send_sentence (char *sent); + + + +void waypoint_set_debug (int n) +{ + s_waypoint_debug = n; +} + + +/*------------------------------------------------------------------- + * + * Name: waypoint_init + * + * Purpose: Initialization for waypoint output port. + * + * Inputs: mc - Pointer to configuration options. + * + * ->waypoint_serial_port - Name of serial port. COM1, /dev/ttyS0, etc. + * + * ->waypoint_udp_hostname - Destination host when using UDP. + * + * ->waypoint_udp_portnum - UDP port number. + * + * (currently none) - speed, baud. Default 4800 if not set + * + * + * ->waypoint_formats - Set of formats enabled. + * If none set, default to generic & Kenwood here. + * + * Global output: s_waypoint_serial_port_fd + * s_waypoint_udp_sock_fd + * + * Description: First to see if this is shared with GPS input. + * If not, open serial port. + * In version 1.6 UDP is added. It is possible to use both. + * + * Restriction: MUST be done after GPS init because we might be sharing the + * same serial port device. + * + *---------------------------------------------------------------*/ + + +void waypoint_init (struct misc_config_s *mc) +{ + +#if DEBUG + text_color_set (DW_COLOR_DEBUG); + dw_printf ("waypoint_init() serial device=%s formats=%02x\n", mc->waypoint_serial_port, mc->waypoint_formats); + dw_printf ("waypoint_init() destination hostname=%s UDP port=%d\n", mc->waypoint_udp_hostname, mc->waypoint_udp_portnum); +#endif + + s_waypoint_udp_sock_fd = -1; + + if (mc->waypoint_udp_portnum > 0) { + + s_waypoint_udp_sock_fd = socket(AF_INET, SOCK_DGRAM, IPPROTO_UDP); + if (s_waypoint_udp_sock_fd != -1) { + + // Not thread-safe. Should use getaddrinfo instead. + struct hostent *hp = gethostbyname(mc->waypoint_udp_hostname); + + if (hp != NULL) { + memset ((char *)&s_udp_dest_addr, 0, sizeof(s_udp_dest_addr)); + s_udp_dest_addr.sin_family = AF_INET; + memcpy ((char *)&s_udp_dest_addr.sin_addr, (char *)hp->h_addr, hp->h_length); + s_udp_dest_addr.sin_port = htons(mc->waypoint_udp_portnum); + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Waypoint: Couldn't get address for %s\n", mc->waypoint_udp_hostname); + close (s_waypoint_udp_sock_fd); + s_waypoint_udp_sock_fd = -1; + } + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Couldn't create socket for waypoint send to %s\n", mc->waypoint_udp_hostname); + } + } + +/* + * TODO: + * Are we sharing with GPS input? + * First try to get fd if they have same device name. + * If that fails, do own serial port open. + */ + s_waypoint_serial_port_fd = MYFDERROR; + + if (strlen(mc->waypoint_serial_port) > 0) { + + s_waypoint_serial_port_fd = dwgpsnmea_get_fd (mc->waypoint_serial_port, 4800); + + if (s_waypoint_serial_port_fd == MYFDERROR) { + s_waypoint_serial_port_fd = serial_port_open (mc->waypoint_serial_port, 4800); + } + else { + text_color_set (DW_COLOR_INFO); + dw_printf ("Note: Sharing same port for GPS input and waypoint output.\n"); + } + + if (s_waypoint_serial_port_fd == MYFDERROR) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("Unable to open serial port %s for waypoint output.\n", mc->waypoint_serial_port); + } + } + +// Set default formats if user did not specify any. + + s_waypoint_formats = mc->waypoint_formats; + if (s_waypoint_formats == 0) { + s_waypoint_formats = WPL_FORMAT_NMEA_GENERIC | WPL_FORMAT_KENWOOD; + } + if (s_waypoint_formats & WPL_FORMAT_GARMIN) { + s_waypoint_formats |= WPL_FORMAT_NMEA_GENERIC; /* See explanation below. */ + } + +#if DEBUG + text_color_set (DW_COLOR_DEBUG); + dw_printf ("end of waypoint_init: s_waypoint_serial_port_fd = %d\n", s_waypoint_serial_port_fd); + dw_printf ("end of waypoint_init: s_waypoint_udp_sock_fd = %d\n", s_waypoint_udp_sock_fd); +#endif +} + + + +/*------------------------------------------------------------------- + * + * Name: append_checksum + * + * Purpose: Append checksum to the sentence. + * + * In/out: sentence - NMEA sentence beginning with '$'. + * + * Description: Checksum is exclusive of characters except leading '$'. + * We append '*' and an upper case two hexadecimal value. + * + * Don't add CR/LF at this point. + * + *--------------------------------------------------------------------*/ + +static void append_checksum (char *sentence) +{ + char *p; + int cs; + + assert (sentence[0] == '$'); + + cs = 0; + for (p = sentence+1; *p != '\0'; p++) { + cs ^= *p; + } + + sprintf (p, "*%02X", cs & 0xff); + +} /* end append_checksum */ + + + +/*------------------------------------------------------------------- + * + * Name: nema_send_waypoint + * + * Purpose: Convert APRS position or object into NMEA waypoint sentence + * for use by a GPS display or other mapping application. + * + * Inputs: wname_in - Name of waypoint. Max of 9 characters. + * dlat - Latitude. + * dlong - Longitude. + * symtab - Symbol table or overlay character. + * symbol - Symbol code. + * alt - Altitude in meters or G_UNKNOWN. + * course - Course in degrees or G_UNKNOWN for unknown. + * speed - Speed in knots or G_UNKNOWN. + * comment_in - Description or message. + * + * + * Description: Currently we send multiple styles. Maybe someday there might + * be an option to send a selected subset. + * + * $GPWPL - NMEA generic with only location and name. + * $PGRMW - Garmin, adds altitude, symbol, and comment + * to previously named waypoint. + * $PMGNWPL - Magellan, more complete for stationary objects. + * $PKWDWPL - Kenwood with APRS style symbol but missing comment. + * +* + * AvMap G5 notes: + * + * https://sites.google.com/site/kd7kuj/home/files?pli=1 + * https://sites.google.com/site/kd7kuj/home/files/AvMapMessaging040810.pdf?attredirects=0&d=1 + * + * It sends $GPGGA & $GPRMC with location. + * It understands generic $GPWPL and Kenwood $PKWDWPL. + * + * There are some proprietary $PAVP* used only for messaging. + * Messaging would be a separate project. + * + *--------------------------------------------------------------------*/ + + +void waypoint_send_sentence (char *name_in, double dlat, double dlong, char symtab, char symbol, + float alt, float course, float speed, char *comment_in) +{ + char wname[12]; /* Waypoint name. Any , or * removed. */ + char slat[12]; /* DDMM.mmmm */ + char slat_ns[2]; /* N or S */ + char slong[12]; /* DDDMM.mmmm */ + char slong_ew[2]; /* E or W */ + char wcomment[256]; /* Comment. Any , or * removed. */ + char salt[12]; /* altitude as string, empty if unknown */ + char sspeed[12]; /* speed as string, empty if unknown */ + char scourse[12]; /* course as string, empty if unknown */ + char *p; + + char sentence[500]; + +#if DEBUG + text_color_set (DW_COLOR_DEBUG); + dw_printf ("waypoint_send_sentence (\"%s\", \"%c%c\")\n", name_in, symtab, symbol); +#endif + +// Don't waste time if no destinations specified. + + if (s_waypoint_serial_port_fd == MYFDERROR && + s_waypoint_udp_sock_fd == -1) { + return; + } + +/* + * We need to remove any , or * from name, symbol, or comment because they are field delimiters. + * Follow precedent of Geosat AvMap $PAVPMSG sentence and make the following substitutions: + * + * , -> | + * * -> ~ + * + * The system on the other end would need to change them back after extracting the + * fields delimited by , or *. + * We will deal with the symbol in the Kenwood section. + * Needs to be left intact for other icon/symbol conversions. + */ + + strlcpy (wname, name_in, sizeof(wname)); + for (p=wname; *p != '\0'; p++) { + if (*p == ',') *p = '|'; + if (*p == '*') *p = '~'; + } + + strlcpy (wcomment, comment_in, sizeof(wcomment)); + for (p=wcomment; *p != '\0'; p++) { + if (*p == ',') *p = '|'; + if (*p == '*') *p = '~'; + } + + +/* + * Convert numeric values to character form. + * G_UNKNOWN value will result in an empty string. + */ + + latitude_to_nmea (dlat, slat, slat_ns); + longitude_to_nmea (dlong, slong, slong_ew); + + + if (alt == G_UNKNOWN) { + strcpy (salt, ""); + } + else { + snprintf (salt, sizeof(salt), "%.1f", alt); + } + + if (speed == G_UNKNOWN) { + strcpy (sspeed, ""); + } + else { + snprintf (sspeed, sizeof(sspeed), "%.1f", speed); + } + + if (course == G_UNKNOWN) { + strcpy (scourse, ""); + } + else { + snprintf (scourse, sizeof(scourse), "%.1f", course); + } + + +/* + * NMEA Generic. + * + * Has only location and name. Rather disappointing. + * + * $GPWPL,ddmm.mmmm,ns,dddmm.mmmm,ew,wname*99 + * + * Where, + * ddmm.mmmm,ns is latitude + * dddmm.mmmm,ew is longitude + * wname is the waypoint name + * *99 is checksum + */ + + if (s_waypoint_formats & WPL_FORMAT_NMEA_GENERIC) { + + snprintf (sentence, sizeof(sentence), "$GPWPL,%s,%s,%s,%s,%s", slat, slat_ns, slong, slong_ew, wname); + append_checksum (sentence); + send_sentence (sentence); + } + + +/* + * Garmin + * + * https://www8.garmin.com/support/pdf/NMEA_0183.pdf + * + * No location! Adds altitude, symbol, and comment to existing waypoint. + * So, we should always send the NMEA generic waypoint before this one. + * The init function should take care of that. + * + * $PGRMW,wname,alt,symbol,comment*99 + * + * Where, + * + * wname is waypoint name. Must match existing waypoint. + * alt is altitude in meters. + * symbol is symbol code. Hexadecimal up to FFFF. + * See Garmin Device Interface Specification + * 001-0063-00 for values of "symbol_type." + * comment is comment for the waypoint. + * *99 is checksum + */ + + if (s_waypoint_formats & WPL_FORMAT_GARMIN) { + + int i = symbol - ' '; + int grm_sym; /* Garmin symbol code. */ + + if (i >= 0 && i < SYMTAB_SIZE) { + if (symtab == '/') { + grm_sym = grm_primary_symtab[i]; + } + else { + grm_sym = grm_alternate_symtab[i]; + } + } + else { + grm_sym = sym_default; + } + + snprintf (sentence, sizeof(sentence), "$PGRMW,%s,%s,%04X,%s", wname, salt, grm_sym, wcomment); + append_checksum (sentence); + send_sentence (sentence); + } + + +/* + * Magellan + * + * http://www.gpsinformation.org/mag-proto-2-11.pdf Rev 2.11, Mar 2003, P/N 21-00091-000 + * http://gpsinformation.net/mag-proto.htm Rev 1.0, Aug 1999, P/N 21-00091-000 + * + * + * $PMGNWPL,ddmm.mmmm,ns,dddmm.mmmm,ew,alt,unit,wname,comment,icon,xx*99 + * + * Where, + * ddmm.mmmm,ns is latitude + * dddmm.mmmm,ew is longitude + * alt is altitude + * unit is M for meters or F for feet + * wname is the waypoint name + * comment is message or comment + * icon is one or two letters for icon code + * xx is waypoint type which is optional, not well + * defined, and not used in their example + * so we won't use it. + * *99 is checksum + * + * Possible enhancement: If the "object report" has the kill option set, use $PMGNDWP + * to delete that specific waypoint. + */ + + if (s_waypoint_formats & WPL_FORMAT_MAGELLAN) { + + int i = symbol - ' '; + char sicon[3]; /* Magellan icon string. Currently 1 or 2 characters. */ + + if (i >= 0 && i < SYMTAB_SIZE) { + if (symtab == '/') { + strlcpy (sicon, mgn_primary_symtab[i], sizeof(sicon)); + } + else { + strlcpy (sicon, mgn_alternate_symtab[i], sizeof(sicon)); + } + } + else { + strlcpy (sicon, MGN_default, sizeof(sicon)); + } + + snprintf (sentence, sizeof(sentence), "$PMGNWPL,%s,%s,%s,%s,%s,M,%s,%s,%s", + slat, slat_ns, slong, slong_ew, salt, wname, wcomment, sicon); + append_checksum (sentence); + send_sentence (sentence); + } + + +/* + * Kenwood + * + * + * $PKWDWPL,hhmmss,v,ddmm.mm,ns,dddmm.mm,ew,speed,course,ddmmyy,alt,wname,ts*99 + * + * Where, + * hhmmss is time in UTC from the clock in the transceiver. + * + * This will be bogus if the clock was not set properly. + * It does not use the timestamp from a position + * report which could be useful. + * + * GPS Status A = active, V = void. + * It looks like this might be modeled after the GPS status values + * we see in $GPRMC. i.e. Does the transceiver know its location? + * I don't see how that information would be relevant in this context. + * I've observed this under various conditions (No GPS, GPS with/without + * fix) and it has always been "V." + * (There is some information out there indicating this field + * can contain "I" for invalid but I don't think that is accurate.) + * + * ddmm.mm,ns is latitude. N or S. + * dddmm.mm,ew is longitude. E or W. + * + * The D710 produces two fractional digits for minutes. + * This is the same resolution most often used + * in APRS packets. Any additional resolution offered by + * the compressed format or the DAO option is not conveyed here. + * We will provide greater resolution. + * + * speed is speed over ground, knots. + * course is course over ground, degrees. + * + * Empty if not available. + * + * ddmmyy is date. See comments for time. + * + * alt is altitude, meters above mean sea level. + * + * Empty if no altitude is available. + * + * wname is the waypoint name. For an Object Report, the id is the object name. + * For a position report, it is the call of the sending station. + * + * An Object name can contain any printable characters. + * What if object name contains , or * characters? + * Those are field delimiter characters and it would be unfortunate + * if they appeared in a NMEA sentence data field. + * + * If there is a comma in the name, such as "test,5" the D710A displays + * it fine but we end up with an extra field. + * + * $PKWDWPL,150803,V,4237.14,N,07120.83,W,,,190316,,test,5,/'*30 + * + * If the name contains an asterisk, it doesn't show up on the + * display and no waypoint sentence is generated. + * We will substitute these two characters following the AvMap precedent. + * + * $PKWDWPL,204714,V,4237.1400,N,07120.8300,W,,,200316,,test|5,/'*61 + * $PKWDWPL,204719,V,4237.1400,N,07120.8300,W,,,200316,,test~6,/'*6D + * + * ts are the table and symbol. + * + * What happens if the symbol is comma or asterisk? + * , Boy Scouts / Girl Scouts + * * SnowMobile / Snow + * + * the D710A just pushes them thru without checking. + * These would not be parsed properly: + * + * $PKWDWPL,150753,V,4237.14,N,07120.83,W,,,190316,,test3,/,*1B + * $PKWDWPL,150758,V,4237.14,N,07120.83,W,,,190316,,test4,/ **3B + * + * We perform the usual substitution and the other end would + * need to change them back after extracting from NMEA sentence. + * + * $PKWDWPL,204704,V,4237.1400,N,07120.8300,W,,,200316,,test3,/|*41 + * $PKWDWPL,204709,V,4237.1400,N,07120.8300,W,,,200316,,test4,/~*49 + * + * + * *99 is checksum + * + * Oddly, there is no place for comment. + */ + + + + if (s_waypoint_formats & WPL_FORMAT_KENWOOD) { + + time_t now; + struct tm tm; + char stime[8]; + char sdate[8]; + char ken_sym; /* APRS symbol with , or * substituted. */ + + now = time(NULL); + (void)gmtime_r (&now, &tm); + strftime (stime, sizeof(stime), "%H%M%S", &tm); + strftime (sdate, sizeof(sdate), "%d%m%y", &tm); + + // A symbol code of , or * would not be good because + // they are field delimiters for NMEA sentences. + + // The AvMap G5 to Kenwood protocol description performs a substitution + // for these characters that appear in message text. + // , -> | + // * -> ~ + + // Those two are listed as "TNC Stream Switch" and are not used for symbols. + // It might be reasonable assumption that this same substitution might be + // used for the symbol code. + + if (symbol == ',') ken_sym = '|'; + else if (symbol == '*') ken_sym = '~'; + else ken_sym = symbol; + + snprintf (sentence, sizeof(sentence), "$PKWDWPL,%s,V,%s,%s,%s,%s,%s,%s,%s,%s,%s,%c%c", + stime, slat, slat_ns, slong, slong_ew, + sspeed, scourse, sdate, salt, wname, symtab, ken_sym); + append_checksum (sentence); + send_sentence (sentence); + } + + +/* + * One application recognizes these. Not implemented at this time. + * + * $GPTLL,01,ddmm.mmmm,ns,dddmm.mmmm,ew,tname,000000.00,T,R*99 + * + * Where, + * ddmm.mmmm,ns is latitude + * dddmm.mmmm,ew is longitude + * tname is the target name + * 000000.00 is timestamp ??? + * T is target status (S for need help) + * R is reference target ??? + * *99 is checksum + * + * + * $GPTXT,01,01,tname,message*99 + * + * Where, + * + * 01 is total number of messages in transmission + * 01 is message number in this transmission + * tname is target name. Should match name in WPL or TTL. + * message is the message. + * *99 is checksum + * + */ + + +} /* end waypoint_send_sentence */ + + +/*------------------------------------------------------------------- + * + * Name: nema_send_ais + * + * Purpose: Send NMEA AIS sentence to GPS display or other mapping application. + * + * Inputs: sentence - should look something like this, with checksum, and no CR LF. + * + * !AIVDM,1,1,,A,35NO=dPOiAJriVDH@94E84AJ0000,0*4B + * + *--------------------------------------------------------------------*/ + +void waypoint_send_ais (char *sentence) +{ + if (s_waypoint_serial_port_fd == MYFDERROR && + s_waypoint_udp_sock_fd == -1) { + return; + } + + if (s_waypoint_formats & WPL_FORMAT_AIS) { + send_sentence (sentence); + } +} + + +/* + * Append CR LF and send it. + */ + +static void send_sentence (char *sent) +{ + char final[256]; + + if (s_waypoint_debug) { + text_color_set(DW_COLOR_XMIT); + dw_printf ("waypoint send sentence: \"%s\"\n", sent); + } + + strlcpy (final, sent, sizeof(final)); + strlcat (final, "\r\n", sizeof(final)); + int final_len = strlen(final); + + if (s_waypoint_serial_port_fd != MYFDERROR) { + serial_port_write (s_waypoint_serial_port_fd, final, final_len); + } + + if (s_waypoint_udp_sock_fd != -1) { + int n = sendto(s_waypoint_udp_sock_fd, final, final_len, 0, (struct sockaddr*)(&s_udp_dest_addr), sizeof(struct sockaddr_in)); + if (n != final_len) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Failed to send waypoint via UDP, errno=%d\n", errno); + } + } + +} /* send_sentence */ + + + +void waypoint_term (void) +{ + if (s_waypoint_serial_port_fd != MYFDERROR) { + //serial_port_close (s_waypoint_port_fd); + s_waypoint_serial_port_fd = MYFDERROR; + } + if (s_waypoint_udp_sock_fd != -1) { + close (s_waypoint_udp_sock_fd); + s_waypoint_udp_sock_fd = -1; + } +} + + +/* end waypoint.c */ diff --git a/src/waypoint.h b/src/waypoint.h new file mode 100644 index 00000000..3ba6f1c8 --- /dev/null +++ b/src/waypoint.h @@ -0,0 +1,24 @@ + +/* + * Name: waypoint.h + */ + + +#include "ax25_pad.h" /* for packet_t */ + +#include "config.h" /* for struct misc_config_s */ + + +void waypoint_init (struct misc_config_s *misc_config); + +void waypoint_set_debug (int n); + +void waypoint_send_sentence (char *wname_in, double dlat, double dlong, char symtab, char symbol, + float alt, float course, float speed, char *comment_in); + +void waypoint_send_ais (char *sentence); + +void waypoint_term (); + + +/* end waypoint.h */ diff --git a/src/xid.c b/src/xid.c new file mode 100644 index 00000000..14e67e8d --- /dev/null +++ b/src/xid.c @@ -0,0 +1,837 @@ + +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// +// Copyright (C) 2014, 2016, 2017 John Langner, WB2OSZ +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . + + + +/*------------------------------------------------------------------ + * + * Module: xid.c + * + * Purpose: Encode and decode the info field of XID frames. + * + * Description: If we originate the connection, and the other end is + * capable of AX.25 version 2.2, + * + * - We send an XID command frame with our capabilities. + * - the other sends back an XID response, possibly + * reducing some values to be acceptable there. + * - Both ends use the values in that response. + * + * If the other end originates the connection, + * + * - It sends XID command frame with its capabilities. + * - We might decrease some of them to be acceptable. + * - Send XID response. + * - Both ends use values in my response. + * + * References: AX.25 Protocol Spec, sections 4.3.3.7 & 6.3.2. + * + *---------------------------------------------------------------*/ + +#include "direwolf.h" + +#include +#include +#include +#include +#include + +#include "textcolor.h" +#include "xid.h" + + + +#define FI_Format_Indicator 0x82 +#define GI_Group_Identifier 0x80 + +#define PI_Classes_of_Procedures 2 +#define PI_HDLC_Optional_Functions 3 +#define PI_I_Field_Length_Rx 6 +#define PI_Window_Size_Rx 8 +#define PI_Ack_Timer 9 +#define PI_Retries 10 + +// Forget about the bit order at the physical layer (e.g. HDLC). +// It doesn't matter at all here. We are dealing with bytes. +// A different encoding could send the bits in the opposite order. + +// The bit numbers are confusing because this one table (Fig. 4.5) starts +// with 1 for the LSB when everywhere else refers to the LSB as bit 0. + +// The first byte must be of the form 0xx0 0001 +// The second byte must be of the form 0000 0000 +// If we process the two byte "Classes of Procedures" like +// the other multibyte numeric fields, with the more significant +// byte first, we end up with the bit masks below. +// The bit order would be 8 7 6 5 4 3 2 1 16 15 14 13 12 11 10 9 + +// (This has nothing to do with the HDLC serializing order. +// I'm talking about the way we would normally write binary numbers.) + +#define PV_Classes_Procedures_Balanced_ABM 0x0100 +#define PV_Classes_Procedures_Half_Duplex 0x2000 +#define PV_Classes_Procedures_Full_Duplex 0x4000 + + +// The first byte must be of the form 1000 0xx0 +// The second byte must be of the form 1010 xx00 +// The third byte must be of the form 0000 0010 +// If we process the three byte "HDLC Optional Parameters" like +// the other multibyte numeric fields, with the most significant +// byte first, we end up with bit masks like this. +// The bit order would be 8 7 6 5 4 3 2 1 16 15 14 13 12 11 10 9 24 23 22 21 20 19 18 17 + +#define PV_HDLC_Optional_Functions_REJ_cmd_resp 0x020000 +#define PV_HDLC_Optional_Functions_SREJ_cmd_resp 0x040000 +#define PV_HDLC_Optional_Functions_Extended_Address 0x800000 + +#define PV_HDLC_Optional_Functions_Modulo_8 0x000400 +#define PV_HDLC_Optional_Functions_Modulo_128 0x000800 +#define PV_HDLC_Optional_Functions_TEST_cmd_resp 0x002000 +#define PV_HDLC_Optional_Functions_16_bit_FCS 0x008000 + +#define PV_HDLC_Optional_Functions_Multi_SREJ_cmd_resp 0x000020 +#define PV_HDLC_Optional_Functions_Segmenter 0x000040 + +#define PV_HDLC_Optional_Functions_Synchronous_Tx 0x000002 + + +/*------------------------------------------------------------------- + * + * Name: xid_parse + * + * Purpose: Decode information part of XID frame into individual values. + * + * Inputs: info - pointer to information part of frame. + * + * info_len - Number of bytes in information part of frame. + * Could be 0. + * + * desc_size - Size of desc. 100 is good. + * + * Outputs: result - Structure with extracted values. + * + * desc - Text description for troubleshooting. + * + * Returns: 1 for mostly successful (with possible error messages), 0 for failure. + * + * Description: 6.3.2 "The receipt of an XID response from the other station + * establishes that both stations are using AX.25 version + * 2.2 or higher and enables the use of the segmenter/reassembler + * and selective reject." + * + *--------------------------------------------------------------------*/ + + +int xid_parse (unsigned char *info, int info_len, struct xid_param_s *result, char *desc, int desc_size) +{ + unsigned char *p; + int group_len; + char stemp[64]; + + + strlcpy (desc, "", desc_size); + +// What should we do when some fields are missing? + +// The AX.25 v2.2 protocol spec says, for most of these, +// "If this field is not present, the current values are retained." + +// We set the numeric values to our usual G_UNKNOWN to mean undefined and let the caller deal with it. +// rej and modulo are enum so we can't use G_UNKNOWN there. + + result->full_duplex = G_UNKNOWN; + result->srej = srej_not_specified; + result->modulo = modulo_unknown; + result->i_field_length_rx = G_UNKNOWN; + result->window_size_rx = G_UNKNOWN; + result->ack_timer = G_UNKNOWN; + result->retries = G_UNKNOWN; + + +/* Information field is optional but that seems pretty lame. */ + + if (info_len == 0) { + return (1); + } + + p = info; + + if (*p != FI_Format_Indicator) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("XID error: First byte of info field should be Format Indicator, %02x.\n", FI_Format_Indicator); + dw_printf ("XID info part: %02x %02x %02x %02x %02x ... length=%d\n", info[0], info[1], info[2], info[3], info[4], info_len); + return 0; + } + p++; + + if (*p != GI_Group_Identifier) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("XID error: Second byte of info field should be Group Indicator, %d.\n", GI_Group_Identifier); + return 0; + } + p++; + + group_len = *p++; + group_len = (group_len << 8) + *p++; + + while (p < info + 4 + group_len) { + + int pind, plen, pval, j; + + pind = *p++; + plen = *p++; // should have sanity checking + if (plen < 1 || plen > 4) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("XID error: Length ????? TODO ???? %d.\n", plen); + return (1); // got this far. + } + pval = 0; + for (j=0; jfull_duplex = 0; + strlcat (desc, "Half-Duplex ", desc_size); + } + else if (pval & PV_Classes_Procedures_Full_Duplex && ! (pval & PV_Classes_Procedures_Half_Duplex)) { + result->full_duplex = 1; + strlcat (desc, "Full-Duplex ", desc_size); + } + else { + text_color_set (DW_COLOR_ERROR); + dw_printf ("XID error: Expected one of Half or Full Duplex be set.\n"); + result->full_duplex = 0; + } + + break; + + case PI_HDLC_Optional_Functions: + + // Pick highest of those offered. + + if (pval & PV_HDLC_Optional_Functions_REJ_cmd_resp) { + strlcat (desc, "REJ ", desc_size); + } + if (pval & PV_HDLC_Optional_Functions_SREJ_cmd_resp) { + strlcat (desc, "SREJ ", desc_size); + } + if (pval & PV_HDLC_Optional_Functions_Multi_SREJ_cmd_resp) { + strlcat (desc, "Multi-SREJ ", desc_size); + } + + if (pval & PV_HDLC_Optional_Functions_Multi_SREJ_cmd_resp) { + result->srej = srej_multi; + } + else if (pval & PV_HDLC_Optional_Functions_SREJ_cmd_resp) { + result->srej = srej_single; + } + else if (pval & PV_HDLC_Optional_Functions_REJ_cmd_resp) { + result->srej = srej_none; + } + else { + text_color_set (DW_COLOR_ERROR); + dw_printf ("XID error: Expected at least one of REJ, SREJ, Multi-SREJ to be set.\n"); + result->srej = srej_none; + } + + if ((pval & PV_HDLC_Optional_Functions_Modulo_8) && ! (pval & PV_HDLC_Optional_Functions_Modulo_128)) { + result->modulo = modulo_8; + strlcat (desc, "modulo-8 ", desc_size); + } + else if ((pval & PV_HDLC_Optional_Functions_Modulo_128) && ! (pval & PV_HDLC_Optional_Functions_Modulo_8)) { + result->modulo = modulo_128; + strlcat (desc, "modulo-128 ", desc_size); + } + else { + text_color_set (DW_COLOR_ERROR); + dw_printf ("XID error: Expected one of Modulo 8 or 128 be set.\n"); + } + + if ( ! (pval & PV_HDLC_Optional_Functions_Extended_Address)) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("XID error: Expected Extended Address to be set.\n"); + } + + if ( ! (pval & PV_HDLC_Optional_Functions_TEST_cmd_resp)) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("XID error: Expected TEST cmd/resp to be set.\n"); + } + + if ( ! (pval & PV_HDLC_Optional_Functions_16_bit_FCS)) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("XID error: Expected 16 bit FCS to be set.\n"); + } + + if ( ! (pval & PV_HDLC_Optional_Functions_Synchronous_Tx)) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("XID error: Expected Synchronous Tx to be set.\n"); + } + + break; + + case PI_I_Field_Length_Rx: + + result->i_field_length_rx = pval / 8; + + snprintf (stemp, sizeof(stemp), "I-Field-Length-Rx=%d ", result->i_field_length_rx); + strlcat (desc, stemp, desc_size); + + if (pval & 0x7) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("XID error: I Field Length Rx, %d, is not a whole number of bytes.\n", pval); + } + + break; + + case PI_Window_Size_Rx: + + result->window_size_rx = pval; + + snprintf (stemp, sizeof(stemp), "Window-Size-Rx=%d ", result->window_size_rx); + strlcat (desc, stemp, desc_size); + + if (pval < 1 || pval > 127) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("XID error: Window Size Rx, %d, is not in range of 1 thru 127.\n", pval); + result->window_size_rx = 127; + // Let the caller deal with modulo 8 consideration. + } + +//continue here with more error checking. + + break; + + case PI_Ack_Timer: + result->ack_timer = pval; + + snprintf (stemp, sizeof(stemp), "Ack-Timer=%d ", result->ack_timer); + strlcat (desc, stemp, desc_size); + + break; + + case PI_Retries: // Is it retrys or retries? + result->retries = pval; + + snprintf (stemp, sizeof(stemp), "Retries=%d ", result->retries); + strlcat (desc, stemp, desc_size); + + break; + + default: + break; // Ignore anything we don't recognize. + } + } + + if (p != info + info_len) { + text_color_set (DW_COLOR_ERROR); + dw_printf ("XID error: Frame / Group Length mismatch.\n"); + } + + return (1); + +} /* end xid_parse */ + + +/*------------------------------------------------------------------- + * + * Name: xid_encode + * + * Purpose: Encode the information part of an XID frame. + * + * Inputs: param-> + * full_duplex - As command, am I capable of full duplex operation? + * When a response, are we both? + * 0 = half duplex. + * 1 = full duplex. + * + * srej - Level of selective reject. + * srej_none (use REJ), srej_single, srej_multi + * As command, offer a menu of what I can handle. (i.e. perhaps multiple bits set) + * As response, take minimum of what is offered and what I can handle. (one bit set) + * + * modulo - 8 or 128. + * + * i_field_length_rx - Maximum number of bytes I can handle in info part. + * Default is 256. + * Up to 8191 will fit into the field. + * Use G_UNKNOWN to omit this. + * + * window_size_rx - Maximum window size ("k") that I can handle. + * Defaults are are 4 for modulo 8 and 32 for modulo 128. + * + * ack_timer - Acknowledge timer in milliseconds. + * *** describe meaning. *** + * Default is 3000. + * Use G_UNKNOWN to omit this. + * + * retries - Allows negotiation of retries. + * Default is 10. + * Use G_UNKNOWN to omit this. + * + * cr - Is it a command or response? + * + * Outputs: info - Information part of XID frame. + * Does not include the control byte. + * Use buffer of 40 bytes just to be safe. + * + * Returns: Number of bytes in the info part. Should be at most 27. + * Again, provide a larger space just to be safe in case this ever changes. + * + * Description: 6.3.2 "Parameter negotiation occurs at any time. It is accomplished by sending + * the XID command frame and receiving the XID response frame. Implementations of + * AX.25 prior to version 2.2 respond to an XID command frame with a FRMR response + * frame. The TNC receiving the FRMR uses a default set of parameters compatible + * with previous versions of AX.25." + * + * "This version of AX.25 implements the negotiation or notification of six AX.25 + * parameters. Notification simply tells the distant TNC some limit that cannot be exceeded. + * The distant TNC can choose to use the limit or some other value that is within the + * limits. Notification is used with the Window Size Receive (k) and Information + * Field Length Receive (N1) parameters. Negotiation involves both TNCs choosing a + * value that is mutually acceptable. The XID command frame contains a set of values + * acceptable to the originating TNC. The distant TNC chooses to accept the values + * offered, or other acceptable values, and places these values in the XID response. + * Both TNCs set themselves up based on the values used in the XID response. Negotiation + * is used by Classes of Procedures, HDLC Optional Functions, Acknowledge Timer and Retries." + * + * Comment: I have a problem with "... occurs at any time." What if we were in the middle + * of transferring a large file with k=32 then along comes XID which says switch to modulo 8? + * + * Insight: Or is it Erratum? + * After reading the base standards documents, it seems that the XID command should offer + * up a menu of all the acceptable choices. e.g. REJ, SREJ, Multi-SREJ. One or more bits + * can be set. The XID response, would set a single bit which is the desired choice from + * among those offered. + * Should go back and review half/full duplex and modulo. + * + *--------------------------------------------------------------------*/ + + +int xid_encode (struct xid_param_s *param, unsigned char *info, cmdres_t cr) +{ + unsigned char *p; + int len; + int x; + int m = 0; + + + p = info; + + *p++ = FI_Format_Indicator; + *p++ = GI_Group_Identifier; + *p++ = 0; + + m = 4; // classes of procedures + m += 5; // HDLC optional features + if (param->i_field_length_rx != G_UNKNOWN) m += 4; + if (param->window_size_rx != G_UNKNOWN) m += 3; + if (param->ack_timer != G_UNKNOWN) m += 4; + if (param->retries != G_UNKNOWN) m += 3; + + *p++ = m; // 0x17 if all present. + +// "Classes of Procedures" has half / full duplex. + +// We always send this. + + *p++ = PI_Classes_of_Procedures; + *p++ = 2; + + x = PV_Classes_Procedures_Balanced_ABM; + + if (param->full_duplex == 1) + x |= PV_Classes_Procedures_Full_Duplex; + else // includes G_UNKNOWN + x |= PV_Classes_Procedures_Half_Duplex; + + *p++ = (x >> 8) & 0xff; + *p++ = x & 0xff; + +// "HDLC Optional Functions" contains REJ/SREJ & modulo 8/128. + +// We always send this. +// Watch out for unknown values and do something reasonable. + + *p++ = PI_HDLC_Optional_Functions; + *p++ = 3; + + x = PV_HDLC_Optional_Functions_Extended_Address | + PV_HDLC_Optional_Functions_TEST_cmd_resp | + PV_HDLC_Optional_Functions_16_bit_FCS | + PV_HDLC_Optional_Functions_Synchronous_Tx; + + //text_color_set (DW_COLOR_ERROR); + //dw_printf ("****** XID temp hack - test no SREJ ******\n"); + // param->srej = srej_none; + + if (cr == cr_cmd) { + // offer a "menu" of acceptable choices. i.e. 1, 2 or 3 bits set. + switch (param->srej) { + case srej_none: + default: + x |= PV_HDLC_Optional_Functions_REJ_cmd_resp; + break; + case srej_single: + x |= PV_HDLC_Optional_Functions_REJ_cmd_resp | + PV_HDLC_Optional_Functions_SREJ_cmd_resp; + break; + case srej_multi: + x |= PV_HDLC_Optional_Functions_REJ_cmd_resp | + PV_HDLC_Optional_Functions_SREJ_cmd_resp | + PV_HDLC_Optional_Functions_Multi_SREJ_cmd_resp; + break; + } + } + else { + // for response, set only a single bit. + switch (param->srej) { + case srej_none: + default: + x |= PV_HDLC_Optional_Functions_REJ_cmd_resp; + break; + case srej_single: + x |= PV_HDLC_Optional_Functions_SREJ_cmd_resp; + break; + case srej_multi: + x |= PV_HDLC_Optional_Functions_Multi_SREJ_cmd_resp; + break; + } + } + + if (param->modulo == modulo_128) + x |= PV_HDLC_Optional_Functions_Modulo_128; + else // includes modulo_8 and modulo_unknown + x |= PV_HDLC_Optional_Functions_Modulo_8; + + *p++ = (x >> 16) & 0xff; + *p++ = (x >> 8) & 0xff; + *p++ = x & 0xff; + +// The rest are skipped if undefined values. + +// "I Field Length Rx" - max I field length acceptable to me. +// This is in bits. 8191 would be max number of bytes to fit in field. + + if (param->i_field_length_rx != G_UNKNOWN) { + *p++ = PI_I_Field_Length_Rx; + *p++ = 2; + x = param->i_field_length_rx * 8; + *p++ = (x >> 8) & 0xff; + *p++ = x & 0xff; + } + +// "Window Size Rx" + + if (param->window_size_rx != G_UNKNOWN) { + *p++ = PI_Window_Size_Rx; + *p++ = 1; + *p++ = param->window_size_rx; + } + +// "Ack Timer" milliseconds. We could handle up to 65535 here. + + if (param->ack_timer != G_UNKNOWN) { + *p++ = PI_Ack_Timer; + *p++ = 2; + *p++ = (param->ack_timer >> 8) & 0xff; + *p++ = param->ack_timer & 0xff; + } + +// "Retries." + + if (param->retries != G_UNKNOWN) { + *p++ = PI_Retries; + *p++ = 1; + *p++ = param->retries; + } + + len = p - info; + + return (len); + +} /* end xid_encode */ + + + +/*------------------------------------------------------------------- + * + * Name: main + * + * Purpose: Unit test for other functions here. + * + * Description: Run with: + * + * gcc -DXIDTEST -g xid.c textcolor.o && ./a + * + * Result should be: + * + * XID test: Success. + * + * with no error messages. + * + *--------------------------------------------------------------------*/ + + +#if XIDTEST + +/* From Figure 4.6. Typical XID frame, from AX.25 protocol spec, v. 2.2 */ +/* This is the info part after a control byte of 0xAF. */ + +static unsigned char example[27] = { + + /* FI */ 0x82, /* Format indicator */ + /* GI */ 0x80, /* Group Identifier - parameter negotiation */ + /* GL */ 0x00, /* Group length - all of the PI/PL/PV fields */ + /* GL */ 0x17, /* (2 bytes) */ + /* PI */ 0x02, /* Parameter Indicator - classes of procedures */ + /* PL */ 0x02, /* Parameter Length */ +#if 0 // Erratum: Example in the protocol spec looks wrong. + /* PV */ 0x00, /* Parameter Variable - Half Duplex, Async, Balanced Mode */ + /* PV */ 0x20, /* */ +#else // I think it should be like this instead. + /* PV */ 0x21, /* Parameter Variable - Half Duplex, Async, Balanced Mode */ + /* PV */ 0x00, /* Reserved */ +#endif + /* PI */ 0x03, /* Parameter Indicator - optional functions */ + /* PL */ 0x03, /* Parameter Length */ + /* PV */ 0x86, /* Parameter Variable - SREJ/REJ, extended addr */ + /* PV */ 0xA8, /* 16-bit FCS, TEST cmd/resp, Modulo 128 */ + /* PV */ 0x02, /* synchronous transmit */ + /* PI */ 0x06, /* Parameter Indicator - Rx I field length (bits) */ + /* PL */ 0x02, /* Parameter Length */ + +// Erratum: The text does not say anything about the byte order for multibyte +// numeric values. In the example, we have two cases where 16 bit numbers are +// sent with the more significant byte first. + + /* PV */ 0x04, /* Parameter Variable - 1024 bits (128 octets) */ + /* PV */ 0x00, /* */ + /* PI */ 0x08, /* Parameter Indicator - Rx window size */ + /* PL */ 0x01, /* Parameter length */ + /* PV */ 0x02, /* Parameter Variable - 2 frames */ + /* PI */ 0x09, /* Parameter Indicator - Timer T1 */ + /* PL */ 0x02, /* Parameter Length */ + /* PV */ 0x10, /* Parameter Variable - 4096 MSec */ + /* PV */ 0x00, /* */ + /* PI */ 0x0A, /* Parameter Indicator - Retries (N1) */ + /* PL */ 0x01, /* Parameter Length */ + /* PV */ 0x03 /* Parameter Variable - 3 retries */ +}; + +int main (int argc, char *argv[]) { + + struct xid_param_s param; + struct xid_param_s param2; + int n; + unsigned char info[40]; // Currently max of 27 but things can change. + char desc[150]; // I've seen 109. + + +/* parse example. */ + + n = xid_parse (example, sizeof(example), ¶m, desc, sizeof(desc)); + + text_color_set (DW_COLOR_DEBUG); + dw_printf ("%d: %s\n", __LINE__, desc); + fflush (stdout); + SLEEP_SEC (1); + + text_color_set (DW_COLOR_ERROR); + +#ifdef NDEBUG +#error "This won't work properly if NDEBUG is defined. It should be undefined in direwolf.h" +#endif + assert (n==1); + assert (param.full_duplex == 0); + assert (param.srej == srej_single); + assert (param.modulo == modulo_128); + assert (param.i_field_length_rx == 128); + assert (param.window_size_rx == 2); + assert (param.ack_timer == 4096); + assert (param.retries == 3); + +/* encode and verify it comes out the same. */ + + n = xid_encode (¶m, info, cr_cmd); + + assert (n == sizeof(example)); + n = memcmp(info, example, 27); + + //for (n=0; n<27; n++) { + // dw_printf ("%2d %02x %02x\n", n, example[n], info[n]); + //} + + assert (n == 0); + +/* try a couple different values, no srej. */ + + param.full_duplex = 1; + param.srej = srej_none; + param.modulo = modulo_8; + param.i_field_length_rx = 2048; + param.window_size_rx = 3; + param.ack_timer = 1234; + param.retries = 12; + + n = xid_encode (¶m, info, cr_cmd); + n = xid_parse (info, n, ¶m2, desc, sizeof(desc)); + + text_color_set (DW_COLOR_DEBUG); + dw_printf ("%d: %s\n", __LINE__, desc); + fflush (stdout); + SLEEP_SEC (1); + + text_color_set (DW_COLOR_ERROR); + + assert (param2.full_duplex == 1); + assert (param2.srej == srej_none); + assert (param2.modulo == modulo_8); + assert (param2.i_field_length_rx == 2048); + assert (param2.window_size_rx == 3); + assert (param2.ack_timer == 1234); + assert (param2.retries == 12); + +/* Other values, single srej. */ + + param.full_duplex = 0; + param.srej = srej_single; + param.modulo = modulo_8; + param.i_field_length_rx = 61; + param.window_size_rx = 4; + param.ack_timer = 5555; + param.retries = 9; + + n = xid_encode (¶m, info, cr_cmd); + n = xid_parse (info, n, ¶m2, desc, sizeof(desc)); + + text_color_set (DW_COLOR_DEBUG); + dw_printf ("%d: %s\n", __LINE__, desc); + fflush (stdout); + SLEEP_SEC (1); + + text_color_set (DW_COLOR_ERROR); + + assert (param2.full_duplex == 0); + assert (param2.srej == srej_single); + assert (param2.modulo == modulo_8); + assert (param2.i_field_length_rx == 61); + assert (param2.window_size_rx == 4); + assert (param2.ack_timer == 5555); + assert (param2.retries == 9); + + +/* Other values, multi srej. */ + + param.full_duplex = 0; + param.srej = srej_multi; + param.modulo = modulo_128; + param.i_field_length_rx = 61; + param.window_size_rx = 4; + param.ack_timer = 5555; + param.retries = 9; + + n = xid_encode (¶m, info, cr_cmd); + n = xid_parse (info, n, ¶m2, desc, sizeof(desc)); + + text_color_set (DW_COLOR_DEBUG); + dw_printf ("%d: %s\n", __LINE__, desc); + fflush (stdout); + SLEEP_SEC (1); + + text_color_set (DW_COLOR_ERROR); + + assert (param2.full_duplex == 0); + assert (param2.srej == srej_multi); + assert (param2.modulo == modulo_128); + assert (param2.i_field_length_rx == 61); + assert (param2.window_size_rx == 4); + assert (param2.ack_timer == 5555); + assert (param2.retries == 9); + + +/* Specify some and not others. */ + + param.full_duplex = 0; + param.srej = srej_single; + param.modulo = modulo_8; + param.i_field_length_rx = G_UNKNOWN; + param.window_size_rx = G_UNKNOWN; + param.ack_timer = 999; + param.retries = G_UNKNOWN; + + n = xid_encode (¶m, info, cr_cmd); + n = xid_parse (info, n, ¶m2, desc, sizeof(desc)); + + text_color_set (DW_COLOR_DEBUG); + dw_printf ("%d: %s\n", __LINE__, desc); + fflush (stdout); + SLEEP_SEC (1); + + text_color_set (DW_COLOR_ERROR); + + assert (param2.full_duplex == 0); + assert (param2.srej == srej_single); + assert (param2.modulo == modulo_8); + assert (param2.i_field_length_rx == G_UNKNOWN); + assert (param2.window_size_rx == G_UNKNOWN); + assert (param2.ack_timer == 999); + assert (param2.retries == G_UNKNOWN); + +/* Default values for empty info field. */ + + n = 0; + n = xid_parse (info, n, ¶m2, desc, sizeof(desc)); + + text_color_set (DW_COLOR_DEBUG); + dw_printf ("%d: %s\n", __LINE__, desc); + fflush (stdout); + SLEEP_SEC (1); + + text_color_set (DW_COLOR_ERROR); + + assert (param2.full_duplex == G_UNKNOWN); + assert (param2.srej == srej_not_specified); + assert (param2.modulo == modulo_unknown); + assert (param2.i_field_length_rx == G_UNKNOWN); + assert (param2.window_size_rx == G_UNKNOWN); + assert (param2.ack_timer == G_UNKNOWN); + assert (param2.retries == G_UNKNOWN); + + + text_color_set (DW_COLOR_REC); + dw_printf ("XID test: Success.\n"); + + exit (0); + +} + +#endif + +/* end xid.c */ diff --git a/src/xid.h b/src/xid.h new file mode 100644 index 00000000..a221b737 --- /dev/null +++ b/src/xid.h @@ -0,0 +1,32 @@ + + +/* xid.h */ + + +#include "ax25_pad.h" // for enum ax25_modulo_e + + +struct xid_param_s { + + int full_duplex; + + // Order is important because negotiation keeps the lower value of + // REJ (srej_none), SREJ (default without negotiation), Multi-SREJ (if both agree). + + enum srej_e { srej_none=0, srej_single=1, srej_multi=2, srej_not_specified=3 } srej; + + enum ax25_modulo_e modulo; + + int i_field_length_rx; /* In bytes. XID has it in bits. */ + + int window_size_rx; + + int ack_timer; /* "T1" in mSec. */ + + int retries; /* "N1" */ +}; + + +int xid_parse (unsigned char *info, int info_len, struct xid_param_s *result, char *desc, int desc_size); + +int xid_encode (struct xid_param_s *param, unsigned char *info, cmdres_t cr); \ No newline at end of file diff --git a/src/xmit.c b/src/xmit.c new file mode 100644 index 00000000..13bbaecb --- /dev/null +++ b/src/xmit.c @@ -0,0 +1,1506 @@ + +// +// This file is part of Dire Wolf, an amateur radio packet TNC. +// +// Copyright (C) 2011, 2013, 2014, 2015, 2016, 2017 John Langner, WB2OSZ +// +// This program 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 2 of the License, or +// (at your option) any later version. +// +// This program 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 this program. If not, see . +// + + +/*------------------------------------------------------------------ + * + * Module: xmit.c + * + * Purpose: Transmit queued up packets when channel is clear. + * + * Description: Producers of packets to be transmitted call tq_append and then + * go merrily on their way, unconcerned about when the packet might + * actually get transmitted. + * + * This thread waits until the channel is clear and then removes + * packets from the queue and transmits them. + * + * + * Usage: (1) The main application calls xmit_init. + * + * This will initialize the transmit packet queue + * and create a thread to empty the queue when + * the channel is clear. + * + * (2) The application queues up packets by calling tq_append. + * + * Packets that are being digipeated should go in the + * high priority queue so they will go out first. + * + * Other packets should go into the lower priority queue. + * + * (3) xmit_thread removes packets from the queue and transmits + * them when other signals are not being heard. + * + *---------------------------------------------------------------*/ + +#include "direwolf.h" + +#include +#include +#include +#include +#include +#include +#include +#include + +#include "direwolf.h" +#include "ax25_pad.h" +#include "textcolor.h" +#include "audio.h" +#include "tq.h" +#include "xmit.h" +#include "hdlc_send.h" +#include "hdlc_rec.h" +#include "ptt.h" +#include "dtime_now.h" +#include "morse.h" +#include "dtmf.h" +#include "xid.h" +#include "dlq.h" +#include "server.h" + + +/* + * Parameters for transmission. + * Each channel can have different timing values. + * + * These are initialized once at application startup time + * and some can be changed later by commands from connected applications. + */ + + +static int xmit_slottime[MAX_CHANS]; /* Slot time in 10 mS units for persistence algorithm. */ + +static int xmit_persist[MAX_CHANS]; /* Sets probability for transmitting after each */ + /* slot time delay. Transmit if a random number */ + /* in range of 0 - 255 <= persist value. */ + /* Otherwise wait another slot time and try again. */ + +static int xmit_txdelay[MAX_CHANS]; /* After turning on the transmitter, */ + /* send "flags" for txdelay * 10 mS. */ + +static int xmit_txtail[MAX_CHANS]; /* Amount of time to keep transmitting after we */ + /* are done sending the data. This is to avoid */ + /* dropping PTT too soon and chopping off the end */ + /* of the frame. Again 10 mS units. */ + +static int xmit_fulldup[MAX_CHANS]; /* Full duplex if non-zero. */ + +static int xmit_bits_per_sec[MAX_CHANS]; /* Data transmission rate. */ + /* Often called baud rate which is equivalent for */ + /* 1200 & 9600 cases but could be different with other */ + /* modulation techniques. */ + +static int g_debug_xmit_packet; /* print packet in hexadecimal form for debugging. */ + + +// TODO: When this was first written, bits/sec was same as baud. +// Need to revisit this for PSK modes where they are not the same. + +#if 0 // Added during 1.5 beta test + +static int BITS_TO_MS (int b, int ch) { + + int bits_per_symbol; + + switch (save_audio_config_p->achan[ch].modem_type) { + case MODEM_QPSK: bits_per_symbol = 2; break; + case MODEM_8PSK: bits_per_symbol = 3; break; + case default: bits_per_symbol = 1; break; + } + + return ( (b * 1000) / (xmit_bits_per_sec[(ch)] * bits_per_symbol) ); +} + +static int MS_TO_BITS (int ms, int ch) { + + int bits_per_symbol; + + switch (save_audio_config_p->achan[ch].modem_type) { + case MODEM_QPSK: bits_per_symbol = 2; break; + case MODEM_8PSK: bits_per_symbol = 3; break; + case default: bits_per_symbol = 1; break; + } + + return ( (ms * xmit_bits_per_sec[(ch)] * bits_per_symbol) / 1000 ); TODO... +} + +#else // OK for 1200, 9600 but wrong for PSK + +#define BITS_TO_MS(b,ch) (((b)*1000)/xmit_bits_per_sec[(ch)]) + +#define MS_TO_BITS(ms,ch) (((ms)*xmit_bits_per_sec[(ch)])/1000) + +#endif + +#define MAXX(a,b) (((a)>(b)) ? (a) : (b)) + + +#if __WIN32__ +static unsigned __stdcall xmit_thread (void *arg); +#else +static void * xmit_thread (void *arg); +#endif + + +/* + * When an audio device is in stereo mode, we can have two + * different channels that want to transmit at the same time. + * We are not clever enough to multiplex them so use this + * so only one is activte at the same time. + */ +static dw_mutex_t audio_out_dev_mutex[MAX_ADEVS]; + + + +static int wait_for_clear_channel (int channel, int slotttime, int persist, int fulldup); +static void xmit_ax25_frames (int c, int p, packet_t pp, int max_bundle); +static int send_one_frame (int c, int p, packet_t pp); +static void xmit_speech (int c, packet_t pp); +static void xmit_morse (int c, packet_t pp, int wpm); +static void xmit_dtmf (int c, packet_t pp, int speed); + + +/*------------------------------------------------------------------- + * + * Name: xmit_init + * + * Purpose: Initialize the transmit process. + * + * Inputs: modem - Structure with modem and timing parameters. + * + * + * Outputs: Remember required information for future use. + * + * Description: Initialize the queue to be empty and set up other + * mechanisms for sharing it between different threads. + * + * Start up xmit_thread(s) to actually send the packets + * at the appropriate time. + * + * Version 1.2: We now allow multiple audio devices with one or two channels each. + * Each audio channel has its own thread. + * + *--------------------------------------------------------------------*/ + +static struct audio_s *save_audio_config_p; + + +void xmit_init (struct audio_s *p_modem, int debug_xmit_packet) +{ + int j; + int ad; + +#if __WIN32__ + HANDLE xmit_th[MAX_CHANS]; +#else + //pthread_attr_t attr; + //struct sched_param sp; + pthread_t xmit_tid[MAX_CHANS]; +#endif + //int e; + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("xmit_init ( ... )\n"); +#endif + + save_audio_config_p = p_modem; + + g_debug_xmit_packet = debug_xmit_packet; + +/* + * Push to Talk (PTT) control. + */ +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("xmit_init: about to call ptt_init \n"); +#endif + ptt_init (p_modem); + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("xmit_init: back from ptt_init \n"); +#endif + +/* + * Save parameters for later use. + * TODO1.2: Any reason to use global config rather than making a copy? + */ + + for (j=0; jachan[j].baud; + xmit_slottime[j] = p_modem->achan[j].slottime; + xmit_persist[j] = p_modem->achan[j].persist; + xmit_txdelay[j] = p_modem->achan[j].txdelay; + xmit_txtail[j] = p_modem->achan[j].txtail; + xmit_fulldup[j] = p_modem->achan[j].fulldup; + } + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("xmit_init: about to call tq_init \n"); +#endif + tq_init (p_modem); + + + for (ad = 0; ad < MAX_ADEVS; ad++) { + dw_mutex_init (&(audio_out_dev_mutex[ad])); + } + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("xmit_init: about to create threads \n"); +#endif + +//TODO: xmit thread should be higher priority to avoid +// underrun on the audio output device. + + + for (j=0; jchan_medium[j] == MEDIUM_RADIO) { +#if __WIN32__ + xmit_th[j] = (HANDLE)_beginthreadex (NULL, 0, xmit_thread, (void*)(ptrdiff_t)j, 0, NULL); + if (xmit_th[j] == NULL) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Could not create xmit thread %d\n", j); + return; + } +#else + int e; +#if 0 + +//TODO: not this simple. probably need FIFO policy. + pthread_attr_init (&attr); + e = pthread_attr_getschedparam (&attr, &sp); + if (e != 0) { + text_color_set(DW_COLOR_ERROR); + perror("pthread_attr_getschedparam"); + } + + text_color_set(DW_COLOR_ERROR); + dw_printf ("Default scheduling priority = %d, min=%d, max=%d\n", + sp.sched_priority, + sched_get_priority_min(SCHED_OTHER), + sched_get_priority_max(SCHED_OTHER)); + sp.sched_priority--; + + e = pthread_attr_setschedparam (&attr, &sp); + if (e != 0) { + text_color_set(DW_COLOR_ERROR); + perror("pthread_attr_setschedparam"); + } + + e = pthread_create (&(xmit_tid[j]), &attr, xmit_thread, (void *)(ptrdiff_t)j); + pthread_attr_destroy (&attr); +#else + e = pthread_create (&(xmit_tid[j]), NULL, xmit_thread, (void *)(ptrdiff_t)j); +#endif + if (e != 0) { + text_color_set(DW_COLOR_ERROR); + perror("Could not create xmit thread for audio device"); + return; + } +#endif + } + } + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("xmit_init: finished \n"); +#endif + + +} /* end tq_init */ + + + +/*------------------------------------------------------------------- + * + * Name: xmit_set_txdelay + * xmit_set_persist + * xmit_set_slottime + * xmit_set_txtail + * xmit_set_fulldup + * + * + * Purpose: The KISS protocol, and maybe others, can specify + * transmit timing parameters. If the application + * specifies these, they will override what was read + * from the configuration file. + * + * Inputs: channel - should be 0 or 1. + * + * value - time values are in 10 mSec units. + * + * + * Outputs: Remember required information for future use. + * + * Question: Should we have an option to enable or disable the + * application changing these values? + * + * Bugs: No validity checking other than array subscript out of bounds. + * + *--------------------------------------------------------------------*/ + +void xmit_set_txdelay (int channel, int value) +{ + if (channel >= 0 && channel < MAX_CHANS) { + xmit_txdelay[channel] = value; + } +} + +void xmit_set_persist (int channel, int value) +{ + if (channel >= 0 && channel < MAX_CHANS) { + xmit_persist[channel] = value; + } +} + +void xmit_set_slottime (int channel, int value) +{ + if (channel >= 0 && channel < MAX_CHANS) { + xmit_slottime[channel] = value; + } +} + +void xmit_set_txtail (int channel, int value) +{ + if (channel >= 0 && channel < MAX_CHANS) { + xmit_txtail[channel] = value; + } +} + +void xmit_set_fulldup (int channel, int value) +{ + if (channel >= 0 && channel < MAX_CHANS) { + xmit_fulldup[channel] = value; + } +} + + +/*------------------------------------------------------------------- + * + * Name: frame_flavor + * + * Purpose: Separate frames into different flavors so we can decide + * which can be bundled into a single transmission and which should + * be sent separately. + * + * Inputs: pp - Packet object. + * + * Returns: Flavor, one of: + * + * FLAVOR_SPEECH - Destination address is SPEECH. + * FLAVOR_MORSE - Destination address is MORSE. + * FLAVOR_DTMF - Destination address is DTMF. + * FLAVOR_APRS_NEW - APRS original, i.e. not digipeating. + * FLAVOR_APRS_DIGI - APRS digipeating. + * FLAVOR_OTHER - Anything left over, i.e. connected mode. + * + *--------------------------------------------------------------------*/ + +typedef enum flavor_e { FLAVOR_APRS_NEW, FLAVOR_APRS_DIGI, FLAVOR_SPEECH, FLAVOR_MORSE, FLAVOR_DTMF, FLAVOR_OTHER } flavor_t; + +static flavor_t frame_flavor (packet_t pp) +{ + + if (ax25_is_aprs (pp)) { // UI frame, PID 0xF0. + // It's unfortunate APRS did not use its own special PID. + + char dest[AX25_MAX_ADDR_LEN]; + + ax25_get_addr_no_ssid(pp, AX25_DESTINATION, dest); + + if (strcmp(dest, "SPEECH") == 0) { + return (FLAVOR_SPEECH); + } + + if (strcmp(dest, "MORSE") == 0) { + return (FLAVOR_MORSE); + } + + if (strcmp(dest, "DTMF") == 0) { + return (FLAVOR_DTMF); + } + + /* Is there at least one digipeater AND has first one been used? */ + /* I could be the first in the list or later. Doesn't matter. */ + + if (ax25_get_num_repeaters(pp) >= 1 && ax25_get_h(pp,AX25_REPEATER_1)) { + return (FLAVOR_APRS_DIGI); + } + + return (FLAVOR_APRS_NEW); + } + + return (FLAVOR_OTHER); + +} /* end frame_flavor */ + + +/*------------------------------------------------------------------- + * + * Name: xmit_thread + * + * Purpose: Process transmit queue for one channel. + * + * Inputs: transmit packet queue. + * + * Outputs: + * + * Description: We have different timing rules for different types of + * packets so they are put into different queues. + * + * High Priority - + * + * Packets which are being digipeated go out first. + * Latest recommendations are to retransmit these + * immdediately (after no one else is heard, of course) + * rather than waiting random times to avoid collisions. + * The KPC-3 configuration option for this is "UIDWAIT OFF". (?) + * + * AX.25 connected mode also has a couple cases + * where "expedited" frames are sent. + * + * Low Priority - + * + * Other packets are sent after a random wait time + * (determined by PERSIST & SLOTTIME) to help avoid + * collisions. + * + * If more than one audio channel is being used, a separate + * pair of transmit queues is used for each channel. + * + * + * + * Version 1.2: Allow more than one audio device. + * each channel has its own thread. + * Add speech capability. + * + * Version 1.4: Rearranged logic for bundling multiple frames into a single transmission. + * + * The rule is that Speech, Morse Code, DTMF, and APRS digipeated frames + * are all sent separately. The rest can be bundled. + * + *--------------------------------------------------------------------*/ + +#if __WIN32__ +static unsigned __stdcall xmit_thread (void *arg) +#else +static void * xmit_thread (void *arg) +#endif +{ + int chan = (int)(ptrdiff_t)arg; // channel number. + packet_t pp; + int prio; + int ok; + + + while (1) { + + tq_wait_while_empty (chan); +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("xmit_thread, channel %d: woke up\n", chan); +#endif + + // Does this extra loop offer any benefit? + while (tq_peek(chan, TQ_PRIO_0_HI) != NULL || tq_peek(chan, TQ_PRIO_1_LO) != NULL) { + +/* + * Wait for the channel to be clear. + * If there is something in the high priority queue, begin transmitting immediately. + * Otherwise, wait a random amount of time, in hopes of minimizing collisions. + */ + ok = wait_for_clear_channel (chan, xmit_slottime[chan], xmit_persist[chan], xmit_fulldup[chan]); + + prio = TQ_PRIO_1_LO; + pp = tq_remove (chan, TQ_PRIO_0_HI); + if (pp != NULL) { + prio = TQ_PRIO_0_HI; + } + else { + pp = tq_remove (chan, TQ_PRIO_1_LO); + } + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("xmit_thread: tq_remove(chan=%d, prio=%d) returned %p\n", chan, prio, pp); +#endif + // Shouldn't have NULL here but be careful. + + if (pp != NULL) { + + + if (ok) { +/* + * Channel is clear and we have lock on output device. + * + * If destination is "SPEECH" send info part to speech synthesizer. + * If destination is "MORSE" send as morse code. + * If destination is "DTMF" send as Touch Tones. + */ + + int ssid, wpm, speed; + + switch (frame_flavor(pp)) { + + case FLAVOR_SPEECH: + xmit_speech (chan, pp); + break; + + case FLAVOR_MORSE: + ssid = ax25_get_ssid(pp, AX25_DESTINATION); + wpm = (ssid > 0) ? (ssid * 2) : MORSE_DEFAULT_WPM; + + // This is a bit of a hack so we don't respond too quickly for APRStt. + // It will be sent in high priority queue while a beacon wouldn't. + // Add a little delay so user has time release PTT after sending #. + // This and default txdelay would give us a second. + + if (prio == TQ_PRIO_0_HI) { + //text_color_set(DW_COLOR_DEBUG); + //dw_printf ("APRStt morse xmit delay hack...\n"); + SLEEP_MS (700); + } + xmit_morse (chan, pp, wpm); + break; + + case FLAVOR_DTMF: + speed = ax25_get_ssid(pp, AX25_DESTINATION); + if (speed == 0) speed = 5; // default half of maximum + if (speed > 10) speed = 10; + + xmit_dtmf (chan, pp, speed); + break; + + case FLAVOR_APRS_DIGI: + xmit_ax25_frames (chan, prio, pp, 1); /* 1 means don't bundle */ + // I don't know if this in some official specification + // somewhere, but it is generally agreed that APRS digipeaters + // should send only one frame at a time rather than + // bundling multiple frames into a single transmission. + // Discussion here: http://lists.tapr.org/pipermail/aprssig_lists.tapr.org/2021-September/049034.html + break; + + case FLAVOR_APRS_NEW: + case FLAVOR_OTHER: + default: + xmit_ax25_frames (chan, prio, pp, 256); + break; + } + + // Corresponding lock is in wait_for_clear_channel. + + dw_mutex_unlock (&(audio_out_dev_mutex[ACHAN2ADEV(chan)])); + } + else { +/* + * Timeout waiting for clear channel. + * Discard the packet. + * Display with ERROR color rather than XMIT color. + */ + char stemp[1024]; /* max size needed? */ + int info_len; + unsigned char *pinfo; + + + text_color_set(DW_COLOR_ERROR); + dw_printf ("Waited too long for clear channel. Discarding packet below.\n"); + + ax25_format_addrs (pp, stemp); + + info_len = ax25_get_info (pp, &pinfo); + + text_color_set(DW_COLOR_INFO); + dw_printf ("[%d%c] ", chan, (prio==TQ_PRIO_0_HI) ? 'H' : 'L'); + + dw_printf ("%s", stemp); /* stations followed by : */ + ax25_safe_print ((char *)pinfo, info_len, ! ax25_is_aprs(pp)); + dw_printf ("\n"); + ax25_delete (pp); + + } /* wait for clear channel error. */ + } /* Have pp */ + } /* while queue not empty */ + } /* while 1 */ + + return 0; /* unreachable but quiet the warning. */ + +} /* end xmit_thread */ + + + +/*------------------------------------------------------------------- + * + * Name: xmit_ax25_frames + * + * Purpose: After we have a clear channel, and possibly waited a random time, + * we transmit one or more frames. + * + * Inputs: chan - Channel number. + * + * prio - Priority of the first frame. + * Subsequent frames could be different. + * + * pp - Packet object pointer. + * It will be deleted so caller should not try + * to reference it after this. + * + * max_bundle - Max number of frames to bundle into one transmission. + * + * Description: Turn on transmitter. + * Send flags for TXDELAY time. + * Send the first packet, given by pp. + * Possibly send more packets from either queue. + * Send flags for TXTAIL time. + * Turn off transmitter. + * + * + * How many frames in one transmission? (for APRS) + * + * Should we send multiple frames in one transmission if we + * have more than one sitting in the queue? At first I was thinking + * this would help reduce channel congestion. I don't recall seeing + * anything in the APRS specifications allowing or disallowing multiple + * frames in one transmission. I can think of some scenarios + * where it might help. I can think of some where it would + * definitely be counter productive. + * + * What to others have to say about this topic? + * + * "For what it is worth, the original APRSdos used a several second random + * generator each time any kind of packet was generated... This is to avoid + * bundling. Because bundling, though good for connected packet, is not good + * on APRS. Sometimes the digi begins digipeating the first packet in the + * bundle and steps all over the remainder of them. So best to make sure each + * packet is isolated in time from others..." + * + * Bob, WB4APR + * + * + * Version 0.9: Earlier versions always sent one frame per transmission. + * This was fine for APRS but more and more people are now + * using this as a KISS TNC for connected protocols. + * Rather than having a configuration file item, + * we try setting the maximum number automatically. + * 1 for digipeated frames, 7 for others. + * + * Version 1.4: Lift the limit. We could theoretically have a window size up to 127. + * If another section pumps out that many quickly we shouldn't + * break it up here. Empty out both queues with some exceptions. + * + * Digipeated APRS, Speech, and Morse code should have + * their own separate transmissions. + * Everything else can be bundled together. + * Different priorities can share a single transmission. + * Once we have control of the channel, we might as well keep going. + * [High] Priority frames will always go to head of the line, + * + * Version 1.5: Add full duplex option. + * + *--------------------------------------------------------------------*/ + + +static void xmit_ax25_frames (int chan, int prio, packet_t pp, int max_bundle) +{ + + int pre_flags, post_flags; + int num_bits; /* Total number of bits in transmission */ + /* including all flags and bit stuffing. */ + int duration; /* Transmission time in milliseconds. */ + int already; + int wait_more; + + int numframe = 0; /* Number of frames sent during this transmission. */ + +/* + * These are for timing of a transmission. + * All are in usual unix time (seconds since 1/1/1970) but higher resolution + */ + double time_ptt; /* Time when PTT is turned on. */ + double time_now; /* Current time. */ + + + int nb; + +/* + * Turn on transmitter. + * Start sending leading flag bytes. + */ + time_ptt = dtime_now (); + +// TODO: This was written assuming bits/sec = baud. +// Does it is need to be scaled differently for PSK? + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("xmit_thread: t=%.3f, Turn on PTT now for channel %d. speed = %d\n", dtime_now()-time_ptt, chan, xmit_bits_per_sec[chan]); +#endif + ptt_set (OCTYPE_PTT, chan, 1); + +// Inform data link state machine that we are now transmitting. + + dlq_seize_confirm (chan); // C4.2. "This primitive indicates, to the Data-link State + // machine, that the transmission opportunity has arrived." + + pre_flags = MS_TO_BITS(xmit_txdelay[chan] * 10, chan) / 8; + num_bits = layer2_preamble_postamble (chan, pre_flags, 0, save_audio_config_p); +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("xmit_thread: t=%.3f, txdelay=%d [*10], pre_flags=%d, num_bits=%d\n", dtime_now()-time_ptt, xmit_txdelay[chan], pre_flags, num_bits); + double presleep = dtime_now(); +#endif + + SLEEP_MS (10); // Give data link state machine a chance to + // to stuff more frames into the transmit queue, + // in response to dlq_seize_confirm, so + // we don't run off the end too soon. + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + // How long did sleep last? + dw_printf ("xmit_thread: t=%.3f, Should be 0.010 second after the above.\n", dtime_now()-time_ptt); + double naptime = dtime_now() - presleep; + if (naptime > 0.015) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Sleep for 10 ms actually took %.3f second!\n", naptime); + } +#endif + +/* + * Transmit the frame. + */ + + nb = send_one_frame (chan, prio, pp); + + num_bits += nb; + if (nb > 0) numframe++; +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("xmit_thread: t=%.3f, nb=%d, num_bits=%d, numframe=%d\n", dtime_now()-time_ptt, nb, num_bits, numframe); +#endif + ax25_delete (pp); + +/* + * See if we can bundle additional frames into this transmission. + */ + + int done = 0; + while (numframe < max_bundle && ! done) { + +/* + * Peek at what is available. + * Don't remove from queue yet because it might not be eligible. + */ + prio = TQ_PRIO_1_LO; + pp = tq_peek (chan, TQ_PRIO_0_HI); + if (pp != NULL) { + prio = TQ_PRIO_0_HI; + } + else { + pp = tq_peek (chan, TQ_PRIO_1_LO); + } + + if (pp != NULL) { + + switch (frame_flavor(pp)) { + + case FLAVOR_SPEECH: + case FLAVOR_MORSE: + case FLAVOR_DTMF: + case FLAVOR_APRS_DIGI: + default: + done = 1; // not eligible for bundling. + break; + + case FLAVOR_APRS_NEW: + case FLAVOR_OTHER: + + pp = tq_remove (chan, prio); +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("xmit_thread: t=%.3f, tq_remove(chan=%d, prio=%d) returned %p\n", dtime_now()-time_ptt, chan, prio, pp); +#endif + + nb = send_one_frame (chan, prio, pp); + + num_bits += nb; + if (nb > 0) numframe++; +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("xmit_thread: t=%.3f, nb=%d, num_bits=%d, numframe=%d\n", dtime_now()-time_ptt, nb, num_bits, numframe); +#endif + ax25_delete (pp); + + break; + } + } + else { + done = 1; + } + } + +/* + * Need TXTAIL because we don't know exactly when the sound is done. + */ + + post_flags = MS_TO_BITS(xmit_txtail[chan] * 10, chan) / 8; + nb = layer2_preamble_postamble (chan, post_flags, 1, save_audio_config_p); + num_bits += nb; +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("xmit_thread: t=%.3f, txtail=%d [*10], post_flags=%d, nb=%d, num_bits=%d\n", dtime_now()-time_ptt, xmit_txtail[chan], post_flags, nb, num_bits); +#endif + + +/* + * While demodulating is CPU intensive, generating the tones is not. + * Example: on the RPi model 1, with 50% of the CPU taken with two receive + * channels, a transmission of more than a second is generated in + * about 40 mS of elapsed real time. + */ + + audio_wait(ACHAN2ADEV(chan)); + +/* + * Ideally we should be here just about the time when the audio is ending. + * However, the innards of "audio_wait" are not satisfactory in all cases. + * + * Calculate how long the frame(s) should take in milliseconds. + */ + + duration = BITS_TO_MS(num_bits, chan); + +/* + * See how long it has been since PTT was turned on. + * Wait additional time if necessary. + */ + + time_now = dtime_now(); + already = (int) ((time_now - time_ptt) * 1000.); + wait_more = duration - already; + +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + dw_printf ("xmit_thread: t=%.3f, xmit duration=%d, %d already elapsed since PTT, wait %d more\n", dtime_now()-time_ptt, duration, already, wait_more ); +#endif + + if (wait_more > 0) { + SLEEP_MS(wait_more); + } + else if (wait_more < -100) { + + /* If we run over by 10 mSec or so, it's nothing to worry about. */ + /* However, if PTT is still on about 1/10 sec after audio */ + /* should be done, something is wrong. */ + + /* Looks like a bug with the RPi audio system. Never an issue with Ubuntu. */ + /* This runs over randomly sometimes. TODO: investigate more fully sometime. */ +#ifndef __arm__ + text_color_set(DW_COLOR_ERROR); + dw_printf ("Transmit timing error: PTT is on %d mSec too long.\n", -wait_more); +#endif + } + +/* + * Turn off transmitter. + */ +#if DEBUG + text_color_set(DW_COLOR_DEBUG); + time_now = dtime_now(); + dw_printf ("xmit_thread: t=%.3f, Turn off PTT now. Actual time on was %d mS, vs. %d desired\n", dtime_now()-time_ptt, (int) ((time_now - time_ptt) * 1000.), duration); +#endif + + ptt_set (OCTYPE_PTT, chan, 0); + +} /* end xmit_ax25_frames */ + + + +/*------------------------------------------------------------------- + * + * Name: send_one_frame + * + * Purpose: Send one AX.25 frame. + * + * Inputs: c - Channel number. + * + * p - Priority. + * + * pp - Packet object pointer. Caller will delete it. + * + * Returns: Number of bits transmitted. + * + * Description: Caller is responsible for activiating PTT, TXDELAY, + * deciding how many frames can be in one transmission, + * deactivating PTT. + * + *--------------------------------------------------------------------*/ + + +static int send_one_frame (int c, int p, packet_t pp) +{ + char stemp[1024]; /* max size needed? */ + int info_len; + unsigned char *pinfo; + int nb; + + + if (ax25_is_null_frame(pp)) { + + // Issue 132 - We could end up in a situation where: + // Transmitter is already on. + // Application wants to send a frame. + // dl_seize_request turns into this null frame. + // It was being ignored here so the data got stuck in the queue. + // I think the solution is to send back a seize confirm here. + // It shouldn't hurt if we send it redundantly. + // Added for 1.5 beta test 4. + + dlq_seize_confirm (c); // C4.2. "This primitive indicates, to the Data-link State + // machine, that the transmission opportunity has arrived." + + SLEEP_MS (10); // Give data link state machine a chance to + // to stuff more frames into the transmit queue, + // in response to dlq_seize_confirm, so + // we don't run off the end too soon. + + return(0); + } + + char ts[100]; // optional time stamp. + + if (strlen(save_audio_config_p->timestamp_format) > 0) { + char tstmp[100]; + timestamp_user_format (tstmp, sizeof(tstmp), save_audio_config_p->timestamp_format); + strlcpy (ts, " ", sizeof(ts)); // space after channel. + strlcat (ts, tstmp, sizeof(ts)); + } + else { + strlcpy (ts, "", sizeof(ts)); + } + + ax25_format_addrs (pp, stemp); + info_len = ax25_get_info (pp, &pinfo); + text_color_set(DW_COLOR_XMIT); +#if 0 // FIXME - enable this? + dw_printf ("[%d%c%s%s] ", c, + p==TQ_PRIO_0_HI ? 'H' : 'L', + save_audio_config_p->achan[c].fx25_strength ? "F" : "", + ts); +#else + dw_printf ("[%d%c%s] ", c, p==TQ_PRIO_0_HI ? 'H' : 'L', ts); +#endif + dw_printf ("%s", stemp); /* stations followed by : */ + +/* Demystify non-APRS. Use same format for received frames in direwolf.c. */ + + if ( ! ax25_is_aprs(pp)) { + ax25_frame_type_t ftype; + cmdres_t cr; + char desc[80]; + int pf; + int nr; + int ns; + + ftype = ax25_frame_type (pp, &cr, desc, &pf, &nr, &ns); + + dw_printf ("(%s)", desc); + + if (ftype == frame_type_U_XID) { + struct xid_param_s param; + char info2text[150]; + + xid_parse (pinfo, info_len, ¶m, info2text, sizeof(info2text)); + dw_printf (" %s\n", info2text); + } + else { + ax25_safe_print ((char *)pinfo, info_len, ! ax25_is_aprs(pp)); + dw_printf ("\n"); + } + } + else { + ax25_safe_print ((char *)pinfo, info_len, ! ax25_is_aprs(pp)); + dw_printf ("\n"); + } + + (void)ax25_check_addresses (pp); + +/* Optional hex dump of packet. */ + + if (g_debug_xmit_packet) { + + text_color_set(DW_COLOR_DEBUG); + dw_printf ("------\n"); + ax25_hex_dump (pp); + dw_printf ("------\n"); + } + + +/* + * Transmit the frame. + */ + int send_invalid_fcs2 = 0; + + if (save_audio_config_p->xmit_error_rate != 0) { + float r = (float)(rand()) / (float)RAND_MAX; // Random, 0.0 to 1.0 + + if (save_audio_config_p->xmit_error_rate / 100.0 > r) { + send_invalid_fcs2 = 1; + text_color_set(DW_COLOR_INFO); + dw_printf ("Intentionally sending invalid CRC for frame above. Xmit Error rate = %d per cent.\n", save_audio_config_p->xmit_error_rate); + } + } + + nb = layer2_send_frame (c, pp, send_invalid_fcs2, save_audio_config_p); + +// Optionally send confirmation to AGW client app if monitoring enabled. + + server_send_monitored (c, pp, 1); + + return (nb); + +} /* end send_one_frame */ + + + + +/*------------------------------------------------------------------- + * + * Name: xmit_speech + * + * Purpose: After we have a clear channel, and possibly waited a random time, + * we transmit information part of frame as speech. + * + * Inputs: c - Channel number. + * + * pp - Packet object pointer. + * It will be deleted so caller should not try + * to reference it after this. + * + * Description: Turn on transmitter. + * Invoke the text-to-speech script. + * Turn off transmitter. + * + *--------------------------------------------------------------------*/ + + +static void xmit_speech (int c, packet_t pp) +{ + int info_len; + unsigned char *pinfo; + +/* + * Print spoken packet. Prefix by channel. + */ + + char ts[100]; // optional time stamp. + + if (strlen(save_audio_config_p->timestamp_format) > 0) { + char tstmp[100]; + timestamp_user_format (tstmp, sizeof(tstmp), save_audio_config_p->timestamp_format); + strlcpy (ts, " ", sizeof(ts)); // space after channel. + strlcat (ts, tstmp, sizeof(ts)); + } + else { + strlcpy (ts, "", sizeof(ts)); + } + + info_len = ax25_get_info (pp, &pinfo); + (void)info_len; + + text_color_set(DW_COLOR_XMIT); + dw_printf ("[%d.speech%s] \"%s\"\n", c, ts, pinfo); + + + if (strlen(save_audio_config_p->tts_script) == 0) { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Text-to-speech script has not been configured.\n"); + ax25_delete (pp); + return; + } + +/* + * Turn on transmitter. + */ + ptt_set (OCTYPE_PTT, c, 1); + +/* + * Invoke the speech-to-text script. + */ + + xmit_speak_it (save_audio_config_p->tts_script, c, (char*)pinfo); + +/* + * Turn off transmitter. + */ + + ptt_set (OCTYPE_PTT, c, 0); + ax25_delete (pp); + +} /* end xmit_speech */ + + +/* Broken out into separate function so configuration can validate it. */ +/* Returns 0 for success. */ + +int xmit_speak_it (char *script, int c, char *orig_msg) +{ + int err; + char msg[2000]; + char cmd[sizeof(msg) + 16]; + char *p; + +/* Remove any quotes because it will mess up command line argument parsing. */ + + strlcpy (msg, orig_msg, sizeof(msg)); + + for (p=msg; *p!='\0'; p++) { + if (*p == '"') *p = ' '; + } + +#if __WIN32__ + snprintf (cmd, sizeof(cmd), "%s %d \"%s\" >nul", script, c, msg); +#else + snprintf (cmd, sizeof(cmd), "%s %d \"%s\"", script, c, msg); +#endif + + //text_color_set(DW_COLOR_DEBUG); + //dw_printf ("cmd=%s\n", cmd); + + err = system (cmd); + + if (err != 0) { + char cwd[1000]; + char path[3000]; + char *ignore; + + text_color_set(DW_COLOR_ERROR); + dw_printf ("Failed to run text-to-speech script, %s\n", script); + + ignore = getcwd (cwd, sizeof(cwd)); + (void)ignore; + strlcpy (path, getenv("PATH"), sizeof(path)); + + dw_printf ("CWD = %s\n", cwd); + dw_printf ("PATH = %s\n", path); + + } + return (err); +} + + + +/*------------------------------------------------------------------- + * + * Name: xmit_morse + * + * Purpose: After we have a clear channel, and possibly waited a random time, + * we transmit information part of frame as Morse code. + * + * Inputs: c - Channel number. + * + * pp - Packet object pointer. + * It will be deleted so caller should not try + * to reference it after this. + * + * wpm - Speed in words per minute. + * + * Description: Turn on transmitter. + * Send text as Morse code. + * A small amount of quiet padding will appear at start and end. + * Turn off transmitter. + * + *--------------------------------------------------------------------*/ + + +static void xmit_morse (int c, packet_t pp, int wpm) +{ + int info_len; + unsigned char *pinfo; + int length_ms, wait_ms; + double start_ptt, wait_until, now; + + char ts[100]; // optional time stamp. + + if (strlen(save_audio_config_p->timestamp_format) > 0) { + char tstmp[100]; + timestamp_user_format (tstmp, sizeof(tstmp), save_audio_config_p->timestamp_format); + strlcpy (ts, " ", sizeof(ts)); // space after channel. + strlcat (ts, tstmp, sizeof(ts)); + } + else { + strlcpy (ts, "", sizeof(ts)); + } + + info_len = ax25_get_info (pp, &pinfo); + (void)info_len; + text_color_set(DW_COLOR_XMIT); + dw_printf ("[%d.morse%s] \"%s\"\n", c, ts, pinfo); + + ptt_set (OCTYPE_PTT, c, 1); + start_ptt = dtime_now(); + + // make txdelay at least 300 and txtail at least 250 ms. + + length_ms = morse_send (c, (char*)pinfo, wpm, MAXX(xmit_txdelay[c] * 10, 300), MAXX(xmit_txtail[c] * 10, 250)); + + // there is probably still sound queued up in the output buffers. + + wait_until = start_ptt + length_ms * 0.001; + + now = dtime_now(); + + wait_ms = (int) ( ( wait_until - now ) * 1000 ); + if (wait_ms > 0) { + SLEEP_MS(wait_ms); + } + + ptt_set (OCTYPE_PTT, c, 0); + ax25_delete (pp); + +} /* end xmit_morse */ + + + +/*------------------------------------------------------------------- + * + * Name: xmit_dtmf + * + * Purpose: After we have a clear channel, and possibly waited a random time, + * we transmit information part of frame as DTMF tones. + * + * Inputs: c - Channel number. + * + * pp - Packet object pointer. + * It will be deleted so caller should not try + * to reference it after this. + * + * speed - Button presses per second. + * + * Description: Turn on transmitter. + * Send text as touch tones. + * A small amount of quiet padding will appear at start and end. + * Turn off transmitter. + * + *--------------------------------------------------------------------*/ + + +static void xmit_dtmf (int c, packet_t pp, int speed) +{ + int info_len; + unsigned char *pinfo; + int length_ms, wait_ms; + double start_ptt, wait_until, now; + + char ts[100]; // optional time stamp. + + if (strlen(save_audio_config_p->timestamp_format) > 0) { + char tstmp[100]; + timestamp_user_format (tstmp, sizeof(tstmp), save_audio_config_p->timestamp_format); + strlcpy (ts, " ", sizeof(ts)); // space after channel. + strlcat (ts, tstmp, sizeof(ts)); + } + else { + strlcpy (ts, "", sizeof(ts)); + } + + info_len = ax25_get_info (pp, &pinfo); + (void)info_len; + text_color_set(DW_COLOR_XMIT); + dw_printf ("[%d.dtmf%s] \"%s\"\n", c, ts, pinfo); + + ptt_set (OCTYPE_PTT, c, 1); + start_ptt = dtime_now(); + + // make txdelay at least 300 and txtail at least 250 ms. + + length_ms = dtmf_send (c, (char*)pinfo, speed, MAXX(xmit_txdelay[c] * 10, 300), MAXX(xmit_txtail[c] * 10, 250)); + + // there is probably still sound queued up in the output buffers. + + wait_until = start_ptt + length_ms * 0.001; + + now = dtime_now(); + + wait_ms = (int) ( ( wait_until - now ) * 1000 ); + if (wait_ms > 0) { + SLEEP_MS(wait_ms); + } + else { + text_color_set(DW_COLOR_ERROR); + dw_printf ("Oops. CPU too slow to keep up with DTMF generation.\n"); + } + + ptt_set (OCTYPE_PTT, c, 0); + ax25_delete (pp); + +} /* end xmit_dtmf */ + + + +/*------------------------------------------------------------------- + * + * Name: wait_for_clear_channel + * + * Purpose: Wait for the radio channel to be clear and any + * additional time for collision avoidance. + * + * Inputs: chan - Radio channel number. + * + * slottime - Amount of time to wait for each iteration + * of the waiting algorithm. 10 mSec units. + * + * persist - Probability of transmitting. + * + * fulldup - Full duplex. Just start sending immediately. + * + * Returns: 1 for OK. 0 for timeout. + * + * Description: New in version 1.2: also obtain a lock on audio out device. + * + * New in version 1.5: full duplex. + * Just start transmitting rather than waiting for clear channel. + * This would only be appropriate when transmit and receive are + * using different radio frequencies. e.g. VHF up, UHF down satellite. + * + * Transmit delay algorithm: + * + * Wait for channel to be clear. + * If anything in high priority queue, bail out of the following. + * + * Wait slottime * 10 milliseconds. + * Generate an 8 bit random number in range of 0 - 255. + * If random number <= persist value, return. + * Otherwise repeat. + * + * Example: + * + * For typical values of slottime=10 and persist=63, + * + * Delay Probability + * ----- ----------- + * 100 .25 = 25% + * 200 .75 * .25 = 19% + * 300 .75 * .75 * .25 = 14% + * 400 .75 * .75 * .75 * .25 = 11% + * 500 .75 * .75 * .75 * .75 * .25 = 8% + * 600 .75 * .75 * .75 * .75 * .75 * .25 = 6% + * 700 .75 * .75 * .75 * .75 * .75 * .75 * .25 = 4% + * etc. ... + * + *--------------------------------------------------------------------*/ + +/* Give up if we can't get a clear channel in a minute. */ +/* That's a long time to wait for APRS. */ +/* Might need to revisit some day for connected mode file transfers. */ + +#define WAIT_TIMEOUT_MS (60 * 1000) +#define WAIT_CHECK_EVERY_MS 10 + +static int wait_for_clear_channel (int chan, int slottime, int persist, int fulldup) +{ + int n = 0; + +/* + * For dull duplex we skip the channel busy check and random wait. + * We still need to wait if operating in stereo and the other audio + * half is busy. + */ + if ( ! fulldup) { + +start_over_again: + + while (hdlc_rec_data_detect_any(chan)) { + SLEEP_MS(WAIT_CHECK_EVERY_MS); + n++; + if (n > (WAIT_TIMEOUT_MS / WAIT_CHECK_EVERY_MS)) { + return 0; + } + } + +//TODO: rethink dwait. + +/* + * Added in version 1.2 - for transceivers that can't + * turn around fast enough when using squelch and VOX. + */ + + if (save_audio_config_p->achan[chan].dwait > 0) { + SLEEP_MS (save_audio_config_p->achan[chan].dwait * 10); + } + + if (hdlc_rec_data_detect_any(chan)) { + goto start_over_again; + } + +/* + * Wait random time. + * Proceed to transmit sooner if anything shows up in high priority queue. + */ + while (tq_peek(chan, TQ_PRIO_0_HI) == NULL) { + int r; + + SLEEP_MS (slottime * 10); + + if (hdlc_rec_data_detect_any(chan)) { + goto start_over_again; + } + + r = rand() & 0xff; + if (r <= persist) { + break; + } + } + } + +/* + * This is to prevent two channels from transmitting at the same time + * thru a stereo audio device. + * We are not clever enough to combine two audio streams. + * They must go out one at a time. + * Documentation recommends using separate audio device for each channel rather than stereo. + * That also allows better use of multiple cores for receiving. + */ + +// TODO: review this. + + while ( ! dw_mutex_try_lock(&(audio_out_dev_mutex[ACHAN2ADEV(chan)]))) { + SLEEP_MS(WAIT_CHECK_EVERY_MS); + n++; + if (n > (WAIT_TIMEOUT_MS / WAIT_CHECK_EVERY_MS)) { + return 0; + } + } + + return 1; + +} /* end wait_for_clear_channel */ + + +/* end xmit.c */ + + + diff --git a/xmit.h b/src/xmit.h similarity index 77% rename from xmit.h rename to src/xmit.h index a237b322..248037df 100644 --- a/xmit.h +++ b/src/xmit.h @@ -16,7 +16,10 @@ extern void xmit_set_slottime (int channel, int value); extern void xmit_set_txtail (int channel, int value); -extern double dtime_now (void); +extern void xmit_set_fulldup (int channel, int value); + + +extern int xmit_speak_it (char *script, int c, char *msg); #endif diff --git a/systemd/direwolf.logrotate b/systemd/direwolf.logrotate new file mode 100644 index 00000000..143b6083 --- /dev/null +++ b/systemd/direwolf.logrotate @@ -0,0 +1,20 @@ +/var/log/direwolf/stdout /var/log/direwolf/stderr { + missingok + rotate 30 + daily + copytruncate + notifempty + compress + delaycompress + dateext + dateyesterday + } + +/var/log/direwolf/*.log { + missingok + daily + rotate 30 + minage 7 + maxage 30 + compress +} diff --git a/systemd/direwolf.service b/systemd/direwolf.service new file mode 100644 index 00000000..c3380fac --- /dev/null +++ b/systemd/direwolf.service @@ -0,0 +1,27 @@ +[Unit] +Description=Direwolf Sound Card-based AX.25 TNC +After=sound.target +After=network.target + +[Service] +EnvironmentFile=/etc/sysconfig/direwolf +User=direwolf +# You may want to set the audio levels of your radio-connected soundcard +# prior to starting direwolf. To do so, copy this file to /etc/systemd/system/ +# and edit the ExecStartPre line to point to your preferred method of +# doing so. Then run systemctl daemon-reload so systemd uses your updated +# copy of this service file. +#ExecStartPre=/some/script.sh +ExecStart=/bin/bash -ce "exec /usr/bin/direwolf $DIREWOLF_ARGS >>/var/log/direwolf/stdout 2>>/var/log/direwolf/stderr" +Restart=always +StandardOutput=null +StandardError=null +ProtectSystem=strict +ProtectHome=true +ReadWritePaths=/var/log/direwolf + +[Install] +WantedBy=multi-user.target +DefaultInstance=1 + +# alternate version: https://www.f4fxl.org/start-direwolf-at-boot-the-systemd-way/ diff --git a/systemd/direwolf.sysconfig b/systemd/direwolf.sysconfig new file mode 100644 index 00000000..748dfe77 --- /dev/null +++ b/systemd/direwolf.sysconfig @@ -0,0 +1,2 @@ +# Set direwolf command line arguments here +DIREWOLF_ARGS="-l /var/log/direwolf -c /etc/direwolf.conf" diff --git a/telemetry.h b/telemetry.h deleted file mode 100644 index a6b8c717..00000000 --- a/telemetry.h +++ /dev/null @@ -1,15 +0,0 @@ - - -/* telemetry.h */ - -void telemetry_data_original (char *station, char *info, char *output, char *comment); - -void telemetry_data_base91 (char *station, char *cdata, char *output); - -void telemetry_name_message (char *station, char *msg); - -void telemetry_unit_label_message (char *station, char *msg); - -void telemetry_coefficents_message (char *station, char *msg); - -void telemetry_bit_sense_message (char *station, char *msg); diff --git a/test/CMakeLists.txt b/test/CMakeLists.txt new file mode 100644 index 00000000..91e06a2c --- /dev/null +++ b/test/CMakeLists.txt @@ -0,0 +1,714 @@ +# This is a trick to avoid more complication +# because configure_file() is done at configuration time + +set(CUSTOM_TEST_BINARY_DIR "${CMAKE_BINARY_DIR}/test") +set(GEN_PACKETS_BIN "${CMAKE_BINARY_DIR}/src/gen_packets${CMAKE_EXECUTABLE_SUFFIX}") +set(ATEST_BIN "${CMAKE_BINARY_DIR}/src/atest${CMAKE_EXECUTABLE_SUFFIX}") +set(FXSEND_BIN "${CMAKE_BINARY_DIR}/test/fxsend${CMAKE_EXECUTABLE_SUFFIX}") +set(FXREC_BIN "${CMAKE_BINARY_DIR}/test/fxrec${CMAKE_EXECUTABLE_SUFFIX}") +set(IL2P_TEST_BIN "${CMAKE_BINARY_DIR}/test/il2p_test${CMAKE_EXECUTABLE_SUFFIX}") + +if(WIN32) + set(CUSTOM_SCRIPT_SUFFIX ".bat") +else() + set(CUSTOM_SCRIPT_SUFFIX "") +endif() + +set(TEST_CHECK-FX25_FILE "check-fx25") +set(TEST_CHECK-IL2P_FILE "check-il2p") +set(TEST_CHECK-MODEM1200_FILE "check-modem1200") +set(TEST_CHECK-MODEM1200_IL2P_FILE "check-modem1200-i") +set(TEST_CHECK-MODEM300_FILE "check-modem300") +set(TEST_CHECK-MODEM9600_FILE "check-modem9600") +set(TEST_CHECK-MODEM9600_IL2P_FILE "check-modem9600-i") +set(TEST_CHECK-MODEM19200_FILE "check-modem19200") +set(TEST_CHECK-MODEM2400-a_FILE "check-modem2400-a") +set(TEST_CHECK-MODEM2400-b_FILE "check-modem2400-b") +set(TEST_CHECK-MODEM2400-g_FILE "check-modem2400-g") +set(TEST_CHECK-MODEM4800_FILE "check-modem4800") +set(TEST_CHECK-MODEMEAS_FILE "check-modemeas") + +# generate the scripts that run the tests + +configure_file( + "${CUSTOM_TEST_SCRIPTS_DIR}/${TEST_CHECK-FX25_FILE}" + "${CUSTOM_TEST_BINARY_DIR}/${TEST_CHECK-FX25_FILE}${CUSTOM_SCRIPT_SUFFIX}" + @ONLY + ) + +configure_file( + "${CUSTOM_TEST_SCRIPTS_DIR}/${TEST_CHECK-IL2P_FILE}" + "${CUSTOM_TEST_BINARY_DIR}/${TEST_CHECK-IL2P_FILE}${CUSTOM_SCRIPT_SUFFIX}" + @ONLY + ) + +configure_file( + "${CUSTOM_TEST_SCRIPTS_DIR}/${TEST_CHECK-MODEM1200_FILE}" + "${CUSTOM_TEST_BINARY_DIR}/${TEST_CHECK-MODEM1200_FILE}${CUSTOM_SCRIPT_SUFFIX}" + @ONLY + ) + +configure_file( + "${CUSTOM_TEST_SCRIPTS_DIR}/${TEST_CHECK-MODEM1200_IL2P_FILE}" + "${CUSTOM_TEST_BINARY_DIR}/${TEST_CHECK-MODEM1200_IL2P_FILE}${CUSTOM_SCRIPT_SUFFIX}" + @ONLY + ) + +configure_file( + "${CUSTOM_TEST_SCRIPTS_DIR}/${TEST_CHECK-MODEM300_FILE}" + "${CUSTOM_TEST_BINARY_DIR}${CUSTOM_SCRIPT_SUFFIX}" + @ONLY + ) + +configure_file( + "${CUSTOM_TEST_SCRIPTS_DIR}/${TEST_CHECK-MODEM9600_FILE}" + "${CUSTOM_TEST_BINARY_DIR}/${TEST_CHECK-MODEM9600_FILE}${CUSTOM_SCRIPT_SUFFIX}" + @ONLY + ) + +configure_file( + "${CUSTOM_TEST_SCRIPTS_DIR}/${TEST_CHECK-MODEM9600_IL2P_FILE}" + "${CUSTOM_TEST_BINARY_DIR}/${TEST_CHECK-MODEM9600_IL2P_FILE}${CUSTOM_SCRIPT_SUFFIX}" + @ONLY + ) + +configure_file( + "${CUSTOM_TEST_SCRIPTS_DIR}/${TEST_CHECK-MODEM19200_FILE}" + "${CUSTOM_TEST_BINARY_DIR}/${TEST_CHECK-MODEM19200_FILE}${CUSTOM_SCRIPT_SUFFIX}" + @ONLY + ) + +configure_file( + "${CUSTOM_TEST_SCRIPTS_DIR}/${TEST_CHECK-MODEM2400-a_FILE}" + "${CUSTOM_TEST_BINARY_DIR}/${TEST_CHECK-MODEM2400-a_FILE}${CUSTOM_SCRIPT_SUFFIX}" + @ONLY + ) + +configure_file( + "${CUSTOM_TEST_SCRIPTS_DIR}/${TEST_CHECK-MODEM2400-b_FILE}" + "${CUSTOM_TEST_BINARY_DIR}/${TEST_CHECK-MODEM2400-b_FILE}${CUSTOM_SCRIPT_SUFFIX}" + @ONLY + ) + +configure_file( + "${CUSTOM_TEST_SCRIPTS_DIR}/${TEST_CHECK-MODEM2400-g_FILE}" + "${CUSTOM_TEST_BINARY_DIR}/${TEST_CHECK-MODEM2400-g_FILE}${CUSTOM_SCRIPT_SUFFIX}" + @ONLY + ) + +configure_file( + "${CUSTOM_TEST_SCRIPTS_DIR}/${TEST_CHECK-MODEM4800_FILE}" + "${CUSTOM_TEST_BINARY_DIR}/${TEST_CHECK-MODEM4800_FILE}${CUSTOM_SCRIPT_SUFFIX}" + @ONLY + ) + +configure_file( + "${CUSTOM_TEST_SCRIPTS_DIR}/${TEST_CHECK-MODEMEAS_FILE}" + "${CUSTOM_TEST_BINARY_DIR}/${TEST_CHECK-MODEMEAS_FILE}${CUSTOM_SCRIPT_SUFFIX}" + @ONLY + ) + + +# global includes +# not ideal but not so slow +# otherwise use target_include_directories +include_directories( + ${CUSTOM_SRC_DIR} + ${GPSD_INCLUDE_DIRS} + ${HAMLIB_INCLUDE_DIRS} + ${ALSA_INCLUDE_DIRS} + ${UDEV_INCLUDE_DIRS} + ${PORTAUDIO_INCLUDE_DIRS} + ${CUSTOM_GEOTRANZ_DIR} + ${CMAKE_BINARY_DIR}/src + ) + +if(WIN32 OR CYGWIN) + include_directories( + ${CUSTOM_REGEX_DIR} + ) +endif() + +if(WIN32 OR CYGWIN) + list(REMOVE_ITEM atest9_SOURCES + ${CUSTOM_SRC_DIR}/dwgpsd.c + ) +endif() + + +# Unit test for inner digipeater algorithm +list(APPEND dtest_SOURCES + ${CUSTOM_SRC_DIR}/digipeater.c + ${CUSTOM_SRC_DIR}/ais.c + ${CUSTOM_SRC_DIR}/dedupe.c + ${CUSTOM_SRC_DIR}/pfilter.c + ${CUSTOM_SRC_DIR}/ax25_pad.c + ${CUSTOM_SRC_DIR}/fcs_calc.c + ${CUSTOM_SRC_DIR}/tq.c + ${CUSTOM_SRC_DIR}/textcolor.c + ${CUSTOM_SRC_DIR}/decode_aprs.c + ${CUSTOM_SRC_DIR}/dwgpsnmea.c + ${CUSTOM_SRC_DIR}/dwgps.c + ${CUSTOM_SRC_DIR}/dwgpsd.c + ${CUSTOM_SRC_DIR}/serial_port.c + ${CUSTOM_SRC_DIR}/latlong.c + ${CUSTOM_SRC_DIR}/telemetry.c + ${CUSTOM_SRC_DIR}/symbols.c + ${CUSTOM_SRC_DIR}/tt_text.c + ) + +if(WIN32 OR CYGWIN) + list(REMOVE_ITEM dtest_SOURCES + ${CUSTOM_SRC_DIR}/dwgpsd.c + ) +endif() + +add_executable(dtest + ${dtest_SOURCES} + ) + +set_target_properties(dtest + PROPERTIES COMPILE_FLAGS "-DDIGITEST -DUSE_REGEX_STATIC" + ) + +target_link_libraries(dtest + ${MISC_LIBRARIES} + ${REGEX_LIBRARIES} + ${GPSD_LIBRARIES} + Threads::Threads + ) + +if(WIN32 OR CYGWIN) + target_link_libraries(dtest ws2_32) +endif() + + +# Unit test for APRStt tone sequence parsing. +list(APPEND ttest_SOURCES + ${CUSTOM_SRC_DIR}/aprs_tt.c + ${CUSTOM_SRC_DIR}/tt_text.c + ${CUSTOM_SRC_DIR}/latlong.c + ${CUSTOM_SRC_DIR}/textcolor.c + ) + +add_executable(ttest + ${ttest_SOURCES} + ) + +set_target_properties(ttest + PROPERTIES COMPILE_FLAGS "-DTT_MAIN" + ) + +target_link_libraries(ttest + ${MISC_LIBRARIES} + ${GEOTRANZ_LIBRARIES} + ) + + +# Unit test for APRStt tone sequence / text conversions. +list(APPEND tttexttest_SOURCES + ${CUSTOM_SRC_DIR}/tt_text.c + ${CUSTOM_SRC_DIR}/textcolor.c + ) + +add_executable(tttexttest + ${tttexttest_SOURCES} + ) + +set_target_properties(tttexttest + PROPERTIES COMPILE_FLAGS "-DTTT_TEST" + ) + +target_link_libraries(tttexttest + ${MISC_LIBRARIES} + ) + + +# Unit test for Packet Filtering. +list(APPEND pftest_SOURCES + ${CUSTOM_SRC_DIR}/pfilter.c + ${CUSTOM_SRC_DIR}/ais.c + ${CUSTOM_SRC_DIR}/ax25_pad.c + ${CUSTOM_SRC_DIR}/textcolor.c + ${CUSTOM_SRC_DIR}/fcs_calc.c + ${CUSTOM_SRC_DIR}/decode_aprs.c + ${CUSTOM_SRC_DIR}/dwgpsnmea.c + ${CUSTOM_SRC_DIR}/dwgps.c + ${CUSTOM_SRC_DIR}/dwgpsd.c + ${CUSTOM_SRC_DIR}/serial_port.c + ${CUSTOM_SRC_DIR}/latlong.c + ${CUSTOM_SRC_DIR}/symbols.c + ${CUSTOM_SRC_DIR}/telemetry.c + ${CUSTOM_SRC_DIR}/tt_text.c + ) + +if(WIN32 OR CYGWIN) + list(REMOVE_ITEM pftest_SOURCES + ${CUSTOM_SRC_DIR}/dwgpsd.c + ) +endif() + +add_executable(pftest + ${pftest_SOURCES} + ) + +set_target_properties(pftest + PROPERTIES COMPILE_FLAGS "-DPFTEST -DUSE_REGEX_STATIC" + ) + +target_link_libraries(pftest + ${MISC_LIBRARIES} + ${REGEX_LIBRARIES} + ${GPSD_LIBRARIES} + Threads::Threads + ) + +if(WIN32 OR CYGWIN) + target_link_libraries(pftest ws2_32) +endif() + +# Unit test for telemetry decoding. +list(APPEND tlmtest_SOURCES + ${CUSTOM_SRC_DIR}/telemetry.c + ${CUSTOM_SRC_DIR}/ax25_pad.c + ${CUSTOM_SRC_DIR}/fcs_calc.c + ${CUSTOM_SRC_DIR}/textcolor.c + ) + +if(WIN32 OR CYGWIN) + list(REMOVE_ITEM tlmtest_SOURCES + ${CUSTOM_SRC_DIR}/dwgpsd.c + ) +endif() + +add_executable(tlmtest + ${tlmtest_SOURCES} + ) + +set_target_properties(tlmtest + PROPERTIES COMPILE_FLAGS "-DTEST -DUSE_REGEX_STATIC" + ) + +target_link_libraries(tlmtest + ${MISC_LIBRARIES} + ${REGEX_LIBRARIES} + ) + +if(WIN32 OR CYGWIN) + target_link_libraries(tlmtest ws2_32) +endif() + + +# Unit test for location coordinate conversion. +list(APPEND lltest_SOURCES + ${CUSTOM_SRC_DIR}/latlong.c + ${CUSTOM_SRC_DIR}/textcolor.c + ) + +add_executable(lltest + ${lltest_SOURCES} + ) + +set_target_properties(lltest + PROPERTIES COMPILE_FLAGS "-DLLTEST" + ) + +target_link_libraries(lltest + ${MISC_LIBRARIES} + ) + + +# Unit test for encoding position & object report. +list(APPEND enctest_SOURCES + ${CUSTOM_SRC_DIR}/encode_aprs.c + ${CUSTOM_SRC_DIR}/latlong.c + ${CUSTOM_SRC_DIR}/textcolor.c + ) + +add_executable(enctest + ${enctest_SOURCES} + ) + +set_target_properties(enctest + PROPERTIES COMPILE_FLAGS "-DEN_MAIN" + ) + +target_link_libraries(enctest + ${MISC_LIBRARIES} + ) + + +# Unit test for KISS encapsulation. +list(APPEND kisstest_SOURCES + ${CUSTOM_SRC_DIR}/kiss_frame.c + ) + +add_executable(kisstest + ${kisstest_SOURCES} + ) + +set_target_properties(kisstest + PROPERTIES COMPILE_FLAGS "-DKISSTEST" + ) + + +# Unit test for constructing frames besides UI. +list(APPEND pad2test_SOURCES + ${CUSTOM_SRC_DIR}/ax25_pad2.c + ${CUSTOM_SRC_DIR}/ax25_pad.c + ${CUSTOM_SRC_DIR}/fcs_calc.c + ${CUSTOM_SRC_DIR}/textcolor.c + ) + +add_executable(pad2test + ${pad2test_SOURCES} + ) + +set_target_properties(pad2test + PROPERTIES COMPILE_FLAGS "-DPAD2TEST -DUSE_REGEX_STATIC" + ) + +target_link_libraries(pad2test + ${MISC_LIBRARIES} + ${REGEX_LIBRARIES} + ) + +if(WIN32 OR CYGWIN) + target_link_libraries(pad2test ws2_32) +endif() + + +# Unit Test for XID frame encode/decode. +list(APPEND xidtest_SOURCES + ${CUSTOM_SRC_DIR}/xid.c + ${CUSTOM_SRC_DIR}/textcolor.c + ) + +add_executable(xidtest + ${xidtest_SOURCES} + ) + +set_target_properties(xidtest + PROPERTIES COMPILE_FLAGS "-DXIDTEST" + ) + +target_link_libraries(xidtest + ${MISC_LIBRARIES} + ) + + +# Unit Test for DTMF encode/decode. +list(APPEND dtmftest_SOURCES + ${CUSTOM_SRC_DIR}/dtmf.c + ${CUSTOM_SRC_DIR}/textcolor.c + ) + +add_executable(dtmftest + ${dtmftest_SOURCES} + ) + +set_target_properties(dtmftest + PROPERTIES COMPILE_FLAGS "-DDTMF_TEST" + ) + +# Unit Test FX.25 algorithm. + +list(APPEND fxsend_SOURCES + ${CUSTOM_SRC_DIR}/fx25_send.c + ${CUSTOM_SRC_DIR}/fx25_encode.c + ${CUSTOM_SRC_DIR}/fx25_init.c + ${CUSTOM_SRC_DIR}/fcs_calc.c + ${CUSTOM_SRC_DIR}/textcolor.c + ) + +add_executable(fxsend + ${fxsend_SOURCES} + ) + +set_target_properties(fxsend + PROPERTIES COMPILE_FLAGS "-DFXTEST" + ) + +list(APPEND fxrec_SOURCES + ${CUSTOM_SRC_DIR}/fx25_rec.c + ${CUSTOM_SRC_DIR}/fx25_extract.c + ${CUSTOM_SRC_DIR}/fx25_init.c + ${CUSTOM_SRC_DIR}/fcs_calc.c + ${CUSTOM_SRC_DIR}/textcolor.c + ) + +add_executable(fxrec + ${fxrec_SOURCES} + ) + +set_target_properties(fxrec + PROPERTIES COMPILE_FLAGS "-DFXTEST" + ) + + +# Unit Test IL2P with out modems. + +list(APPEND il2p_test_SOURCES + ${CUSTOM_SRC_DIR}/il2p_test.c + ${CUSTOM_SRC_DIR}/il2p_init.c + ${CUSTOM_SRC_DIR}/il2p_rec.c + ${CUSTOM_SRC_DIR}/il2p_send.c + ${CUSTOM_SRC_DIR}/il2p_codec.c + ${CUSTOM_SRC_DIR}/il2p_payload.c + ${CUSTOM_SRC_DIR}/il2p_header.c + ${CUSTOM_SRC_DIR}/il2p_scramble.c + ${CUSTOM_SRC_DIR}/ax25_pad.c + ${CUSTOM_SRC_DIR}/ax25_pad2.c + ${CUSTOM_SRC_DIR}/fx25_encode.c + ${CUSTOM_SRC_DIR}/fx25_extract.c + ${CUSTOM_SRC_DIR}/fx25_init.c + ${CUSTOM_SRC_DIR}/fcs_calc.c + ${CUSTOM_SRC_DIR}/textcolor.c + ) + +add_executable(il2p_test + ${il2p_test_SOURCES} + ) + +#FIXME - remove if not needed. +#set_target_properties(il2p_test +# PROPERTIES COMPILE_FLAGS "-DXXXXX" +# ) + +target_link_libraries(il2p_test + ${MISC_LIBRARIES} + ) + +# doing ctest on previous programs + +add_test(dtest dtest) +add_test(ttest ttest) +add_test(tttexttest tttexttest) +add_test(pftest pftest) +add_test(tlmtest tlmtest) +add_test(lltest lltest) +add_test(enctest enctest) +add_test(kisstest kisstest) +add_test(pad2test pad2test) +add_test(xidtest xidtest) +add_test(dtmftest dtmftest) + +add_test(check-fx25 "${CUSTOM_TEST_BINARY_DIR}/${TEST_CHECK-FX25_FILE}${CUSTOM_SCRIPT_SUFFIX}") +add_test(check-il2p "${CUSTOM_TEST_BINARY_DIR}/${TEST_CHECK-IL2P_FILE}${CUSTOM_SCRIPT_SUFFIX}") +add_test(check-modem1200 "${CUSTOM_TEST_BINARY_DIR}/${TEST_CHECK-MODEM1200_FILE}${CUSTOM_SCRIPT_SUFFIX}") +add_test(check-modem1200-i "${CUSTOM_TEST_BINARY_DIR}/${TEST_CHECK-MODEM1200_IL2P_FILE}${CUSTOM_SCRIPT_SUFFIX}") +add_test(check-modem300 "${CUSTOM_TEST_BINARY_DIR}/${TEST_CHECK-MODEM300_FILE}${CUSTOM_SCRIPT_SUFFIX}") +add_test(check-modem9600 "${CUSTOM_TEST_BINARY_DIR}/${TEST_CHECK-MODEM9600_FILE}${CUSTOM_SCRIPT_SUFFIX}") +add_test(check-modem9600-i "${CUSTOM_TEST_BINARY_DIR}/${TEST_CHECK-MODEM9600_IL2P_FILE}${CUSTOM_SCRIPT_SUFFIX}") +add_test(check-modem19200 "${CUSTOM_TEST_BINARY_DIR}/${TEST_CHECK-MODEM19200_FILE}${CUSTOM_SCRIPT_SUFFIX}") +add_test(check-modem2400-a "${CUSTOM_TEST_BINARY_DIR}/${TEST_CHECK-MODEM2400-a_FILE}${CUSTOM_SCRIPT_SUFFIX}") +add_test(check-modem2400-b "${CUSTOM_TEST_BINARY_DIR}/${TEST_CHECK-MODEM2400-b_FILE}${CUSTOM_SCRIPT_SUFFIX}") +add_test(check-modem2400-g "${CUSTOM_TEST_BINARY_DIR}/${TEST_CHECK-MODEM2400-g_FILE}${CUSTOM_SCRIPT_SUFFIX}") +add_test(check-modem4800 "${CUSTOM_TEST_BINARY_DIR}/${TEST_CHECK-MODEM4800_FILE}${CUSTOM_SCRIPT_SUFFIX}") +add_test(check-modemeas "${CUSTOM_TEST_BINARY_DIR}/${TEST_CHECK-MODEMEAS_FILE}${CUSTOM_SCRIPT_SUFFIX}") + + + +# ----------------------------- Manual tests and experiments --------------------------- +if(OPTIONAL_TEST) + + # Unit test for IGate + list(APPEND itest_SOURCES + ${CUSTOM_SRC_DIR}/igate.c + ${CUSTOM_SRC_DIR}/ais.c + ${CUSTOM_SRC_DIR}/ax25_pad.c + ${CUSTOM_SRC_DIR}/fcs_calc.c + ${CUSTOM_SRC_DIR}/mheard.c + ${CUSTOM_SRC_DIR}/pfilter.c + ${CUSTOM_SRC_DIR}/telemetry.c + ${CUSTOM_SRC_DIR}/decode_aprs.c + ${CUSTOM_SRC_DIR}/dwgpsnmea.c + ${CUSTOM_SRC_DIR}/dwgps.c + ${CUSTOM_SRC_DIR}/dwgpsd.c + ${CUSTOM_SRC_DIR}/serial_port.c + ${CUSTOM_SRC_DIR}/textcolor.c + ${CUSTOM_SRC_DIR}/dtime_now.c + ${CUSTOM_SRC_DIR}/latlong.c + ${CUSTOM_SRC_DIR}/tt_text.c + ${CUSTOM_SRC_DIR}/symbols.c + ) + + if(WIN32 OR CYGWIN) + list(REMOVE_ITEM itest_SOURCES + ${CUSTOM_SRC_DIR}/dwgpsd.c + ) + endif() + + add_executable(itest + ${itest_SOURCES} + ) + + set_target_properties(itest + PROPERTIES COMPILE_FLAGS "-DITEST" + ) + + target_link_libraries(itest + ${MISC_LIBRARIES} + ${GPSD_LIBRARIES} + Threads::Threads + ) + + if(WIN32 OR CYGWIN) + target_link_libraries(itest ws2_32) + endif() + + + # For demodulator tweaking experiments. + list(APPEND testagc_SOURCES + ${CUSTOM_SRC_DIR}/atest.c + ${CUSTOM_SRC_DIR}/ais.c + ${CUSTOM_SRC_DIR}/demod.c + ${CUSTOM_SRC_DIR}/dsp.c + ${CUSTOM_SRC_DIR}/demod_afsk.c + ${CUSTOM_SRC_DIR}/demod_psk.c + ${CUSTOM_SRC_DIR}/demod_9600.c + ${CUSTOM_SRC_DIR}/hdlc_rec.c + ${CUSTOM_SRC_DIR}/hdlc_rec2.c + ${CUSTOM_SRC_DIR}/multi_modem.c + ${CUSTOM_SRC_DIR}/rrbb.c + ${CUSTOM_SRC_DIR}/fcs_calc.c + ${CUSTOM_SRC_DIR}/ax25_pad.c + ${CUSTOM_SRC_DIR}/decode_aprs.c + ${CUSTOM_SRC_DIR}/dwgpsnmea.c + ${CUSTOM_SRC_DIR}/dwgps.c + ${CUSTOM_SRC_DIR}/dwgpsd.c + ${CUSTOM_SRC_DIR}/serial_port.c + ${CUSTOM_SRC_DIR}/telemetry.c + ${CUSTOM_SRC_DIR}/dtime_now.c + ${CUSTOM_SRC_DIR}/latlong.c + ${CUSTOM_SRC_DIR}/tt_text.c + ${CUSTOM_SRC_DIR}/symbols.c + ${CUSTOM_SRC_DIR}/textcolor.c + ) + + if(WIN32 OR CYGWIN) + list(REMOVE_ITEM testagc_SOURCES + ${CUSTOM_SRC_DIR}/dwgpsd.c + ) + endif() + + add_executable(testagc + ${testagc_SOURCES} + ) + + target_link_libraries(testagc + ${MISC_LIBRARIES} + ${GPSD_LIBRARIES} + Threads::Threads + ) + + if(WIN32 OR CYGWIN) + target_link_libraries(testagc ws2_32) + endif() + + + # Send GPS location to KISS TNC each second. + list(APPEND walk96_SOURCES + ${CUSTOM_SRC_DIR}/walk96.c + ${CUSTOM_SRC_DIR}/ais.c + ${CUSTOM_SRC_DIR}/dwgps.c + ${CUSTOM_SRC_DIR}/dwgpsnmea.c + ${CUSTOM_SRC_DIR}/dwgpsd.c + ${CUSTOM_SRC_DIR}/kiss_frame.c + ${CUSTOM_SRC_DIR}/latlong.c + ${CUSTOM_SRC_DIR}/encode_aprs.c + ${CUSTOM_SRC_DIR}/serial_port.c + ${CUSTOM_SRC_DIR}/textcolor.c + ${CUSTOM_SRC_DIR}/ax25_pad.c + ${CUSTOM_SRC_DIR}/fcs_calc.c + ${CUSTOM_SRC_DIR}/xmit.c + ${CUSTOM_SRC_DIR}/xid.c + ${CUSTOM_SRC_DIR}/hdlc_send.c + ${CUSTOM_SRC_DIR}/gen_tone.c + ${CUSTOM_SRC_DIR}/ptt.c + ${CUSTOM_SRC_DIR}/tq.c + ${CUSTOM_SRC_DIR}/hdlc_rec.c + ${CUSTOM_SRC_DIR}/hdlc_rec2.c + ${CUSTOM_SRC_DIR}/rrbb.c + ${CUSTOM_SRC_DIR}/dsp.c + ${CUSTOM_SRC_DIR}/multi_modem.c + ${CUSTOM_SRC_DIR}/demod.c + ${CUSTOM_SRC_DIR}/demod_afsk.c + ${CUSTOM_SRC_DIR}/demod_psk.c + ${CUSTOM_SRC_DIR}/demod_9600.c + ${CUSTOM_SRC_DIR}/server.c + ${CUSTOM_SRC_DIR}/morse.c + ${CUSTOM_SRC_DIR}/dtmf.c + ${CUSTOM_SRC_DIR}/audio_stats.c + ${CUSTOM_SRC_DIR}/dtime_now.c + ${CUSTOM_SRC_DIR}/dlq.c + ) + + if(LINUX) + list(APPEND walk96_SOURCES + ${CUSTOM_SRC_DIR}/audio.c + ) + if(UDEV_FOUND) + list(APPEND walk96_SOURCES + ${CUSTOM_SRC_DIR}/cm108.c + ) + endif() + elseif(WIN32 OR CYGWIN) # windows + list(APPEND walk96_SOURCES + ${CUSTOM_SRC_DIR}/audio_win.c + ) + list(REMOVE_ITEM walk96_SOURCES + ${CUSTOM_SRC_DIR}/dwgpsd.c + ) + else() # macOS freebsd openbsd + list(APPEND walk96_SOURCES + ${CUSTOM_SRC_DIR}/audio_portaudio.c + ) + endif() + + add_executable(walk96 + ${walk96_SOURCES} + ) + + set_target_properties(walk96 + PROPERTIES COMPILE_FLAGS "-DWALK96 -DUSE_REGEX_STATIC" + ) + + target_link_libraries(walk96 + ${MISC_LIBRARIES} + ${REGEX_LIBRARIES} + ${GPSD_LIBRARIES} + ${HAMLIB_LIBRARIES} + ${ALSA_LIBRARIES} + ${PORTAUDIO_LIBRARIES} + ${UDEV_LIBRARIES} + Threads::Threads + ) + + if(WIN32 OR CYGWIN) + target_link_libraries(walk96 ws2_32) + endif() + + + # TODO miss the audio file + + # testagc + # ./atest -P H+ -F 0 ../01_Track_1.wav ../02_Track_2.wav | grep "packets decoded in" >atest.out + + # testagc3 + # ./gen_packets -B 300 -n 100 -o noisy3.wav + # ./atest3 -B 300 -P D -D 3 noisy3.wav | grep "packets decoded in" >atest.out + + # testagc96 + # ./gen_packets -B 9600 -n 100 -o noisy96.wav + # ./atest96 -B 9600 ../walkabout9600c.wav noisy96.wav zzz16.wav zzz16.wav zzz16.wav zzz8.wav zzz8.wav zzz8.wav | grep "packets decoded in" >atest.out + + # testagc24 + # ./atest24 -B 2400 test2400.wav | grep "packets decoded in" >atest.out + + # testagc24mfj + # ./atest24mfj -F 1 -B 2400 ../ref-doc/MFJ-2400-PSK/2k4_short.wav + + # testagc48 + # ./atest48 -B 4800 test4800.wav | grep "packets decoded in" >atest.out +endif() # OPTIONAL_TEST diff --git a/test/scripts/check-fx25 b/test/scripts/check-fx25 new file mode 100755 index 00000000..d5003337 --- /dev/null +++ b/test/scripts/check-fx25 @@ -0,0 +1,16 @@ +@CUSTOM_SHELL_SHABANG@ + +@FXSEND_BIN@ +@FXREC_BIN@ + +@GEN_PACKETS_BIN@ -B9600 -n 100 -X 0 -o test96f0.wav +@ATEST_BIN@ -B9600 -F0 -L60 -G64 test96f0.wav + +@GEN_PACKETS_BIN@ -B9600 -n 100 -X 16 -o test96f16.wav +@ATEST_BIN@ -B9600 -F0 -L63 -G67 test96f16.wav + +@GEN_PACKETS_BIN@ -B9600 -n 100 -X 32 -o test96f32.wav +@ATEST_BIN@ -B9600 -F0 -L64 -G68 test96f32.wav + +@GEN_PACKETS_BIN@ -B9600 -n 100 -X 64 -o test96f64.wav +@ATEST_BIN@ -B9600 -F0 -L71 -G75 test96f64.wav diff --git a/test/scripts/check-il2p b/test/scripts/check-il2p new file mode 100755 index 00000000..da404720 --- /dev/null +++ b/test/scripts/check-il2p @@ -0,0 +1,4 @@ +@CUSTOM_SHELL_SHABANG@ + +@IL2P_TEST_BIN@ + diff --git a/test/scripts/check-modem1200 b/test/scripts/check-modem1200 new file mode 100755 index 00000000..d3022796 --- /dev/null +++ b/test/scripts/check-modem1200 @@ -0,0 +1,7 @@ +@CUSTOM_SHELL_SHABANG@ + +@GEN_PACKETS_BIN@ -n 100 -o test12.wav +@ATEST_BIN@ -F0 -PA -D1 -L66 -G72 test12.wav +@ATEST_BIN@ -F1 -PA -D1 -L72 -G78 test12.wav +@ATEST_BIN@ -F0 -PB -D1 -L66 -G74 test12.wav +@ATEST_BIN@ -F1 -PB -D1 -L70 -G82 test12.wav diff --git a/test/scripts/check-modem1200-i b/test/scripts/check-modem1200-i new file mode 100755 index 00000000..9ef01bab --- /dev/null +++ b/test/scripts/check-modem1200-i @@ -0,0 +1,4 @@ +@CUSTOM_SHELL_SHABANG@ + +@GEN_PACKETS_BIN@ -I1 -n 100 -o test12-il2p.wav +@ATEST_BIN@ -P+ -D1 -L92 -G94 test12-il2p.wav diff --git a/test/scripts/check-modem19200 b/test/scripts/check-modem19200 new file mode 100755 index 00000000..ae49e46f --- /dev/null +++ b/test/scripts/check-modem19200 @@ -0,0 +1,7 @@ +@CUSTOM_SHELL_SHABANG@ + +@GEN_PACKETS_BIN@ -r 96000 -B19200 -a 170 -o test19.wav +@ATEST_BIN@ -B19200 -F0 -L4 test19.wav +@GEN_PACKETS_BIN@ -r 96000 -B19200 -n 100 -o test19.wav +@ATEST_BIN@ -B19200 -F0 -L60 -G66 test19.wav +@ATEST_BIN@ -B19200 -F1 -L64 -G69 test19.wav diff --git a/test/scripts/check-modem2400-a b/test/scripts/check-modem2400-a new file mode 100755 index 00000000..33dfebf4 --- /dev/null +++ b/test/scripts/check-modem2400-a @@ -0,0 +1,5 @@ +@CUSTOM_SHELL_SHABANG@ + +@GEN_PACKETS_BIN@ -B2400 -j -n 100 -o test24-a.wav +@ATEST_BIN@ -B2400 -j -F0 -L76 -G83 test24-a.wav +@ATEST_BIN@ -B2400 -j -F1 -L84 -G89 test24-a.wav diff --git a/test/scripts/check-modem2400-b b/test/scripts/check-modem2400-b new file mode 100755 index 00000000..913a6088 --- /dev/null +++ b/test/scripts/check-modem2400-b @@ -0,0 +1,5 @@ +@CUSTOM_SHELL_SHABANG@ + +@GEN_PACKETS_BIN@ -B2400 -J -n 100 -o test24-b.wav +@ATEST_BIN@ -B2400 -J -F0 -L81 -G88 test24-b.wav +@ATEST_BIN@ -B2400 -J -F1 -L86 -G90 test24-b.wav diff --git a/test/scripts/check-modem2400-g b/test/scripts/check-modem2400-g new file mode 100755 index 00000000..da7e233f --- /dev/null +++ b/test/scripts/check-modem2400-g @@ -0,0 +1,4 @@ +@CUSTOM_SHELL_SHABANG@ + +@GEN_PACKETS_BIN@ -B2400 -g -n 100 -o test24-g.wav +@ATEST_BIN@ -B2400 -g -F0 -L99 -G101 test24-g.wav diff --git a/test/scripts/check-modem300 b/test/scripts/check-modem300 new file mode 100755 index 00000000..6d6e6432 --- /dev/null +++ b/test/scripts/check-modem300 @@ -0,0 +1,7 @@ +@CUSTOM_SHELL_SHABANG@ + +@GEN_PACKETS_BIN@ -B300 -n 100 -o test3.wav +@ATEST_BIN@ -B300 -PA -F0 -L65 -G71 test3.wav +@ATEST_BIN@ -B300 -PA -F1 -L69 -G75 test3.wav +@ATEST_BIN@ -B300 -PB -F0 -L69 -G75 test3.wav +@ATEST_BIN@ -B300 -PB -F1 -L73 -G79 test3.wav diff --git a/test/scripts/check-modem4800 b/test/scripts/check-modem4800 new file mode 100755 index 00000000..7d511bb1 --- /dev/null +++ b/test/scripts/check-modem4800 @@ -0,0 +1,5 @@ +@CUSTOM_SHELL_SHABANG@ + +@GEN_PACKETS_BIN@ -B4800 -n 100 -o test48.wav +@ATEST_BIN@ -B4800 -F0 -L68 -G74 test48.wav +@ATEST_BIN@ -B4800 -F1 -L72 -G84 test48.wav diff --git a/test/scripts/check-modem9600 b/test/scripts/check-modem9600 new file mode 100755 index 00000000..fa5f6583 --- /dev/null +++ b/test/scripts/check-modem9600 @@ -0,0 +1,7 @@ +@CUSTOM_SHELL_SHABANG@ + +@GEN_PACKETS_BIN@ -B9600 -a 170 -o test96.wav +@ATEST_BIN@ -B9600 -F0 -L4 -G4 test96.wav +@GEN_PACKETS_BIN@ -B9600 -n 100 -o test96.wav +@ATEST_BIN@ -B9600 -F0 -L61 -G65 test96.wav +@ATEST_BIN@ -B9600 -F1 -L62 -G66 test96.wav diff --git a/test/scripts/check-modem9600-i b/test/scripts/check-modem9600-i new file mode 100755 index 00000000..0ba01bea --- /dev/null +++ b/test/scripts/check-modem9600-i @@ -0,0 +1,18 @@ +@CUSTOM_SHELL_SHABANG@ + +@GEN_PACKETS_BIN@ -B9600 -I1 -n 100 -o test96-il2p-I1.wav +@ATEST_BIN@ -B9600 -L72 -G76 test96-il2p-I1.wav +@ATEST_BIN@ -B9600 -P+ -L76 -G80 test96-il2p-I1.wav + +@GEN_PACKETS_BIN@ -B9600 -I0 -n 100 -o test96-il2p-I0.wav +@ATEST_BIN@ -B9600 -L64 -G68 test96-il2p-I0.wav + + +@GEN_PACKETS_BIN@ -B9600 -i1 -n 100 -o test96-il2p-i1.wav +@ATEST_BIN@ -B9600 -L70 -G74 test96-il2p-i1.wav +@ATEST_BIN@ -B9600 -P+ -L73 -G77 test96-il2p-i1.wav + +@GEN_PACKETS_BIN@ -B9600 -i0 -n 100 -o test96-il2p-i0.wav +@ATEST_BIN@ -B9600 -L67 -G71 test96-il2p-i0.wav + + diff --git a/test/scripts/check-modemeas b/test/scripts/check-modemeas new file mode 100755 index 00000000..c2a88539 --- /dev/null +++ b/test/scripts/check-modemeas @@ -0,0 +1,4 @@ +@CUSTOM_SHELL_SHABANG@ + +@GEN_PACKETS_BIN@ -B EAS -o testeas.wav +@ATEST_BIN@ -B EAS -L 6 -G 6 testeas.wav diff --git a/textcolor.c b/textcolor.c deleted file mode 100644 index 94054a65..00000000 --- a/textcolor.c +++ /dev/null @@ -1,371 +0,0 @@ -// -// This file is part of Dire Wolf, an amateur radio packet TNC. -// -// Copyright (C) 2011,2012,2013 John Langner, WB2OSZ -// -// This program 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 2 of the License, or -// (at your option) any later version. -// -// This program 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 this program. If not, see . -// - - -/*------------------------------------------------------------------- - * - * Name: textcolor.c - * - * Purpose: Originally this would only set color of text - * and we used printf everywhere. - * Now we also have a printf replacement that can - * be used to redirect all output to the desired place. - * This opens the door to using ncurses, a GUI, or - * running as a daemon. - * - * Description: For Linux and Cygwin use the ANSI escape sequences. - * In earlier versions of Windows, the cmd window and ANSI.SYS - * could interpret this but it doesn't seem to be available - * anymore so we use a different interface. - * - * References: - * http://en.wikipedia.org/wiki/ANSI_escape_code - * http://academic.evergreen.edu/projects/biophysics/technotes/program/ansi_esc.htm - * - * Problem: The ANSI escape sequences, used on Linux, allow 8 basic colors. - * Unfortunately, white is not one of them. We only have dark - * white, also known as light gray. To get brighter colors, - * we need to apply an attribute. On some systems, the bold - * attribute produces a brighter color rather than a bold font. - * On other systems, we need to use the blink attribute to get - * bright colors, including white. However on others, blink - * does actually produce blinking characters. - * - * Several people have also complained that bright green is - * very hard to read against a light background. The current - * implementation does not allow easy user customization of colors. - * - * Currently, the only option is to put "-t 0" on the command - * line to disable all text color. This is more readable but - * makes it harder to distinguish different types of - * information, e.g. received packets vs. error messages. - * - * A few people have suggested ncurses. This needs to - * be investigated for a future version. The foundation has - * already been put in place. All of the printf's have been - * replaced by dw_printf, defined in this file. All of the - * text output is now being funneled thru this one function - * so it should be easy to send it to the user by some - * other means. - * - *--------------------------------------------------------------------*/ - - -#include -#include -#include - - -#if __WIN32__ - -// /* Missing from MinGW header file. */ -// #define vsprintf_s vsnprintf - -//_CRTIMP int __cdecl __MINGW_NOTHROW vsprintf_s (char*, size_t, const char*, __VALIST); - -//int vsprintf_s( -// char *buffer, -// size_t numberOfElements, -// const char *format, -// va_list argptr -//); - - -#include - -#define BACKGROUND_WHITE (BACKGROUND_RED | BACKGROUND_GREEN | BACKGROUND_BLUE | BACKGROUND_INTENSITY) - - - -#elif __CYGWIN__ /* Cygwin */ - -/* For Cygwin we need "blink" (5) rather than the */ -/* expected bright/bold (1) to get bright white background. */ -/* Makes no sense but I stumbled across that somewhere. */ - -static const char background_white[] = "\e[5;47m"; - -/* Whenever a dark color is used, the */ -/* background is reset and needs to be set again. */ - -static const char black[] = "\e[0;30m" "\e[5;47m"; -static const char red[] = "\e[1;31m"; -static const char green[] = "\e[1;32m"; -static const char yellow[] = "\e[1;33m"; -static const char blue[] = "\e[1;34m"; -static const char magenta[] = "\e[1;35m"; -static const char cyan[] = "\e[1;36m"; -static const char dark_green[] = "\e[0;32m" "\e[5;47m"; - -/* Clear from cursor to end of screen. */ - -static const char clear_eos[] = "\e[0J"; - - -#elif __arm__ /* Linux on Raspberry Pi or similar */ - - -/* We need "blink" (5) rather than the */ -/* expected bright/bold (1) to get bright white background. */ -/* Makes no sense but I stumbled across that somewhere. */ - -static const char background_white[] = "\e[5;47m"; - -/* Whenever a dark color is used, the */ -/* background is reset and needs to be set again. */ - -static const char black[] = "\e[0;30m" "\e[5;47m"; -static const char red[] = "\e[1;31m"; -static const char green[] = "\e[1;32m"; -static const char yellow[] = "\e[1;33m"; -static const char blue[] = "\e[1;34m"; -static const char magenta[] = "\e[1;35m"; -static const char cyan[] = "\e[1;36m"; -static const char dark_green[] = "\e[0;32m" "\e[5;47m"; - -/* Clear from cursor to end of screen. */ - -static const char clear_eos[] = "\e[0J"; - - -#else /* Other Linux */ - -static const char background_white[] = "\e[47;1m"; - -/* Whenever a dark color is used, the */ -/* background is reset and needs to be set again. */ - -static const char black[] = "\e[0;30m" "\e[1;47m"; -static const char red[] = "\e[1;31m" "\e[1;47m"; -static const char green[] = "\e[1;32m" "\e[1;47m"; -static const char yellow[] = "\e[1;33m" "\e[1;47m"; -static const char blue[] = "\e[1;34m" "\e[1;47m"; -static const char magenta[] = "\e[1;35m" "\e[1;47m"; -static const char cyan[] = "\e[1;36m" "\e[1;47m"; -static const char dark_green[] = "\e[0;32m" "\e[1;47m"; - -/* Clear from cursor to end of screen. */ - -static const char clear_eos[] = "\e[0J"; - -#endif /* end Linux */ - - -#include "textcolor.h" - - -/* - * g_enable_color: - * 0 = disable text colors. - * 1 = normal. - * others... future possibility. - */ - -static int g_enable_color = 1; - - -void text_color_init (int enable_color) -{ - - g_enable_color = enable_color; - - -#if __WIN32__ - - - if (g_enable_color) { - - HANDLE h; - CONSOLE_SCREEN_BUFFER_INFO csbi; - WORD attr = BACKGROUND_WHITE; - DWORD length; - COORD coord; - DWORD nwritten; - - h = GetStdHandle(STD_OUTPUT_HANDLE); - if (h != NULL && h != INVALID_HANDLE_VALUE) { - - GetConsoleScreenBufferInfo (h, &csbi); - - length = csbi.dwSize.X * csbi.dwSize.Y; - coord.X = 0; - coord.Y = 0; - FillConsoleOutputAttribute (h, attr, length, coord, &nwritten); - } - } - -#else - if (g_enable_color) { - //printf ("%s", clear_eos); - printf ("%s", background_white); - //printf ("%s", clear_eos); - printf ("%s", black); - } -#endif -} - - -#if __WIN32__ - -/* Seems that ANSI.SYS is no longer available. */ - - -void text_color_set ( enum dw_color_e c ) -{ - WORD attr; - HANDLE h; - - if (g_enable_color == 0) { - return; - } - - switch (c) { - - default: - case DW_COLOR_INFO: - attr = BACKGROUND_WHITE; - break; - - case DW_COLOR_ERROR: - attr = FOREGROUND_RED | FOREGROUND_INTENSITY | BACKGROUND_WHITE; - break; - - case DW_COLOR_REC: - attr = FOREGROUND_GREEN | FOREGROUND_INTENSITY | BACKGROUND_WHITE; - break; - - case DW_COLOR_DECODED: - attr = FOREGROUND_BLUE | FOREGROUND_INTENSITY | BACKGROUND_WHITE; - break; - - case DW_COLOR_XMIT: - attr = FOREGROUND_RED | FOREGROUND_BLUE | FOREGROUND_INTENSITY | BACKGROUND_WHITE; - break; - - case DW_COLOR_DEBUG: - attr = FOREGROUND_GREEN | BACKGROUND_WHITE; - break; - } - - h = GetStdHandle(STD_OUTPUT_HANDLE); - - if (h != NULL && h != INVALID_HANDLE_VALUE) { - SetConsoleTextAttribute (h, attr); - } -} - -#else - -void text_color_set ( enum dw_color_e c ) -{ - - if (g_enable_color == 0) { - return; - } - - switch (c) { - - default: - case DW_COLOR_INFO: - printf ("%s", black); - break; - - case DW_COLOR_ERROR: - printf ("%s", red); - break; - - case DW_COLOR_REC: - printf ("%s", green); - break; - - case DW_COLOR_DECODED: - printf ("%s", blue); - break; - - case DW_COLOR_XMIT: - printf ("%s", magenta); - break; - - case DW_COLOR_DEBUG: - printf ("%s", dark_green); - break; - } -} - -#endif - - -/*------------------------------------------------------------------- - * - * Name: dw_printf - * - * Purpose: printf replacement that allows us to send all text - * output to stdout or other desired destination. - * - * Inputs: fmt - C language format. - * ... - Addtional arguments, just like printf. - * - * - * Returns: Number of characters in result. - * - * Bug: Fixed size buffer. - * I'd rather not do a malloc for each print. - * - *--------------------------------------------------------------------*/ - - -// TODO: replace all printf, look for stderr, perror -// TODO: $ grep printf *.c | grep -v dw_printf | grep -v fprintf | gawk '{ print $1 }' | sort -u - - -int dw_printf (const char *fmt, ...) -{ -#define BSIZE 1000 - va_list args; - char buffer[BSIZE]; - int len; - - va_start (args, fmt); - len = vsnprintf (buffer, BSIZE, fmt, args); - va_end (args); - -// TODO: other possible destinations... - - fputs (buffer, stdout); - return (len); -} - - - -#if TESTC -main () -{ - printf ("Initial condition\n"); - text_color_init (1); - printf ("After text_color_init\n"); - text_color_set(DW_COLOR_INFO); printf ("Info\n"); - text_color_set(DW_COLOR_ERROR); printf ("Error\n"); - text_color_set(DW_COLOR_REC); printf ("Rec\n"); - text_color_set(DW_COLOR_DECODED); printf ("Decoded\n"); - text_color_set(DW_COLOR_XMIT); printf ("Xmit\n"); - text_color_set(DW_COLOR_DEBUG); printf ("Debug\n"); -} -#endif - -/* end textcolor.c */ diff --git a/tnc-test-cd-results.png b/tnc-test-cd-results.png new file mode 100644 index 00000000..facff309 Binary files /dev/null and b/tnc-test-cd-results.png differ diff --git a/tocalls.txt b/tocalls.txt deleted file mode 100644 index cca3b8a5..00000000 --- a/tocalls.txt +++ /dev/null @@ -1,216 +0,0 @@ -APRS TO-CALL VERSION NUMBERS 02 Sep 2014 -------------------------------------------------------------------- - WB4APR - -02 Sep 14 added APSTMx for W7QO's Balloon trackers -21 Aug 14 added APSMSx for Paul Defrusne's SMS gateway -11 Aug 14 added APCWP8 for John GM7HHB, WinphoneAPRS -18 Dec 13 added APZWKR for GM1WKR NetSked application -22 Oct 13 added APFIxx for APRS.FI OH7LZB, Hessu -23 Aug 13 added APOxxx for OSCAR satellites for AMSAT-LU by LU9DO -22 Feb 13 added APNWxx SQ3FYK.com & SQ3PLX http://microsat.com.pl/ - and APMIxx SQ3PLX http://microsat.com.pl/ -29 Jan 13 added APICxx for HA9MCQ Pic IGate -23 Jan 13 added APWAxx APRSISCE Android version -18 Jan 13 added APDGxx,APDHxx,APDOxx,APDDxx,APDKxx,APD4xx for Dstar -13 Jan 13 added APLMxx WA0TQG transceiver controller -17 Dec 12 added APAMxx Altus Metrum GPS trackers -03 Dec 12 added APUDRx NW Digital Radio's UDR (APRS/Dstar) -03 Nov 12 added APHAXn SM2APRS by PY2UEP -17 Sep 12 added APSCxx aprsc APRS-IS core server (OH7LZB, OH2MQK) -12 Sep 12 added APSARx for ZL4FOX's SARTRACK -02 Jul 12 added APDGxx D-Star Gateways by G4KLX -28 Jun 12 added APDInn DIXPRS - Bela, HA5DI -27 jun 12 added APMGxx MiniGate - Alex, AB0TJ -17 Feb 12 added APJYnn KA2DDO yet another APRS system -20 Jan 12 added APDSXX SP9UOB for dsDigi and ds-tracker - APBPQx John G8BPQ Digipeater/IGate - APLQRU Charlie - QRU Server -11 Jan 12 added APYTxx for YagTracker and updated Yaesu APY008/350 - -In APRS, the AX.25 Destination address is not used for packet -routing as is normally done in AX.25. So APRS uses it for two -things. The initial APxxxx is used as a group identifier to make -APRS packets instanantly recognizable on shared channels. Most -applicaitons ignore all non APRS packets. The remaining 4 xxxx -bytes of the field are available to indicate the software version -number or application. The following applications have requested -a TOCALL number series: - - APn 3rd digit is a number - AP1WWX TAPR T-238+ WX station - AP4Rxy APRS4R software interface - APnnnD Painter Engineering uSmartDigi D-Gate DSTAR Gateway - APnnnU Painter Engineering uSmartDigi Digipeater - APA APAFxx AFilter. - APAGxx AGATE - APAGWx SV2AGW's AGWtracker - APALxx Alinco DR-620/635 internal TNC digis. "Hachi" ,JF1AJE - APAXxx AFilterX. - APAHxx AHub - APAND1 APRSdroid (replaced by APDRxx - APAMxx Altus Metrum GPS trackers - APAWxx AGWPE - APB APBxxx Beacons or Rabbit TCPIP micros? - APBLxx BigRedBee BeeLine - APBLO MOdel Rocketry K7RKT - APBPQx John G8BPQ Digipeater/IGate - APC APCxxx Cellular applications - APCBBx for VE7UDP Blackberry Applications - APCLEY EYTraker GPRS/GSM tracker by ZS6EY - APCLWX EYWeather GPRS/GSM WX station by ZS6EY - APCLEZ Telit EZ10 GSM application ZS6CEY - APCWP8 John GM7HHB, WinphoneAPRS - APCYxx Cybiko applications - APD APD4xx UP4DAR platform - APDDxx DV-RPTR Modem and Control Center Software - APDFxx Automatic DF units - APDGxx D-Star Gateways by G4KLX ircDDB - APDHxx WinDV (DUTCH*Star DV Node for Windows) - APDInn DIXPRS - Bela, HA5DI - APDKxx KI4LKF g2_ircddb Dstar gateway software - APDOxx ON8JL Standalone DStar Node - APDPRS D-Star originated posits - APDRxx APrsDRoid replaces old APAND1. - APDSXX SP9UOB for dsDigi and ds-tracker - APDTxx APRStouch Tone (DTMF) - APDUxx U2APRS by JA7UDE - APDWxx DireWolf, WB2OSZ - APE APExxx Telemetry devices - APERXQ Experimental tracker by PE1RXQ - APF APFxxx Firenet - APFGxx Flood Gage (KP4DJT) - APFIxx for APRS.FI OH7LZB, Hessu - APG APGxxx Gates, etc - APGOxx for AA3NJ PDA application - APH APHKxx for LA1BR tracker/digipeater - APHAXn SM2APRS by PY2UEP - API APICQx for ICQ - APICxx for HA9MCQ Pic IGate - APJ APJAxx JavAPRS - APJExx JeAPRS - APJIxx jAPRSIgate - APJSxx javAPRSSrvr - APJYnn KA2DDO Yet another APRS system - APK APK0xx Kenwood TH-D7's - APK003 Kenwood TH-D72 - APK1xx Kenwood D700's - APK102 Kenwood D710 - APKRAM KRAMstuff.com - Mark. G7LEU - APL APLQRU Charlie - QRU Server - APLMxx WA0TQG transceiver controller - APM APMxxx MacAPRS, - APMGxx MiniGate - Alex, AB0TJ - APMIxx SQ3PLX http://microsat.com.pl/ - APN APNxxx Network nodes, digis, etc - APN3xx Kantronics KPC-3 rom versions - APN9xx Kantronics KPC-9612 Roms - APNAxx WB6ZSU's APRServe - APNDxx DIGI_NED - APNK01 Kenwood D700 (APK101) type - APNK80 KAM version 8.0 - APNKMP KAM+ - APNMxx MJF TNC roms - APNPxx Paccom TNC roms - APNTxx SV2AGW's TNT tnc as a digi - APNUxx UIdigi - APNXxx TNC-X (K6DBG) - APNWxx SQ3FYK.com WX/Digi and SQ3PLX http://microsat.com.pl/ - APO APRSpoint - APOLUx for OSCAR satellites for AMSAT-LU by LU9DO - APOAxx OpenAPRS - Greg Carter - APOTxx Open Track - APOD1w Open Track with 1 wire WX - APOU2k Open Track for Ultimeter - APOZxx www.KissOZ.dk Tracker. OZ1EKD and OZ7HVO - APP APPTxx KetaiTracker by JF6LZE, Takeki (msg capable) - APQ APQxxx Earthquake data - APR APR8xx APRSdos versions 800+ - APRDxx APRSdata, APRSdr - APRGxx aprsg igate software, OH2GVE - APRHH2 HamHud 2 - APRKxx APRStk - APRNOW W5GGW ipad application - APRRTx RPC electronics - APRS Generic, (obsolete. Digis should use APNxxx instead) - APRXxx >40 APRSmax - APRXxx <39 for OH2MQK's RX-igate - APRTLM used in MIM's and Mic-lites, etc - APRtfc APRStraffic - APRSTx APRStt (Touch tone) - APS APSxxx APRS+SA, etc - APSARx ZL4FOX's SARTRACK - APSCxx aprsc APRS-IS core server (OH7LZB, OH2MQK) - APSK63 APRS Messenger -over-PSK63 - APSK25 APRS Messenger GMSK-250 - APSMSx Paul Defrusne's SMS gateway - APSTMx for W7QO's Balloon trackers - APT APTIGR TigerTrack - APTTxx Tiny Track - APT2xx Tiny Track II - APT3xx Tiny Track III - APTAxx K4ATM's tiny track - APTWxx Byons WXTrac - APTVxx for ATV/APRN and SSTV applications - APU APU1xx UIview 16 bit applications - APU2xx UIview 32 bit apps - APU3xx UIview terminal program - APUDRx NW Digital Radio's UDR (APRS/Dstar) - APV APVxxx Voice over Internet applications - APVRxx for IRLP - APVLxx for I-LINK - APVExx for ECHO link - APW APWxxx WinAPRS, etc - APWAxx APRSISCE Android version - APWSxx DF4IAN's WS2300 WX station - APWMxx APRSISCE KJ4ERJ - APWWxx APRSISCE win32 version - APX APXnnn Xastir - APXRnn Xrouter - APY APYxxx Yeasu - APY008 Yaesu VX-8 series - APY350 Yaesu FTM-350 series - APYTxx for YagTracker - APZ APZxxx Experimental - APZ0xx Xastir (old versions. See APX) - APZMDR for HaMDR trackers - hessu * hes.iki.fi] - APZPAD Smart Palm - APZTKP TrackPoint, Nick N0LP (Balloon tracking) - APZWIT MAP27 radio (Mountain Rescue) EI7IG - APZWKR GM1WKR NetSked application - -Authors with similar alphabetic requirements are encouraged to share -their address space with other software. Work out agreements amongst -yourselves and keep me informed. - - -REGISTERED ALTNETS: -------------------- - -ALTNETS are uses of the AX-25 tocall to distinguish specialized -traffic that may be flowing on the APRS-IS, but that are not intended -to be part of normal APRS distribution to all normal APRS software -operating in normal (default) modes. Proper APRS software that -honors this design are supposed to IGNORE all ALTNETS unless the -particular operator has selected an ALTNET to monitor for. - -An example is when testing; an author may want to transmit objects -all over his map for on-air testing, but does not want these to -clutter everyone's maps or databases. He could use the ALTNET of -"TEST" and client APRS software that respects the ALTNET concept -should ignore these packets. - -An ALTNET is defined to be ANY AX.25 TOCALL that is NOT one of the -normal APRS TOCALL's. The normal TOCALL's that APRS is supposed to -process are: ALL, BEACON, CQ, QST, GPSxxx and of course APxxxx. - -The following is a list of ALTNETS that may be of interest to other -users. This list is by no means complete, since ANY combination of -characters other than APxxxx are considered an ALTNET. But this list -can give consisntecy to ALTNETS that may be using the global APRS-IS -and need some special recognition: - - TEST - A generic ALTNET for use during testing - PSKAPR - PSKmail . But it is not AX.25 anyway - -de WB4APR, Bob diff --git a/tq.c b/tq.c deleted file mode 100644 index 9f4a58d9..00000000 --- a/tq.c +++ /dev/null @@ -1,599 +0,0 @@ -// -// This file is part of Dire Wolf, an amateur radio packet TNC. -// -// Copyright (C) 2011,2012 John Langner, WB2OSZ -// -// This program 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 2 of the License, or -// (at your option) any later version. -// -// This program 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 this program. If not, see . -// - - -/*------------------------------------------------------------------ - * - * Module: tq.c - * - * Purpose: Transmit queue - hold packets for transmission until the channel is clear. - * - * Description: Producers of packets to be transmitted call tq_append and then - * go merrily on their way, unconcerned about when the packet might - * actually get transmitted. - * - * Another thread waits until the channel is clear and then removes - * packets from the queue and transmits them. - * - *---------------------------------------------------------------*/ - -#include -#include -#include -#include -#include - -#include "direwolf.h" -#include "ax25_pad.h" -#include "textcolor.h" -#include "audio.h" -#include "tq.h" -#include "dedupe.h" - - - -static int tq_num_channels; /* Set once during intialization and */ - /* should not change after that. */ - -static packet_t queue_head[MAX_CHANS][TQ_NUM_PRIO]; /* Head of linked list for each queue. */ - -#if __WIN32__ - -static CRITICAL_SECTION tq_cs; /* Critical section for updating queues. */ - -static HANDLE wake_up_event; /* Notify transmit thread when queue not empty. */ - -#else - -static pthread_mutex_t tq_mutex; /* Critical section for updating queues. */ - -static pthread_cond_t wake_up_cond; /* Notify transmit thread when queue not empty. */ - -static pthread_mutex_t wake_up_mutex; /* Required by cond_wait. */ - -static int xmit_thread_is_waiting = 0; - -#endif - -static int tq_is_empty (void); - - -/*------------------------------------------------------------------- - * - * Name: tq_init - * - * Purpose: Initialize the transmit queue. - * - * Inputs: nchan - Number of communication channels. - * - * Outputs: - * - * Description: Initialize the queue to be empty and set up other - * mechanisms for sharing it between different threads. - * - * We have different timing rules for different types of - * packets so they are put into different queues. - * - * High Priority - - * - * Packets which are being digipeated go out first. - * Latest recommendations are to retransmit these - * immdediately (after no one else is heard, of course) - * rather than waiting random times to avoid collisions. - * The KPC-3 configuration option for this is "UIDWAIT OFF". - * - * Low Priority - - * - * Other packets are sent after a random wait time - * (determined by PERSIST & SLOTTIME) to help avoid - * collisions. - * - * If more than one audio channel is being used, a separate - * pair of transmit queues is used for each channel. - * - *--------------------------------------------------------------------*/ - - -void tq_init (int nchan) -{ - int c, p; - int err; - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("tq_init ( %d )\n", nchan); -#endif - tq_num_channels = nchan; - assert (tq_num_channels >= 1 && tq_num_channels <= MAX_CHANS); - - for (c=0; c= 1 && tq_num_channels <= MAX_CHANS); - assert (prio >= 0 && prio < TQ_NUM_PRIO); - - if (chan < 0 || chan >= tq_num_channels) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("ERROR - Request to transmit on radio channel %d.\n", chan); - ax25_delete(pp); - return; - } - -/* Is transmit queue out of control? */ - - if (tq_count(chan,prio) > 20) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Transmit packet queue is too long. Discarding transmit request.\n"); - dw_printf ("Perhaps the channel is so busy there is no opportunity to send.\n"); - ax25_delete(pp); - return; - } - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("tq_append: enter critical section\n"); -#endif -#if __WIN32__ - EnterCriticalSection (&tq_cs); -#else - err = pthread_mutex_lock (&tq_mutex); - if (err != 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("tq_append: pthread_mutex_lock err=%d", err); - perror (""); - exit (1); - } -#endif - -// was_empty = 1; -// for (c=0; c= 1 && tq_num_channels <= MAX_CHANS); - - -#if __WIN32__ - EnterCriticalSection (&tq_cs); -#else - err = pthread_mutex_lock (&tq_mutex); - if (err != 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("tq_wait_while_empty: pthread_mutex_lock err=%d", err); - perror (""); - exit (1); - } -#endif - -#if DEBUG - //text_color_set(DW_COLOR_DEBUG); - //dw_printf ("tq_wait_while_empty (): after pthread_mutex_lock\n"); -#endif - is_empty = tq_is_empty(); - -#if __WIN32__ - LeaveCriticalSection (&tq_cs); -#else - err = pthread_mutex_unlock (&tq_mutex); - if (err != 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("tq_wait_while_empty: pthread_mutex_unlock err=%d", err); - perror (""); - exit (1); - } -#endif -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("tq_wait_while_empty () : left critical section\n"); -#endif - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("tq_wait_while_empty (): is_empty = %d\n", is_empty); -#endif - - if (is_empty) { -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("tq_wait_while_empty (): SLEEP - about to call cond wait\n"); -#endif - - -#if __WIN32__ - WaitForSingleObject (wake_up_event, INFINITE); - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("tq_wait_while_empty (): returned from wait\n"); -#endif - -#else - err = pthread_mutex_lock (&wake_up_mutex); - if (err != 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("tq_wait_while_empty: pthread_mutex_lock wu err=%d", err); - perror (""); - exit (1); - } - - xmit_thread_is_waiting = 1; - err = pthread_cond_wait (&wake_up_cond, &wake_up_mutex); - xmit_thread_is_waiting = 0; - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("tq_wait_while_empty (): WOKE UP - returned from cond wait, err = %d\n", err); -#endif - - if (err != 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("tq_wait_while_empty: pthread_cond_wait err=%d", err); - perror (""); - exit (1); - } - - err = pthread_mutex_unlock (&wake_up_mutex); - if (err != 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("tq_wait_while_empty: pthread_mutex_unlock wu err=%d", err); - perror (""); - exit (1); - } - -#endif - } - - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("tq_wait_while_empty () returns\n"); -#endif - -} - - -/*------------------------------------------------------------------- - * - * Name: tq_remove - * - * Purpose: Remove a packet from the head of the specified transmit queue. - * - * Inputs: chan - Channel, 0 is first. - * - * prio - Priority, use TQ_PRIO_0_HI or TQ_PRIO_1_LO. - * - * Returns: Pointer to packet object. - * Caller should destroy it with ax25_delete when finished with it. - * - *--------------------------------------------------------------------*/ - -packet_t tq_remove (int chan, int prio) -{ - - packet_t result_p; - int err; - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("tq_remove(%d,%d) enter critical section\n", chan, prio); -#endif - -#if __WIN32__ - EnterCriticalSection (&tq_cs); -#else - err = pthread_mutex_lock (&tq_mutex); - if (err != 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("tq_remove: pthread_mutex_lock err=%d", err); - perror (""); - exit (1); - } -#endif - - if (queue_head[chan][prio] == NULL) { - - result_p = NULL; - } - else { - - result_p = queue_head[chan][prio]; - queue_head[chan][prio] = ax25_get_nextp(result_p); - ax25_set_nextp (result_p, NULL); - } - -#if __WIN32__ - LeaveCriticalSection (&tq_cs); -#else - err = pthread_mutex_unlock (&tq_mutex); - if (err != 0) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("tq_remove: pthread_mutex_unlock err=%d", err); - perror (""); - exit (1); - } -#endif - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("tq_remove(%d,%d) leave critical section, returns %p\n", chan, prio, result_p); -#endif - return (result_p); -} - - -/*------------------------------------------------------------------- - * - * Name: tq_is_empty - * - * Purpose: Test queue is empty. - * - * Inputs: None - this applies to all channels and priorities. - * - * Returns: True if nothing in the queue. - * - *--------------------------------------------------------------------*/ - -static int tq_is_empty (void) -{ - int c, p; - - - for (c=0; c= 0 && c < MAX_CHANS); - assert (p >= 0 && p < TQ_NUM_PRIO); - - if (queue_head[c][p] != NULL) - return (0); - } - } - return (1); - -} /* end tq_is_empty */ - - -/*------------------------------------------------------------------- - * - * Name: tq_count - * - * Purpose: Return count of the number of packets in the specified transmit queue. - * - * Inputs: chan - Channel, 0 is first. - * - * prio - Priority, use TQ_PRIO_0_HI or TQ_PRIO_1_LO. - * - * Returns: Number of items in specified queue. - * - *--------------------------------------------------------------------*/ - -int tq_count (int chan, int prio) -{ - - packet_t p; - int n; - - -/* Don't bother with critical section. */ -/* Only used for debugging a problem. */ - - n = 0; - p = queue_head[chan][prio]; - while (p != NULL) { - n++; - p = ax25_get_nextp(p); - } - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("tq_count(%d,%d) returns %d\n", chan, prio, n); -#endif - - return (n); - -} /* end tq_count */ - -/* end tq.c */ diff --git a/tt_text.c b/tt_text.c deleted file mode 100644 index 3df216cf..00000000 --- a/tt_text.c +++ /dev/null @@ -1,677 +0,0 @@ -// -// This file is part of Dire Wolf, an amateur radio packet TNC. -// -// Copyright (C) 2013 John Langner, WB2OSZ -// -// This program 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 2 of the License, or -// (at your option) any later version. -// -// This program 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 this program. If not, see . -// - -/*------------------------------------------------------------------ - * - * Module: tt-text.c - * - * Purpose: Translate between text and touch tone representation. - * - * Description: Letters can be represented by different touch tone - * keypad sequences. - * - * References: This is based upon APRStt (TM) documents but not 100% - * compliant due to ambiguities and inconsistencies in - * the specifications. - * - * http://www.aprs.org/aprstt.html - * - *---------------------------------------------------------------*/ - -/* - * There are two different encodings called: - * - * * Two-key - * - * Digits are represented by a single key press. - * Letters (or space) are represented by the corresponding - * key followed by A, B, C, or D depending on the position - * of the letter. - * - * * Multi-press - * - * Letters are represented by one or more key presses - * depending on their position. - * e.g. on 5/JKL key, J = 1 press, K = 2, etc. - * The digit is the number of letters plus 1. - * In this case, press 5 key four times to get digit 5. - * When two characters in a row use the same key, - * use the "A" key as a separator. - * - * Examples: - * - * Character Multipress Two Key Comments - * --------- ---------- ------- -------- - * 0 00 0 Space is handled like a letter. - * 1 1 1 No letters on 1 button. - * 2 2222 2 3 letters -> 4 key presses - * 9 99999 9 - * W 9 9A - * X 99 9B - * Y 999 9C - * Z 9999 9D - * space 0 0A 0A was used in an APRStt comment example. - * - * - * Note that letters can occur in callsigns and comments. - * Everywhere else they are simply digits. - */ - -/* - * Everything is based on this table. - * Changing it will change everything. - */ - -static const char translate[10][4] = { - /* A B C D */ - /* --- --- --- --- */ - /* 0 */ { ' ', 0, 0, 0 }, - /* 1 */ { 0, 0, 0, 0 }, - /* 2 */ { 'A', 'B', 'C', 0 }, - /* 3 */ { 'D', 'E', 'F', 0 }, - /* 4 */ { 'G', 'H', 'I', 0 }, - /* 5 */ { 'J', 'K', 'L', 0 }, - /* 6 */ { 'M', 'N', 'O', 0 }, - /* 7 */ { 'P', 'Q', 'R', 'S' }, - /* 8 */ { 'T', 'U', 'V', 0 }, - /* 9 */ { 'W', 'X', 'Y', 'Z' } }; - -#include -#include -#include -#include -#include -#include - -#include "textcolor.h" - - -#if defined(ENC_MAIN) || defined(DEC_MAIN) - -void text_color_set (dw_color_t c) { return; } - -int dw_printf (const char *fmt, ...) -{ - va_list args; - int len; - - va_start (args, fmt); - len = vprintf (fmt, args); - va_end (args); - return (len); -} - -#endif - - -/*------------------------------------------------------------------ - * - * Name: tt_text_to_multipress - * - * Purpose: Convert text to the multi-press representation. - * - * Inputs: text - Input string. - * Should contain only digits, letters, or space. - * All other punctuation is treated as space. - * - * quiet - True to suppress error messages. - * - * Outputs: buttons - Sequence of buttons to press. - * - * Returns: Number of errors detected. - * - *----------------------------------------------------------------*/ - -int tt_text_to_multipress (char *text, int quiet, char *buttons) -{ - char *t = text; - char *b = buttons; - char c; - int row, col; - int errors = 0; - int found; - int n; - - *b = '\0'; - - while ((c = *t++) != '\0') { - - if (isdigit(c)) { - -/* Count number of other characters assigned to this button. */ -/* Press that number plus one more. */ - - n = 1; - row = c - '0'; - for (col=0; col<4; col++) { - if (translate[row][col] != 0) { - n++; - } - } - if (buttons[0] != '\0' && *(b-1) == row + '0') { - *b++ = 'A'; - } - while (n--) { - *b++ = row + '0'; - *b = '\0'; - } - } - else { - if (isupper(c)) { - ; - } - else if (islower(c)) { - c = toupper(c); - } - else if (c != ' ') { - errors++; - if (! quiet) { - text_color_set (DW_COLOR_ERROR); - dw_printf ("Text to multi-press: Only letters, digits, and space allowed.\n"); - } - c = ' '; - } - -/* Search for everything else in the translation table. */ -/* Press number of times depending on column where found. */ - - found = 0; - - for (row=0; row<10 && ! found; row++) { - for (col=0; col<4 && ! found; col++) { - if (c == translate[row][col]) { - -/* Stick in 'A' if previous character used same button. */ - - if (buttons[0] != '\0' && *(b-1) == row + '0') { - *b++ = 'A'; - } - n = col + 1; - while (n--) { - *b++ = row + '0'; - *b = '\0'; - found = 1; - } - } - } - } - if (! found) { - errors++; - text_color_set (DW_COLOR_ERROR); - dw_printf ("Text to multi-press: INTERNAL ERROR. Should not be here.\n"); - } - } - } - return (errors); - -} /* end tt_text_to_multipress */ - - -/*------------------------------------------------------------------ - * - * Name: tt_text_to_two_key - * - * Purpose: Convert text to the two-key representation. - * - * Inputs: text - Input string. - * Should contain only digits, letters, or space. - * All other punctuation is treated as space. - * - * quiet - True to suppress error messages. - * - * Outputs: buttons - Sequence of buttons to press. - * - * Returns: Number of errors detected. - * - *----------------------------------------------------------------*/ - -int tt_text_to_two_key (char *text, int quiet, char *buttons) -{ - char *t = text; - char *b = buttons; - char c; - int row, col; - int errors = 0; - int found; - - - *b = '\0'; - - while ((c = *t++) != '\0') { - - if (isdigit(c)) { - -/* Digit is single key press. */ - - *b++ = c; - *b = '\0'; - } - else { - if (isupper(c)) { - ; - } - else if (islower(c)) { - c = toupper(c); - } - else if (c != ' ') { - errors++; - if (! quiet) { - text_color_set (DW_COLOR_ERROR); - dw_printf ("Text to two key: Only letters, digits, and space allowed.\n"); - } - c = ' '; - } - -/* Search for everything else in the translation table. */ - - found = 0; - - for (row=0; row<10 && ! found; row++) { - for (col=0; col<4 && ! found; col++) { - if (c == translate[row][col]) { - *b++ = '0' + row; - *b++ = 'A' + col; - *b = '\0'; - found = 1; - } - } - } - if (! found) { - errors++; - text_color_set (DW_COLOR_ERROR); - dw_printf ("Text to two-key: INTERNAL ERROR. Should not be here.\n"); - } - } - } - return (errors); - -} /* end tt_text_to_two_key */ - - -/*------------------------------------------------------------------ - * - * Name: tt_multipress_to_text - * - * Purpose: Convert the multi-press representation to text. - * - * Inputs: buttons - Input string. - * Should contain only 0123456789A. - * - * quiet - True to suppress error messages. - * - * Outputs: text - Converted to letters, digits, space. - * - * Returns: Number of errors detected. - * - *----------------------------------------------------------------*/ - -int tt_multipress_to_text (char *buttons, int quiet, char *text) -{ - char *b = buttons; - char *t = text; - char c; - int row, col; - int errors = 0; - int maxspan; - int n; - - *t = '\0'; - - while ((c = *b++) != '\0') { - - if (isdigit(c)) { - -/* Determine max that can occur in a row. */ -/* = number of other characters assigned to this button + 1. */ - - maxspan = 1; - row = c - '0'; - for (col=0; col<4; col++) { - if (translate[row][col] != 0) { - maxspan++; - } - } - -/* Count number of consecutive same digits. */ - - n = 1; - while (c == *b) { - b++; - n++; - } - - if (n < maxspan) { - *t++ = translate[row][n-1]; - *t = '\0'; - } - else if (n == maxspan) { - *t++ = c; - *t = '\0'; - } - else { - errors++; - if (! quiet) { - text_color_set (DW_COLOR_ERROR); - dw_printf ("Multi-press to text: Maximum of %d \"%c\" can occur in a row.\n", maxspan, c); - } - /* Treat like the maximum length. */ - *t++ = c; - *t = '\0'; - } - } - else if (c == 'A' || c == 'a') { - -/* Separator should occur only if digit before and after are the same. */ - - if (b == buttons + 1 || *b == '\0' || *(b-2) != *b) { - errors++; - if (! quiet) { - text_color_set (DW_COLOR_ERROR); - dw_printf ("Multi-press to text: \"A\" can occur only between two same digits.\n"); - } - } - } - else { - -/* Completely unexpected character. */ - - errors++; - if (! quiet) { - text_color_set (DW_COLOR_ERROR); - dw_printf ("Multi-press to text: \"%c\" not allowed.\n", c); - } - } - } - return (errors); - -} /* end tt_multipress_to_text */ - - -/*------------------------------------------------------------------ - * - * Name: tt_two_key_to_text - * - * Purpose: Convert the two key representation to text. - * - * Inputs: buttons - Input string. - * Should contain only 0123456789ABCD. - * - * quiet - True to suppress error messages. - * - * Outputs: text - Converted to letters, digits, space. - * - * Returns: Number of errors detected. - * - *----------------------------------------------------------------*/ - -int tt_two_key_to_text (char *buttons, int quiet, char *text) -{ - char *b = buttons; - char *t = text; - char c; - int row, col; - int errors = 0; - int n; - - *t = '\0'; - - while ((c = *b++) != '\0') { - - if (isdigit(c)) { - -/* Letter (or space) if followed by ABCD. */ - - row = c - '0'; - col = -1; - - if (*b >= 'A' && *b <= 'D') { - col = *b++ - 'A'; - } - else if (*b >= 'a' && *b <= 'd') { - col = *b++ - 'a'; - } - - if (col >= 0) { - if (translate[row][col] != 0) { - *t++ = translate[row][col]; - *t = '\0'; - } - else { - errors++; - if (! quiet) { - text_color_set (DW_COLOR_ERROR); - dw_printf ("Two key to text: Invalid combination \"%c%c\".\n", c, col+'A'); - } - } - } - else { - *t++ = c; - *t = '\0'; - } - } - else if ((c >= 'A' && c <= 'D') || (c >= 'a' && c <= 'd')) { - -/* ABCD not expected here. */ - - errors++; - if (! quiet) { - text_color_set (DW_COLOR_ERROR); - dw_printf ("Two-key to text: A, B, C, or D in unexpected location.\n"); - } - } - else { - -/* Completely unexpected character. */ - - errors++; - if (! quiet) { - text_color_set (DW_COLOR_ERROR); - dw_printf ("Two-key to text: Invalid character \"%c\".\n", c); - } - } - } - return (errors); - -} /* end tt_two_key_to_text */ - - -/*------------------------------------------------------------------ - * - * Name: tt_guess_type - * - * Purpose: Try to guess which encoding we have. - * - * Inputs: buttons - Input string. - * Should contain only 0123456789ABCD. - * - * Returns: TT_MULTIPRESS - Looks like multipress. - * TT_TWO_KEY - Looks like two key. - * TT_EITHER - Could be either one. - * - *----------------------------------------------------------------*/ - -typedef enum { TT_EITHER, TT_MULTIPRESS, TT_TWO_KEY } tt_enc_t; - -tt_enc_t tt_guess_type (char *buttons) -{ - char text[256]; - int err_mp; - int err_tk; - -/* If it contains B, C, or D, it can't be multipress. */ - - if (strchr (buttons, 'B') != NULL || strchr (buttons, 'b') != NULL || - strchr (buttons, 'C') != NULL || strchr (buttons, 'c') != NULL || - strchr (buttons, 'D') != NULL || strchr (buttons, 'd') != NULL) { - return (TT_TWO_KEY); - } - -/* Try parsing quietly and see if one gets errors and the other doesn't. */ - - err_mp = tt_multipress_to_text (buttons, 1, text); - err_tk = tt_two_key_to_text (buttons, 1, text); - - if (err_mp == 0 && err_tk > 0) { - return (TT_MULTIPRESS); - } - else if (err_tk == 0 && err_mp > 0) { - return (TT_TWO_KEY); - } - -/* Could be either one. */ - - return (TT_EITHER); - -} /* end tt_guess_type */ - - - -/*------------------------------------------------------------------ - * - * Name: main - * - * Purpose: Utility program for testing the encoding. - * - *----------------------------------------------------------------*/ - - -#if ENC_MAIN - -int checksum (char *tt) -{ - int cs = 10; /* Assume leading 'A'. */ - /* Doesn't matter due to mod 10 at the end. */ - char *p; - - for (p = tt; *p != '\0'; p++) { - if (isdigit(*p)) { - cs += *p - '0'; - } - else if (isupper(*p)) { - cs += *p - 'A' + 10; - } - else if (islower(*p)) { - cs += *p - 'a' + 10; - } - } - - return (cs % 10); -} - -int main (int argc, char *argv[]) -{ - char text[1000], buttons[2000]; - int n; - int cs; - - text_color_set (DW_COLOR_INFO); - - if (argc < 2) { - text_color_set (DW_COLOR_ERROR); - dw_printf ("Supply text string on command line.\n"); - exit (1); - } - - strcpy (text, argv[1]); - - for (n = 2; n < argc; n++) { - strcat (text, " "); - strcat (text, argv[n]); - } - - dw_printf ("Push buttons for multi-press method:\n"); - n = tt_text_to_multipress (text, 0, buttons); - cs = checksum (buttons); - - dw_printf ("\"%s\" checksum for call = %d\n", buttons, cs); - - dw_printf ("Push buttons for two-key method:\n"); - n = tt_text_to_two_key (text, 0, buttons); - cs = checksum (buttons); - - dw_printf ("\"%s\" checksum for call = %d\n", buttons, cs); - - return(0); - -} /* end main */ - -#endif /* encoding */ - - -/*------------------------------------------------------------------ - * - * Name: main - * - * Purpose: Utility program for testing the decoding. - * - *----------------------------------------------------------------*/ - - -#if DEC_MAIN - - -int main (int argc, char *argv[]) -{ - char buttons[2000], text[1000]; - int n; - - text_color_set (DW_COLOR_INFO); - - if (argc < 2) { - text_color_set (DW_COLOR_ERROR); - dw_printf ("Supply button sequence on command line.\n"); - exit (1); - } - - strcpy (buttons, argv[1]); - - for (n = 2; n < argc; n++) { - strcat (buttons, argv[n]); - } - - switch (tt_guess_type(buttons)) { - case TT_MULTIPRESS: - dw_printf ("Looks like multi-press encoding.\n"); - break; - case TT_TWO_KEY: - dw_printf ("Looks like two-key encoding.\n"); - break; - default: - dw_printf ("Could be either type of encoding.\n"); - break; - } - - dw_printf ("Decoded text from multi-press method:\n"); - n = tt_multipress_to_text (buttons, 0, text); - dw_printf ("\"%s\"\n", text); - - dw_printf ("Decoded text from two-key method:\n"); - n = tt_two_key_to_text (buttons, 0, text); - dw_printf ("\"%s\"\n", text); - - return(0); - -} /* end main */ - -#endif /* decoding */ - - - -/* end tt-text.c */ - diff --git a/tt_text.h b/tt_text.h deleted file mode 100644 index 23892dae..00000000 --- a/tt_text.h +++ /dev/null @@ -1,17 +0,0 @@ - -/* tt_text.h */ - - -int tt_text_to_multipress (char *text, int quiet, char *buttons); - - -int tt_text_to_two_key (char *text, int quiet, char *buttons); - - -int tt_multipress_to_text (char *buttons, int quiet, char *text); - - -int tt_two_key_to_text (char *buttons, int quiet, char *text); - - -/* end tt_text.h */ \ No newline at end of file diff --git a/tt_user.c b/tt_user.c deleted file mode 100644 index fd048cf8..00000000 --- a/tt_user.c +++ /dev/null @@ -1,806 +0,0 @@ -// -// This file is part of Dire Wolf, an amateur radio packet TNC. -// -// Copyright (C) 2013 John Langner, WB2OSZ -// -// This program 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 2 of the License, or -// (at your option) any later version. -// -// This program 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 this program. If not, see . -// - -/*------------------------------------------------------------------ - * - * Module: tt-user.c - * - * Purpose: Keep track of the APRStt users. - * - * Description: This maintains a list of recently heard APRStt users - * and prepares "object" format packets for transmission. - * - * References: This is based upon APRStt (TM) documents but not 100% - * compliant due to ambiguities and inconsistencies in - * the specifications. - * - * http://www.aprs.org/aprstt.html - * - *---------------------------------------------------------------*/ - -#include -#include -#include -#include -#include -#include -#include - -#include "direwolf.h" -#include "ax25_pad.h" -#include "textcolor.h" -#include "aprs_tt.h" -#include "tt_text.h" -#include "dedupe.h" -#include "tq.h" -#include "igate.h" -#include "tt_user.h" -#include "encode_aprs.h" -#include "latlong.h" - -/* - * Information kept about local APRStt users. - * - * For now, just use a fixed size array for simplicity. - */ - -#if TT_MAIN -#define MAX_TT_USERS 3 -#else -#define MAX_TT_USERS 100 -#endif - -#define MAX_CALLSIGN_LEN 9 /* "Object Report" names can be up to 9 characters. */ - -#define MAX_COMMENT_LEN 43 /* Max length of comment in "Object Report." */ - -//#define G_UNKNOWN -999999 /* Should be in one place. */ - -#define NUM_XMITS 3 -#define XMIT_DELAY_1 5 -#define XMIT_DELAY_2 8 -#define XMIT_DELAY_3 13 - - -static struct tt_user_s { - - char callsign[MAX_CALLSIGN_LEN+1]; /* Callsign of station heard. */ - /* Does not include the "-12" SSID added later. */ - /* Possibly other tactical call / object label. */ - /* Null string indicates table position is not used. */ - - int ssid; /* SSID to add. */ - /* Default of 12 but not always. */ - - char overlay; /* Overlay character. Should be 0-9, A-Z. */ - /* Could be / or \ for general object. */ - - char symbol; /* 'A' for traditional. */ - /* Can be any symbol for extended objects. */ - - char digit_suffix[3+1]; /* Suffix abbreviation as 3 digits. */ - - time_t last_heard; /* Timestamp when last heard. */ - /* User information will be deleted at some */ - /* point after last time being heard. */ - - int xmits; /* Number of remaining times to transmit info */ - /* about the user. This is set to 3 when */ - /* a station is heard and decremented each time */ - /* an object packet is sent. The idea is to send */ - /* 3 within 30 seconds to improve chances of */ - /* being heard while using digipeater duplicate */ - /* removal. */ - - time_t next_xmit; /* Time for next transmit. Meaningful only */ - /* if xmits > 0. */ - - int corral_slot; /* If location is known, set this to 0. */ - /* Otherwise, this is a display offset position */ - /* from the gateway. */ - - double latitude, longitude; /* Location either from user or generated */ - /* position in the corral. */ - - char freq[12]; /* Frequency in format 999.999MHz */ - - char comment[MAX_COMMENT_LEN+1]; /* Free form comment. */ - - char mic_e; /* Position status. */ - - char dao[8]; /* Enhanced position information. */ - -} tt_user[MAX_TT_USERS]; - - -static void clear_user(int i); - -static void xmit_object_report (int i, double c_lat, double c_long, int ambiguity, double c_offs); - - -/*------------------------------------------------------------------ - * - * Name: tt_user_init - * - * Purpose: Initialize the APRStt gateway at system startup time. - * - * Inputs: Configuration options gathered by config.c. - * - * Global out: Make our own local copy of the structure here. - * - * Returns: None - * - * Description: The main program needs to call this at application - * start up time after reading the configuration file. - * - * TT_MAIN is defined for unit testing. - * - *----------------------------------------------------------------*/ - -static struct tt_config_s tt_config; - - -void tt_user_init (struct tt_config_s *p) -{ - int i; - -#if TT_MAIN - /* For unit testing. */ - - memset (&tt_config, 0, sizeof(struct tt_config_s)); - - /* Don't care about the location translation here. */ - - tt_config.retain_time = 20; /* Normally 80 minutes. */ - tt_config.num_xmits = 3; - assert (tt_config.num_xmits <= TT_MAX_XMITS); - tt_config.xmit_delay[0] = 3; /* Before initial transmission. */ - tt_config.xmit_delay[1] = 5; - tt_config.xmit_delay[2] = 5; - - tt_config.corral_lat = 42.61900; - tt_config.corral_lon = -71.34717; - tt_config.corral_offset = 0.02 / 60; - tt_config.corral_ambiguity = 0; - -#else - memcpy (&tt_config, p, sizeof(struct tt_config_s)); -#endif - - for (i=0; i= 0 && i < MAX_TT_USERS); - - memset (&tt_user[i], 0, sizeof (struct tt_user_s)); - -} /* end clear_user */ - - -/*------------------------------------------------------------------ - * - * Name: find_avail - * - * Purpose: Find an available user table location. - * - * Inputs: none - * - * Returns: Handle for refering to table position. - * - * Description: If table is already full, this should delete the - * least recently heard user to make room. - * - *----------------------------------------------------------------*/ - -static int find_avail (void) -{ - int i; - int i_oldest; - - for (i=0; i= 1 not already in use. - * - *----------------------------------------------------------------*/ - -static int corral_slot (void) -{ - int slot, i, used; - - for (slot=1; ; slot++) { - used = 0;; - for (i=0; i= 0 && i < MAX_TT_USERS); - strncpy (tt_user[i].callsign, callsign, MAX_CALLSIGN_LEN); - tt_user[i].callsign[MAX_CALLSIGN_LEN] = '\0'; - tt_user[i].ssid = ssid; - tt_user[i].overlay = overlay; - tt_user[i].symbol = symbol; - digit_suffix(tt_user[i].callsign, tt_user[i].digit_suffix); - if (latitude != G_UNKNOWN && longitude != G_UNKNOWN) { - /* We have specific location. */ - tt_user[i].corral_slot = 0; - tt_user[i].latitude = latitude; - tt_user[i].longitude = longitude; - } - else { - /* Unknown location, put it in the corral. */ - tt_user[i].corral_slot = corral_slot(); - } - - strcpy (tt_user[i].freq, freq); - strncpy (tt_user[i].comment, comment, MAX_COMMENT_LEN); - tt_user[i].comment[MAX_COMMENT_LEN] = '\0'; - tt_user[i].mic_e = mic_e; - strncpy(tt_user[i].dao, dao, 6); - } - else { -/* - * Known user. Update with any new information. - */ - assert (i >= 0 && i < MAX_TT_USERS); - - /* Any reason to look at ssid here? */ - - if (latitude != G_UNKNOWN && longitude != G_UNKNOWN) { - /* We have specific location. */ - tt_user[i].corral_slot = 0; - tt_user[i].latitude = latitude; - tt_user[i].longitude = longitude; - } - - if (freq[0] != '\0') { - strcpy (tt_user[i].freq, freq); - } - - if (comment[0] != '\0') { - strncpy (tt_user[i].comment, comment, MAX_COMMENT_LEN); - tt_user[i].comment[MAX_COMMENT_LEN] = '\0'; - } - - if (mic_e != ' ') { - tt_user[i].mic_e = mic_e; - } - if (strlen(dao) > 0) { - strncpy(tt_user[i].dao, dao, 6); - tt_user[i].dao[5] = '\0'; - } - } - -/* - * In both cases, note last time heard and schedule object report transmission. - */ - tt_user[i].last_heard = time(NULL); - tt_user[i].xmits = 0; - tt_user[i].next_xmit = tt_user[i].last_heard + tt_config.xmit_delay[0]; - - return (0); /* Success! */ - -} /* end tt_user_heard */ - - -/*------------------------------------------------------------------ - * - * Name: tt_user_background - * - * Purpose: - * - * Inputs: - * - * Outputs: Append to transmit queue. - * - * Returns: None - * - * Description: ...... TBD - * - *----------------------------------------------------------------*/ - -void tt_user_background (void) -{ - time_t now = time(NULL); - int i; - - for (i=0; i= 0 && i < MAX_TT_USERS); - -/* - * Prepare the object name. - * Tack on "-12" if it is a callsign. - */ - strcpy (object_name, tt_user[i].callsign); - - if (strlen(object_name) <= 6 && tt_user[i].ssid != 0) { - char stemp8[8]; - sprintf (stemp8, "-%d", tt_user[i].ssid); - strcat (object_name, stemp8); - } - - if (tt_user[i].corral_slot == 0) { -/* - * Known location. - */ - olat = tt_user[i].latitude; - olong = tt_user[i].longitude; - } - else { -/* - * Use made up position in the corral. - */ - olat = c_lat - (tt_user[i].corral_slot - 1) * c_offs; - olong = c_long; - } - -/* - * Build comment field from various information. - */ - strcpy (info_comment, ""); - - if (strlen(tt_user[i].comment) != 0) { - strcat (info_comment, tt_user[i].comment); - } - if (tt_user[i].mic_e >= '1' && tt_user[i].mic_e <= '9') { - strcat (info_comment, mic_e_position_comment[tt_user[i].mic_e - '0']); - } - if (strlen(tt_user[i].dao) > 0) { - strcat (info_comment, tt_user[i].dao); - } - - /* Official limit is 43 characters. */ - info_comment[MAX_COMMENT_LEN] = '\0'; - -/* - * Combine with header from configuration file. - * - * (If APRStt gateway has been configured.) - */ - if (tt_config.obj_xmit_header[0] != '\0') { - -// TODO: Should take the call from radio channel configuration. -// Application version is compiled in. -// Config should have only optional via path. - - strcpy (stemp, tt_config.obj_xmit_header); - strcat (stemp, ":"); - - encode_object (object_name, 0, tt_user[i].last_heard, olat, olong, - tt_user[i].overlay, tt_user[i].symbol, - 0,0,0,NULL, 0,0, /* PHGD, C/S */ - atof(tt_user[i].freq), 0, 0, info_comment, object_info); - - strcat (stemp, object_info); - - //text_color_set(DW_COLOR_ERROR); - //printf ("\nDEBUG: %s\n\n", stemp); - - -#if TT_MAIN - - printf ("---> %s\n\n", stemp); - -#else - -/* - * Convert to packet and append to transmit queue. - */ - pp = ax25_from_text (stemp, 1); - - flen = ax25_pack (pp, fbuf); - -/* - * Process as if we heard ourself. - */ - // TODO: We need radio channel where this came from. - // It would make a difference if running two radios - // and they have different station identifiers. - - int chan = 0; - igate_send_rec_packet (chan, pp); - - /* Remember it so we don't digipeat our own. */ - - dedupe_remember (pp, tt_config.obj_xmit_chan); - - tq_append (tt_config.obj_xmit_chan, TQ_PRIO_1_LO, pp); -#endif - } -} - - - -/*------------------------------------------------------------------ - * - * Name: tt_user_dump - * - * Purpose: Print information about known users for debugging. - * - * Inputs: None. - * - * Description: Timestamps displayed relative to current time. - * - *----------------------------------------------------------------*/ - -void tt_user_dump (void) -{ - int i; - time_t now = time(NULL); - - printf ("call ov suf lsthrd xmit nxt cor lat long freq m comment\n"); - for (i=0; i. -// - - -/*------------------------------------------------------------------- - * - * Name: udp_test.c - * - * Purpose: Unit test for the udp reception with AFSK demodulator. - * - * Inputs: Get data by listening on a given UDP port (first parameter is the udp port) - * - * Description: This can be used to test the AFSK demodulator with udp data - * - *--------------------------------------------------------------------*/ - -// #define X 1 - - -#include -#include -//#include -#include -#include -#include -#include - -#define UDPTEST_C 1 - -#include "audio.h" -#include "demod.h" -// #include "fsk_demod_agc.h" -#include "textcolor.h" -#include "ax25_pad.h" -#include "hdlc_rec2.h" -#include -#include -#include -#include -static FILE *fp; -static int e_o_f; -static int packets_decoded = 0; -//Bytes read in the current UDP socket buffer -static int bytes_read = 0; -//Total bytes read from UDP -static int total_bytes_read = 0; -//UDP socket used for receiving data -static int sock; - -//UDP receiving port -#define DEFAULT_UDP_PORT 6667 -//Maximum size of the UDP buffer (for allowing IP routing, udp packets are often limited to 1472 bytes) -#define UDP_BUF_MAXLEN 20000 -//UDP receiving buffer , may use double or FIFO buffers in the future for better performance -unsigned char udp_buf[UDP_BUF_MAXLEN]; - -//TODO Provide cmdline parameters or config to change these values -#define DEFAULT_UDP_NUM_CHANNELS 1 -#define DEFAULT_UDP_SAMPLES_PER_SEC 48000 -#define DEFAULT_UDP_BITS_PER_SAMPLE 16 - - -int main (int argc, char *argv[]) -{ - - struct audio_s modem; - int channel; - time_t start_time; - int udp_port; - - text_color_init(1); - text_color_set(DW_COLOR_INFO); - if (argc < 2) { - udp_port = DEFAULT_UDP_PORT; - printf ("Using default UDP port : %d\n", udp_port); - } else { - udp_port = atoi(argv[1]); - } - - struct sockaddr_in si_me; - int i, slen=sizeof(si_me); - int data_size = 0; - - if ((sock=socket(AF_INET, SOCK_DGRAM, IPPROTO_UDP))==-1) { - fprintf (stderr, "Couldn't create socket %d\n", errno); - exit(errno); - } - - memset((char *) &si_me, 0, sizeof(si_me)); - si_me.sin_family = AF_INET; - si_me.sin_port = htons(6667); - si_me.sin_addr.s_addr = htonl(INADDR_ANY); - if (bind(sock, &si_me, sizeof(si_me))==-1) { - fprintf (stderr, "Couldn't bind socket %d\n", errno); - exit(errno); - } - -#ifdef DEBUG_RECEIVED_DATA - fp = fopen("udp.raw", "w"); - if (fp == NULL) { - fprintf (stderr, "Couldn't open file for read: %s\n", argv[1]); - //perror ("more info?"); - exit (1); - } -#endif - - start_time = time(NULL); - -/* - * First apply defaults. - * TODO: split config into two parts: _init (use here) and _read (only in direwolf). - */ - modem.num_channels = DEFAULT_UDP_NUM_CHANNELS; - modem.samples_per_sec = DEFAULT_UDP_SAMPLES_PER_SEC; - modem.bits_per_sample = DEFAULT_UDP_BITS_PER_SAMPLE; - - /* TODO: should have a command line option for this. */ - //modem.fix_bits = RETRY_NONE; - //modem.fix_bits = RETRY_SINGLE; - //modem.fix_bits = RETRY_DOUBLE; - //modem.fix_bits = RETRY_TRIPLE; - modem.fix_bits = RETRY_TWO_SEP; - //Only one channel for UDP - channel = 0; - - modem.modem_type[channel] = AFSK; - modem.mark_freq[channel] = DEFAULT_MARK_FREQ; - modem.space_freq[channel] = DEFAULT_SPACE_FREQ; - modem.baud[channel] = DEFAULT_BAUD; - - strcpy (modem.profiles[channel], "C"); - // temp - // strcpy (modem.profiles[channel], "F"); - modem.num_subchan[channel] = strlen(modem.profiles); - - //TODO: add -h command line option. -//#define HF 1 - -#if HF - modem.mark_freq[channel] = 1600; - modem.space_freq[channel] = 1800; - modem.baud[channel] = 300; - strcpy (modem.profiles[channel], "B"); - modem.num_subchan[channel] = strlen(modem.profiles); -#endif - - - modem.num_freq[channel] = 1; - modem.offset[channel] = 0; - - - text_color_set(DW_COLOR_INFO); - printf ("%d samples per second\n", modem.samples_per_sec); - printf ("%d bits per sample\n", modem.bits_per_sample); - printf ("%d audio channels\n", modem.num_channels); -/* - * Initialize the AFSK demodulator and HDLC decoder. - */ - multi_modem_init (&modem); - - - e_o_f = 0; - bytes_read = 0; - data_size = 0; - - while ( ! e_o_f ) - { - - int audio_sample; - int c; - - //If all the data in the udp buffer has been processed, get new data from udp socket - if (bytes_read == data_size) { - data_size = buffer_get(UDP_BUF_MAXLEN); - //Got EOF packet - if (data_size >= 0 && data_size <= 1) { - printf("Got NULL packet : terminate decoding (packet received with size %d)", data_size); - e_o_f = 1; - break; - } - - bytes_read = 0; - } - - - /* This reads either 1 or 2 bytes depending on */ - /* bits per sample. */ - - audio_sample = demod_get_sample (); - - if (audio_sample >= 256 * 256) - e_o_f = 1; - multi_modem_process_sample(c,audio_sample); - - /* When a complete frame is accumulated, */ - /* process_rec_frame, below, is called. */ - - } - - text_color_set(DW_COLOR_INFO); - printf ("\n\n"); - printf ("%d packets decoded in %d seconds.\n", packets_decoded, (int)(time(NULL) - start_time)); -#ifdef DEBUG_RECEIVED_DATA - fclose(fp); -#endif - exit (0); -} - -int buffer_get (unsigned int size) { - struct sockaddr_in si_other; - int slen=sizeof(si_other); - int ch, res,i; - if (size > UDP_BUF_MAXLEN) { - printf("size too big %d", size); - return -1; - } - - res = recvfrom(sock, udp_buf, size, 0, &si_other, &slen); -#ifdef DEBUG_RECEIVED_DATA - fwrite(udp_buf,res,1,fp); -#endif - - return res; -} -/* - * Simulate sample from the audio device. - */ -int audio_get (void) -{ - int ch; - ch = udp_buf[bytes_read]; - bytes_read++; - total_bytes_read++; - - return (ch); -} - - - -/* - * Rather than queuing up frames with bad FCS, - * try to fix them immediately. - */ - -void rdq_append (rrbb_t rrbb) -{ - int chan; - int alevel; - int subchan; - - - chan = rrbb_get_chan(rrbb); - subchan = rrbb_get_subchan(rrbb); - alevel = rrbb_get_audio_level(rrbb); - - hdlc_rec2_try_to_fix_later (rrbb, chan, subchan, alevel); -} - - -/* - * This is called when we have a good frame. - */ - -void app_process_rec_packet (int chan, int subchan, packet_t pp, int alevel, retry_t retries, char *spectrum) -{ - - //int err; - //char *p; - char stemp[500]; - unsigned char *pinfo; - int info_len; - int h; - char heard[20]; - //packet_t pp; - - - packets_decoded++; - - - ax25_format_addrs (pp, stemp); - - info_len = ax25_get_info (pp, &pinfo); - - /* Print so we can see what is going on. */ - -#if 1 - /* Display audio input level. */ - /* Who are we hearing? Original station or digipeater. */ - - h = ax25_get_heard(pp); - ax25_get_addr_with_ssid(pp, h, heard); - - text_color_set(DW_COLOR_DEBUG); - printf ("\n"); - - if (h != AX25_SOURCE) { - printf ("Digipeater "); - } - printf ("%s audio level = %d [%s] %s\n", heard, alevel, retry_text[(int)retries], spectrum); - - -#endif - -// Display non-APRS packets in a different color. - - if (ax25_is_aprs(pp)) { - text_color_set(DW_COLOR_REC); - printf ("[%d] ", chan); - } - else { - text_color_set(DW_COLOR_DEBUG); - printf ("[%d] ", chan); - } - - printf ("%s", stemp); /* stations followed by : */ - ax25_safe_print ((char *)pinfo, info_len, 0); - printf ("\n"); - - ax25_delete (pp); - -} /* end app_process_rec_packet */ - - - - - - -/* Current time in seconds but more resolution than time(). */ - -/* We don't care what date a 0 value represents because we */ -/* only use this to calculate elapsed time. */ - - - -double dtime_now (void) -{ -#if __WIN32__ - /* 64 bit integer is number of 100 nanosecond intervals from Jan 1, 1601. */ - - FILETIME ft; - - GetSystemTimeAsFileTime (&ft); - - return ((( (double)ft.dwHighDateTime * (256. * 256. * 256. * 256.) + - (double)ft.dwLowDateTime ) / 10000000.) - 11644473600.); -#else - /* tv_sec is seconds from Jan 1, 1970. */ - - struct timespec ts; - int sec, ns; - double x1, x2; - double result; - - clock_gettime (CLOCK_REALTIME, &ts); - - //result = (double)(ts.tv_sec) + (double)(ts.tv_nsec) / 1000000000.; - //result = (double)(ts.tv_sec) + ((double)(ts.tv_nsec) * .001 * .001 *.001); - sec = (int)(ts.tv_sec); - ns = (int)(ts.tv_nsec); - x1 = (double)(sec); - //x1 = (double)(sec-1300000000); /* try to work around strange result. */ - //x2 = (double)(ns) * .001 * .001 *.001; - x2 = (double)(ns/1000000) *.001; - result = x1 + x2; - - /* Sometimes this returns NAN. How could that possibly happen? */ - /* This is REALLY BIZARRE! */ - /* Multiplying a number by a billionth often produces NAN. */ - /* Adding a fraction to a number over a billion often produces NAN. */ - - /* Hardware problem??? Need to test on different computer. */ - - if (isnan(result)) { - text_color_set(DW_COLOR_ERROR); - printf ("\ndtime_now(): %d, %d -> %.3f + %.3f -> NAN!!!\n\n", sec, ns, x1, x2); - } - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - printf ("dtime_now() returns %.3f\n", result); -#endif - - return (result); -#endif -} - - - -/* end atest.c */ diff --git a/utm/LatLong-UTMconversion.c b/utm/LatLong-UTMconversion.c deleted file mode 100644 index a0c4cd9a..00000000 --- a/utm/LatLong-UTMconversion.c +++ /dev/null @@ -1,190 +0,0 @@ -//LatLong- UTM conversion.c -//Lat Long - UTM, UTM - Lat Long conversions - -#include -#include -#include -#include "constants.h" -#include "LatLong-UTMconversion.h" - - -/*Reference ellipsoids derived from Peter H. Dana's website- -http://www.utexas.edu/depts/grg/gcraft/notes/datum/elist.html -Department of Geography, University of Texas at Austin -Internet: pdana@mail.utexas.edu -3/22/95 - -Source -Defense Mapping Agency. 1987b. DMA Technical Report: Supplement to Department of Defense World Geodetic System -1984 Technical Report. Part I and II. Washington, DC: Defense Mapping Agency -*/ - - - -void LLtoUTM(int ReferenceEllipsoid, const double Lat, const double Long, - double *UTMNorthing, double *UTMEasting, char* UTMZone) -{ -//converts lat/long to UTM coords. Equations from USGS Bulletin 1532 -//East Longitudes are positive, West longitudes are negative. -//North latitudes are positive, South latitudes are negative -//Lat and Long are in decimal degrees - //Written by Chuck Gantz- chuck.gantz@globalstar.com - - double a = ellipsoid[ReferenceEllipsoid].EquatorialRadius; - double eccSquared = ellipsoid[ReferenceEllipsoid].eccentricitySquared; - double k0 = 0.9996; - - double LongOrigin; - double eccPrimeSquared; - double N, T, C, A, M; - -//Make sure the longitude is between -180.00 .. 179.9 - double LongTemp = (Long+180)-(int)((Long+180)/360)*360-180; // -180.00 .. 179.9; - - double LatRad = Lat*deg2rad; - double LongRad = LongTemp*deg2rad; - double LongOriginRad; - int ZoneNumber; - - ZoneNumber = (int)((LongTemp + 180)/6) + 1; - - if( Lat >= 56.0 && Lat < 64.0 && LongTemp >= 3.0 && LongTemp < 12.0 ) - ZoneNumber = 32; - - // Special zones for Svalbard - if( Lat >= 72.0 && Lat < 84.0 ) - { - if( LongTemp >= 0.0 && LongTemp < 9.0 ) ZoneNumber = 31; - else if( LongTemp >= 9.0 && LongTemp < 21.0 ) ZoneNumber = 33; - else if( LongTemp >= 21.0 && LongTemp < 33.0 ) ZoneNumber = 35; - else if( LongTemp >= 33.0 && LongTemp < 42.0 ) ZoneNumber = 37; - } - LongOrigin = (ZoneNumber - 1)*6 - 180 + 3; //+3 puts origin in middle of zone - LongOriginRad = LongOrigin * deg2rad; - - //compute the UTM Zone from the latitude and longitude - sprintf(UTMZone, "%d%c", ZoneNumber, UTMLetterDesignator(Lat)); - - eccPrimeSquared = (eccSquared)/(1-eccSquared); - - N = a/sqrt(1-eccSquared*sin(LatRad)*sin(LatRad)); - T = tan(LatRad)*tan(LatRad); - C = eccPrimeSquared*cos(LatRad)*cos(LatRad); - A = cos(LatRad)*(LongRad-LongOriginRad); - - M = a*((1 - eccSquared/4 - 3*eccSquared*eccSquared/64 - 5*eccSquared*eccSquared*eccSquared/256)*LatRad - - (3*eccSquared/8 + 3*eccSquared*eccSquared/32 + 45*eccSquared*eccSquared*eccSquared/1024)*sin(2*LatRad) - + (15*eccSquared*eccSquared/256 + 45*eccSquared*eccSquared*eccSquared/1024)*sin(4*LatRad) - - (35*eccSquared*eccSquared*eccSquared/3072)*sin(6*LatRad)); - - *UTMEasting = (double)(k0*N*(A+(1-T+C)*A*A*A/6 - + (5-18*T+T*T+72*C-58*eccPrimeSquared)*A*A*A*A*A/120) - + 500000.0); - - *UTMNorthing = (double)(k0*(M+N*tan(LatRad)*(A*A/2+(5-T+9*C+4*C*C)*A*A*A*A/24 - + (61-58*T+T*T+600*C-330*eccPrimeSquared)*A*A*A*A*A*A/720))); - if(Lat < 0) - *UTMNorthing += 10000000.0; //10000000 meter offset for southern hemisphere -} - -char UTMLetterDesignator(double Lat) -{ -//This routine determines the correct UTM letter designator for the given latitude -//returns 'Z' if latitude is outside the UTM limits of 84N to 80S - //Written by Chuck Gantz- chuck.gantz@globalstar.com - char LetterDesignator; - - if((84 >= Lat) && (Lat >= 72)) LetterDesignator = 'X'; - else if((72 > Lat) && (Lat >= 64)) LetterDesignator = 'W'; - else if((64 > Lat) && (Lat >= 56)) LetterDesignator = 'V'; - else if((56 > Lat) && (Lat >= 48)) LetterDesignator = 'U'; - else if((48 > Lat) && (Lat >= 40)) LetterDesignator = 'T'; - else if((40 > Lat) && (Lat >= 32)) LetterDesignator = 'S'; - else if((32 > Lat) && (Lat >= 24)) LetterDesignator = 'R'; - else if((24 > Lat) && (Lat >= 16)) LetterDesignator = 'Q'; - else if((16 > Lat) && (Lat >= 8)) LetterDesignator = 'P'; - else if(( 8 > Lat) && (Lat >= 0)) LetterDesignator = 'N'; - else if(( 0 > Lat) && (Lat >= -8)) LetterDesignator = 'M'; - else if((-8> Lat) && (Lat >= -16)) LetterDesignator = 'L'; - else if((-16 > Lat) && (Lat >= -24)) LetterDesignator = 'K'; - else if((-24 > Lat) && (Lat >= -32)) LetterDesignator = 'J'; - else if((-32 > Lat) && (Lat >= -40)) LetterDesignator = 'H'; - else if((-40 > Lat) && (Lat >= -48)) LetterDesignator = 'G'; - else if((-48 > Lat) && (Lat >= -56)) LetterDesignator = 'F'; - else if((-56 > Lat) && (Lat >= -64)) LetterDesignator = 'E'; - else if((-64 > Lat) && (Lat >= -72)) LetterDesignator = 'D'; - else if((-72 > Lat) && (Lat >= -80)) LetterDesignator = 'C'; - else LetterDesignator = 'Z'; //This is here as an error flag to show that the Latitude is outside the UTM limits - - return LetterDesignator; -} - - -void UTMtoLL(int ReferenceEllipsoid, const double UTMNorthing, const double UTMEasting, const char* UTMZone, - double *Lat, double *Long ) -{ -//converts UTM coords to lat/long. Equations from USGS Bulletin 1532 -//East Longitudes are positive, West longitudes are negative. -//North latitudes are positive, South latitudes are negative -//Lat and Long are in decimal degrees. - //Written by Chuck Gantz- chuck.gantz@globalstar.com - - double k0 = 0.9996; - double a = ellipsoid[ReferenceEllipsoid].EquatorialRadius; - double eccSquared = ellipsoid[ReferenceEllipsoid].eccentricitySquared; - double eccPrimeSquared; - double e1 = (1-sqrt(1-eccSquared))/(1+sqrt(1-eccSquared)); - double N1, T1, C1, R1, D, M; - double LongOrigin; - double mu, phi1, phi1Rad; - double x, y; - int ZoneNumber; - char* ZoneLetter; - int NorthernHemisphere; //1 for northern hemispher, 0 for southern - - x = UTMEasting - 500000.0; //remove 500,000 meter offset for longitude - y = UTMNorthing; - - ZoneNumber = strtoul(UTMZone, &ZoneLetter, 10); - if (*ZoneLetter == '\0') - { - NorthernHemisphere = 1; //no letter - assume northern hemisphere - } - else if((*ZoneLetter >= 'N' && *ZoneLetter <= 'X') || - (*ZoneLetter >= 'n' && *ZoneLetter <= 'x')) - { - NorthernHemisphere = 1; //point is in northern hemisphere - } - else - { - NorthernHemisphere = 0; //point is in southern hemisphere - y -= 10000000.0; //remove 10,000,000 meter offset used for southern hemisphere - } - - LongOrigin = (ZoneNumber - 1)*6 - 180 + 3; //+3 puts origin in middle of zone - - eccPrimeSquared = (eccSquared)/(1-eccSquared); - - M = y / k0; - mu = M/(a*(1-eccSquared/4-3*eccSquared*eccSquared/64-5*eccSquared*eccSquared*eccSquared/256)); - - phi1Rad = mu + (3*e1/2-27*e1*e1*e1/32)*sin(2*mu) - + (21*e1*e1/16-55*e1*e1*e1*e1/32)*sin(4*mu) - +(151*e1*e1*e1/96)*sin(6*mu); - phi1 = phi1Rad*rad2deg; - - N1 = a/sqrt(1-eccSquared*sin(phi1Rad)*sin(phi1Rad)); - T1 = tan(phi1Rad)*tan(phi1Rad); - C1 = eccPrimeSquared*cos(phi1Rad)*cos(phi1Rad); - R1 = a*(1-eccSquared)/pow(1-eccSquared*sin(phi1Rad)*sin(phi1Rad), 1.5); - D = x/(N1*k0); - - *Lat = phi1Rad - (N1*tan(phi1Rad)/R1)*(D*D/2-(5+3*T1+10*C1-4*C1*C1-9*eccPrimeSquared)*D*D*D*D/24 - +(61+90*T1+298*C1+45*T1*T1-252*eccPrimeSquared-3*C1*C1)*D*D*D*D*D*D/720); - *Lat = *Lat * rad2deg; - - *Long = (D-(1+2*T1+C1)*D*D*D/6+(5-2*C1+28*T1-3*C1*C1+8*eccPrimeSquared+24*T1*T1) - *D*D*D*D*D/120)/cos(phi1Rad); - *Long = LongOrigin + *Long * rad2deg; - -} diff --git a/utm/LatLong-UTMconversion.h b/utm/LatLong-UTMconversion.h deleted file mode 100644 index e05bfa08..00000000 --- a/utm/LatLong-UTMconversion.h +++ /dev/null @@ -1,30 +0,0 @@ -//LatLong- UTM conversion..h -//definitions for lat/long to UTM and UTM to lat/lng conversions -#include - -#ifndef LATLONGCONV -#define LATLONGCONV - -void LLtoUTM(int ReferenceEllipsoid, const double Lat, const double Long, - double *UTMNorthing, double *UTMEasting, char* UTMZone); -void UTMtoLL(int ReferenceEllipsoid, const double UTMNorthing, const double UTMEasting, const char* UTMZone, - double *Lat, double *Long ); -char UTMLetterDesignator(double Lat); -void LLtoSwissGrid(const double Lat, const double Long, - double *SwissNorthing, double *SwissEasting); -void SwissGridtoLL(const double SwissNorthing, const double SwissEasting, - double *Lat, double *Long); - -struct Ellipsoid_s { - int id; - char* ellipsoidName; - double EquatorialRadius; - double eccentricitySquared; -}; - -typedef struct Ellipsoid_s Ellipsoid; - -#define WSG84 23 - - -#endif diff --git a/utm/README.txt b/utm/README.txt deleted file mode 100644 index 5be72f8e..00000000 --- a/utm/README.txt +++ /dev/null @@ -1,14 +0,0 @@ - -The other files in this directory were copied from - -http://www.gpsy.com/gpsinfo/geotoutm/ - -See attachments to message from Chuck Gantz. -There is no obvious copyright on the source code. -The links in the message are no longer valid. - - -A few minor modifications were made: - -1. Convert from C++ to C. -2. Make the zone check more robust. \ No newline at end of file diff --git a/utm/SwissGrid.cpp b/utm/SwissGrid.cpp deleted file mode 100644 index b3dd3c52..00000000 --- a/utm/SwissGrid.cpp +++ /dev/null @@ -1,140 +0,0 @@ - -#include -#include "constants.h" -#include "LatLong- UTM conversion.h" - -//forward declarations -double CorrRatio(double LatRad, const double C); -double NewtonRaphson(const double initEstimate); - - -void LLtoSwissGrid(const double Lat, const double Long, - double &SwissNorthing, double &SwissEasting) -{ -//converts lat/long to Swiss Grid coords. Equations from "Supplementary PROJ.4 Notes- -//Swiss Oblique Mercator Projection", August 5, 1995, Release 4.3.3, by Gerald I. Evenden -//Lat and Long are in decimal degrees -//This transformation is, of course, only valid in Switzerland - //Written by Chuck Gantz- chuck.gantz@globalstar.com - double a = ellipsoid[3].EquatorialRadius; //Bessel ellipsoid - double eccSquared = ellipsoid[3].eccentricitySquared; - double ecc = sqrt(eccSquared); - - double LongOrigin = 7.43958333; //E7d26'22.500" - double LatOrigin = 46.95240556; //N46d57'8.660" - - double LatRad = Lat*deg2rad; - double LongRad = Long*deg2rad; - double LatOriginRad = LatOrigin*deg2rad; - double LongOriginRad = LongOrigin*deg2rad; - - double c = sqrt(1+((eccSquared * pow(cos(LatOriginRad), 4)) / (1-eccSquared))); - - double equivLatOrgRadPrime = asin(sin(LatOriginRad) / c); - - //eqn. 1 - double K = log(tan(FOURTHPI + equivLatOrgRadPrime/2)) - -c*(log(tan(FOURTHPI + LatOriginRad/2)) - - ecc/2 * log((1+ecc*sin(LatOriginRad)) / (1-ecc*sin(LatOriginRad)))); - - - double LongRadPrime = c*(LongRad - LongOriginRad); //eqn 2 - double w = c*(log(tan(FOURTHPI + LatRad/2)) - - ecc/2 * log((1+ecc*sin(LatRad)) / (1-ecc*sin(LatRad)))) + K; //eqn 1 - double LatRadPrime = 2 * (atan(exp(w)) - FOURTHPI); //eqn 1 - - //eqn 3 - double sinLatDoublePrime = cos(equivLatOrgRadPrime) * sin(LatRadPrime) - - sin(equivLatOrgRadPrime) * cos(LatRadPrime) * cos(LongRadPrime); - double LatRadDoublePrime = asin(sinLatDoublePrime); - - //eqn 4 - double sinLongDoublePrime = cos(LatRadPrime)*sin(LongRadPrime) / cos(LatRadDoublePrime); - double LongRadDoublePrime = asin(sinLongDoublePrime); - - double R = a*sqrt(1-eccSquared) / (1-eccSquared*sin(LatOriginRad) * sin(LatOriginRad)); - - SwissNorthing = R*log(tan(FOURTHPI + LatRadDoublePrime/2)) + 200000.0; //eqn 5 - SwissEasting = R*LongRadDoublePrime + 600000.0; //eqn 6 - -} - - -void SwissGridtoLL(const double SwissNorthing, const double SwissEasting, - double& Lat, double& Long) -{ - double a = ellipsoid[3].EquatorialRadius; //Bessel ellipsoid - double eccSquared = ellipsoid[3].eccentricitySquared; - double ecc = sqrt(eccSquared); - - double LongOrigin = 7.43958333; //E7d26'22.500" - double LatOrigin = 46.95240556; //N46d57'8.660" - - double LatOriginRad = LatOrigin*deg2rad; - double LongOriginRad = LongOrigin*deg2rad; - - double R = a*sqrt(1-eccSquared) / (1-eccSquared*sin(LatOriginRad) * sin(LatOriginRad)); - - double LatRadDoublePrime = 2*(atan(exp((SwissNorthing - 200000.0)/R)) - FOURTHPI); //eqn. 7 - double LongRadDoublePrime = (SwissEasting - 600000.0)/R; //eqn. 8 with equation corrected - - - double c = sqrt(1+((eccSquared * pow(cos(LatOriginRad), 4)) / (1-eccSquared))); - double equivLatOrgRadPrime = asin(sin(LatOriginRad) / c); - - double sinLatRadPrime = cos(equivLatOrgRadPrime)*sin(LatRadDoublePrime) - + sin(equivLatOrgRadPrime)*cos(LatRadDoublePrime)*cos(LongRadDoublePrime); - double LatRadPrime = asin(sinLatRadPrime); - - double sinLongRadPrime = cos(LatRadDoublePrime)*sin(LongRadDoublePrime)/cos(LatRadPrime); - double LongRadPrime = asin(sinLongRadPrime); - - Long = (LongRadPrime/c + LongOriginRad) * rad2deg; - - Lat = NewtonRaphson(LatRadPrime) * rad2deg; - -} - -double NewtonRaphson(const double initEstimate) -{ - double Estimate = initEstimate; - double tol = 0.00001; - double corr; - - double eccSquared = ellipsoid[3].eccentricitySquared; - double ecc = sqrt(eccSquared); - - double LatOrigin = 46.95240556; //N46d57'8.660" - double LatOriginRad = LatOrigin*deg2rad; - - double c = sqrt(1+((eccSquared * pow(cos(LatOriginRad), 4)) / (1-eccSquared))); - - double equivLatOrgRadPrime = asin(sin(LatOriginRad) / c); - - //eqn. 1 - double K = log(tan(FOURTHPI + equivLatOrgRadPrime/2)) - -c*(log(tan(FOURTHPI + LatOriginRad/2)) - - ecc/2 * log((1+ecc*sin(LatOriginRad)) / (1-ecc*sin(LatOriginRad)))); - double C = (K - log(tan(FOURTHPI + initEstimate/2)))/c; - - do - { - corr = CorrRatio(Estimate, C); - Estimate = Estimate - corr; - } - while (fabs(corr) > tol); - - return Estimate; -} - - - -double CorrRatio(double LatRad, const double C) -{ - double eccSquared = ellipsoid[3].eccentricitySquared; - double ecc = sqrt(eccSquared); - double corr = (C + log(tan(FOURTHPI + LatRad/2)) - - ecc/2 * log((1+ecc*sin(LatRad)) / (1-ecc*sin(LatRad)))) * (((1-eccSquared*sin(LatRad)*sin(LatRad)) * cos(LatRad)) / (1-eccSquared)); - - return corr; -} diff --git a/utm/UTMConversions.cpp b/utm/UTMConversions.cpp deleted file mode 100644 index 34e5ae92..00000000 --- a/utm/UTMConversions.cpp +++ /dev/null @@ -1,39 +0,0 @@ -//UTM Conversion.cpp- test program for lat/long to UTM and UTM to lat/long conversions -#include -#include -#include "LatLong-UTMconversion.h" - - -void main() -{ - double Lat = 47.37816667; - double Long = 8.23250000; - double UTMNorthing; - double UTMEasting; - double SwissNorthing; - double SwissEasting; - char UTMZone[4]; - int RefEllipsoid = 23;//WGS-84. See list with file "LatLong- UTM conversion.cpp" for id numbers - - cout << "Starting position(Lat, Long): " << Lat << " " << Long < -#include - -#include "LatLong-UTMconversion.h" - - -static void usage(); - - -void main (int argc, char *argv[]) -{ - double easting; - double northing; - double lat, lon; - char zone[100]; - int znum; - char *zlet; - - if (argc != 4) usage(); - - strcpy (zone, argv[1]); - znum = strtoul(zone, &zlet, 10); - - if (znum < 1 || znum > 60) { - fprintf (stderr, "Zone number is out of range.\n\n"); - usage(); - } - - //printf ("zlet = %c 0x%02x\n", *zlet, *zlet); - if (*zlet != '\0' && strchr ("CDEFGHJKLMNPQRSTUVWX", *zlet) == NULL) { - fprintf (stderr, "Latitudinal band must be one of CDEFGHJKLMNPQRSTUVWX.\n\n"); - usage(); - } - - easting = atof(argv[2]); - if (easting < 0 || easting > 999999) { - fprintf (stderr, "Easting value is out of range.\n\n"); - usage(); - } - - northing = atof(argv[3]); - if (northing < 0 || northing > 9999999) { - fprintf (stderr, "Northing value is out of range.\n\n"); - usage(); - } - - UTMtoLL (WSG84, northing, easting, zone, &lat, &lon); - - printf ("latitude = %f, longitude = %f\n", lat, lon); -} - - -static void usage (void) -{ - fprintf (stderr, "UTM to Latitude / Longitude conversion\n"); - fprintf (stderr, "\n"); - fprintf (stderr, "Usage:\n"); - fprintf (stderr, "\tutm2ll zone easting northing\n"); - fprintf (stderr, "\n"); - fprintf (stderr, "where,\n"); - fprintf (stderr, "\tzone is UTM zone 1 thru 60 with optional latitudinal band.\n"); - fprintf (stderr, "\teasting is x coordinate in meters\n"); - fprintf (stderr, "\tnorthing is y coordinate in meters\n"); - fprintf (stderr, "\n"); - fprintf (stderr, "Example:\n"); - fprintf (stderr, "\tutm2ll 19T 306130 4726010\n"); - - exit (1); -} \ No newline at end of file diff --git a/version.h b/version.h deleted file mode 100644 index fd7e8c87..00000000 --- a/version.h +++ /dev/null @@ -1,7 +0,0 @@ - -/* Dire Wolf version 1.1 */ - -#define APP_TOCALL "APDW" - -#define MAJOR_VERSION 1 -#define MINOR_VERSION 1 diff --git a/xmit.c b/xmit.c deleted file mode 100644 index 6822b62d..00000000 --- a/xmit.c +++ /dev/null @@ -1,759 +0,0 @@ -// -// This file is part of Dire Wolf, an amateur radio packet TNC. -// -// Copyright (C) 2011,2013,2014 John Langner, WB2OSZ -// -// This program 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 2 of the License, or -// (at your option) any later version. -// -// This program 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 this program. If not, see . -// - - -/*------------------------------------------------------------------ - * - * Module: xmit.c - * - * Purpose: Transmit queued up packets when channel is clear. - * - * Description: Producers of packets to be transmitted call tq_append and then - * go merrily on their way, unconcerned about when the packet might - * actually get transmitted. - * - * This thread waits until the channel is clear and then removes - * packets from the queue and transmits them. - * - * - * Usage: (1) The main application calls xmit_init. - * - * This will initialize the transmit packet queue - * and create a thread to empty the queue when - * the channel is clear. - * - * (2) The application queues up packets by calling tq_append. - * - * Packets that are being digipeated should go in the - * high priority queue so they will go out first. - * - * Other packets should go into the lower priority queue. - * - * (3) xmit_thread removes packets from the queue and transmits - * them when other signals are not being heard. - * - *---------------------------------------------------------------*/ - -#include -#include -#include -#include -#include -#include - -//#include -#include - -#if __WIN32__ -#include -#endif - -#include "direwolf.h" -#include "ax25_pad.h" -#include "textcolor.h" -#include "audio.h" -#include "tq.h" -#include "xmit.h" -#include "hdlc_send.h" -#include "hdlc_rec.h" -#include "ptt.h" - - -static int xmit_num_channels; /* Number of radio channels. */ - - -/* - * Parameters for transmission. - * Each channel can have different timing values. - * - * These are initialized once at application startup time - * and some can be changed later by commands from connected applications. - */ - - - - - -static int xmit_slottime[MAX_CHANS]; /* Slot time in 10 mS units for persistance algorithm. */ - -static int xmit_persist[MAX_CHANS]; /* Sets probability for transmitting after each */ - /* slot time delay. Transmit if a random number */ - /* in range of 0 - 255 <= persist value. */ - /* Otherwise wait another slot time and try again. */ - -static int xmit_txdelay[MAX_CHANS]; /* After turning on the transmitter, */ - /* send "flags" for txdelay * 10 mS. */ - -static int xmit_txtail[MAX_CHANS]; /* Amount of time to keep transmitting after we */ - /* are done sending the data. This is to avoid */ - /* dropping PTT too soon and chopping off the end */ - /* of the frame. Again 10 mS units. */ - -static int xmit_bits_per_sec[MAX_CHANS]; /* Data transmission rate. */ - /* Often called baud rate which is equivalent in */ - /* this case but could be different with other */ - /* modulation techniques. */ - -static int g_debug_xmit_packet; /* print packet in hexadecimal form for debugging. */ - - - -#define BITS_TO_MS(b,ch) (((b)*1000)/xmit_bits_per_sec[(ch)]) - -#define MS_TO_BITS(ms,ch) (((ms)*xmit_bits_per_sec[(ch)])/1000) - - -#if __WIN32__ -static unsigned __stdcall xmit_thread (void *arg); -#else -static void * xmit_thread (void *arg); -#endif - -static int wait_for_clear_channel (int channel, int nowait, int slotttime, int persist); - - -/*------------------------------------------------------------------- - * - * Name: xmit_init - * - * Purpose: Initialize the transmit process. - * - * Inputs: modem - Structure with modem and timing parameters. - * - * - * Outputs: Remember required information for future use. - * - * Description: Initialize the queue to be empty and set up other - * mechanisms for sharing it between different threads. - * - * Start up xmit_thread to actually send the packets - * at the appropriate time. - * - *--------------------------------------------------------------------*/ - - - -void xmit_init (struct audio_s *p_modem, int debug_xmit_packet) -{ - int j; -#if __WIN32__ - HANDLE xmit_th; -#else - //pthread_attr_t attr; - //struct sched_param sp; - pthread_t xmit_tid; -#endif - int e; - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("xmit_init ( ... )\n"); -#endif - - g_debug_xmit_packet = debug_xmit_packet; - -/* - * Push to Talk (PTT) control. - */ -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("xmit_init: about to call ptt_init \n"); -#endif - ptt_init (p_modem); - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("xmit_init: back from ptt_init \n"); -#endif - -/* - * Save parameters for later use. - */ - xmit_num_channels = p_modem->num_channels; - assert (xmit_num_channels >= 1 && xmit_num_channels <= MAX_CHANS); - - for (j=0; jbaud[j]; - xmit_slottime[j] = p_modem->slottime[j]; - xmit_persist[j] = p_modem->persist[j]; - xmit_txdelay[j] = p_modem->txdelay[j]; - xmit_txtail[j] = p_modem->txtail[j]; - } - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("xmit_init: about to call tq_init \n"); -#endif - tq_init (xmit_num_channels); - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("xmit_init: about to create thread \n"); -#endif - -//TODO: xmit thread should be higher priority to avoid -// underrun on the audio output device. - -#if __WIN32__ - xmit_th = (HANDLE)_beginthreadex (NULL, 0, xmit_thread, NULL, 0, NULL); - if (xmit_th == NULL) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("Could not create xmit thread\n"); - return; - } -#else - -#if 0 - -//TODO: not this simple. probably need FIFO policy. - pthread_attr_init (&attr); - e = pthread_attr_getschedparam (&attr, &sp); - if (e != 0) { - text_color_set(DW_COLOR_ERROR); - perror("pthread_attr_getschedparam"); - } - - text_color_set(DW_COLOR_ERROR); - dw_printf ("Default scheduling priority = %d, min=%d, max=%d\n", - sp.sched_priority, - sched_get_priority_min(SCHED_OTHER), - sched_get_priority_max(SCHED_OTHER)); - sp.sched_priority--; - - e = pthread_attr_setschedparam (&attr, &sp); - if (e != 0) { - text_color_set(DW_COLOR_ERROR); - perror("pthread_attr_setschedparam"); - } - - e = pthread_create (&xmit_tid, &attr, xmit_thread, (void *)0); - pthread_attr_destroy (&attr); -#else - e = pthread_create (&xmit_tid, NULL, xmit_thread, (void *)0); -#endif - if (e != 0) { - text_color_set(DW_COLOR_ERROR); - perror("Could not create xmit thread"); - return; - } -#endif - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("xmit_init: finished \n"); -#endif - - -} /* end tq_init */ - - - - -/*------------------------------------------------------------------- - * - * Name: xmit_set_txdelay - * xmit_set_persist - * xmit_set_slottime - * xmit_set_txtail - * - * - * Purpose: The KISS protocol, and maybe others, can specify - * transmit timing parameters. If the application - * specifies these, they will override what was read - * from the configuration file. - * - * Inputs: channel - should be 0 or 1. - * - * value - time values are in 10 mSec units. - * - * - * Outputs: Remember required information for future use. - * - * Question: Should we have an option to enable or disable the - * application changing these values? - * - * Bugs: No validity checking other than array subscript out of bounds. - * - *--------------------------------------------------------------------*/ - -void xmit_set_txdelay (int channel, int value) -{ - if (channel >= 0 && channel < MAX_CHANS) { - xmit_txdelay[channel] = value; - } -} - -void xmit_set_persist (int channel, int value) -{ - if (channel >= 0 && channel < MAX_CHANS) { - xmit_persist[channel] = value; - } -} - -void xmit_set_slottime (int channel, int value) -{ - if (channel >= 0 && channel < MAX_CHANS) { - xmit_slottime[channel] = value; - } -} - -void xmit_set_txtail (int channel, int value) -{ - if (channel >= 0 && channel < MAX_CHANS) { - xmit_txtail[channel] = value; - } -} - -/*------------------------------------------------------------------- - * - * Name: xmit_thread - * - * Purpose: Initialize the transmit process. - * - * Inputs: None. - * - * Outputs: - * - * Description: Initialize the queue to be empty and set up other - * mechanisms for sharing it between different threads. - * - * We have different timing rules for different types of - * packets so they are put into different queues. - * - * High Priority - - * - * Packets which are being digipeated go out first. - * Latest recommendations are to retransmit these - * immdediately (after no one else is heard, of course) - * rather than waiting random times to avoid collisions. - * The KPC-3 configuration option for this is "UIDWAIT OFF". (?) - * - * Low Priority - - * - * Other packets are sent after a random wait time - * (determined by PERSIST & SLOTTIME) to help avoid - * collisions. - * - * If more than one audio channel is being used, a separate - * pair of transmit queues is used for each channel. - * - * - * Thought for future research: - * - * Should we send multiple frames in one transmission if we - * have more than one sitting in the queue? At first I was thinking - * this would help reduce channel congestion. I don't recall seeing - * anything in the specifications allowing or disallowing multiple - * frames in one transmission. I can think of some scenarios - * where it might help. I can think of some where it would - * definitely be counter productive. - * For now, one frame per transmission. - * - * What to others have to say about this topic? - * - * "For what it is worth, the original APRSdos used a several second random - * generator each time any kind of packet was generated... This is to avoid - * bundling. Because bundling, though good for connected packet, is not good - * on APRS. Sometimes the digi begins digipeating the first packet in the - * bundle and steps all over the remainder of them. So best to make sure each - * packet is isolated in time from others..." - * - * Bob, WB4APR - * - * - * Version 0.9: Earlier versions always sent one frame per transmission. - * This was fine for APRS but more and more people are now - * using this as a KISS TNC for connected protocols. - * Rather than having a MAXFRAME configuration file item, - * we try setting the maximum number automatically. - * 1 for digipeated frames, 7 for others. - * - *--------------------------------------------------------------------*/ - -#if __WIN32__ -static unsigned __stdcall xmit_thread (void *arg) -#else -static void * xmit_thread (void *arg) -#endif -{ - packet_t pp; - unsigned char fbuf[AX25_MAX_PACKET_LEN+2]; - int flen; - int c, p; - char stemp[1024]; /* max size needed? */ - int info_len; - unsigned char *pinfo; - int pre_flags, post_flags; - int num_bits; /* Total number of bits in transmission */ - /* including all flags and bit stuffing. */ - int duration; /* Transmission time in milliseconds. */ - int already; - int wait_more; - int ok; - - int maxframe; /* Maximum number of frames for one transmission. */ - int numframe; /* Number of frames sent during this transmission. */ - -/* - * These are for timing of a transmission. - * All are in usual unix time (seconds since 1/1/1970) but higher resolution - */ - double time_ptt; /* Time when PTT is turned on. */ - double time_now; /* Current time. */ - - - - while (1) { - - tq_wait_while_empty (); -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("xmit_thread: woke up\n"); -#endif - - for (p=0; p= 1 && flen <= sizeof(fbuf)); - num_bits += hdlc_send_frame (c, fbuf, flen); - numframe = 1; - ax25_delete (pp); - -/* - * Additional packets if available and not exceeding max. - */ - - while (numframe < maxframe && tq_count (c,p) > 0) { - - pp = tq_remove (c, p); -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("xmit_thread: tq_remove(chan=%d, prio=%d) returned %p\n", c, p, pp); -#endif - ax25_format_addrs (pp, stemp); - info_len = ax25_get_info (pp, &pinfo); - text_color_set(DW_COLOR_XMIT); - dw_printf ("[%d%c] ", c, p==TQ_PRIO_0_HI ? 'H' : 'L'); - dw_printf ("%s", stemp); /* stations followed by : */ - ax25_safe_print ((char *)pinfo, info_len, ! ax25_is_aprs(pp)); - dw_printf ("\n"); - - if (g_debug_xmit_packet) { - text_color_set(DW_COLOR_DEBUG); - dw_printf ("------\n"); - ax25_hex_dump (pp); - dw_printf ("------\n"); - } - -/* - * Transmit the frame. - */ - flen = ax25_pack (pp, fbuf); - assert (flen >= 1 && flen <= sizeof(fbuf)); - num_bits += hdlc_send_frame (c, fbuf, flen); - numframe++; - ax25_delete (pp); - } - -/* - * Generous TXTAIL because we don't know exactly when the sound is done. - */ - - post_flags = MS_TO_BITS(xmit_txtail[c] * 10, c) / 8; - num_bits += hdlc_send_flags (c, post_flags, 1); - - -/* - * We don't know when the sound has actually been produced. - * hldc_send finishes before anything starts coming out of the speaker. - * It's all queued up somewhere. - * - * Calculate duration of entire frame in milliseconds. - * - * Subtract out elapsed time already since PTT was turned to determine - * how much longer to wait til we turn PTT off. - */ - duration = BITS_TO_MS(num_bits, c); - time_now = dtime_now(); - already = (int) ((time_now - time_ptt) * 1000.); - wait_more = duration - already; - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("xmit_thread: maxframe = %d, numframe = %d\n", maxframe, numframe); -#endif - -/* - * Wait for all audio to be out before continuing. - * Provide a hint at delay required in case we don't have a - * way to ask the hardware when all the sound has been pushed out. - */ -// TODO: We have an issue if this is negative. That means -// we couldn't generate the data fast enough for the sound -// system output and there probably gaps in the signal. - - audio_wait(wait_more); - -/* - * Turn off transmitter. - */ - - ptt_set (c, 0); - } - else { -/* - * Timeout waiting for clear channel. - * Discard the packet. - * Display with ERROR color rather than XMIT color. - */ - - text_color_set(DW_COLOR_ERROR); - dw_printf ("Waited too long for clear channel. Discarding packet below.\n"); - - ax25_format_addrs (pp, stemp); - - info_len = ax25_get_info (pp, &pinfo); - - text_color_set(DW_COLOR_INFO); - dw_printf ("[%d%c] ", c, p==TQ_PRIO_0_HI ? 'H' : 'L'); - - dw_printf ("%s", stemp); /* stations followed by : */ - ax25_safe_print ((char *)pinfo, info_len, ! ax25_is_aprs(pp)); - dw_printf ("\n"); - ax25_delete (pp); - - } - } /* for each channel */ - } /* for high priority then low priority */ - } - } - -} /* end xmit_thread */ - - - -/*------------------------------------------------------------------- - * - * Name: wait_for_clear_channel - * - * Purpose: Wait for the radio channel to be clear and any - * additional time for collision avoidance. - * - * Inputs: channel - Radio channel number. - * - * nowait - Should be true for the high priority queue - * (packets being digipeated). This will - * allow transmission immediately when the - * channel is clear rather than waiting a - * random amount of time. - * - * slottime - Amount of time to wait for each iteration - * of the waiting algorithm. 10 mSec units. - * - * persist - Probability of transmitting - * - * Returns: 1 for OK. 0 for timeout. - * - * Description: - * - * Transmit delay algorithm: - * - * Wait for channel to be clear. - * Return if nowait is true. - * - * Wait slottime * 10 milliseconds. - * Generate an 8 bit random number in range of 0 - 255. - * If random number <= persist value, return. - * Otherwise repeat. - * - * Example: - * - * For typical values of slottime=10 and persist=63, - * - * Delay Probability - * ----- ----------- - * 100 .25 = 25% - * 200 .75 * .25 = 19% - * 300 .75 * .75 * .25 = 14% - * 400 .75 * .75 * .75 * .25 = 11% - * 500 .75 * .75 * .75 * .75 * .25 = 8% - * 600 .75 * .75 * .75 * .75 * .75 * .25 = 6% - * 700 .75 * .75 * .75 * .75 * .75 * .75 * .25 = 4% - * etc. ... - * - *--------------------------------------------------------------------*/ - -/* Give up if we can't get a clear channel in a minute. */ - -#define WAIT_TIMEOUT_MS (60 * 1000) -#define WAIT_CHECK_EVERY_MS 10 - -static int wait_for_clear_channel (int channel, int nowait, int slottime, int persist) -{ - int r; - int n; - - n = 0; - while (hdlc_rec_data_detect_any(channel)) { - SLEEP_MS(WAIT_CHECK_EVERY_MS); - n++; - if (n > (WAIT_TIMEOUT_MS / WAIT_CHECK_EVERY_MS)) { - return 0; - } - } - - if (nowait) { - return 1; - } - - while (1) { - - SLEEP_MS (slottime * 10); - - if (hdlc_rec_data_detect_any(channel)) { - continue; - } - - r = rand() & 0xff; - if (r <= persist) { - return 1; - } - } - -} /* end wait_for_clear_channel */ - - - - -/* Current time in seconds but more resolution than time(). */ - -/* We don't care what date a 0 value represents because we */ -/* only use this to calculate elapsed time. */ - - - -double dtime_now (void) -{ -#if __WIN32__ - /* 64 bit integer is number of 100 nanosecond intervals from Jan 1, 1601. */ - - FILETIME ft; - - GetSystemTimeAsFileTime (&ft); - - return ((( (double)ft.dwHighDateTime * (256. * 256. * 256. * 256.) + - (double)ft.dwLowDateTime ) / 10000000.) - 11644473600.); -#else - /* tv_sec is seconds from Jan 1, 1970. */ - - struct timespec ts; - int sec, ns; - double x1, x2; - double result; - - clock_gettime (CLOCK_REALTIME, &ts); - - sec = (int)(ts.tv_sec); - ns = (int)(ts.tv_nsec); - x1 = (double)(sec); - x2 = (double)(ns/1000000) *.001; - result = x1 + x2; - - /* Sometimes this returns NAN. How could that possibly happen? */ - /* This is REALLY BIZARRE! */ - /* Multiplying a number by a billionth often produces NAN. */ - /* Adding a fraction to a number over a billion often produces NAN. */ - - /* Turned out to be a hardware problem with one specific computer. */ - - if (isnan(result)) { - text_color_set(DW_COLOR_ERROR); - dw_printf ("\ndtime_now(): %d, %d -> %.3f + %.3f -> NAN!!!\n\n", sec, ns, x1, x2); - } - -#if DEBUG - text_color_set(DW_COLOR_DEBUG); - dw_printf ("dtime_now() returns %.3f\n", result); -#endif - - return (result); -#endif -} - - -/* end xmit.c */ - - -