knx/src/knx/rf/rf_physical_layer_cc1310.cpp

#include "../config.h"
#ifdef USE_RF
#ifdef DeviceFamily_CC13X0


#include <stdlib.h>
#include <stdio.h>
#include <string.h>

#include "rf_physical_layer_cc1310.h"
#include "rf_data_link_layer.h"

#include <ti/devices/DeviceFamily.h>
#include DeviceFamily_constructPath(driverlib/rf_data_entry.h)
#include DeviceFamily_constructPath(driverlib/rf_prop_mailbox.h)
#include <ti/drivers/rf/RF.h>
#include "smartrf_settings/smartrf_settings.h"

#include "../platform/cc1310_platform.h"
#include "Board.h"

#include "bits.h"
#include "platform.h"

#define RX_MAX_BUFFER_LENGTH 256
#define RF_TERMINATION_EVENT_MASK (RF_EventLastCmdDone | RF_EventLastFGCmdDone | RF_EventCmdAborted | RF_EventCmdStopped | RF_EventCmdCancelled)

#define DEBUG_DUMP_PACKETS

static RF_Object rfObject;
static RF_Handle rfHandle;
static RF_CmdHandle rxCommandHandle;

static uint8_t rxBuffer[sizeof(rfc_dataEntryPartial_t) + RX_MAX_BUFFER_LENGTH] __attribute__((aligned(4)));
static rfc_dataEntryPartial_t* pDataEntry = (rfc_dataEntryPartial_t*)& rxBuffer;
static dataQueue_t dataQueue;

static uint8_t addrFilterTable[2] = {0x44, 0xFF}; // Do not modify the size without changing RF_cmdPropRxAdv.addrConf.addrSize!

static rfc_propRxOutput_t rxStatistics;

static uint8_t packetLength;
static uint8_t* packetDataPointer;
static int32_t packetStartTime = 0;

static volatile bool rfDone = false;
static volatile int rfErr = 0;
static volatile int err;

static void RxCallback(RF_Handle h, RF_CmdHandle ch, RF_EventMask e)
{
    /*
    static uint32_t count = 0;

    print("count: ");println(count++);
    print("nextIndex: ");println(pDataEntry->nextIndex);
    //print("pktStatus.numElements: ");println(pDataEntry->pktStatus.numElements);
    print("RF_cmdPropRxAdv.status: ");println(RF_cmdPropRxAdv.status, HEX);
    print("pktStatus.bEntryOpen: ");println(pDataEntry->pktStatus.bEntryOpen, HEX);
    print("RF_EventMask: ");println(e, HEX);
    */

    if (e & RF_EventNDataWritten)
    {
        // Make sure sure we are at the beginning of the packet
        if (packetStartTime == 0)
        {
            packetStartTime = millis();

            // pDataEntry->rxData contains the first byte of the received packet.
            // Just get the address to get the start address of the receive buffer
            uint8_t* pData = &pDataEntry->rxData;

            // Make sure we have a valid first block
            if (((pData[1] != addrFilterTable[0]) || (pData[2] != addrFilterTable[1])) ||
                    (crc16Dnp(pData, 10) != ((pData[10] << 8) | pData[11])))
            {
                // cancel early because it does not seem to be KNX RF packet
                RF_cancelCmd(rfHandle, rxCommandHandle, 0 /* force abort RF */);
                return;
            }

            // First block is valid, so the length is valid
            uint8_t len = pDataEntry->rxData;
            struct rfc_CMD_PROP_SET_LEN_s RF_cmdPropSetLen =
            {
                .commandNo = CMD_PROP_SET_LEN,        // command identifier
                .rxLen   = (uint16_t)PACKET_SIZE(len) // packet length to set
            };

            //RF_runImmediateCmd(rfHandle, (uint32_t*)&RF_cmdPropSetLen); // for length > 255
            RF_Stat status = RF_runDirectCmd(rfHandle, (uint32_t)&RF_cmdPropSetLen);

            if (status != RF_StatCmdDoneSuccess)
            {
                println("RF CMD_PROP_SET_LEN failed!");
            }
        }
    }
    else if (e & RF_TERMINATION_EVENT_MASK)
    {
        if (e & RF_EventCmdAborted)
        {
            println("RX ABORT");
        }

        rfDone = true;
        rfErr = e & (RF_EventCmdStopped | RF_EventCmdAborted | RF_EventCmdCancelled);
    }
    else /* unknown reason - should not occur */
    {
        pDataEntry->status = DATA_ENTRY_PENDING;
        err++;
    }
}

RfPhysicalLayerCC1310::RfPhysicalLayerCC1310(RfDataLinkLayer& rfDataLinkLayer, Platform& platform)
    : RfPhysicalLayer(rfDataLinkLayer, platform)
{
}

