top_entity.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 TOP_ENTITY_HPP
#define TOP_ENTITY_HPP

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

class top_entity : public HLSFunctionStep
{
 protected:
   structural_managerRef SM;

   void add_ports(structural_objectRef circuit, structural_objectRef clock_port, structural_objectRef reset_port);

   void add_command_signals(structural_objectRef circuit);

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

   virtual void add_input_register(structural_objectRef port_in, const std::string& port_prefix,
                                   structural_objectRef circuit, structural_objectRef clock_port,
                                   structural_objectRef reset_port, structural_objectRef e_port);

 public:
   top_entity(const ParameterConstRef _parameters, const HLS_managerRef HLSMgr, unsigned int funId,
              const DesignFlowManagerConstRef design_flow_manager,
              const HLSFlowStep_Type = HLSFlowStep_Type::TOP_ENTITY_CREATION);

   ~top_entity() override;

   DesignFlowStep_Status InternalExec() override;
};
#endif