gem5  v20.1.0.0
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 template <typename T>
48 inline T
50 {
52  assert(sizeof(T) <= size);
53  return *(T*)data;
54 }
55 
56 template <typename T>
57 inline void
59 {
61  assert(sizeof(T) <= size);
62  *(T*)data = v;
63 }
64 
65 
66 template <typename T>
67 inline T
69 {
70  return betoh(getRaw<T>());
71 }
72 
73 template <typename T>
74 inline T
76 {
77  return letoh(getRaw<T>());
78 }
79 
80 template <typename T>
81 inline T
82 Packet::get(ByteOrder endian) const
83 {
84  switch (endian) {
85  case ByteOrder::big:
86  return getBE<T>();
87 
88  case ByteOrder::little:
89  return getLE<T>();
90 
91  default:
92  panic("Illegal byte order in Packet::get()\n");
93  };
94 }
95 
96 template <typename T>
97 inline void
99 {
100  setRaw(htobe(v));
101 }
102 
103 template <typename T>
104 inline void
106 {
107  setRaw(htole(v));
108 }
109 
110 template <typename T>
111 inline void
112 Packet::set(T v, ByteOrder endian)
113 {
114  switch (endian) {
115  case ByteOrder::big:
116  return setBE<T>(v);
117 
118  case ByteOrder::little:
119  return setLE<T>(v);
120 
121  default:
122  panic("Illegal byte order in Packet::set()\n");
123  };
124 }
125 
126 #endif //__MEM_PACKET_ACCESS_HH__
Packet::getBE
T getBE() const
Get the data in the packet byte swapped from big endian to host endian.
Definition: packet_access.hh:68
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:112
Packet::setRaw
void setRaw(T v)
Set the value in the data pointer to v without byte swapping.
Definition: packet_access.hh:58
htole
T htole(T value)
Definition: byteswap.hh:140
Packet::data
PacketDataPtr data
A pointer to the data being transferred.
Definition: packet.hh:350
Packet::flags
Flags flags
Definition: packet.hh:329
Packet::setBE
void setBE(T v)
Set the value in the data pointer to v as big endian.
Definition: packet_access.hh:98
packet.hh
letoh
T letoh(T value)
Definition: byteswap.hh:141
betoh
T betoh(T value)
Definition: byteswap.hh:143
Packet::getRaw
T getRaw() const
Get the data in the packet without byte swapping.
Definition: packet_access.hh:49
Packet::get
T get(ByteOrder endian) const
Get the data in the packet byte swapped from the specified endianness.
Definition: packet_access.hh:82
Packet::getLE
T getLE() const
Get the data in the packet byte swapped from little endian to host endian.
Definition: packet_access.hh:75
htobe
T htobe(T value)
Definition: byteswap.hh:142
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:314
Packet::setLE
void setLE(T v)
Set the value in the data pointer to v as little endian.
Definition: packet_access.hh:105
Packet::size
unsigned size
The size of the request or transfer.
Definition: packet.hh:360
Flags::isSet
bool isSet() const
Definition: flags.hh:79
Packet::DYNAMIC_DATA
@ DYNAMIC_DATA
The data pointer points to a value that should be freed when the packet is destroyed.
Definition: packet.hh:318
ArmISA::v
Bitfield< 28 > v
Definition: miscregs_types.hh:51
byteswap.hh
panic
#define panic(...)
This implements a cprintf based panic() function.
Definition: logging.hh:171

Generated on Wed Sep 30 2020 14:02:13 for gem5 by doxygen 1.8.17