ExtMaster.hh revision 10779
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 <sst/core/serialization.h> 52#include <sst/core/component.h> 53#include <sst/elements/memHierarchy/memEvent.h> 54 55#include <sim/sim_object.hh> 56#include <mem/packet.hh> 57#include <mem/request.hh> 58#include <mem/external_master.hh> 59 60namespace SST { 61 62using MemHierarchy::MemEvent; 63class Link; 64class Event; 65 66namespace MemHierarchy { 67class MemNIC; 68} 69 70namespace gem5 { 71 72class gem5Component; 73 74class ExtMaster : public ExternalMaster::Port { 75 76 enum Phase { CONSTRUCTION, INIT, RUN }; 77 78 Output& out; 79 const ExternalMaster& port; 80 Phase simPhase; 81 82 gem5Component *const gem5; 83 const std::string name; 84 std::list<PacketPtr> sendQ; 85 bool blocked() { return !sendQ.empty(); } 86 87 MemHierarchy::MemNIC * nic; 88 89 struct SenderState : public Packet::SenderState 90 { 91 MemEvent *event; 92 SenderState(MemEvent* e) : event(e) {} 93 }; 94 95 std::set<AddrRange> ranges; 96 97public: 98 bool recvTimingResp(PacketPtr); 99 void recvReqRetry(); 100 101 ExtMaster(gem5Component*, Output&, ExternalMaster&, std::string&); 102 void init(unsigned phase); 103 void setup(); 104 void finish(); 105 106 void clock(); 107 108 // receive Requests from SST bound for a gem5 slave; 109 // this module is "external" from gem5's perspective, thus ExternalMaster. 110 void handleEvent(SST::Event*); 111 112protected: 113 virtual void recvRangeChange(); 114}; 115 116} // namespace gem5 117} // namespace SST 118 119#endif 120