/** * 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 MMDVMHost project. (https://github.com/g4klx/MMDVMHost) // Licensed under the GPLv2 License (https://opensource.org/licenses/GPL-2.0) // /* * Copyright (C) 2015,2016,2017,2018 Jonathan Naylor, G4KLX * Copyright (C) 2017-2020 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; version 2 of the License. * * 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. */ #include "Defines.h" #include "dmr/ControlPacket.h" #include "dmr/acl/AccessControl.h" #include "dmr/data/DataHeader.h" #include "dmr/data/EMB.h" #include "dmr/edac/Trellis.h" #include "dmr/lc/ShortLC.h" #include "dmr/lc/FullLC.h" #include "dmr/lc/CSBK.h" #include "dmr/SlotType.h" #include "dmr/Sync.h" #include "edac/BPTC19696.h" #include "edac/CRC.h" #include "Log.h" #include "Utils.h" using namespace dmr; #include #include #include #include // --------------------------------------------------------------------------- // Macros // --------------------------------------------------------------------------- // Don't process RF frames if the network isn't in a idle state. #define CHECK_TRAFFIC_COLLISION(_DST_ID) \ if (m_slot->m_netState != RS_NET_IDLE && _DST_ID == m_slot->m_netLastDstId) { \ LogWarning(LOG_RF, "DMR Slot %u, Traffic collision detect, preempting new RF traffic to existing network traffic!", m_slot->m_slotNo); \ return false; \ } #define CHECK_TRAFFIC_COLLISION_DELLC(_DST_ID) \ if (m_slot->m_netState != RS_NET_IDLE && _DST_ID == m_slot->m_netLastDstId) { \ LogWarning(LOG_RF, "DMR Slot %u, Traffic collision detect, preempting new RF traffic to existing network traffic!", m_slot->m_slotNo); \ delete lc; \ return false; \ } #define CHECK_TG_HANG(_DST_ID) \ if (m_slot->m_rfLastDstId != 0U) { \ if (m_slot->m_rfLastDstId != _DST_ID && (m_slot->m_rfTGHang.isRunning() && !m_slot->m_rfTGHang.hasExpired())) { \ return; \ } \ } #define CHECK_TG_HANG_DELLC(_DST_ID) \ if (m_slot->m_rfLastDstId != 0U) { \ if (m_slot->m_rfLastDstId != _DST_ID && (m_slot->m_rfTGHang.isRunning() && !m_slot->m_rfTGHang.hasExpired())) { \ delete lc; \ return; \ } \ } // --------------------------------------------------------------------------- // Public Class Members // --------------------------------------------------------------------------- /// /// Process DMR data frame from the RF interface. /// /// Buffer containing data frame. /// Length of data frame. /// bool ControlPacket::process(uint8_t* data, uint32_t len) { assert(data != NULL); // Get the type from the packet metadata uint8_t dataType = data[1U] & 0x0FU; SlotType slotType; slotType.setColorCode(m_slot->m_colorCode); slotType.setDataType(dataType); if (dataType == DT_CSBK) { // generate a new CSBK and check validity lc::CSBK csbk = lc::CSBK(); csbk.setVerbose(m_dumpCSBKData); bool valid = csbk.decode(data + 2U); if (!valid) return false; uint8_t csbko = csbk.getCSBKO(); if (csbko == CSBKO_BSDWNACT) return false; bool gi = csbk.getGI(); uint32_t srcId = csbk.getSrcId(); uint32_t dstId = csbk.getDstId(); if (srcId != 0U || dstId != 0U) { CHECK_TRAFFIC_COLLISION(dstId); // validate the source RID if (!acl::AccessControl::validateSrcId(srcId)) { LogWarning(LOG_RF, "DMR Slot %u, DT_CSBK denial, RID rejection, srcId = %u", m_slot->m_slotNo, srcId); return false; } // validate the target ID if (gi) { if (!acl::AccessControl::validateTGId(m_slot->m_slotNo, dstId)) { LogWarning(LOG_RF, "DMR Slot %u, DT_CSBK denial, TGID rejection, srcId = %u, dstId = %u", m_slot->m_slotNo, srcId, dstId); return false; } } } // Regenerate the CSBK data csbk.encode(data + 2U); // Regenerate the Slot Type slotType.encode(data + 2U); // Convert the Data Sync to be from the BS or MS as needed Sync::addDMRDataSync(data + 2U, m_slot->m_duplex); m_slot->m_rfSeqNo = 0U; data[0U] = TAG_DATA; data[1U] = 0x00U; if (m_slot->m_duplex) m_slot->writeQueueRF(data); m_slot->writeNetworkRF(data, DT_CSBK, gi ? FLCO_GROUP : FLCO_PRIVATE, srcId, dstId); if (m_verbose) { switch (csbko) { case CSBKO_UU_V_REQ: if (m_verbose) { LogMessage(LOG_RF, "DMR Slot %u, DT_CSBK, CSBKO_UU_V_REQ (Unit to Unit Voice Service Request), src = %u, dst = %s%u", m_slot->m_slotNo, srcId, gi ? "TG " : "", dstId); } break; case CSBKO_UU_ANS_RSP: if (m_verbose) { LogMessage(LOG_RF, "DMR Slot %u, DT_CSBK, CSBKO_UU_ANS_RSP (Unit to Unit Voice Service Answer Response), src = %u, dst = %s%u", m_slot->m_slotNo, srcId, gi ? "TG " : "", dstId); } break; case CSBKO_NACK_RSP: if (m_verbose) { LogMessage(LOG_RF, "DMR Slot %u, DT_CSBK, CSBKO_NACK_RSP (Negative Acknowledgment Response), src = %u, dst = %s%u", m_slot->m_slotNo, srcId, gi ? "TG " : "", dstId); } break; case CSBKO_CALL_ALRT: if (m_verbose) { LogMessage(LOG_RF, "DMR Slot %u, DT_CSBK, CSBKO_CALL_ALRT (Call Alert), src = %u, dst = %s%u", m_slot->m_slotNo, srcId, gi ? "TG " : "", dstId); } ::ActivityLog("DMR", true, "Slot %u call alert request from %u to %u", m_slot->m_slotNo, srcId, dstId); break; case CSBKO_ACK_RSP: if (m_verbose) { LogMessage(LOG_RF, "DMR Slot %u, DT_CSBK, CSBKO_ACK_RSP (Acknowledge Response), src = %u, dst = %s%u", m_slot->m_slotNo, srcId, gi ? "TG " : "", dstId); } ::ActivityLog("DMR", true, "Slot %u ack response from %u to %u", m_slot->m_slotNo, srcId, dstId); break; case CSBKO_EXT_FNCT: if (m_verbose) { LogMessage(LOG_RF, "DMR Slot %u, DT_CSBK, CSBKO_EXT_FNCT (Extended Function), op = $%02X, arg = %u, tgt = %u", m_slot->m_slotNo, csbk.getCBF(), dstId, srcId); } // generate activity log entry if (csbk.getCBF() == DMR_EXT_FNCT_CHECK) { ::ActivityLog("DMR", true, "Slot %u radio check request from %u to %u", m_slot->m_slotNo, dstId, srcId); } else if (csbk.getCBF() == DMR_EXT_FNCT_INHIBIT) { ::ActivityLog("DMR", true, "Slot %u radio inhibit request from %u to %u", m_slot->m_slotNo, dstId, srcId); } else if (csbk.getCBF() == DMR_EXT_FNCT_UNINHIBIT) { ::ActivityLog("DMR", true, "Slot %u radio uninhibit request from %u to %u", m_slot->m_slotNo, dstId, srcId); } else if (csbk.getCBF() == DMR_EXT_FNCT_CHECK_ACK) { ::ActivityLog("DMR", true, "Slot %u radio check response from %u to %u", m_slot->m_slotNo, dstId, srcId); } else if (csbk.getCBF() == DMR_EXT_FNCT_INHIBIT_ACK) { ::ActivityLog("DMR", true, "Slot %u radio inhibit response from %u to %u", m_slot->m_slotNo, dstId, srcId); } else if (csbk.getCBF() == DMR_EXT_FNCT_UNINHIBIT_ACK) { ::ActivityLog("DMR", true, "Slot %u radio uninhibit response from %u to %u", m_slot->m_slotNo, dstId, srcId); } break; case CSBKO_PRECCSBK: if (m_verbose) { LogMessage(LOG_RF, "DMR Slot %u, DT_CSBK, CSBKO_PRECCSBK (%s Preamble CSBK), toFollow = %u, src = %u, dst = %s%u", m_slot->m_slotNo, csbk.getDataContent() ? "Data" : "CSBK", csbk.getCBF(), srcId, gi ? "TG " : "", dstId); } break; default: LogWarning(LOG_RF, "DMR Slot %u, DT_CSBK, unhandled CSBK, csbko = $%02X, fid = $%02X", m_slot->m_slotNo, csbko, csbk.getFID()); break; } } if (m_debug) { Utils::dump(2U, "!!! *TX DMR Frame - DT_CSBK", data + 2U, DMR_FRAME_LENGTH_BYTES); } return true; } return false; } /// /// Process a data frame from the network. /// /// void ControlPacket::processNetwork(const data::Data & dmrData) { uint8_t dataType = dmrData.getDataType(); uint8_t data[DMR_FRAME_LENGTH_BYTES + 2U]; dmrData.getData(data + 2U); if (dataType == DT_CSBK) { lc::CSBK csbk = lc::CSBK(); csbk.setVerbose(m_dumpCSBKData); bool valid = csbk.decode(data + 2U); if (!valid) { LogError(LOG_NET, "DMR Slot %u, DT_CSBK, unable to decode the network CSBK", m_slot->m_slotNo); return; } uint8_t csbko = csbk.getCSBKO(); if (csbko == CSBKO_BSDWNACT) return; bool gi = csbk.getGI(); uint32_t srcId = csbk.getSrcId(); uint32_t dstId = csbk.getDstId(); CHECK_TG_HANG(dstId); // Regenerate the CSBK data csbk.encode(data + 2U); // Regenerate the Slot Type SlotType slotType; slotType.decode(data + 2U); slotType.setColorCode(m_slot->m_colorCode); slotType.encode(data + 2U); // Convert the Data Sync to be from the BS or MS as needed Sync::addDMRDataSync(data + 2U, m_slot->m_duplex); data[0U] = TAG_DATA; data[1U] = 0x00U; if (csbko == CSBKO_PRECCSBK && csbk.getDataContent()) { uint32_t cbf = NO_PREAMBLE_CSBK + csbk.getCBF() - 1U; for (uint32_t i = 0U; i < NO_PREAMBLE_CSBK; i++, cbf--) { // Change blocks to follow csbk.setCBF(cbf); // Regenerate the CSBK data csbk.encode(data + 2U); // Regenerate the Slot Type SlotType slotType; slotType.decode(data + 2U); slotType.setColorCode(m_slot->m_colorCode); slotType.encode(data + 2U); // Convert the Data Sync to be from the BS or MS as needed Sync::addDMRDataSync(data + 2U, m_slot->m_duplex); m_slot->writeQueueNet(data); } } else m_slot->writeQueueNet(data); if (m_verbose) { switch (csbko) { case CSBKO_UU_V_REQ: if (m_verbose) { LogMessage(LOG_NET, "DMR Slot %u, DT_CSBK, CSBKO_UU_V_REQ (Unit to Unit Voice Service Request), src = %u, dst = %s%u", m_slot->m_slotNo, srcId, gi ? "TG " : "", dstId); } break; case CSBKO_UU_ANS_RSP: if (m_verbose) { LogMessage(LOG_NET, "DMR Slot %u, DT_CSBK, CSBKO_UU_ANS_RSP (Unit to Unit Voice Service Answer Response), src = %u, dst = %s%u", m_slot->m_slotNo, srcId, gi ? "TG " : "", dstId); } break; case CSBKO_NACK_RSP: if (m_verbose) { LogMessage(LOG_NET, "DMR Slot %u, DT_CSBK, CSBKO_NACK_RSP (Negative Acknowledgment Response), src = %u, dst = %s%u", m_slot->m_slotNo, srcId, gi ? "TG " : "", dstId); } break; case CSBKO_CALL_ALRT: if (m_verbose) { LogMessage(LOG_NET, "DMR Slot %u, DT_CSBK, CSBKO_CALL_ALRT (Call Alert), src = %u, dst = %s%u", m_slot->m_slotNo, srcId, gi ? "TG " : "", dstId); } ::ActivityLog("DMR", false, "Slot %u call alert request from %u to %u", m_slot->m_slotNo, srcId, dstId); break; case CSBKO_ACK_RSP: if (m_verbose) { LogMessage(LOG_NET, "DMR Slot %u, DT_CSBK, CSBKO_ACK_RSP (Acknowledge Response), src = %u, dst = %s%u", m_slot->m_slotNo, srcId, gi ? "TG " : "", dstId); } ::ActivityLog("DMR", false, "Slot %u ack response from %u to %u", m_slot->m_slotNo, srcId, dstId); break; case CSBKO_EXT_FNCT: if (m_verbose) { LogMessage(LOG_NET, "DMR Slot %u, DT_CSBK, CSBKO_EXT_FNCT (Extended Function), op = $%02X, arg = %u, tgt = %u", m_slot->m_slotNo, csbk.getCBF(), dstId, srcId); } // generate activity log entry if (csbk.getCBF() == DMR_EXT_FNCT_CHECK) { ::ActivityLog("DMR", false, "Slot %u radio check request from %u to %u", m_slot->m_slotNo, dstId, srcId); } else if (csbk.getCBF() == DMR_EXT_FNCT_INHIBIT) { ::ActivityLog("DMR", false, "Slot %u radio inhibit request from %u to %u", m_slot->m_slotNo, dstId, srcId); } else if (csbk.getCBF() == DMR_EXT_FNCT_UNINHIBIT) { ::ActivityLog("DMR", false, "Slot %u radio uninhibit request from %u to %u", m_slot->m_slotNo, dstId, srcId); } else if (csbk.getCBF() == DMR_EXT_FNCT_CHECK_ACK) { ::ActivityLog("DMR", false, "Slot %u radio check response from %u to %u", m_slot->m_slotNo, dstId, srcId); } else if (csbk.getCBF() == DMR_EXT_FNCT_INHIBIT_ACK) { ::ActivityLog("DMR", false, "Slot %u radio inhibit response from %u to %u", m_slot->m_slotNo, dstId, srcId); } else if (csbk.getCBF() == DMR_EXT_FNCT_UNINHIBIT_ACK) { ::ActivityLog("DMR", false, "Slot %u radio uninhibit response from %u to %u", m_slot->m_slotNo, dstId, srcId); } break; case CSBKO_PRECCSBK: if (m_verbose) { LogMessage(LOG_NET, "DMR Slot %u, DT_CSBK, CSBKO_PRECCSBK (%s Preamble CSBK), toFollow = %u, src = %u, dst = %s%u", m_slot->m_slotNo, csbk.getDataContent() ? "Data" : "CSBK", csbk.getCBF(), srcId, gi ? "TG " : "", dstId); } break; default: LogWarning(LOG_NET, "DMR Slot %u, DT_CSBK, unhandled network CSBK, csbko = $%02X, fid = $%02X", m_slot->m_slotNo, csbko, csbk.getFID()); break; } } } else { // Unhandled data type LogWarning(LOG_NET, "DMR Slot %u, unhandled network data, type = $%02X", m_slot->m_slotNo, dataType); } } // --------------------------------------------------------------------------- // Private Class Members // --------------------------------------------------------------------------- /// /// Initializes a new instance of the ControlPacket class. /// /// DMR slot. /// Instance of the BaseNetwork class. /// /// Flag indicating whether DMR debug is enabled. /// Flag indicating whether DMR verbose logging is enabled. ControlPacket::ControlPacket(Slot * slot, network::BaseNetwork * network, bool dumpCSBKData, bool debug, bool verbose) : m_slot(slot), m_dumpCSBKData(dumpCSBKData), m_verbose(verbose), m_debug(debug) { /* stub */ } /// /// Finalizes a instance of the ControlPacket class. /// ControlPacket::~ControlPacket() { /* stub */ }