/*
 * Copyright (c) 2017, 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.
 *
 * Author: Éder F. Zulian
 */

#ifndef RGR_MANAGER_H_
#define RGR_MANAGER_H_
#include "../../../common/dramExtension.h"
#include "../configuration/MemSpec.h"
#include "IRefreshManager.h"
class ControllerCore;
class RGR : public IRefreshManager, public sc_module
{
public:
    RGR(sc_module_name, ControllerCore &ctrlcore);
    virtual ~RGR();
    virtual bool hasCollision(const ScheduledCommand &cmd) override;
    virtual void scheduleRefresh(tlm::tlm_generic_payload &p, sc_time t) override;
    void reInitialize(Bank bank, sc_time time) override;
    bool isInvalidated(tlm::tlm_generic_payload &payload, sc_time time) override;
private:
    bool fmb;
    bool bwl;
    unsigned int ri;
    unsigned int rpr;
    sc_time trp;
    sc_time trcd;
    sc_time tREFIx;
    ControllerCore &ccore;
    RefreshTiming &timing;
    std::map<Bank, tlm::tlm_generic_payload> rps;
    std::map<Bank, sc_time> nextPlannedRefreshs;
    std::map<Bank, sc_time> currentRefresh;
    bool postponeEnabled;
    bool pullInEnabled;
    unsigned int maxpostpone;
    unsigned int maxpullin;
    std::map<Bank, unsigned int> pulledin;
    std::map<Bank, unsigned int> postponed;
    std::map<Bank, ref_fsm_state_t> currentState;
    std::map<Bank, ref_fsm_state_t> previousState;
    std::map<Bank, ref_fsm_state_t> nextState;
    sc_time doRefresh(tlm::tlm_generic_payload &p, sc_time t);
    void planNextRefresh(Bank b, sc_time t, bool align);
    void printDebugMessage(std::string message);
};
#endif /* RGR_MANAGER_H_ */

