HermesRouter.hpp

Go to the documentation of this file.

/******************************************************************************
 * This file is part of project ORCA. More information on the project
 * can be found at the following repositories at GitHub's website.
 *
 * http://https://github.com/andersondomingues/orca-sim
 * http://https://github.com/andersondomingues/orca-software
 * http://https://github.com/andersondomingues/orca-mpsoc
 * http://https://github.com/andersondomingues/orca-tools
 *
 * Copyright (C) 2018-2020 Anderson Domingues, <ti.andersondomingues@gmail.com>
 *
 * This program 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 2 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, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 
******************************************************************************/
#ifndef MODELS_HERMES_ROUTER_INCLUDE_HERMESROUTER_HPP_
#define MODELS_HERMES_ROUTER_INCLUDE_HERMESROUTER_HPP_

// std API
#include <iostream>
#include <string>

// simulator API
#include "TimedModel.hpp"
#include "Buffer.hpp"
#include "Signal.hpp"
#include "FlitType.hpp"

#ifndef BUFFER_CAPACITY
#define BUFFER_CAPACITY 8
#pragma message "Buffer capacity not defined in HermesRouter, set to 8 flits"
#endif

namespace orcasim::models::hermes {

enum class RouterState{
    ROUNDROBIN, FORWARD1, PKTLEN, BURST
};

// routing ports
#define NORTH 0
#define WEST  1
#define SOUTH 2
#define EAST  3
#define LOCAL 4

using orcasim::base::TimedModel;
using orcasim::base::SimulationTime;
using orcasim::modeling::Buffer;

class HermesRouter: public TimedModel{
 private:
    #ifdef ROUTER_ENABLE_COUNTERS
    Signal<uint32_t>* _counter_active;
    #endif

    #ifdef ROUTER_ENABLE_COUNTERS
    bool is_active = false;
    #endif

    // stores info about actively sending ports. For intance, position zero
    // representing the status of LOCAL port. The value in the position indicate
    // to which port the LOCAL port is sending to. Inactive ports have -1
    // written to their position.
    int16_t _switch_control[5];

    // stores how many flits the must be forwarded to the destination port
    int16_t _flits_to_send[5];

    // stores which port has the priority acconding to the round robin policy
    uint32_t _round_robin;

    // address of the router
    uint32_t _x, _y;

    // output buffers
    Buffer<FlitType>* _ob[5];

    // input buffers
    Buffer<FlitType>* _ib[5];

 public:
    #ifdef ROUTER_ENABLE_COUNTERS
    Signal<uint32_t>* GetSignalCounterActive();
    #endif

    uint32_t GetRR();

    Buffer<FlitType>* GetOutputBuffer(uint32_t p);
    Buffer<FlitType>* GetInputBuffer(uint32_t p);

    void SetOutputBuffer(Buffer<FlitType>* b, uint32_t port);

    SimulationTime Run();

    uint32_t GetRouteXY(FlitType flit);

    HermesRouter(std::string name, uint32_t x_pos, uint32_t y_pos);

    ~HermesRouter();

    std::string GetPortName(int port);

    void Reset();
    std::string ToString();
};

}  // namespace orcasim::models::hermes
#endif  // MODELS_HERMES_ROUTER_INCLUDE_HERMESROUTER_HPP_