1/*
2 * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
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#ifndef __MEM_RUBY_SLICC_INTERFACE_RUBYSLICC_COMPONENTMAPPINGS_HH__
30#define __MEM_RUBY_SLICC_INTERFACE_RUBYSLICC_COMPONENTMAPPINGS_HH__
31
32#include "mem/ruby/common/Address.hh"
33#include "mem/ruby/common/MachineID.hh"
34#include "mem/ruby/common/NetDest.hh"
35#include "mem/ruby/protocol/MachineType.hh"
36#include "mem/ruby/structures/DirectoryMemory.hh"
37
38inline NetDest
39broadcast(MachineType type)
40{
41    NetDest dest;
42    for (NodeID i = 0; i < MachineType_base_count(type); i++) {
43        MachineID mach = {type, i};
44        dest.add(mach);
45    }
46    return dest;
47}
48
49inline MachineID
50mapAddressToRange(Addr addr, MachineType type, int low_bit,
51                  int num_bits, int cluster_id = 0)
52{
53    MachineID mach = {type, 0};
54    if (num_bits == 0)
55        mach.num = cluster_id;
56    else
57        mach.num = bitSelect(addr, low_bit, low_bit + num_bits - 1)
58            + (1 << num_bits) * cluster_id;
59    return mach;
60}
61
62inline NodeID
63machineIDToNodeID(MachineID machID)
64{
65    return machID.num;
66}
67
68inline MachineType
69machineIDToMachineType(MachineID machID)
70{
71    return machID.type;
72}
73
74inline int
75machineCount(MachineType machType)
76{
77    return MachineType_base_count(machType);
78}
79
80inline MachineID
81createMachineID(MachineType type, NodeID id)
82{
83    MachineID mach = {type, id};
84    return mach;
85}
86
87inline MachineID
88MachineTypeAndNodeIDToMachineID(MachineType type, NodeID node)
89{
90    MachineID mach = {type, node};
91    return mach;
92}
93
94#endif  // __MEM_RUBY_SLICC_INTERFACE_COMPONENTMAPPINGS_HH__
95