Signal.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_SIGNAL_HPP_
#define ORCASIM_MODELING_INCLUDE_SIGNAL_HPP_

// lib dependent includes
#include <stdint.h>
#include <iostream>
#include <vector>
#include <string>

// api includes
#include "UntimedModel.hpp"
#include "MemoryType.hpp"

namespace orcasim::modeling {

template <typename T>
class Signal{
 private:
    volatile T* _t_ptr;

    volatile T _t_storage;

    std::string _t_name;

    volatile uint32_t _t_addr;

 public:
    Signal(T* t_ptr, uint32_t addr, std::string name);

    Signal(uint32_t addr, std::string name);

    explicit Signal(std::string name);

    ~Signal();

    T Read();

    void MapTo(bool keep_val = true);

    void MapTo(MemoryType* memptr, MemoryAddr address, bool keep_val = true);

    void Write(T val);

    void Inc(T val);

    void Dec(T val);

    uint32_t GetAddress();

    void SetAddress(MemoryAddr);

    std::string GetName();
};

// Some of the most used instances. More can be added later.
// for larger data size, consider using a Memory instead.
template class Signal<bool>;  // wire
template class Signal<uint8_t>;   // mem word
template class Signal<uint16_t>;  // dmni/noc word
template class Signal<uint32_t>;  // proc word
template class Signal<float>;    // float cooprocessor output
template class Signal<uint64_t>;  // double word
template class Signal<int8_t>;   // mem word
template class Signal<int16_t>;  // dmni/noc word
template class Signal<int32_t>;  // proc word
template class Signal<int64_t>;  // double word

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