lut_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/gate_library/gate_type_component/gate_type_component.h"
#include "hal_core/netlist/pins/gate_pin.h"
#include "hal_core/utilities/result.h"
 
#include <memory>
#include <string>
#include <unordered_map>
#include <vector>
 
namespace hal
{
    class Gate;
 
    class LUTComponent : public GateTypeComponent
    {
    public:
        struct LUTOutputConfig
        {
            LUTOutputConfig(std::string init_identifier,
                            u32 bit_offset,
                            u32 bit_count,
                            bool is_ascending,
                            std::vector<std::string> input_pins)
                : init_identifier(std::move(init_identifier)),
                  bit_offset(bit_offset),
                  bit_count(bit_count),
                  is_ascending(is_ascending),
                  input_pins(std::move(input_pins))
            {
            }
 
            std::string init_identifier;
            u32 bit_offset               = 0;
            u32 bit_count                = 0;
            bool is_ascending            = false;
            std::vector<std::string> input_pins;
        };
 
        static std::unique_ptr<LUTComponent> create(std::unordered_map<std::string, LUTOutputConfig> configs = {});
 
        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;
 
        const LUTOutputConfig* get_output_pin_config(const std::string& pin_name) const;
 
        const std::unordered_map<std::string, LUTOutputConfig>& get_output_pin_configs() const;
 
        static Result<std::string> extract_init_slice(const std::string& full_hex, u32 bit_offset, u32 bit_count);
 
        static Result<std::string> splice_init_slice(const std::string& full_hex, const std::string& slice_hex, u32 bit_offset, u32 bit_count);
 
        Result<std::string> get_init_string(const Gate* gate, const std::string& pin_name) const;
 
        Result<std::string> get_init_string(const Gate* gate, const GatePin* pin) const;
 
        Result<std::monostate> set_init_string(Gate* gate, const std::string& pin_name, const std::string& hex) const;
 
        Result<std::monostate> set_init_string(Gate* gate, const GatePin* pin, const std::string& hex) const;
 
    private:
        explicit LUTComponent(std::unordered_map<std::string, LUTOutputConfig> configs);
 
        static constexpr ComponentType m_type = ComponentType::lut;
        std::unordered_map<std::string, LUTOutputConfig> m_output_pin_configs;
    };
}    // namespace hal