void RfPhysicalLayerCC1310::setOutputPowerLevel(int8_t dBm)
{
    RF_TxPowerTable_Entry* rfPowerTable = NULL;
    RF_TxPowerTable_Value newValue;
    uint8_t rfPowerTableSize = 0;

    // Search the default PA power table for the desired power level
    newValue = RF_TxPowerTable_findValue((RF_TxPowerTable_Entry*)PROP_RF_txPowerTable, dBm);

    if (newValue.rawValue != RF_TxPowerTable_INVALID_VALUE)
    {
        // Found a valid entry
        rfPowerTable = (RF_TxPowerTable_Entry*)PROP_RF_txPowerTable;
        rfPowerTableSize = PROP_RF_txPowerTableSize;
    }

    // if max power is requested then the CCFG_FORCE_VDDR_HH must be set in
    // the ccfg
#if (CCFG_FORCE_VDDR_HH != 0x1)

    if ((newValue.paType == RF_TxPowerTable_DefaultPA) &&
            (dBm == rfPowerTable[rfPowerTableSize - 2].power))
    {
        // The desired power level is set to the maximum supported under the
        // default PA settings, but the boost mode (CCFG_FORCE_VDDR_HH) is not
        // turned on
        return;
    }

#endif

    RF_Stat rfStatus = RF_setTxPower(rfHandle, newValue);

    if (rfStatus == RF_StatSuccess)
    {
        print("Successfully set TX output power to: ");
        println(newValue.rawValue);
    }
    else
    {
        print("Could not set TX output power to: ");
        println(newValue.rawValue);
    }
}


bool RfPhysicalLayerCC1310::InitChip()
{
    RF_Params rfParams;
    RF_Params_init(&rfParams);

    pDataEntry->length = 255;
    pDataEntry->config.type = DATA_ENTRY_TYPE_PARTIAL; // --> DATA_ENTRY_TYPE_PARTIAL adds a 12 Byte Header
    pDataEntry-> config.irqIntv = 12; // KNX-RF first block consists of 12 bytes (one length byte, 0x44, 0xFF, one RFinfo byte, six Serial/DoA bytes, two CRC bytes)
    pDataEntry-> config.lenSz  = 0; // no length indicator at beginning of data entry
    pDataEntry->status = DATA_ENTRY_PENDING;
    pDataEntry->pNextEntry = (uint8_t*)pDataEntry;

    dataQueue.pCurrEntry = (uint8_t*)pDataEntry;
    dataQueue.pLastEntry = NULL;

    // Set buffer with address. We use the two fixed bytes 0x44 and 0xFF as our address to let the
    // packet engine do more filtering on itself
    RF_cmdPropRxAdv.pAddr = (uint8_t*)&addrFilterTable;
    // Set the Data Entity queue for received data
    RF_cmdPropRxAdv.pQueue = &dataQueue;
    // Set the output buffer for RX packet statistics
    RF_cmdPropRxAdv.pOutput = (uint8_t*)&rxStatistics;

    // Request access to the radio
    rfHandle = RF_open(&rfObject, &RF_prop, (RF_RadioSetup*)&RF_cmdPropRadioDivSetup, &rfParams);

    /* Set the frequency */
    RF_runCmd(rfHandle, (RF_Op*)&RF_cmdFs, RF_PriorityNormal, NULL, 0);
    return true;
}

void RfPhysicalLayerCC1310::stopChip()
{
    RF_cancelCmd(rfHandle, rxCommandHandle, 0 /* do not stop gracefully, instead hard abort RF */);
    RF_pendCmd(rfHandle, rxCommandHandle, RF_TERMINATION_EVENT_MASK);
    RF_yield(rfHandle);
    RF_close(rfHandle);
}

