port.hh

Go to the documentation of this file.

/*
 * Copyright (c) 2011-2012,2015,2017 ARM Limited
 * All rights reserved
 *
 * The license below extends only to copyright in the software and shall
 * not be construed as granting a license to any other intellectual
 * property including but not limited to intellectual property relating
 * to a hardware implementation of the functionality of the software
 * licensed hereunder.  You may use the software subject to the license
 * terms below provided that you ensure that this notice is replicated
 * unmodified and in its entirety in all distributions of the software,
 * modified or unmodified, in source code or in binary form.
 *
 * Copyright (c) 2002-2005 The Regents of The University of Michigan
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met: redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer;
 * redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution;
 * neither the name of the copyright holders nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef __MEM_PORT_HH__
#define __MEM_PORT_HH__

#include "base/addr_range.hh"
#include "mem/packet.hh"
#include "mem/protocol/atomic.hh"
#include "mem/protocol/functional.hh"
#include "mem/protocol/timing.hh"
#include "sim/port.hh"

class SimObject;

class SlavePort;

class MasterPort : public Port, public AtomicRequestProtocol,
    public TimingRequestProtocol, public FunctionalRequestProtocol
{
    friend class SlavePort;

  private:
    SlavePort *_slavePort;

  protected:
    SimObject &owner;

  public:
    MasterPort(const std::string& name, SimObject* _owner,
               PortID id=InvalidPortID);
    virtual ~MasterPort();

    void bind(Port &peer) override;

    void unbind() override;

    virtual bool isSnooping() const { return false; }

    AddrRangeList getAddrRanges() const;

    void printAddr(Addr a);

  public:
    /* The atomic protocol. */

    Tick sendAtomic(PacketPtr pkt);

    Tick sendAtomicBackdoor(PacketPtr pkt, MemBackdoorPtr &backdoor);

  public:
    /* The functional protocol. */

    void sendFunctional(PacketPtr pkt) const;

  public:
    /* The timing protocol. */

    bool sendTimingReq(PacketPtr pkt);

    bool tryTiming(PacketPtr pkt) const;

    bool sendTimingSnoopResp(PacketPtr pkt);

    virtual void sendRetryResp();

  protected:
    virtual void recvRangeChange() { }

    Tick
    recvAtomicSnoop(PacketPtr pkt) override
    {
        panic("%s was not expecting an atomic snoop request\n", name());
        return 0;
    }

    void
    recvFunctionalSnoop(PacketPtr pkt) override
    {
        panic("%s was not expecting a functional snoop request\n", name());
    }

    void
    recvTimingSnoopReq(PacketPtr pkt) override
    {
        panic("%s was not expecting a timing snoop request.\n", name());
    }

    void
    recvRetrySnoopResp() override
    {
        panic("%s was not expecting a snoop retry.\n", name());
    }
};

class SlavePort : public Port, public AtomicResponseProtocol,
    public TimingResponseProtocol, public FunctionalResponseProtocol
{
    friend class MasterPort;

  private:
    MasterPort* _masterPort;
    bool defaultBackdoorWarned;

  protected:
    SimObject& owner;

  public:
    SlavePort(const std::string& name, SimObject* _owner,
              PortID id=InvalidPortID);
    virtual ~SlavePort();

    bool isSnooping() const { return _masterPort->isSnooping(); }

    void
    sendRangeChange() const
    {
        fatal_if(!_masterPort,
                "%s cannot sendRangeChange() without master port.", name());
        _masterPort->recvRangeChange();
    }

    virtual AddrRangeList getAddrRanges() const = 0;

    void unbind() override {}
    void bind(Port &peer) override {}

  public:
    /* The atomic protocol. */

    Tick
    sendAtomicSnoop(PacketPtr pkt)
    {
        return AtomicResponseProtocol::sendSnoop(_masterPort, pkt);
    }

  public:
    /* The functional protocol. */

    void
    sendFunctionalSnoop(PacketPtr pkt) const
    {
        FunctionalResponseProtocol::sendSnoop(_masterPort, pkt);
    }

  public:
    /* The timing protocol. */

    bool
    sendTimingResp(PacketPtr pkt)
    {
        return TimingResponseProtocol::sendResp(_masterPort, pkt);
    }

    void
    sendTimingSnoopReq(PacketPtr pkt)
    {
        TimingResponseProtocol::sendSnoopReq(_masterPort, pkt);
    }

    void
    sendRetryReq()
    {
        TimingResponseProtocol::sendRetryReq(_masterPort);
    }

    void
    sendRetrySnoopResp()
    {
        TimingResponseProtocol::sendRetrySnoopResp(_masterPort);
    }

  protected:
    void slaveUnbind();

    void slaveBind(MasterPort& master_port);

    Tick recvAtomicBackdoor(PacketPtr pkt, MemBackdoorPtr &backdoor) override;

    bool
    tryTiming(PacketPtr pkt) override
    {
        panic("%s was not expecting a %s\n", name(), __func__);
    }

    bool
    recvTimingSnoopResp(PacketPtr pkt) override
    {
        panic("%s was not expecting a timing snoop response\n", name());
    }
};

inline Tick
MasterPort::sendAtomic(PacketPtr pkt)
{
    return AtomicRequestProtocol::send(_slavePort, pkt);
}

inline Tick
MasterPort::sendAtomicBackdoor(PacketPtr pkt, MemBackdoorPtr &backdoor)
{
    return AtomicRequestProtocol::sendBackdoor(_slavePort, pkt, backdoor);
}

inline void
MasterPort::sendFunctional(PacketPtr pkt) const
{
    return FunctionalRequestProtocol::send(_slavePort, pkt);
}

inline bool
MasterPort::sendTimingReq(PacketPtr pkt)
{
    return TimingRequestProtocol::sendReq(_slavePort, pkt);
}

inline bool
MasterPort::tryTiming(PacketPtr pkt) const
{
    return TimingRequestProtocol::trySend(_slavePort, pkt);
}

inline bool
MasterPort::sendTimingSnoopResp(PacketPtr pkt)
{
    return TimingRequestProtocol::sendSnoopResp(_slavePort, pkt);
}

inline void
MasterPort::sendRetryResp()
{
    TimingRequestProtocol::sendRetryResp(_slavePort);
}

#endif //__MEM_PORT_HH__