src/mem/ruby/network/garnet2.0/NetworkBridge.hh

   1 /*
   2  * Copyright (c) 2020 Advanced Micro Devices, Inc.
   3  * All rights reserved.
   4  *
   5  * For use for simulation and test purposes only
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions are met:
   9  *
  10  * 1. Redistributions of source code must retain the above copyright notice,
  11  * this list of conditions and the following disclaimer.
  12  *
  13  * 2. Redistributions in binary form must reproduce the above copyright notice,
  14  * this list of conditions and the following disclaimer in the documentation
  15  * and/or other materials provided with the distribution.
  16  *
  17  * 3. Neither the name of the copyright holder nor the names of its
  18  * contributors may be used to endorse or promote products derived from this
  19  * software without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  22  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
  25  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  26  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  27  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  28  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  29  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  30  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  31  * POSSIBILITY OF SUCH DAMAGE.
  32  *
  33  * Authors: Srikant Bharadwaj
  34  */
  35
  36 #ifndef __MEM_RUBY_NETWORK_GARNET2_0_NETWORK_BRIDGE_HH__
  37 #define __MEM_RUBY_NETWORK_GARNET2_0_NETWORK_BRIDGE_HH__
  38
  39 #include <iostream>
  40 #include <queue>
  41 #include <vector>
  42
  43 #include "mem/ruby/common/Consumer.hh"
  44 #include "mem/ruby/network/garnet2.0/CommonTypes.hh"
  45 #include "mem/ruby/network/garnet2.0/CreditLink.hh"
  46 #include "mem/ruby/network/garnet2.0/GarnetLink.hh"
  47 #include "mem/ruby/network/garnet2.0/NetworkLink.hh"
  48 #include "mem/ruby/network/garnet2.0/flitBuffer.hh"
  49 #include "params/NetworkBridge.hh"
  50
  51 class GarnetNetwork;
  52
  53 class NetworkBridge: public CreditLink
  54 {
  55   public:
  56     typedef NetworkBridgeParams Params;
  57     NetworkBridge(const Params *p);
  58     ~NetworkBridge();
  59
  60     void initBridge(NetworkBridge *coBrid, bool cdc_en, bool serdes_en);
  61
  62     void wakeup();
  63     void neutralize(int vc, int eCredit);
  64
  65     void scheduleFlit(flit *t_flit, Cycles latency);
  66     void flitisizeAndSend(flit *t_flit);
  67
  68   protected:
  69     // Pointer to co-existing bridge
  70     // CreditBridge for Network Bridge and vice versa
  71     NetworkBridge *coBridge;
  72
  73     // Link connected toBridge
  74     // could be a source or destination
  75     // depending on mType
  76     NetworkLink *nLink;
  77
  78     // CDC enable/disable
  79     bool enCdc;
  80     // SerDes enable/disable
  81     bool enSerDes;
  82
  83     // Type of Bridge
  84     int mType;
  85
  86     Cycles cdcLatency;
  87     Cycles serDesLatency;
  88
  89     Tick lastScheduledAt;
  90
  91     // Used by Credit Deserializer
  92     std::vector<int> lenBuffer;
  93     std::vector<int> sizeSent;
  94     std::vector<int> flitsSent;
  95     std::vector<std::queue<int>> extraCredit;
  96
  97 };
  98
  99 #endif // __MEM_RUBY_NETWORK_GARNET2_0_NETWORK_BRIDGE_HH__