/*
 * 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:
 *    Janik Schlemminger
 *    Matthias Jung
 */

#ifndef CONTROLLER_H_
#define CONTROLLER_H_

#include <tlm.h>
#include <map>
#include <utility>
#include <string>
#include "../IController.h"
#include "configuration/Configuration.h"
#include "powerdown/PowerDownManager.h"
#include "refresh/IRefreshManager.h"
#include "scheduling/checker/ICommandChecker.h"
#include "../RowBufferStates.h"
#include "../ControllerState.h"

using namespace std;

class ControllerCore : public sc_module
{
public:
    ControllerCore(sc_module_name /*name*/, IController &controller,
                   std::map<Bank, int> &numberOfPayloads);
    virtual ~ControllerCore();

    bool scheduleRequest(Command command, tlm::tlm_generic_payload &payload);
    void triggerRefresh(tlm::tlm_generic_payload &payload);

    const std::vector<Bank> &getBanks();
    std::vector<Bank> getFreeBanks();
    const RowBufferState &getRowBufferStates()
    {
        return *(state->rowBufferStates);
    }
    bool hasPendingRequests();
    bool hasPendingRequests(Bank bank);
    bool bankIsBusy(Bank bank);

    ICommandChecker &getCommandChecker(Command command);

    Configuration config;
    ControllerState *state;
    IController &controller;
    IPowerDownManager *powerDownManager;
    IRefreshManager *refreshManager;
    std::map<Bank, int> &numberOfPayloads;

private:

    ScheduledCommand schedule(Command command, sc_time start,
                              tlm::tlm_generic_payload &payload);
    std::map<Command, ICommandChecker *> commandChecker;
    void printDebugMessage(string message);
};

#endif /* CONTROLLER_H_ */

