HDL_manager.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 HDL_MANAGER_HPP
#define HDL_MANAGER_HPP

#include "config_HAVE_FLOPOCO.hpp"

#include "design_flow_step.hpp"

#include <list>
#include <ostream>
#include <string>
#include <vector>

#include "refcount.hpp"

REF_FORWARD_DECL(HDL_manager);
REF_FORWARD_DECL(HLS_manager);
REF_FORWARD_DECL(structural_object);
REF_FORWARD_DECL(language_writer);
REF_FORWARD_DECL(generic_device);
REF_FORWARD_DECL(flopoco_wrapper);
REF_FORWARD_DECL(structural_manager);
CONSTREF_FORWARD_DECL(technology_manager);
CONSTREF_FORWARD_DECL(Parameter);
enum class HDLWriter_Language;

class HDL_manager
{
 private:
   const HLS_managerRef HLSMgr;

   const generic_deviceRef device;

   const technology_managerConstRef TM;

#if HAVE_FLOPOCO
   const flopoco_wrapperRef flopo_wrap;
#endif

   const structural_managerRef SM;

   const ParameterConstRef parameters;

   const int debug_level;

   void get_post_order_structural_components(const structural_objectRef cir,
                                             std::list<structural_objectRef>& list_of_com) const;

   std::string write_components(const std::string& filename, const HDLWriter_Language language,
                                const std::list<structural_objectRef>& components,
                                std::list<std::string>& aux_files) const;

   void write_components(const std::string& filename, const std::list<structural_objectRef>& components,
                         std::list<std::string>& hdl_files, std::list<std::string>& aux_files, bool tb);

   void write_module(const language_writerRef writer, const structural_objectRef cir,
                     std::list<std::string>& aux_files) const;

   void write_flopoco_module(const structural_objectRef& cir, std::list<std::string>& aux_files) const;

   void io_signal_fix_ith(const language_writerRef writer, const structural_objectRef po, bool& lspf) const;
   void io_signal_fix_ith_vector(const language_writerRef writer, const structural_objectRef po, bool& lspf) const;

   bool is_fsm(const structural_objectRef& cir) const;

   void write_fsm(const language_writerRef writer, const structural_objectRef& cir, const std::string& fsm_desc) const;

   void write_behavioral(const language_writerRef writer, const structural_objectRef& cir,
                         const std::string& behav) const;

 public:
   HDL_manager(const HLS_managerRef _HLSMgr, const generic_deviceRef device, const ParameterConstRef parameters);

   HDL_manager(const HLS_managerRef HLSMgr, const generic_deviceRef device, const structural_managerRef SM,
               const ParameterConstRef parameters);

   ~HDL_manager();

   void hdl_gen(const std::string& filename, const std::list<structural_objectRef>& cirs,
                std::list<std::string>& hdl_files, std::list<std::string>& aux_files, bool tb);

   static std::string convert_to_identifier(const language_writer* writer, const std::string& id);

   static std::string get_mod_typename(const language_writer* lan, const structural_objectRef& cir);

#if HAVE_FLOPOCO

   const flopoco_wrapperRef get_flopocowrapper() const
   {
      return flopo_wrap;
   }
#endif
};
using HDL_managerRef = refcount<HDL_manager>;
#endif