/*
 * Copyright (c) 2015, University of Kaiserslautern
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its
 *    contributors may be used to endorse or promote products derived from
 *    this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER
 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * Authors:
 *    Robert Gernhardt
 *    Matthias Jung
 *    Éder F. Zulian
 */

#ifndef REFRESHMANAGER_H_
#define REFRESHMANAGER_H_

#include "IRefreshManager.h"
#include "../configuration/MemSpec.h"

class ControllerCore;

class RefreshManager : public IRefreshManager, public sc_module
{
public:
    RefreshManager(sc_module_name /*name*/, ControllerCore &controllerCore);
    virtual ~RefreshManager();

    virtual bool hasCollision(const ScheduledCommand &command) override;
    virtual void scheduleRefresh(tlm::tlm_generic_payload &payload,
                                 sc_time time) override;
    void reInitialize(Bank bank, sc_time time) override;
    virtual bool isInvalidated(tlm::tlm_generic_payload &payload,
                               sc_time time) override;

private:
    ControllerCore &controllerCore;
    RefreshTiming &timing;
    sc_time nextPlannedRefresh;
    sc_time tREFIx;
    sc_time tRFCx;
    std::map<Bank, tlm::tlm_generic_payload> refreshPayloads;
    bool postponeEnabled;
    bool pullInEnabled;
    unsigned int maxpostpone;
    unsigned int maxpullin;
    unsigned int pulledin;
    unsigned int postponed;
    ref_fsm_state_t currentState;
    ref_fsm_state_t previousState;
    ref_fsm_state_t nextState;

    bool doRefresh(tlm::tlm_generic_payload &payload, sc_time time);
    void planNextRefresh(sc_time time, bool align);
    void printDebugMessage(std::string message);
};

#endif /* REFRESHMANAGER_H_ */

