mem_object.hh revision 5489:94a7bb476fca
1/* 2 * Copyright (c) 2002-2005 The Regents of The University of Michigan 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions are 7 * met: redistributions of source code must retain the above copyright 8 * notice, this list of conditions and the following disclaimer; 9 * redistributions in binary form must reproduce the above copyright 10 * notice, this list of conditions and the following disclaimer in the 11 * documentation and/or other materials provided with the distribution; 12 * neither the name of the copyright holders nor the names of its 13 * contributors may be used to endorse or promote products derived from 14 * this software without specific prior written permission. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 17 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 18 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 19 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 20 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 21 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 26 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 27 * 28 * Authors: Ron Dreslinski 29 */ 30 31/** 32 * @file 33 * Base Memory Object declaration. 34 */ 35 36#ifndef __MEM_MEM_OBJECT_HH__ 37#define __MEM_MEM_OBJECT_HH__ 38 39#include "mem/port.hh" 40#include "params/MemObject.hh" 41#include "sim/sim_object.hh" 42 43/** 44 * The base MemoryObject class, allows for an accesor function to a 45 * simobj that returns the Port. 46 */ 47class MemObject : public SimObject 48{ 49 public: 50 typedef MemObjectParams Params; 51 MemObject(const Params *params); 52 53 const Params * 54 params() const 55 { 56 return dynamic_cast<const Params *>(_params); 57 } 58 59 protected: 60 // static: support for old-style constructors (call manually) 61 static Params *makeParams(const std::string &name); 62 63 public: 64 /** Additional function to return the Port of a memory object. */ 65 virtual Port *getPort(const std::string &if_name, int idx = -1) = 0; 66 67 /** Tell MemObject that this port is no longer in use, so it 68 * should remove it from any structures that it's keeping it in. 69 * If the port was allocated dynamically for this connection, it 70 * should be deleted here. 71 * @return True if the port was deleted, false if it still exists. 72 */ 73 virtual bool deletePort(Port *p); 74}; 75 76#endif //__MEM_MEM_OBJECT_HH__ 77