ram_port_component.h

Go to the documentation of this file.

// MIT License
//
// Copyright (c) 2019 Ruhr University Bochum, Chair for Embedded Security. All Rights reserved.
// Copyright (c) 2019 Marc Fyrbiak, Sebastian Wallat, Max Hoffmann ("ORIGINAL AUTHORS"). All rights reserved.
// Copyright (c) 2021 Max Planck Institute for Security and Privacy. All Rights reserved.
// Copyright (c) 2021 Jörn Langheinrich, Julian Speith, Nils Albartus, René Walendy, Simon Klix ("ORIGINAL AUTHORS"). All Rights reserved.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
 
#pragma once
 
#include "hal_core/netlist/boolean_function.h"
#include "hal_core/netlist/gate_library/gate_type_component/gate_type_component.h"
 
#include <memory>
 
namespace hal
{
    class RAMPortComponent : public GateTypeComponent
    {
    public:
        static std::unique_ptr<RAMPortComponent> create(std::unique_ptr<GateTypeComponent> component,
                                                        const std::string& data_group,
                                                        const std::string& addr_group,
                                                        const BooleanFunction& clock_bf,
                                                        const BooleanFunction& enable_bf,
                                                        bool is_write);
 
        ComponentType get_type() const override;
 
        static bool is_class_of(const GateTypeComponent* component);
 
        std::vector<GateTypeComponent*> get_components(const std::function<bool(const GateTypeComponent*)>& filter = nullptr) const override;
 
        // TODO add tests for functions below
 
        const std::string& get_data_group() const;
 
        void set_data_group(const std::string& data_group);
 
        const std::string& get_address_group() const;
 
        void set_address_group(const std::string& addr_group);
 
        const BooleanFunction& get_clock_function() const;
 
        void set_clock_function(const BooleanFunction& clock_bf);
 
        const BooleanFunction& get_enable_function() const;
 
        void set_enable_function(const BooleanFunction& enable_bf);
 
        bool is_write_port() const;
 
        void set_write_port(bool is_write);
 
    private:
        RAMPortComponent(std::unique_ptr<GateTypeComponent> component,
                         const std::string& data_group,
                         const std::string& addr_group,
                         const BooleanFunction& clock_bf,
                         const BooleanFunction& enable_bf,
                         bool is_write);
 
        static constexpr ComponentType m_type          = ComponentType::ram_port;
        std::unique_ptr<GateTypeComponent> m_component = nullptr;
 
        std::string m_data_group    = "";
        std::string m_addr_group    = "";
        BooleanFunction m_clock_bf  = BooleanFunction();
        BooleanFunction m_enable_bf = BooleanFunction();
        bool m_is_write;
    };
}    // namespace hal