module_interface.hpp

Go to the documentation of this file.

/*
 *
 *                   _/_/_/    _/_/   _/    _/ _/_/_/    _/_/
 *                  _/   _/ _/    _/ _/_/  _/ _/   _/ _/    _/
 *                 _/_/_/  _/_/_/_/ _/  _/_/ _/   _/ _/_/_/_/
 *                _/      _/    _/ _/    _/ _/   _/ _/    _/
 *               _/      _/    _/ _/    _/ _/_/_/  _/    _/
 *
 *             ***********************************************
 *                              PandA Project
 *                     URL: http://panda.dei.polimi.it
 *                       Politecnico di Milano - DEIB
 *                        System Architectures Group
 *             ***********************************************
 *              Copyright (C) 2004-2024 Politecnico di Milano
 *
 *   This file is part of the PandA framework.
 *
 *   The PandA framework 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 3 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, see <http://www.gnu.org/licenses/>.
 *
 */
#ifndef _MODULE_INTERFACE_HPP_
#define _MODULE_INTERFACE_HPP_

#include "hls_function_step.hpp"
REF_FORWARD_DECL(module_interface);
REF_FORWARD_DECL(structural_manager);
REF_FORWARD_DECL(structural_object);

class module_interface : public HLSFunctionStep
{
 protected:
   void add_sign(const structural_managerRef SM, const structural_objectRef sig1, const structural_objectRef sig2,
                 const std::string& sig_name);

   void AddSignal(const structural_managerRef SM, const structural_objectRef component1, const std::string& port1,
                  const structural_objectRef component2, const std::string& port2, const std::string& signal_name);

   void AddConnection(const structural_managerRef SM, const structural_objectRef component1, const std::string& port1,
                      const structural_objectRef component2, const std::string& port2);

   void AddConstant(const structural_managerRef SM, const structural_objectRef component, const std::string& port,
                    const std::string& constant, const unsigned long long size);

   void add_sign_vector(const structural_managerRef SM, const structural_objectRef sig1,
                        const structural_objectRef sig2, const std::string& sig_name);

   const CustomUnorderedSet<std::tuple<HLSFlowStep_Type, HLSFlowStepSpecializationConstRef, HLSFlowStep_Relationship>>
   ComputeHLSRelationships(const DesignFlowStep::RelationshipType relationship_type) const override;

 public:
   module_interface(const ParameterConstRef _parameters, const HLS_managerRef HLSMgr, unsigned int funId,
                    const DesignFlowManagerConstRef design_flow_manager, const HLSFlowStep_Type hls_flow_step_type);

   ~module_interface() override;
};

#endif