ext/sst/ExtMaster.hh

   1 // Copyright (c) 2015 ARM Limited
   2 // All rights reserved.
   3 //
   4 // The license below extends only to copyright in the software and shall
   5 // not be construed as granting a license to any other intellectual
   6 // property including but not limited to intellectual property relating
   7 // to a hardware implementation of the functionality of the software
   8 // licensed hereunder.  You may use the software subject to the license
   9 // terms below provided that you ensure that this notice is replicated
  10 // unmodified and in its entirety in all distributions of the software,
  11 // modified or unmodified, in source code or in binary form.
  12 //
  13 // Redistribution and use in source and binary forms, with or without
  14 // modification, are permitted provided that the following conditions are
  15 // met: redistributions of source code must retain the above copyright
  16 // notice, this list of conditions and the following disclaimer;
  17 // redistributions in binary form must reproduce the above copyright
  18 // notice, this list of conditions and the following disclaimer in the
  19 // documentation and/or other materials provided with the distribution;
  20 // neither the name of the copyright holders nor the names of its
  21 // contributors may be used to endorse or promote products derived from
  22 // this software without specific prior written permission.
  23 //
  24 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  25 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  26 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  27 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  28 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  29 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  30 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  31 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  32 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  33 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  34 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  35
  36 // Copyright 2009-2014 Sandia Coporation.  Under the terms
  37 // of Contract DE-AC04-94AL85000 with Sandia Corporation, the U.S.
  38 // Government retains certain rights in this software.
  39 //
  40 // Copyright (c) 2009-2014, Sandia Corporation
  41 // All rights reserved.
  42 //
  43 // For license information, see the LICENSE file in the current directory.
  44
  45 #ifndef EXT_SST_EXTMASTER_HH
  46 #define EXT_SST_EXTMASTER_HH
  47
  48 #include <list>
  49 #include <set>
  50
  51 #include <core/component.h>
  52 #include <elements/memHierarchy/memEvent.h>
  53
  54 #include <sim/sim_object.hh>
  55 #include <mem/packet.hh>
  56 #include <mem/request.hh>
  57 #include <mem/external_master.hh>
  58
  59 namespace SST {
  60
  61 using MemHierarchy::MemEvent;
  62 class Link;
  63 class Event;
  64
  65 namespace MemHierarchy {
  66 class MemNIC;
  67 }
  68
  69 namespace gem5 {
  70
  71 class gem5Component;
  72
  73 class ExtMaster : public ExternalMaster::Port {
  74
  75     enum Phase { CONSTRUCTION, INIT, RUN };
  76
  77     Output& out;
  78     const ExternalMaster& port;
  79     Phase simPhase;
  80
  81     gem5Component *const gem5;
  82     const std::string name;
  83     std::list<PacketPtr> sendQ;
  84     bool blocked() { return !sendQ.empty(); }
  85
  86     MemHierarchy::MemNIC * nic;
  87
  88     struct SenderState : public Packet::SenderState
  89     {
  90         MemEvent *event;
  91         SenderState(MemEvent* e) : event(e) {}
  92     };
  93
  94     std::set<AddrRange> ranges;
  95
  96 public:
  97     bool recvTimingResp(PacketPtr);
  98     void recvReqRetry();
  99
 100     ExtMaster(gem5Component*, Output&, ExternalMaster&, std::string&);
 101     void init(unsigned phase);
 102     void setup();
 103     void finish();
 104
 105     void clock();
 106
 107     // receive Requests from SST bound for a gem5 slave;
 108     // this module is "external" from gem5's perspective, thus ExternalMaster.
 109     void handleEvent(SST::Event*);
 110
 111 protected:
 112     virtual void recvRangeChange();
 113 };
 114
 115 } // namespace gem5
 116 } // namespace SST
 117
 118 #endif