TopEntityMemoryMapped.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 _TOPENTITYMEMORYMAPPED_H_
#define _TOPENTITYMEMORYMAPPED_H_

#include "custom_set.hpp"
#include "top_entity.hpp"

#include <list>
#include <string>

class module;
enum class MemoryAllocation_ChannelsType;

class TopEntityMemoryMapped : public top_entity
{
 public:
   TopEntityMemoryMapped(const ParameterConstRef _parameters, const HLS_managerRef HLSMgr, unsigned int funId,
                         const DesignFlowManagerConstRef design_flow_manager);

   ~TopEntityMemoryMapped() override;

   DesignFlowStep_Status InternalExec() override;

 private:
   std::list<std::string> ParametersName;
   std::list<structural_objectRef> AddedComponents;
   bool needMemoryMappedRegisters{false};

   bool is_root_function{false};

   unsigned int _channels_number;

   MemoryAllocation_ChannelsType _channels_type;

   void allocate_parameters() const;

   void insertMemoryMappedRegister(structural_managerRef SM, structural_objectRef wrappedObj);

   void insertStartDoneLogic(structural_managerRef SM, structural_objectRef wrappedObj);

   void insertStatusRegister(structural_managerRef SM, structural_objectRef wrappedObj);

   void resizing_IO(module* fu_module, unsigned int max_n_ports) const;

   void Initialize() override;
};

#endif /* _TOPENTITYMEMORYMAPPED_H_ */