physical.hh revision 3012 
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 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  private:
78    // prevent copying of a MainMemory object
79    PhysicalMemory(const PhysicalMemory &specmem);
80    const PhysicalMemory &operator=(const PhysicalMemory &specmem);
81
82  protected:
83    uint8_t *pmemAddr;
84    MemoryPort *port;
85    int pagePtr;
86    Tick lat;
87
88  public:
89    Addr new_page();
90    uint64_t size() { return params()->addrRange.size(); }
91
92    struct Params
93    {
94        std::string name;
95        Range<Addr> addrRange;
96        Tick latency;
97    };
98
99  protected:
100    Params *_params;
101
102  public:
103    const Params *params() const { return _params; }
104    PhysicalMemory(Params *p);
105    virtual ~PhysicalMemory();
106
107  public:
108    int deviceBlockSize();
109    void getAddressRanges(AddrRangeList &resp, AddrRangeList &snoop);
110    virtual Port *getPort(const std::string &if_name, int idx = -1);
111    void virtual init();
112    unsigned int drain(Event *de);
113
114  protected:
115    Tick doFunctionalAccess(Packet *pkt);
116    virtual Tick calculateLatency(Packet *pkt);
117    void recvStatusChange(Port::Status status);
118
119  public:
120    virtual void serialize(std::ostream &os);
121    virtual void unserialize(Checkpoint *cp, const std::string &section);
122
123};
124
125#endif //__PHYSICAL_MEMORY_HH__
126