src/mem/mport.hh

   1 /*
   2  * Copyright (c) 2012 ARM Limited
   3  * All rights reserved
   4  *
   5  * The license below extends only to copyright in the software and shall
   6  * not be construed as granting a license to any other intellectual
   7  * property including but not limited to intellectual property relating
   8  * to a hardware implementation of the functionality of the software
   9  * licensed hereunder.  You may use the software subject to the license
  10  * terms below provided that you ensure that this notice is replicated
  11  * unmodified and in its entirety in all distributions of the software,
  12  * modified or unmodified, in source code or in binary form.
  13  *
  14  * Copyright (c) 2008 The Regents of The University of Michigan
  15  * All rights reserved.
  16  *
  17  * Redistribution and use in source and binary forms, with or without
  18  * modification, are permitted provided that the following conditions are
  19  * met: redistributions of source code must retain the above copyright
  20  * notice, this list of conditions and the following disclaimer;
  21  * redistributions in binary form must reproduce the above copyright
  22  * notice, this list of conditions and the following disclaimer in the
  23  * documentation and/or other materials provided with the distribution;
  24  * neither the name of the copyright holders nor the names of its
  25  * contributors may be used to endorse or promote products derived from
  26  * this software without specific prior written permission.
  27  *
  28  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  29  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  30  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  31  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  32  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  33  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  34  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  35  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  36  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  37  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  38  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  39  *
  40  * Authors: Gabe Black
  41  */
  42
  43 #ifndef __MEM_MPORT_HH__
  44 #define __MEM_MPORT_HH__
  45
  46 #include "mem/mem_object.hh"
  47 #include "mem/tport.hh"
  48
  49 /*
  50  * This file defines a port class which is used for sending and receiving
  51  * messages. These messages are atomic units which don't interact and
  52  * should be smaller than a cache block. This class is based on
  53  * the underpinnings of SimpleTimingPort, but it tweaks some of the external
  54  * functions.
  55  */
  56 class MessageSlavePort : public SimpleTimingPort
  57 {
  58
  59   public:
  60     MessageSlavePort(const std::string &name, MemObject *owner) :
  61         SimpleTimingPort(name, owner)
  62     {}
  63
  64     virtual ~MessageSlavePort()
  65     {}
  66
  67   protected:
  68
  69     Tick recvAtomic(PacketPtr pkt);
  70
  71     virtual Tick recvMessage(PacketPtr pkt) = 0;
  72 };
  73
  74 class MessageMasterPort : public QueuedMasterPort
  75 {
  76   public:
  77
  78     MessageMasterPort(const std::string &name, MemObject *owner) :
  79         QueuedMasterPort(name, owner, reqQueue, snoopRespQueue),
  80         reqQueue(*owner, *this), snoopRespQueue(*owner, *this)
  81     {}
  82
  83     virtual ~MessageMasterPort()
  84     {}
  85
  86     bool recvTimingResp(PacketPtr pkt) { recvResponse(pkt); return true; }
  87
  88   protected:
  89
  90     /** A packet queue for outgoing packets. */
  91     ReqPacketQueue reqQueue;
  92     SnoopRespPacketQueue snoopRespQueue;
  93
  94     // Accept and ignore responses.
  95     virtual Tick recvResponse(PacketPtr pkt)
  96     {
  97         return 0;
  98     }
  99 };
 100
 101 #endif