06c1068eb84fd23a2b62b6de8a69223d300e1785
[gem5.git] / src / mem / packet_access.hh
1 /*
2 * Copyright (c) 2015 ARM Limited
3 * All rights reserved
4 *
5 * The license below extends only to copyright in the software and shall
6 * not be construed as granting a license to any other intellectual
7 * property including but not limited to intellectual property relating
8 * to a hardware implementation of the functionality of the software
9 * licensed hereunder. You may use the software subject to the license
10 * terms below provided that you ensure that this notice is replicated
11 * unmodified and in its entirety in all distributions of the software,
12 * modified or unmodified, in source code or in binary form.
13 *
14 * Copyright (c) 2006 The Regents of The University of Michigan
15 * All rights reserved.
16 *
17 * Redistribution and use in source and binary forms, with or without
18 * modification, are permitted provided that the following conditions are
19 * met: redistributions of source code must retain the above copyright
20 * notice, this list of conditions and the following disclaimer;
21 * redistributions in binary form must reproduce the above copyright
22 * notice, this list of conditions and the following disclaimer in the
23 * documentation and/or other materials provided with the distribution;
24 * neither the name of the copyright holders nor the names of its
25 * contributors may be used to endorse or promote products derived from
26 * this software without specific prior written permission.
27 *
28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
29 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
30 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
31 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
32 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
33 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
34 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
38 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39 *
40 * Authors: Ali Saidi
41 * Nathan Binkert
42 * Andreas Sandberg
43 */
44
45 #ifndef __MEM_PACKET_ACCESS_HH__
46 #define __MEM_PACKET_ACCESS_HH__
47
48 #include "mem/packet.hh"
49 #include "sim/byteswap.hh"
50
51 template <typename T>
52 inline T
53 Packet::getRaw() const
54 {
55 assert(flags.isSet(STATIC_DATA|DYNAMIC_DATA));
56 assert(sizeof(T) <= size);
57 return *(T*)data;
58 }
59
60 template <typename T>
61 inline void
62 Packet::setRaw(T v)
63 {
64 assert(flags.isSet(STATIC_DATA|DYNAMIC_DATA));
65 assert(sizeof(T) <= size);
66 *(T*)data = v;
67 }
68
69
70 template <typename T>
71 inline T
72 Packet::getBE() const
73 {
74 return betoh(getRaw<T>());
75 }
76
77 template <typename T>
78 inline T
79 Packet::getLE() const
80 {
81 return letoh(getRaw<T>());
82 }
83
84 template <typename T>
85 inline T
86 Packet::get(ByteOrder endian) const
87 {
88 switch (endian) {
89 case BigEndianByteOrder:
90 return getBE<T>();
91
92 case LittleEndianByteOrder:
93 return getLE<T>();
94
95 default:
96 panic("Illegal byte order in Packet::get()\n");
97 };
98 }
99
100 template <typename T>
101 inline void
102 Packet::setBE(T v)
103 {
104 setRaw(htobe(v));
105 }
106
107 template <typename T>
108 inline void
109 Packet::setLE(T v)
110 {
111 setRaw(htole(v));
112 }
113
114 template <typename T>
115 inline void
116 Packet::set(T v, ByteOrder endian)
117 {
118 switch (endian) {
119 case BigEndianByteOrder:
120 return setBE<T>(v);
121
122 case LittleEndianByteOrder:
123 return setLE<T>(v);
124
125 default:
126 panic("Illegal byte order in Packet::set()\n");
127 };
128 }
129
130 #endif //__MEM_PACKET_ACCESS_HH__