RateGroupDriver.cpp

Go to the documentation of this file.

#include <Fw/FPrimeBasicTypes.hpp>
#include <Fw/Types/Assert.hpp>
#include <Svc/RateGroupDriver/RateGroupDriver.hpp>
#include <cstdio>
#include <cstring>

namespace Svc {

RateGroupDriver::RateGroupDriver(const char* compName)
    : RateGroupDriverComponentBase(compName), m_ticks(0), m_rollover(1), m_configured(false) {}

void RateGroupDriver::configure(const DividerSet& dividerSet) {
    // verify port/table size matches
    static_assert(FW_NUM_ARRAY_ELEMENTS(m_dividers) == NUM_CYCLEOUT_OUTPUT_PORTS,
                  "Divider table size must match the number of cycle output ports");
    // reset rollover so a reconfigure does not multiply onto the prior product
    this->m_rollover = 1;
    // copy provided array of dividers
    for (FwIndexType entry = 0; entry < RateGroupDriver::DIVIDER_SIZE; entry++) {
        // A port with an offset equal or bigger than the divisor is not accepted because it would never be called
        FW_ASSERT((dividerSet.dividers[entry].offset == 0) ||
                      (dividerSet.dividers[entry].offset < dividerSet.dividers[entry].divisor),
                  static_cast<FwAssertArgType>(dividerSet.dividers[entry].offset),
                  static_cast<FwAssertArgType>(dividerSet.dividers[entry].divisor));
        this->m_dividers[entry] = dividerSet.dividers[entry];
        // rollover value should be product of all dividers to make sure integer rollover doesn't jump cycles
        // only use non-zero dividers
        if (dividerSet.dividers[entry].divisor != 0) {
            // Ensure that rollover will not overflow
            FW_ASSERT((std::numeric_limits<FwSizeType>::max() / dividerSet.dividers[entry].divisor) >= this->m_rollover,
                      static_cast<FwAssertArgType>(this->m_rollover),
                      static_cast<FwAssertArgType>(dividerSet.dividers[entry].divisor));
            this->m_rollover *= dividerSet.dividers[entry].divisor;
        }
    }
    this->m_configured = true;
}

RateGroupDriver::~RateGroupDriver() {}

void RateGroupDriver::CycleIn_handler(FwIndexType portNum, Os::RawTime& cycleStart) {
    // Make sure that the dividers have been configured:
    // If this asserts, add the configure() call to initialization.
    FW_ASSERT(this->m_configured);

    // Loop through each divider. For a given port, the port will be called when the divider value
    // divides evenly into the number of ticks. For example, if the divider value for a port is 4,
    // it would be called every fourth invocation of the CycleIn port.
    for (FwIndexType entry = 0; entry < RateGroupDriver::DIVIDER_SIZE; entry++) {
        if (this->m_dividers[entry].divisor != 0) {
            if (this->isConnected_CycleOut_OutputPort(static_cast<FwIndexType>(entry))) {
                if ((this->m_ticks % this->m_dividers[entry].divisor) == this->m_dividers[entry].offset) {
                    this->CycleOut_out(static_cast<FwIndexType>(entry), cycleStart);
                }
            }
        }
    }

    // rollover the tick value when the tick count reaches the rollover value
    // the rollover value is the product of all the dividers. See comment in constructor.
    FW_ASSERT(this->m_rollover > 0);
    this->m_ticks = (this->m_ticks + 1) % this->m_rollover;
}

}  // namespace Svc