/** * Digital Voice Modem - Host Software * GPLv2 Open Source. Use is subject to license terms. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * @package DVM / Host Software * */ // // Based on code from the MMDVMCal project. (https://github.com/g4klx/MMDVMCal) // Licensed under the GPLv2 License (https://opensource.org/licenses/GPL-2.0) // /* * Copyright (C) 2015,2016,2017 by Jonathan Naylor G4KLX * Copyright (C) 2017,2018 by Andy Uribe CA6JAU * Copyright (C) 2017-2021 by Bryan Biedenkapp N2PLL * * 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, write to the Free Software * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */ #if !defined(__HOST_CAL_H__) #define __HOST_CAL_H__ #include "Defines.h" #include "edac/AMBEFEC.h" #include "modem/Modem.h" #include "host/calibrate/Console.h" #include "host/Host.h" #include "lookups/IdenTableLookup.h" #include "yaml/Yaml.h" #include // --------------------------------------------------------------------------- // Class Declaration // This class implements the interactive calibration mode. // --------------------------------------------------------------------------- class HOST_SW_API HostCal { public: /// Initializes a new instance of the HostCal class. HostCal(const std::string& confFile); /// Finalizes a instance of the HostCal class. ~HostCal(); /// Executes the calibration processing loop. int run(); private: const std::string& m_confFile; yaml::Node m_conf; modem::Modem* m_modem; Console m_console; edac::AMBEFEC m_fec; bool m_transmit; bool m_duplex; bool m_rxInvert; // dedicated modem - Rx signal inversion bool m_txInvert; // dedicated modem - Tx signal inversion bool m_pttInvert; // dedicated modem - PTT signal inversion bool m_dcBlocker; // dedicated modem - DC blocker float m_rxLevel; // dedicated/hotspot modem - Rx modulation level float m_txLevel; // dedicated/hotspot modem - Tx modulation level bool m_dmrEnabled; bool m_dmrRx1K; bool m_p25Enabled; bool m_p25Rx1K; bool m_nxdnEnabled; int m_rxDCOffset; // dedicated modem - Rx signal DC offset int m_txDCOffset; // dedicated modem - Tx signal DC offset bool m_isHotspot; int8_t m_dmrDiscBWAdj; // hotspot modem - DMR discriminator BW adjustment int8_t m_p25DiscBWAdj; // hotspot modem - P25 discriminator BW adjustment int8_t m_nxdnDiscBWAdj; // hotspot modem - NXDN discriminator BW adjustment int8_t m_dmrPostBWAdj; // hotspot modem - DMR post demod BW adjustment int8_t m_p25PostBWAdj; // hotspot modem - P25 post demod BW adjustment int8_t m_nxdnPostBWAdj; // hotspot modem - NXDN post demod BW adjustment modem::ADF_GAIN_MODE m_adfGainMode; // hotspot modem - ADF7021 Rx gain int m_dmrSymLevel3Adj; // dedicated modem - +3/-3 DMR symbol adjustment int m_dmrSymLevel1Adj; // dedicated modem - +1/-1 DMR symbol adjustment int m_p25SymLevel3Adj; // dedicated modem - +3/-3 P25 symbol adjustment int m_p25SymLevel1Adj; // dedicated modem - +1/-1 P25 symbol adjustment int m_nxdnSymLevel3Adj; // dedicated modem - +3/-3 NXDN symbol adjustment int m_nxdnSymLevel1Adj; // dedicated modem - +1/-1 NXDN symbol adjustment uint8_t m_rxCoarsePot; // dedicated modem - with softpot uint8_t m_rxFinePot; // dedicated modem - with softpot uint8_t m_txCoarsePot; // dedicated modem - with softpot uint8_t m_txFinePot; // dedicated modem - with softpot uint8_t m_rssiCoarsePot; // dedicated modem - with softpot uint8_t m_rssiFinePot; // dedicated modem - with softpot uint8_t m_fdmaPreamble; uint8_t m_dmrRxDelay; uint8_t m_p25CorrCount; bool m_debug; uint8_t m_mode; std::string m_modeStr; int m_rxTuning; int m_txTuning; uint32_t m_rxFrequency; // hotspot modem - Rx Frequency uint32_t m_rxAdjustedFreq; uint32_t m_txFrequency; // hotspot modem - Tx Frequency uint32_t m_txAdjustedFreq; uint8_t m_channelId; uint32_t m_channelNo; lookups::IdenTableLookup* m_idenTable; uint32_t m_berFrames; uint32_t m_berBits; uint32_t m_berErrs; uint32_t m_berUndecodableLC; uint32_t m_berUncorrectable; uint32_t m_timeout; uint32_t m_timer; bool m_updateConfigFromModem; bool m_hasFetchedStatus; /// Modem port open callback. bool portModemOpen(modem::Modem* modem); /// Modem port close callback. bool portModemClose(modem::Modem* modem); /// Modem clock callback. bool portModemHandler(modem::Modem* modem, uint32_t ms, modem::RESP_TYPE_DVM rspType, bool rspDblLen, const uint8_t* buffer, uint16_t len); /// Helper to print the calibration help to the console. void displayHelp(); /// Helper to change the Tx level. bool setTXLevel(int incr); /// Helper to change the Rx level. bool setRXLevel(int incr); /// Helper to change the Tx DC offset. bool setTXDCOffset(int incr); /// Helper to change the Rx DC offset. bool setRXDCOffset(int incr); /// Helper to toggle modem transmit mode. bool setTransmit(); /// Helper to change the DMR Symbol Level 3 adjust. bool setDMRSymLevel3Adj(int incr); /// Helper to change the DMR Symbol Level 1 adjust. bool setDMRSymLevel1Adj(int incr); /// Helper to change the P25 Symbol Level 3 adjust. bool setP25SymLevel3Adj(int incr); /// Helper to change the P25 Symbol Level 1 adjust. bool setP25SymLevel1Adj(int incr); /// Helper to change the NXDN Symbol Level 3 adjust. bool setNXDNSymLevel3Adj(int incr); /// Helper to change the NXDN Symbol Level 1 adjust. bool setNXDNSymLevel1Adj(int incr); /// Process DMR Rx BER. void processDMRBER(const uint8_t* buffer, uint8_t seq); /// Process DMR Tx 1011hz BER. void processDMR1KBER(const uint8_t* buffer, uint8_t seq); /// Process P25 Rx BER. void processP25BER(const uint8_t* buffer); /// Process P25 Tx 1011hz BER. void processP251KBER(const uint8_t* buffer); /// Process NXDN Rx BER. void processNXDNBER(const uint8_t* buffer); /// Write configuration to the modem DSP. bool writeConfig(); /// Write configuration to the modem DSP. bool writeConfig(uint8_t modeOverride); /// Write RF parameters to the air interface modem. bool writeRFParams(); /// Write symbol level adjustments to the modem DSP. bool writeSymbolAdjust(); /// Helper to sleep the calibration thread. void sleep(uint32_t ms); /// Read the configuration area on the air interface modem. bool readFlash(); /// Process the configuration data from the air interface modem. void processFlashConfig(const uint8_t *buffer); /// Erase the configuration area on the air interface modem. bool eraseFlash(); /// Write the configuration area on the air interface modem. bool writeFlash(); /// Helper to clock the calibration BER timer. void timerClock(); /// Helper to start the calibration BER timer. void timerStart(); /// Helper to stop the calibration BER timer. void timerStop(); /// Retrieve the current status from the air interface modem. void getStatus(); /// Prints the current status of the calibration. void printStatus(); /// void nxdnScrambler(uint8_t* data) const; /// Counts the total number of bit errors between bytes. uint8_t countErrs(uint8_t a, uint8_t b); }; #endif // __HOST_CAL_H__