gem5  v21.1.0.2
packet_access.hh
Go to the documentation of this file.
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 
41 #ifndef __MEM_PACKET_ACCESS_HH__
42 #define __MEM_PACKET_ACCESS_HH__
43 
44 #include "mem/packet.hh"
45 #include "sim/byteswap.hh"
46 
47 namespace gem5
48 {
49 
50 template <typename T>
51 inline T
53 {
55  assert(sizeof(T) <= size);
56  return *(T*)data;
57 }
58 
59 template <typename T>
60 inline void
62 {
64  assert(sizeof(T) <= size);
65  *(T*)data = v;
66 }
67 
68 
69 template <typename T>
70 inline T
72 {
73  return betoh(getRaw<T>());
74 }
75 
76 template <typename T>
77 inline T
79 {
80  return letoh(getRaw<T>());
81 }
82 
83 template <typename T>
84 inline T
85 Packet::get(ByteOrder endian) const
86 {
87  switch (endian) {
88  case ByteOrder::big:
89  return getBE<T>();
90 
91  case ByteOrder::little:
92  return getLE<T>();
93 
94  default:
95  panic("Illegal byte order in Packet::get()\n");
96  };
97 }
98 
99 template <typename T>
100 inline void
102 {
103  setRaw(htobe(v));
104 }
105 
106 template <typename T>
107 inline void
109 {
110  setRaw(htole(v));
111 }
112 
113 template <typename T>
114 inline void
115 Packet::set(T v, ByteOrder endian)
116 {
117  switch (endian) {
118  case ByteOrder::big:
119  return setBE<T>(v);
120 
121  case ByteOrder::little:
122  return setLE<T>(v);
123 
124  default:
125  panic("Illegal byte order in Packet::set()\n");
126  };
127 }
128 
129 } // namespace gem5
130 
131 #endif //__MEM_PACKET_ACCESS_HH__
gem5::Packet::setRaw
void setRaw(T v)
Set the value in the data pointer to v without byte swapping.
Definition: packet_access.hh:61
gem5::Packet::size
unsigned size
The size of the request or transfer.
Definition: packet.hh:386
gem5::Packet::data
PacketDataPtr data
A pointer to the data being transferred.
Definition: packet.hh:376
gem5::betoh
T betoh(T value)
Definition: byteswap.hh:175
gem5::htobe
T htobe(T value)
Definition: byteswap.hh:174
gem5::letoh
T letoh(T value)
Definition: byteswap.hh:173
packet.hh
gem5::Packet::getRaw
T getRaw() const
Get the data in the packet without byte swapping.
Definition: packet_access.hh:52
gem5::Flags::isSet
bool isSet(Type mask) const
Verifies whether any bit matching the given mask is set.
Definition: flags.hh:83
gem5::Packet::getBE
T getBE() const
Get the data in the packet byte swapped from big endian to host endian.
Definition: packet_access.hh:71
gem5::ArmISA::v
Bitfield< 28 > v
Definition: misc_types.hh:54
gem5::Packet::setBE
void setBE(T v)
Set the value in the data pointer to v as big endian.
Definition: packet_access.hh:101
gem5::Packet::DYNAMIC_DATA
@ DYNAMIC_DATA
The data pointer points to a value that should be freed when the packet is destroyed.
Definition: packet.hh:344
gem5::Packet::STATIC_DATA
@ STATIC_DATA
Is the data pointer set to a value that shouldn't be freed when the packet is destroyed?
Definition: packet.hh:340
gem5::Packet::flags
Flags flags
Definition: packet.hh:355
gem5::Packet::get
T get(ByteOrder endian) const
Get the data in the packet byte swapped from the specified endianness.
Definition: packet_access.hh:85
gem5::htole
T htole(T value)
Definition: byteswap.hh:172
gem5::Packet::getLE
T getLE() const
Get the data in the packet byte swapped from little endian to host endian.
Definition: packet_access.hh:78
gem5::Packet::setLE
void setLE(T v)
Set the value in the data pointer to v as little endian.
Definition: packet_access.hh:108
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: decoder.cc:40
gem5::Packet::set
void set(T v, ByteOrder endian)
Set the value in the data pointer to v using the specified endianness.
Definition: packet_access.hh:115
byteswap.hh
panic
#define panic(...)
This implements a cprintf based panic() function.
Definition: logging.hh:177

Generated on Tue Sep 21 2021 12:25:33 for gem5 by doxygen 1.8.17