ExtMaster.hh revision 11618
110695SAli.Saidi@ARM.com// Copyright (c) 2015 ARM Limited 210695SAli.Saidi@ARM.com// All rights reserved. 310695SAli.Saidi@ARM.com// 410695SAli.Saidi@ARM.com// The license below extends only to copyright in the software and shall 510695SAli.Saidi@ARM.com// not be construed as granting a license to any other intellectual 610695SAli.Saidi@ARM.com// property including but not limited to intellectual property relating 710695SAli.Saidi@ARM.com// to a hardware implementation of the functionality of the software 810695SAli.Saidi@ARM.com// licensed hereunder. You may use the software subject to the license 910695SAli.Saidi@ARM.com// terms below provided that you ensure that this notice is replicated 1010695SAli.Saidi@ARM.com// unmodified and in its entirety in all distributions of the software, 1110695SAli.Saidi@ARM.com// modified or unmodified, in source code or in binary form. 1210695SAli.Saidi@ARM.com// 1310695SAli.Saidi@ARM.com// Redistribution and use in source and binary forms, with or without 1410695SAli.Saidi@ARM.com// modification, are permitted provided that the following conditions are 1510695SAli.Saidi@ARM.com// met: redistributions of source code must retain the above copyright 1610695SAli.Saidi@ARM.com// notice, this list of conditions and the following disclaimer; 1710695SAli.Saidi@ARM.com// redistributions in binary form must reproduce the above copyright 1810695SAli.Saidi@ARM.com// notice, this list of conditions and the following disclaimer in the 1910695SAli.Saidi@ARM.com// documentation and/or other materials provided with the distribution; 2010695SAli.Saidi@ARM.com// neither the name of the copyright holders nor the names of its 2110695SAli.Saidi@ARM.com// contributors may be used to endorse or promote products derived from 2210695SAli.Saidi@ARM.com// this software without specific prior written permission. 2310695SAli.Saidi@ARM.com// 2410695SAli.Saidi@ARM.com// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 2510695SAli.Saidi@ARM.com// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 2610695SAli.Saidi@ARM.com// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 2710695SAli.Saidi@ARM.com// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 2810695SAli.Saidi@ARM.com// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 2910695SAli.Saidi@ARM.com// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 3010695SAli.Saidi@ARM.com// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 3110695SAli.Saidi@ARM.com// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 3210695SAli.Saidi@ARM.com// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 3310695SAli.Saidi@ARM.com// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 3410695SAli.Saidi@ARM.com// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 3510695SAli.Saidi@ARM.com 3610695SAli.Saidi@ARM.com// Copyright 2009-2014 Sandia Coporation. Under the terms 3710695SAli.Saidi@ARM.com// of Contract DE-AC04-94AL85000 with Sandia Corporation, the U.S. 3810695SAli.Saidi@ARM.com// Government retains certain rights in this software. 3910695SAli.Saidi@ARM.com// 4010695SAli.Saidi@ARM.com// Copyright (c) 2009-2014, Sandia Corporation 4110695SAli.Saidi@ARM.com// All rights reserved. 4210695SAli.Saidi@ARM.com// 4310695SAli.Saidi@ARM.com// For license information, see the LICENSE file in the current directory. 4410695SAli.Saidi@ARM.com 4510695SAli.Saidi@ARM.com#ifndef EXT_SST_EXTMASTER_HH 4610695SAli.Saidi@ARM.com#define EXT_SST_EXTMASTER_HH 4710695SAli.Saidi@ARM.com 4810695SAli.Saidi@ARM.com#include <list> 4910695SAli.Saidi@ARM.com#include <set> 5010695SAli.Saidi@ARM.com 5110695SAli.Saidi@ARM.com#include <core/component.h> 5210695SAli.Saidi@ARM.com#include <elements/memHierarchy/memEvent.h> 5310695SAli.Saidi@ARM.com 5410695SAli.Saidi@ARM.com#include <sim/sim_object.hh> 5510695SAli.Saidi@ARM.com#include <mem/packet.hh> 5610695SAli.Saidi@ARM.com#include <mem/request.hh> 5710695SAli.Saidi@ARM.com#include <mem/external_master.hh> 5810695SAli.Saidi@ARM.com 5910695SAli.Saidi@ARM.comnamespace SST { 6010695SAli.Saidi@ARM.com 6110695SAli.Saidi@ARM.comusing MemHierarchy::MemEvent; 6210695SAli.Saidi@ARM.comclass Link; 6310695SAli.Saidi@ARM.comclass Event; 6410695SAli.Saidi@ARM.com 6510695SAli.Saidi@ARM.comnamespace MemHierarchy { 6610695SAli.Saidi@ARM.comclass MemNIC; 6710695SAli.Saidi@ARM.com} 6810695SAli.Saidi@ARM.com 6910695SAli.Saidi@ARM.comnamespace gem5 { 7010695SAli.Saidi@ARM.com 7110695SAli.Saidi@ARM.comclass gem5Component; 7210695SAli.Saidi@ARM.com 7310695SAli.Saidi@ARM.comclass ExtMaster : public ExternalMaster::Port { 7410695SAli.Saidi@ARM.com 7510695SAli.Saidi@ARM.com enum Phase { CONSTRUCTION, INIT, RUN }; 7610695SAli.Saidi@ARM.com 7710695SAli.Saidi@ARM.com Output& out; 7810695SAli.Saidi@ARM.com const ExternalMaster& port; 7910695SAli.Saidi@ARM.com Phase simPhase; 8010695SAli.Saidi@ARM.com 8110695SAli.Saidi@ARM.com gem5Component *const gem5; 8210695SAli.Saidi@ARM.com const std::string name; 8310695SAli.Saidi@ARM.com std::list<PacketPtr> sendQ; 8410695SAli.Saidi@ARM.com bool blocked() { return !sendQ.empty(); } 8510695SAli.Saidi@ARM.com 8610695SAli.Saidi@ARM.com MemHierarchy::MemNIC * nic; 8710695SAli.Saidi@ARM.com 8810695SAli.Saidi@ARM.com struct SenderState : public Packet::SenderState 8910695SAli.Saidi@ARM.com { 9010695SAli.Saidi@ARM.com MemEvent *event; 9110695SAli.Saidi@ARM.com SenderState(MemEvent* e) : event(e) {} 9210695SAli.Saidi@ARM.com }; 9310695SAli.Saidi@ARM.com 9410695SAli.Saidi@ARM.com std::set<AddrRange> ranges; 9510695SAli.Saidi@ARM.com 9610695SAli.Saidi@ARM.compublic: 9710695SAli.Saidi@ARM.com bool recvTimingResp(PacketPtr); 9810695SAli.Saidi@ARM.com void recvReqRetry(); 9910695SAli.Saidi@ARM.com 10010695SAli.Saidi@ARM.com ExtMaster(gem5Component*, Output&, ExternalMaster&, std::string&); 10110695SAli.Saidi@ARM.com void init(unsigned phase); 10210695SAli.Saidi@ARM.com void setup(); 10310695SAli.Saidi@ARM.com void finish(); 10410695SAli.Saidi@ARM.com 10510695SAli.Saidi@ARM.com void clock(); 10610695SAli.Saidi@ARM.com 10710695SAli.Saidi@ARM.com // 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 111protected: 112 virtual void recvRangeChange(); 113}; 114 115} // namespace gem5 116} // namespace SST 117 118#endif 119