void RfPhysicalLayerCC1310::loop()
{
    switch (_loopState)
    {
        case TX_START:
        {
            uint8_t* sendBuffer {nullptr};
            uint16_t sendBufferLength {0};

            //println("TX_START...");
            _rfDataLinkLayer.loadNextTxFrame(&sendBuffer, &sendBufferLength);
            uint16_t pktLen = PACKET_SIZE(sendBuffer[0]);

            if (pktLen != sendBufferLength)
            {
                print("Error TX: SendBuffer[0]=");
                println(sendBuffer[0]);
                print("Error TX: SendBufferLength=");
                println(sendBufferLength);
                print("Error TX: PACKET_SIZE=");
                println(PACKET_SIZE(sendBuffer[0]));
            }

            // Calculate total number of bytes in the KNX RF packet from L-field
            // Check for valid length
            if ((pktLen == 0) || (pktLen > 290))
            {
                println("TX packet length error!");
                break;
            }

            if (pktLen > 255)
            {
                println("Unhandled: TX packet > 255");
                break;
            }

            RF_cmdPropTx.pktLen = pktLen;
            RF_cmdPropTx.pPkt = sendBuffer;
            RF_cmdPropTx.startTrigger.triggerType = TRIG_NOW;
            RF_EventMask result = RF_runCmd(rfHandle, (RF_Op*)&RF_cmdPropTx, RF_PriorityNormal, NULL, RF_TERMINATION_EVENT_MASK);
            //print("TX: RF_EventMask: ");println(result, HEX);

#if defined(DEBUG_DUMP_PACKETS)
            printHex("TX: ", sendBuffer, pktLen);
#endif
            delete sendBuffer;

            if (result != RF_EventLastCmdDone)
            {
                print("Unexpected result command: ");
                println(result, HEX);
            }

            //println("Restart RX...");
            _loopState = RX_START;
        }
        break;

        case RX_START:
        {
            packetStartTime = 0;
            rfDone = false;
            rfErr = 0;
            err = 0;
            pDataEntry->status = DATA_ENTRY_PENDING;

            rxCommandHandle = RF_postCmd(rfHandle, (RF_Op*)&RF_cmdPropRxAdv, RF_PriorityNormal, &RxCallback, RF_EventNDataWritten | RF_EventRxAborted);

            if (rxCommandHandle == RF_ALLOC_ERROR)
            {
                println("Error: nRF_pendCmd() failed");
                return;
            }

            _loopState = RX_ACTIVE;
        }
        break;

        case RX_ACTIVE:
        {
            if (!_rfDataLinkLayer.isTxQueueEmpty())
            {
                RF_cancelCmd(rfHandle, rxCommandHandle, RF_ABORT_GRACEFULLY);
                RF_pendCmd(rfHandle, rxCommandHandle, RF_TERMINATION_EVENT_MASK);

                if (RF_cmdPropTx.status != PROP_DONE_OK)
                {
                    print("Unexpected RF_cmdPropTx.status after stopping RX: ");
                    println(RF_cmdPropTx.status, HEX);
                }

                _loopState = TX_START;
                break;
            }

            // Check if we have an incomplete packet reception
            if (!rfDone && ((packetStartTime > 0) && (millis() - packetStartTime > RX_PACKET_TIMEOUT)))
            {
                println("RX packet timeout!");
                RF_cancelCmd(rfHandle, rxCommandHandle, RF_ABORT_GRACEFULLY);
                RF_pendCmd(rfHandle, rxCommandHandle, RF_TERMINATION_EVENT_MASK);
                /*
                print("nRxOk = ");println(rxStatistics.nRxOk);           // Number of packets that have been received with payload, CRC OK and not ignored
                print("nRxNok = ");println(rxStatistics.nRxNok);         // Number of packets that have been received with CRC error
                print("nRxIgnored = ");println(rxStatistics.nRxIgnored); // Number of packets that have been received with CRC OK and ignored due to address mismatch
                print("nRxStopped = ");println(rxStatistics.nRxStopped); // Number of packets not received due to illegal length or address mismatch with pktConf.filterOp = 1
                print("nRxBufFull = ");println(rxStatistics.nRxBufFull); // Number of packets that have been received and discarded due to lack of buffer space
                */
                _loopState = RX_START;
                break;
            }
            else if (rfDone)
            {
                RF_EventMask result = RF_pendCmd(rfHandle, rxCommandHandle, RF_TERMINATION_EVENT_MASK);

                if ((result & RF_EventCmdCancelled) || (result & RF_EventCmdStopped) || (result & RF_EventCmdAborted))
                {
                    println("RF terminated because of RF_flushCmd() or RF_cancelCmd()");
                }
                else if ((result & RF_EventLastCmdDone) != RF_EventLastCmdDone)
                {
                    print("Unexpected Rx result command: ");
                    println(result, HEX);
                }
                else if (rfErr)
                {
                    println("Rx is no KNX frame");
                }
                else if ((result & RF_EventLastCmdDone) == RF_EventLastCmdDone)
                {
                    // add CRC sizes for received blocks, but do not add the length of the L-field (1 byte) itself
                    packetLength = PACKET_SIZE(pDataEntry->rxData);
                    packetDataPointer = (uint8_t*) &pDataEntry->rxData;

                    // Sanity check: the partial data entry index points to the next free location in the partial RX buffer
                    if (packetLength != (pDataEntry->nextIndex - 1))
                    {
                        println("Mismatch between packetLength and pDataEntry->nextIndex: ");
                        print("packetLength = ");
                        print(packetLength);
                        print(", pDataEntry->nextIndex = ");
                        println(pDataEntry->nextIndex);
                    }

                    /*
                    print("nRxOk = ");println(rxStatistics.nRxOk);           // Number of packets that have been received with payload, CRC OK and not ignored
                    print("nRxNok = ");println(rxStatistics.nRxNok);         // Number of packets that have been received with CRC error
                    print("nRxIgnored = ");println(rxStatistics.nRxIgnored); // Number of packets that have been received with CRC OK and ignored due to address mismatch
                    print("nRxStopped = ");println(rxStatistics.nRxStopped); // Number of packets not received due to illegal length or address mismatch with pktConf.filterOp = 1
                    print("nRxBufFull = ");println(rxStatistics.nRxBufFull); // Number of packets that have been received and discarded due to lack of buffer space
                    */

#if defined(DEBUG_DUMP_PACKETS)
                    printHex("RX: ", packetDataPointer, packetLength, false);
                    print ("- RSSI: ");
                    println(rxStatistics.lastRssi);
#endif
                    _rfDataLinkLayer.frameBytesReceived(packetDataPointer, packetLength);
                }

                _loopState = RX_START;
            }
        }
        break;
    }
}

#endif // DeviceFamily_CC13X0
#endif