1/*
2 * Copyright (c) 2001-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/* @file
32 */
33
34#ifndef __PHYSICAL_MEMORY_HH__
35#define __PHYSICAL_MEMORY_HH__
36
37#include "base/range.hh"
38#include "mem/mem_object.hh"
39#include "mem/packet.hh"
40#include "mem/tport.hh"
41#include "sim/eventq.hh"
42#include <map>
43#include <string>
44
45//
46// Functional model for a contiguous block of physical memory. (i.e. RAM)
47//
48class PhysicalMemory : public MemObject
49{
50 class MemoryPort : public SimpleTimingPort
51 {
52 PhysicalMemory *memory;
53
54 public:
55
56 MemoryPort(const std::string &_name, PhysicalMemory *_memory);
57
58 protected:
59
60 virtual Tick recvAtomic(Packet *pkt);
61
62 virtual void recvFunctional(Packet *pkt);
63
64 virtual void recvStatusChange(Status status);
65
66 virtual void getDeviceAddressRanges(AddrRangeList &resp,
67 AddrRangeList &snoop);
68
69 virtual int deviceBlockSize();
70 };
71
72 int numPorts;
73
74
75 private:
76 // prevent copying of a MainMemory object
77 PhysicalMemory(const PhysicalMemory &specmem);
78 const PhysicalMemory &operator=(const PhysicalMemory &specmem);
79
80 protected:
81 uint8_t *pmemAddr;
82 MemoryPort *port;
83 int pagePtr;
84 Tick lat;
85
86 public:
87 Addr new_page();
88 uint64_t size() { return params()->addrRange.size(); }
89
90 struct Params
91 {
92 std::string name;
93 Range<Addr> addrRange;
94 Tick latency;
95 };
96
97 protected:
98 Params *_params;
99
100 public:
101 const Params *params() const { return _params; }
102 PhysicalMemory(Params *p);
103 virtual ~PhysicalMemory();
104
105 public:
106 int deviceBlockSize();
107 void getAddressRanges(AddrRangeList &resp, AddrRangeList &snoop);
108 virtual Port *getPort(const std::string &if_name, int idx = -1);
109 void virtual init();
110 unsigned int drain(Event *de);
111
112 protected:
113 void doFunctionalAccess(Packet *pkt);
114 virtual Tick calculateLatency(Packet *pkt);
115 void recvStatusChange(Port::Status status);
116
117 public:
118 virtual void serialize(std::ostream &os);
119 virtual void unserialize(Checkpoint *cp, const std::string &section);
120
121};
122
123#endif //__PHYSICAL_MEMORY_HH__