physical.hh revision 2640 
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
29/* @file
30 */
31
32#ifndef __PHYSICAL_MEMORY_HH__
33#define __PHYSICAL_MEMORY_HH__
34
35#include "base/range.hh"
36#include "mem/mem_object.hh"
37#include "mem/packet.hh"
38#include "mem/port.hh"
39#include "sim/eventq.hh"
40#include <map>
41#include <string>
42
43//
44// Functional model for a contiguous block of physical memory. (i.e. RAM)
45//
46class PhysicalMemory : public MemObject
47{
48    class MemoryPort : public Port
49    {
50        PhysicalMemory *memory;
51
52      public:
53
54        MemoryPort(const std::string &_name, PhysicalMemory *_memory);
55
56      protected:
57
58        virtual bool recvTiming(Packet *pkt);
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    struct MemResponseEvent : public Event
76    {
77        Packet *pkt;
78        MemoryPort *memoryPort;
79
80        MemResponseEvent(Packet *pkt, MemoryPort *memoryPort);
81        void process();
82        const char *description();
83    };
84
85  private:
86    // prevent copying of a MainMemory object
87    PhysicalMemory(const PhysicalMemory &specmem);
88    const PhysicalMemory &operator=(const PhysicalMemory &specmem);
89
90  protected:
91    Addr base_addr;
92    Addr pmem_size;
93    uint8_t *pmem_addr;
94    MemoryPort *port;
95    int page_ptr;
96    Tick lat;
97
98  public:
99    Addr new_page();
100    uint64_t size() { return pmem_size; }
101
102  public:
103    PhysicalMemory(const std::string &n, Tick latency);
104    virtual ~PhysicalMemory();
105
106  public:
107    int deviceBlockSize();
108    void getAddressRanges(AddrRangeList &resp, AddrRangeList &snoop);
109    virtual Port *getPort(const std::string &if_name);
110    void virtual init();
111
112    // fast back-door memory access for vtophys(), remote gdb, etc.
113    // uint64_t phys_read_qword(Addr addr) const;
114  private:
115    bool doTimingAccess(Packet *pkt, MemoryPort *memoryPort);
116    Tick doAtomicAccess(Packet *pkt);
117    void doFunctionalAccess(Packet *pkt);
118
119    void recvStatusChange(Port::Status status);
120
121  public:
122    virtual void serialize(std::ostream &os);
123    virtual void unserialize(Checkpoint *cp, const std::string &section);
124
125};
126
127#endif //__PHYSICAL_MEMORY_HH__
128