physical.hh revision 2665:a124942bacb8 
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/port.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 Port
51    {
52        PhysicalMemory *memory;
53
54      public:
55
56        MemoryPort(const std::string &_name, PhysicalMemory *_memory);
57
58      protected:
59
60        virtual bool recvTiming(Packet *pkt);
61
62        virtual Tick recvAtomic(Packet *pkt);
63
64        virtual void recvFunctional(Packet *pkt);
65
66        virtual void recvStatusChange(Status status);
67
68        virtual void getDeviceAddressRanges(AddrRangeList &resp,
69                                            AddrRangeList &snoop);
70
71        virtual int deviceBlockSize();
72    };
73
74    int numPorts;
75
76
77    struct MemResponseEvent : public Event
78    {
79        Packet *pkt;
80        MemoryPort *memoryPort;
81
82        MemResponseEvent(Packet *pkt, MemoryPort *memoryPort);
83        void process();
84        const char *description();
85    };
86
87  private:
88    // prevent copying of a MainMemory object
89    PhysicalMemory(const PhysicalMemory &specmem);
90    const PhysicalMemory &operator=(const PhysicalMemory &specmem);
91
92  protected:
93    Addr base_addr;
94    Addr pmem_size;
95    uint8_t *pmem_addr;
96    MemoryPort *port;
97    int page_ptr;
98    Tick lat;
99
100  public:
101    Addr new_page();
102    uint64_t size() { return pmem_size; }
103
104  public:
105    PhysicalMemory(const std::string &n, Tick latency);
106    virtual ~PhysicalMemory();
107
108  public:
109    int deviceBlockSize();
110    void getAddressRanges(AddrRangeList &resp, AddrRangeList &snoop);
111    virtual Port *getPort(const std::string &if_name);
112    void virtual init();
113
114    // fast back-door memory access for vtophys(), remote gdb, etc.
115    // uint64_t phys_read_qword(Addr addr) const;
116  private:
117    bool doTimingAccess(Packet *pkt, MemoryPort *memoryPort);
118    Tick doAtomicAccess(Packet *pkt);
119    void doFunctionalAccess(Packet *pkt);
120
121    void recvStatusChange(Port::Status status);
122
123  public:
124    virtual void serialize(std::ostream &os);
125    virtual void unserialize(Checkpoint *cp, const std::string &section);
126
127};
128
129#endif //__PHYSICAL_MEMORY_HH__
130