// SPDX-License-Identifier: GPL-2.0-only /** * Digital Voice Modem - 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 / Modem Host Software * @derivedfrom MMDVMHost (https://github.com/g4klx/MMDVMHost) * @license GPLv2 License (https://opensource.org/licenses/GPL-2.0) * * Copyright (C) 2015,2016,2017 Jonathan Naylor, G4KLX * Copyright (C) 2017-2024 Bryan Biedenkapp, N2PLL * */ #if !defined(__HOST_H__) #define __HOST_H__ #include "Defines.h" #include "common/Timer.h" #include "common/lookups/AffiliationLookup.h" #include "common/lookups/ChannelLookup.h" #include "common/lookups/IdenTableLookup.h" #include "common/lookups/RadioIdLookup.h" #include "common/lookups/TalkgroupRulesLookup.h" #include "common/yaml/Yaml.h" #include "dmr/Control.h" #include "p25/Control.h" #include "nxdn/Control.h" #include "network/Network.h" #include "network/RESTAPI.h" #include "modem/Modem.h" #include #include #include // --------------------------------------------------------------------------- // Class Prototypes // --------------------------------------------------------------------------- class HOST_SW_API RESTAPI; // --------------------------------------------------------------------------- // Class Declaration // This class implements the core host service logic. // --------------------------------------------------------------------------- class HOST_SW_API Host { public: /// Initializes a new instance of the Host class. Host(const std::string& confFile); /// Finalizes a instance of the Host class. ~Host(); /// Executes the main modem host processing loop. int run(); /// Gets the RF channel lookup class. lookups::ChannelLookup* rfCh() const { return m_channelLookup; } private: const std::string& m_confFile; yaml::Node m_conf; modem::Modem* m_modem; bool m_modemRemote; network::Network* m_network; modem::port::IModemPort* m_modemRemotePort; uint8_t m_state; bool m_isTxCW; Timer m_modeTimer; Timer m_dmrTXTimer; Timer m_cwIdTimer; bool m_dmrEnabled; bool m_p25Enabled; bool m_nxdnEnabled; bool m_duplex; bool m_fixedMode; uint32_t m_timeout; uint32_t m_rfModeHang; uint32_t m_rfTalkgroupHang; uint32_t m_netModeHang; uint32_t m_lastDstId; uint32_t m_lastSrcId; std::string m_identity; std::string m_cwCallsign; uint32_t m_cwIdTime; float m_latitude; float m_longitude; int m_height; uint32_t m_power; std::string m_location; uint32_t m_rxFrequency; uint32_t m_txFrequency; uint8_t m_channelId; uint32_t m_channelNo; lookups::ChannelLookup* m_channelLookup; std::unordered_map m_voiceChPeerId; lookups::VoiceChData m_controlChData; lookups::IdenTableLookup* m_idenTable; lookups::RadioIdLookup* m_ridLookup; lookups::TalkgroupRulesLookup* m_tidLookup; bool m_dmrBeacons; bool m_dmrTSCCData; bool m_dmrCtrlChannel; bool m_p25CCData; bool m_p25CtrlChannel; bool m_p25CtrlBroadcast; bool m_nxdnCCData; bool m_nxdnCtrlChannel; bool m_nxdnCtrlBroadcast; uint32_t m_presenceTime; uint8_t m_siteId; uint32_t m_sysId; uint32_t m_dmrNetId; uint32_t m_dmrColorCode; uint32_t m_p25NAC; uint32_t m_p25NetId; uint8_t m_p25RfssId; uint32_t m_nxdnRAN; uint32_t m_dmrQueueSizeBytes; uint32_t m_p25QueueSizeBytes; uint32_t m_nxdnQueueSizeBytes; bool m_authoritative; bool m_supervisor; Timer m_dmrBeaconDurationTimer; Timer m_p25BcastDurationTimer; Timer m_nxdnBcastDurationTimer; uint8_t m_activeTickDelay; uint8_t m_idleTickDelay; friend class RESTAPI; std::string m_restAddress; uint16_t m_restPort; RESTAPI *m_RESTAPI; /// Modem port open callback. bool rmtPortModemOpen(modem::Modem* modem); /// Modem port close callback. bool rmtPortModemClose(modem::Modem* modem); /// Modem clock callback. bool rmtPortModemHandler(modem::Modem* modem, uint32_t ms, modem::RESP_TYPE_DVM rspType, bool rspDblLen, const uint8_t* buffer, uint16_t len); /// Helper to set the host/modem running state. void setState(uint8_t state); /// Helper to create the state lock file. void createLockFile(const char* state) const; /// Helper to remove the state lock file. void removeLockFile() const; /** (Host.Config.cpp) */ /// Reads basic configuration parameters from the INI. bool readParams(); /// Initializes the modem DSP. bool createModem(); /// Initializes network connectivity. bool createNetwork(); /** Digital Mobile Radio (Host.DMR.cpp) */ /// Helper to interrupt a running DMR beacon. void interruptDMRBeacon(dmr::Control* control); /// Helper to read DMR slot 1 frames from modem. void readFramesDMR1(dmr::Control* control, std::function&& afterReadCallback); /// Helper to write DMR slot 1 frames to modem. void writeFramesDMR1(dmr::Control* control, std::function&& afterWriteCallback); /// Helper to read DMR slot 2 frames from modem. void readFramesDMR2(dmr::Control* control, std::function&& afterReadCallback); /// Helper to write DMR slot 2 frames to modem. void writeFramesDMR2(dmr::Control* control, std::function&& afterWriteCallback); /** Project 25 (Host.P25.cpp) */ /// Helper to interrupt a running P25 control channel. void interruptP25Control(p25::Control* control); /// Helper to read P25 frames from modem. void readFramesP25(p25::Control* control, std::function&& afterReadCallback); /// Helper to write P25 frames to modem. void writeFramesP25(p25::Control* control, std::function&& afterWriteCallback); /** Next Generation Digital Narrowband (Host.NXDN.cpp) */ /// Helper to interrupt a running NXDN control channel. void interruptNXDNControl(nxdn::Control* control); /// Helper to read NXDN frames from modem. void readFramesNXDN(nxdn::Control* control, std::function&& afterReadCallback); /// Helper to write NXDN frames to modem. void writeFramesNXDN(nxdn::Control* control, std::function&& afterWriteCallback); }; #endif // __HOST_H__