You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
dvmhost/src/host/Host.h

403 lines
11 KiB

// 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.
*
* Copyright (C) 2015,2016,2017 Jonathan Naylor, G4KLX
* Copyright (C) 2017-2024 Bryan Biedenkapp, N2PLL
*
*/
/**
* @file Host.h
* @ingroup host
* @file Host.cpp
* @ingroup host
* @file Host.Config.cpp
* @ingroup host
* @file Host.DMR.cpp
* @ingroup host
* @file Host.P25.cpp
* @ingroup host
* @file Host.NXDN.cpp
* @ingroup host
*/
#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/json/json.h"
#include "common/network/Network.h"
#include "common/network/NetRPC.h"
#include "common/yaml/Yaml.h"
#include "dmr/Control.h"
#include "p25/Control.h"
#include "nxdn/Control.h"
#include "network/RPCDefines.h"
#include "restapi/RESTAPI.h"
#include "modem/Modem.h"
#include "modem/ModemV24.h"
#include <string>
#include <unordered_map>
#include <functional>
#include <mutex>
#if defined(_WIN32)
#define WIN32_LEAN_AND_MEAN
#include <Windows.h>
#else
#include <pthread.h>
#endif // defined(_WIN32)
// ---------------------------------------------------------------------------
// Externs
// ---------------------------------------------------------------------------
/** @brief */
extern network::NetRPC* g_RPC;
// ---------------------------------------------------------------------------
// Class Prototypes
// ---------------------------------------------------------------------------
namespace host_restapi { class HOST_SW_API RESTAPI; }
// ---------------------------------------------------------------------------
// Class Declaration
// ---------------------------------------------------------------------------
/**
* @brief This class implements the core host service logic.
* @ingroup host
*/
class HOST_SW_API Host {
public:
/**
* @brief Initializes a new instance of the Host class.
* @param confFile Full-path to the configuration file.
*/
Host(const std::string& confFile);
/**
* @brief Finalizes a instance of the Host class.
*/
~Host();
/**
* @brief Executes the main modem host processing loop.
* @returns int Zero if successful, otherwise error occurred.
*/
int run();
/**
* @brief Gets the RF channel lookup class.
* @returns lookups::ChannelLookup* RF channel lookup.
*/
lookups::ChannelLookup* rfCh() const { return m_channelLookup; }
private:
const std::string& m_confFile;
yaml::Node m_conf;
modem::Modem* m_modem;
bool m_modemRemote;
bool m_isModemDFSI;
modem::port::IModemPort* m_udpDFSIRemotePort;
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;
bool m_allowStatusTransfer;
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<uint32_t, uint32_t> 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;
uint32_t m_dmr1RejCnt;
uint32_t m_dmr2RejCnt;
uint32_t m_p25RejCnt;
uint32_t m_nxdnRejCnt;
Timer m_dmrBeaconDurationTimer;
Timer m_dmrDedicatedTxTestTimer;
Timer m_dmr1RejectTimer;
Timer m_dmr2RejectTimer;
Timer m_p25BcastDurationTimer;
Timer m_p25DedicatedTxTestTimer;
Timer m_p25RejectTimer;
Timer m_nxdnBcastDurationTimer;
Timer m_nxdnDedicatedTxTestTimer;
Timer m_nxdnRejectTimer;
/* Watchdog Timers */
Timer m_dmrTx1WatchdogTimer;
uint32_t m_dmrTx1LoopMS;
Timer m_dmrTx2WatchdogTimer;
uint32_t m_dmrTx2LoopMS;
Timer m_p25TxWatchdogTimer;
uint32_t m_p25TxLoopMS;
Timer m_nxdnTxWatchdogTimer;
uint32_t m_nxdnTxLoopMS;
uint8_t m_mainLoopStage;
uint32_t m_mainLoopMS;
Timer m_mainLoopWatchdogTimer;
uint32_t m_adjSiteLoopMS;
Timer m_adjSiteLoopWatchdogTimer;
uint32_t m_dmr1OverflowCnt;
uint32_t m_dmr2OverflowCnt;
uint32_t m_p25OverflowCnt;
uint32_t m_nxdnOverflowCnt;
bool m_disableWatchdogOverflow;
static std::mutex m_clockingMutex;
static uint8_t m_activeTickDelay;
static uint8_t m_idleTickDelay;
friend class host_restapi::RESTAPI;
std::string m_restAddress;
uint16_t m_restPort;
host_restapi::RESTAPI* m_RESTAPI;
std::string m_rpcAddress;
uint16_t m_rpcPort;
std::unique_ptr<dmr::Control> m_dmr;
std::unique_ptr<p25::Control> m_p25;
std::unique_ptr<nxdn::Control> m_nxdn;
/**
* @brief Helper to generate the status of the host in JSON format.
* @returns json::object Host status as a JSON object.
*/
json::object getStatus();
/**
* @brief Modem port open callback.
* @param modem Instance of the Modem class.
* @returns bool True, if the modem is opened, otherwise false.
*/
bool rmtPortModemOpen(modem::Modem* modem);
/**
* @brief Modem port close callback.
* @param modem Instance of the Modem class.
* @returns bool True, if the modem is closed, otherwise false.
*/
bool rmtPortModemClose(modem::Modem* modem);
/**
* @brief Modem clock callback.
* @param modem Instance of the Modem class.
* @param ms
* @param rspType Modem message response type.
* @param rspDblLen Flag indicating whether or not this message is a double length message.
* @param[in] buffer Buffer containing modem message.
* @param len Length of buffer.
* @returns bool True, if the modem response was handled, otherwise false.
*/
bool rmtPortModemHandler(modem::Modem* modem, uint32_t ms, modem::RESP_TYPE_DVM rspType, bool rspDblLen, const uint8_t* buffer, uint16_t len);
/**
* @brief Helper to set the host/modem running state.
* @param state Host running state.
*/
void setState(uint8_t state);
/**
* @brief Entry point to RPC clocking thread.
* @param arg Instance of the thread_t structure.
* @returns void* (Ignore)
*/
static void* threadRPC(void* arg);
/**
* @brief Entry point to modem clocking thread.
* @param arg Instance of the thread_t structure.
* @returns void* (Ignore)
*/
static void* threadModem(void* arg);
/**
* @brief Entry point to watchdog thread.
* @param arg Instance of the thread_t structure.
* @returns void* (Ignore)
*/
static void* threadWatchdog(void* arg);
/**
* @brief Entry point to site data update thread.
* @param arg Instance of the thread_t structure.
* @returns void* (Ignore)
*/
static void* threadSiteData(void* arg);
/**
* @brief Entry point to presence update thread.
* @param arg Instance of the thread_t structure.
* @returns void* (Ignore)
*/
static void* threadPresence(void* arg);
// Configuration (Host.Config.cpp)
/**
* @brief Reads basic configuration parameters from the INI.
* @returns bool True, if configuration was read successfully, otherwise false.
*/
bool readParams();
/**
* @brief Initializes the modem DSP.
* @returns bool True, if the modem was initialized, otherwise false.
*/
bool createModem();
/**
* @brief Initializes network connectivity.
* @returns bool True, if network connectivity was initialized, otherwise false.
*/
bool createNetwork();
// Digital Mobile Radio (Host.DMR.cpp)
/**
* @brief Entry point to read DMR slot 1 frames from modem Rx queue.
* @param arg Instance of the thread_t structure.
* @returns void* (Ignore)
*/
static void* threadDMRReader1(void* arg);
/**
* @brief Entry point to write DMR slot 1 frames to modem.
* @param arg Instance of the thread_t structure.
* @returns void* (Ignore)
*/
static void* threadDMRWriter1(void* arg);
/**
* @brief Entry point to read DMR slot 2 frames from modem Rx queue.
* @param arg Instance of the thread_t structure.
* @returns void* (Ignore)
*/
static void* threadDMRReader2(void* arg);
/**
* @brief Entry point to write DMR slot 2 frames to modem.
* @param arg Instance of the thread_t structure.
* @returns void* (Ignore)
*/
static void* threadDMRWriter2(void* arg);
/**
* @brief Helper to interrupt a running DMR beacon.
*/
void interruptDMRBeacon();
// Project 25 (Host.P25.cpp)
/**
* @brief Entry point to read P25 frames from modem Rx queue.
* @param arg Instance of the thread_t structure.
* @returns void* (Ignore)
*/
static void* threadP25Reader(void* arg);
/**
* @brief Entry point to write P25 frames to modem.
* @param arg Instance of the thread_t structure.
* @returns void* (Ignore)
*/
static void* threadP25Writer(void* arg);
/**
* @brief Helper to interrupt a running P25 control channel.
*/
void interruptP25Control();
// Next Generation Digital Narrowband (Host.NXDN.cpp)
/**
* @brief Entry point to read NXDN frames from modem Rx queue.
* @param arg Instance of the thread_t structure.
* @returns void* (Ignore)
*/
static void* threadNXDNReader(void* arg);
/**
* @brief Entry point to write NXDN frames to modem.
* @param arg Instance of the thread_t structure.
* @returns void* (Ignore)
*/
static void* threadNXDNWriter(void* arg);
/**
* @brief Helper to interrupt a running NXDN control channel.
*/
void interruptNXDNControl();
};
#endif // __HOST_H__

Powered by TurnKey Linux.