resource_access_if.h

/*******************************************************************************
 * Copyright 2016, 2018 MINRES Technologies GmbH
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *******************************************************************************/
 
#ifndef _SYSC_RESOURCE_ACCESS_IF_H_
#define _SYSC_RESOURCE_ACCESS_IF_H_
 
#include <cstddef>
#include <cstdint>
#include <sysc/kernel/sc_time.h>
 
namespace scc {
class resource_access_if {
public:
    virtual ~resource_access_if() = default;
    virtual char const* full_name() const = 0;
    virtual std::size_t size() const = 0;
    virtual void reset() = 0;
    virtual bool write(const uint8_t* data, std::size_t length, uint64_t offset, sc_core::sc_time& d) = 0;
    inline bool write(const uint8_t* data, std::size_t length, uint64_t offset = 0) {
        sc_core::sc_time d;
        return write(data, length, offset, d);
    }
    virtual bool read(uint8_t* data, std::size_t length, uint64_t offset, sc_core::sc_time& d) const = 0;
    inline bool read(uint8_t* data, std::size_t length, uint64_t offset = 0) const {
        sc_core::sc_time d;
        return read(data, length, offset, d);
    }

    virtual bool write_dbg(const uint8_t* data, std::size_t length, uint64_t offset = 0) = 0;
    virtual bool read_dbg(uint8_t* data, std::size_t length, uint64_t offset = 0) const = 0;
};

class indexed_resource_access_if {
public:
    using value_type = resource_access_if;
    using pointer = value_type*;
    using const_pointer = const value_type*;
    using reference = value_type&;
    using const_reference = const value_type&;
    using iterator = resource_access_if*;
    using const_iterator = const resource_access_if*;
 
    virtual ~indexed_resource_access_if() = default;
    virtual std::size_t size() = 0;
    virtual reference operator[](std::size_t idx) noexcept = 0;
    virtual const_reference operator[](std::size_t idx) const noexcept = 0;
    virtual reference at(std::size_t idx) = 0;
    virtual const_reference at(std::size_t idx) const = 0;
};
} // namespace scc
#endif /* _SYSC_RESOURCE_ACCESS_IF_H_ */