ProcessorBase.hpp

Go to the documentation of this file.

/******************************************************************************
 * This file is part of project ORCA. More information on the project
 * can be found at the following repositories at GitHub's website.
 *
 * http://https://github.com/andersondomingues/orca-sim
 * http://https://github.com/andersondomingues/orca-software
 * http://https://github.com/andersondomingues/orca-mpsoc
 * http://https://github.com/andersondomingues/orca-tools
 *
 * Copyright (C) 2018-2020 Anderson Domingues, <ti.andersondomingues@gmail.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 
******************************************************************************/
#ifndef ORCASIM_MODELING_INCLUDE_PROCESSORBASE_HPP_
#define ORCASIM_MODELING_INCLUDE_PROCESSORBASE_HPP_

#include <string>

#include "TimedModel.hpp"
#include "Memory.hpp"
#include "ProcessorState.hpp"

using orcasim::base::TimedModel;
using orcasim::base::SimulationTime;
using orcasim::modeling::Memory;

namespace orcasim::modeling {

template <typename T>
class ProcessorBase : public TimedModel{
 private:
    struct ProcessorState<T> _state;

    Memory* _memory;

 public:
    ProcessorBase(std::string name, MemoryAddr initial_pc, Memory* mem);

    ~ProcessorBase();

    virtual SimulationTime Run() = 0;

    ProcessorState<T>* GetState();

    Memory* GetMemory();
};

// Some of the most used instances. More can be added later.
template class ProcessorBase<uint8_t>;
template class ProcessorBase<uint16_t>;
template class ProcessorBase<uint32_t>;
template class ProcessorBase<uint64_t>;

// Some of the most used instances. More can be added later.
template class ProcessorBase<int8_t>;
template class ProcessorBase<int16_t>;
template class ProcessorBase<int32_t>;
template class ProcessorBase<int64_t>;

}  // namespace orcasim::modeling
#endif  // ORCASIM_MODELING_INCLUDE_PROCESSORBASE_HPP_