1
2/*
3 * Copyright (c) 1999-2005 Mark D. Hill and David A. Wood
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are
8 * met: redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer;
10 * redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution;
13 * neither the name of the copyright holders nor the names of its
14 * contributors may be used to endorse or promote products derived from
15 * this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 */
29
30/*
31 * $Id$
32 *
33 */
34
35// MemoryRequestType used in MemoryMsg
36
37enumeration(MemoryRequestType, desc="...") {
38
39  // Southbound request: from directory to memory cache
40  // or directory to memory or memory cache to memory
41  MEMORY_READ,     desc="Read request to memory";
42  MEMORY_WB,       desc="Write back data to memory";
43
44  // response from memory to directory
45  // (These are currently unused!)
46  MEMORY_DATA, desc="Data read from memory";
47  MEMORY_ACK,  desc="Write to memory acknowledgement";
48}
49
50
51// Message to and from Memory Control
52
53structure(MemoryMsg, desc="...", interface="Message") {
54  Addr addr,              desc="Physical address for this request";
55  MemoryRequestType Type,       desc="Type of memory request (MEMORY_READ or MEMORY_WB)";
56  MachineID Sender,             desc="What component sent the data";
57  MachineID OriginalRequestorMachId, desc="What component originally requested";
58  DataBlock DataBlk,            desc="Data to writeback";
59  MessageSizeType MessageSize,  desc="size category of the message";
60  // Not all fields used by all protocols:
61  PrefetchBit Prefetch,         desc="Is this a prefetch request";
62  bool ReadX,                   desc="Exclusive";
63  int Acks,                     desc="How many acks to expect";
64
65  bool functionalRead(Packet *pkt) {
66    return testAndRead(addr, DataBlk, pkt);
67  }
68
69  bool functionalWrite(Packet *pkt) {
70    return testAndWrite(addr, DataBlk, pkt);
71  }
72}
73