controller_creator_base_step.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 CONTROLLER_CREATOR_BASE_STEP_HPP
#define CONTROLLER_CREATOR_BASE_STEP_HPP

#include "hls_function_step.hpp"

#include "graph.hpp"

#include <fstream>

#include "custom_map.hpp"
#include "custom_set.hpp"
#include <tuple>

#include "refcount.hpp"

REF_FORWARD_DECL(hls);
REF_FORWARD_DECL(structural_object);
REF_FORWARD_DECL(generic_obj);
REF_FORWARD_DECL(structural_manager);
class xml_element;

class ControllerCreatorBaseStep : public HLSFunctionStep
{
 protected:
   const CustomUnorderedSet<std::tuple<HLSFlowStep_Type, HLSFlowStepSpecializationConstRef, HLSFlowStep_Relationship>>
   ComputeHLSRelationships(const DesignFlowStep::RelationshipType relationship_type) const override;

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

   ~ControllerCreatorBaseStep() override;

 protected:
   void Initialize() override;

   virtual void add_common_ports(structural_objectRef circuit, structural_managerRef SM);

   std::map<generic_objRef, unsigned int> out_ports;

   std::map<vertex, unsigned int> cond_ports;
   std::map<vertex, unsigned int> mu_ports;

   unsigned int out_num;

   unsigned int in_num;

 private:
   void add_clock_reset(structural_objectRef circuit, structural_managerRef SM);

   void add_done_port(structural_objectRef circuit, structural_managerRef SM);

   void add_start_port(structural_objectRef circuit, structural_managerRef SM);

   void add_command_ports(structural_objectRef circuit, structural_managerRef SM);
};
using ControllerCreatorBaseStepRef = refcount<ControllerCreatorBaseStep>;

#endif