ack_delay.cpp

Go to the documentation of this file.

 
 
 
#include "ack_delay.hpp"
#include "../../toe_utils.hpp"
 
using namespace hls;
 
 
#ifndef __SYNTHESIS__
  extern bool gTraceEvent;
#endif
 
#define THIS_NAME "TOE/AKd"
 
#define TRACE_OFF  0x0000
#define TRACE_AKD 1 <<  1
#define TRACE_ALL  0xFFFF
 
#define DEBUG_LEVEL (TRACE_OFF)
 
 
 
void ack_delay(
        stream<ExtendedEvent>   &siEVe_Event,
        stream<SigBit>          &soEVe_RxEventSig,
        stream<SigBit>          &soEVe_TxEventSig,
        stream<ExtendedEvent>   &soTXe_Event)
{
    //-- DIRECTIVES FOR THIS PROCESS -------------------------------------------
    #pragma HLS PIPELINE II=1 enable_flush
 
    const char *myName = THIS_NAME;
 
    //-- STATIC ARRAYS ---------------------------------------------------------
    static AckEntry                 ACK_TABLE[TOE_MAX_SESSIONS];
    #pragma HLS RESOURCE   variable=ACK_TABLE core=RAM_T2P_BRAM
    #pragma HLS DEPENDENCE variable=ACK_TABLE inter false
 
    //-- STATIC CONTROL VARIABLES (with RESET) ---------------------------------
    // [TODO - The type of 'akd_Ptr' could be configured as a functions of 'MAX_SESSIONS']
    // [ E.g. - static const int NR_BITS = ceil(log10(MAX_SESSIONS)/log10(2));
    static SessionId           akd_Ptr;
    #pragma HLS RESET variable=akd_Ptr
 
    //-- DYNAMIC VARIABLES -----------------------------------------------------
    ExtendedEvent ev;
 
    if (!siEVe_Event.empty()) {
 
        // Read incoming event and inform [EVe] that the FiFo stream was read
        siEVe_Event.read(ev);
        assessSize(myName, soEVe_RxEventSig, "soEVe_RxEventSig", cDepth_AKdToEVe_Event);
        soEVe_RxEventSig.write(1);
 
        if (ev.type == ACK_EVENT) {
 
            if (ACK_TABLE[ev.sessionID].delay == 0) {
                // There is no delayed ACK pending --> Schedule a new one
                ACK_TABLE[ev.sessionID] = AckEntry(ACKD_64us, 1);
            }
            else if (ACK_TABLE[ev.sessionID].count == 1) {
                // Received a second ACK  --> Decrease the delay
                if (ACK_TABLE[ev.sessionID].delay > ACKD_32us) {
                    ACK_TABLE[ev.sessionID].delay = ACKD_32us;
                }
                ACK_TABLE[ev.sessionID].count++;
            }
            else if (ACK_TABLE[ev.sessionID].count == 2) {
                // Received a third ACK   --> Decrease the delay
                if (ACK_TABLE[ev.sessionID].delay > ACKD_16us) {
                    ACK_TABLE[ev.sessionID].delay = ACKD_16us;
                }
                ACK_TABLE[ev.sessionID].count++;
            }
            else if (ACK_TABLE[ev.sessionID].count == 3) {
                // Received a fourth ACK  --> Decrease the delay
                if (ACK_TABLE[ev.sessionID].delay > ACKD_8us) {
                    ACK_TABLE[ev.sessionID].delay = ACKD_8us;
                }
                ACK_TABLE[ev.sessionID].count++;
            }
            else if (ACK_TABLE[ev.sessionID].count == 4) {
                // Received a fifth ACK   --> Decrease the delay
                if (ACK_TABLE[ev.sessionID].delay > ACKD_4us) {
                    ACK_TABLE[ev.sessionID].delay = ACKD_4us;
                }
                ACK_TABLE[ev.sessionID].count++;
            }
            else if (ACK_TABLE[ev.sessionID].count == 5) {
                // Received a sixth ACK   --> Decrease the delay
                if (ACK_TABLE[ev.sessionID].delay > ACKD_2us) {
                    ACK_TABLE[ev.sessionID].delay = ACKD_2us;
                }
                ACK_TABLE[ev.sessionID].count++;
            }
            else if (ACK_TABLE[ev.sessionID].count == 6) {
                // Received a seventh ACK --> Decrease the delay
                if (ACK_TABLE[ev.sessionID].delay > ACKD_1us) {
                    ACK_TABLE[ev.sessionID].delay = ACKD_1us;
                }
                ACK_TABLE[ev.sessionID].count++;
            }
            else if (ACK_TABLE[ev.sessionID].count == 7) {
                // Received a eight+ ACK --> Set delay to ONE
                ACK_TABLE[ev.sessionID].delay = 1;
                ACK_TABLE[ev.sessionID].count = 8;
            }
            // Debug trace
            if (DEBUG_LEVEL & TRACE_AKD) {
                printInfo(myName, "S%d - Received \'%s\' - Setting  ACK_TABLE[%d]={D=%4.4d,C=%2.2d}\n",
                          ev.sessionID.to_int(), getEventName(ev.type),
                          ev.sessionID.to_uint(),
                          ACK_TABLE[ev.sessionID].delay.to_uint(),
                          ACK_TABLE[ev.sessionID].count.to_uint());
            }
        }
        else {
            // Received any other event --> Reset current entry
            ACK_TABLE[ev.sessionID] = AckEntry(0, 0);
            // Forward event to TxEngine
            assessSize(myName, soTXe_Event, "soTXe_Event", cDepth_AKdToTXe_Event);
            soTXe_Event.write(ev);
            // Tell the EventEngine that we just forwarded an none-ACK event to TXe
            assessSize(myName, soEVe_TxEventSig, "soEVe_TxEventSig", cDepth_AKdToEVe_Event);
            soEVe_TxEventSig.write(1);
            // Debug trace
            if (DEBUG_LEVEL & TRACE_AKD) {
                printInfo(myName, "S%d - Received '%s' - Clearing ACK_TABLE[%d]={D=%4.4d,C=%2.2d}\n",
                                  ev.sessionID.to_int(), getEventName(ev.type),
                                  ev.sessionID.to_uint(),
                                  ACK_TABLE[ev.sessionID].delay.to_uint(),
                                  ACK_TABLE[ev.sessionID].count.to_uint());
            }
        }
    }
    else {
        if (ACK_TABLE[akd_Ptr].delay > 0 and !soTXe_Event.full()) {
            if (ACK_TABLE[akd_Ptr].delay == 1) {
                soTXe_Event.write(Event(ACK_EVENT, akd_Ptr));
                // Tell the EventEngine that we just forwarded an event to TXe
                assessSize(myName, soEVe_TxEventSig, "soEVe_TxEventSig", cDepth_AKdToEVe_Event);
                soEVe_TxEventSig.write(1);
                // Do not clear the received ACK counter here. It will anyhow be
                //  cleared whenever a new event comes in. Until then, it gives
                //  us a good indication of its usage in the trace.
                 if (DEBUG_LEVEL & TRACE_AKD) {
                    printInfo(myName, "S%d - It's ACK Time (count=%d) - Requesting [TXe] to generate an new ACK\n",
                              akd_Ptr.to_int(), ACK_TABLE[akd_Ptr].count.to_uint());
                }
            }
            ACK_TABLE[akd_Ptr].delay -= 1;
        }
        akd_Ptr++;
        if (akd_Ptr == TOE_MAX_SESSIONS) {
            akd_Ptr = 0;
        }
    }
}
 
 
void ack_delay_OBSO (
        stream<ExtendedEvent>   &siEVe_Event,
        stream<SigBit>          &soEVe_RxEventSig,
        stream<SigBit>          &soEVe_TxEventSig,
        stream<ExtendedEvent>   &soTXe_Event)
{
    //-- DIRECTIVES FOR THIS PROCESS -------------------------------------------
    #pragma HLS PIPELINE II=1 enable_flush
 
    const char *myName = THIS_NAME;
 
    //-- STATIC ARRAYS ---------------------------------------------------------
    // [TODO - The type of 'ACK_TABLE' can be configured as a functions of 'TIME_XXX' and 'MAX_SESSIONS']
    // [ E.g. - TIME_64us  = ( 64.000/0.0064/32) + 1 =  313 = 0x139 ( 9-bits)
    // [ E.g. - TIME_64us  = ( 64.000/0.0064/ 8) + 1 = 1251 = 0x4E3 (11-bits)
    // [ E.g. - TIME_128us = (128.000/0.0064/32) + 1 =  626 = 0x271 (10-bits)
    static ap_uint<12>              ACK_TABLE[TOE_MAX_SESSIONS];
    #pragma HLS RESOURCE   variable=ACK_TABLE core=RAM_T2P_BRAM
    #pragma HLS DEPENDENCE variable=ACK_TABLE inter false
    #pragma HLS RESET      variable=ACK_TABLE
 
    //-- STATIC CONTROL VARIABLES (with RESET) ---------------------------------
    // [TODO - The type of 'akd_Ptr' could be configured as a functions of 'MAX_SESSIONS']
    // [ E.g. - static const int NR_BITS = ceil(log10(MAX_SESSIONS)/log10(2));
    static SessionId           akd_Ptr;
    #pragma HLS RESET variable=akd_Ptr
 
    //-- DYNAMIC VARIABLES -----------------------------------------------------
    ExtendedEvent ev;
 
    if (!siEVe_Event.empty()) {
 
        // Read incoming event and inform [EVe] that the FiFo stream was read
        siEVe_Event.read(ev);
        assessSize(myName, soEVe_RxEventSig, "soEVe_RxEventSig", cDepth_AKdToEVe_Event);
        soEVe_RxEventSig.write(1);
 
        if (ev.type == ACK_EVENT) {
            if (ACK_TABLE[ev.sessionID] == 0) {
                // There is no delayed ACK pending --> Schedule a new one
                ACK_TABLE[ev.sessionID] = ACKD_64us;
                if (DEBUG_LEVEL & TRACE_AKD) {
                    printInfo(myName, "S%d - Received \'%s\' - Setting ACK_TABLE[%d]=%d\n",
                              ev.sessionID.to_int(), getEventName(ev.type), ev.sessionID.to_uint(), ACK_TABLE[ev.sessionID].to_uint());
                }
            }
            else {
                if (DEBUG_LEVEL & TRACE_AKD) {
                     printInfo(myName, "S%d - Received \'%s\' - Current ACK_TABLE[%d]=%d\n",
                              ev.sessionID.to_int(), getEventName(ev.type), ev.sessionID.to_uint(), ACK_TABLE[ev.sessionID].to_uint());
                }
            }
        }
        else {
            // Any other event
            ACK_TABLE[ev.sessionID] = 0;
            // Forward event to TxEngine
            assessSize(myName, soTXe_Event, "soTXe_Event", cDepth_AKdToTXe_Event);
            soTXe_Event.write(ev);
            // Tell the EventEngine that we just forwarded an mone-ACK event to TXe
            assessSize(myName, soEVe_TxEventSig, "soEVe_TxEventSig", cDepth_AKdToEVe_Event);
            soEVe_TxEventSig.write(1);
            // Debug trace
            if (DEBUG_LEVEL & TRACE_AKD) {
                printInfo(myName, "S%d - Received '%s' - Clearing ACK_TABLE[%d]=%d\n",
                                  ev.sessionID.to_int(), getEventName(ev.type), ev.sessionID.to_uint(), ACK_TABLE[ev.sessionID].to_uint());
            }
        }
    }
    else {
        if (ACK_TABLE[akd_Ptr] > 0 and !soTXe_Event.full()) {
            if (ACK_TABLE[akd_Ptr] == 1) {
                soTXe_Event.write(Event(ACK_EVENT, akd_Ptr));
                // Tell the EventEngine that we just forwarded an event to TXe
                assessSize(myName, soEVe_TxEventSig, "soEVe_TxEventSig", cDepth_AKdToEVe_Event);
                soEVe_TxEventSig.write(1);
                if (DEBUG_LEVEL & TRACE_AKD) {
                    printInfo(myName, "S%d - It's ACK Time - Requesting [TXe] to generate an new ACK\n",
                              akd_Ptr.to_int());
                }
            }
            ACK_TABLE[akd_Ptr] -= 1;
        }
        akd_Ptr++;
        if (akd_Ptr == TOE_MAX_SESSIONS) {
            akd_Ptr = 0;
        }
    }
}