state_table_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/utilities/result.h"
 
#include <memory>
#include <string>
#include <vector>
 
namespace hal
{
    class GatePin;
 
    class StateTableComponent : public GateTypeComponent
    {
    public:
        enum class TableInputSymbol
        {
            LOW,        
            HIGH,       
            DONT_CARE,  
            RISING,     
            FALLING,    
            NOT_RISING, 
            NOT_FALLING 
        };
 
        enum class TableOutputSymbol
        {
            LOW,         
            HIGH,        
            UNSPECIFIED, 
            UNKNOWN,     
            HOLD         
        };
 
        struct TableRow
        {
            std::vector<TableInputSymbol> input_values;
            std::vector<TableInputSymbol> current_state_values;
            TableOutputSymbol next_state_value;
        };
 
        struct StateTable
        {
            std::string pin_name;                        
            std::vector<std::string> input_pins;         
            std::vector<std::string> current_state_pins; 
            std::vector<TableRow> rows;                  
        };
 
        static std::unique_ptr<StateTableComponent> create(std::unique_ptr<GateTypeComponent> component, std::vector<StateTable> tables);
 
        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 std::vector<StateTable>& get_state_tables() const;
 
        Result<const StateTable*> get_state_table_for_pin(const std::string& pin_name) const;
 
        Result<const StateTable*> get_state_table_for_pin(const GatePin* pin) const;
 
    private:
        StateTableComponent(std::unique_ptr<GateTypeComponent> component, std::vector<StateTable> tables);
 
        static constexpr ComponentType m_type          = ComponentType::state_table;
        std::unique_ptr<GateTypeComponent> m_component = nullptr;
        std::vector<StateTable> m_tables;
    };
}    // namespace hal