]>
Commit | Line | Data |
---|---|---|
e1f414b6 | 1 | /** @file\r |
2 | Unaligned access functions of BaseLib.\r | |
3 | \r | |
127010dd | 4 | Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r |
9344f092 | 5 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
e1f414b6 | 6 | \r |
e1f414b6 | 7 | **/\r |
8 | \r | |
47fc17d8 | 9 | #include "BaseLibInternals.h"\r |
f734a10a | 10 | \r |
e1f414b6 | 11 | /**\r |
12 | Reads a 16-bit value from memory that may be unaligned.\r | |
13 | \r | |
14 | This function returns the 16-bit value pointed to by Buffer. The function\r | |
15 | guarantees that the read operation does not produce an alignment fault.\r | |
16 | \r | |
17 | If the Buffer is NULL, then ASSERT().\r | |
18 | \r | |
127010dd | 19 | @param Buffer A pointer to a 16-bit value that may be unaligned.\r |
e1f414b6 | 20 | \r |
5385a579 | 21 | @return The 16-bit value read from Buffer.\r |
e1f414b6 | 22 | \r |
23 | **/\r | |
24 | UINT16\r | |
25 | EFIAPI\r | |
26 | ReadUnaligned16 (\r | |
2f88bd3a | 27 | IN CONST UINT16 *Buffer\r |
e1f414b6 | 28 | )\r |
29 | {\r | |
30 | ASSERT (Buffer != NULL);\r | |
31 | \r | |
32 | return *Buffer;\r | |
33 | }\r | |
34 | \r | |
35 | /**\r | |
36 | Writes a 16-bit value to memory that may be unaligned.\r | |
37 | \r | |
38 | This function writes the 16-bit value specified by Value to Buffer. Value is\r | |
39 | returned. The function guarantees that the write operation does not produce\r | |
40 | an alignment fault.\r | |
41 | \r | |
42 | If the Buffer is NULL, then ASSERT().\r | |
43 | \r | |
127010dd | 44 | @param Buffer A pointer to a 16-bit value that may be unaligned.\r |
e1f414b6 | 45 | @param Value 16-bit value to write to Buffer.\r |
46 | \r | |
5385a579 | 47 | @return The 16-bit value to write to Buffer.\r |
e1f414b6 | 48 | \r |
49 | **/\r | |
50 | UINT16\r | |
51 | EFIAPI\r | |
52 | WriteUnaligned16 (\r | |
2f88bd3a MK |
53 | OUT UINT16 *Buffer,\r |
54 | IN UINT16 Value\r | |
e1f414b6 | 55 | )\r |
56 | {\r | |
57 | ASSERT (Buffer != NULL);\r | |
58 | \r | |
59 | return *Buffer = Value;\r | |
60 | }\r | |
61 | \r | |
62 | /**\r | |
63 | Reads a 24-bit value from memory that may be unaligned.\r | |
64 | \r | |
65 | This function returns the 24-bit value pointed to by Buffer. The function\r | |
66 | guarantees that the read operation does not produce an alignment fault.\r | |
67 | \r | |
68 | If the Buffer is NULL, then ASSERT().\r | |
69 | \r | |
127010dd | 70 | @param Buffer A pointer to a 24-bit value that may be unaligned.\r |
e1f414b6 | 71 | \r |
5385a579 | 72 | @return The 24-bit value read from Buffer.\r |
e1f414b6 | 73 | \r |
74 | **/\r | |
75 | UINT32\r | |
76 | EFIAPI\r | |
77 | ReadUnaligned24 (\r | |
2f88bd3a | 78 | IN CONST UINT32 *Buffer\r |
e1f414b6 | 79 | )\r |
80 | {\r | |
81 | ASSERT (Buffer != NULL);\r | |
82 | \r | |
83 | return *Buffer & 0xffffff;\r | |
84 | }\r | |
85 | \r | |
86 | /**\r | |
87 | Writes a 24-bit value to memory that may be unaligned.\r | |
88 | \r | |
89 | This function writes the 24-bit value specified by Value to Buffer. Value is\r | |
90 | returned. The function guarantees that the write operation does not produce\r | |
91 | an alignment fault.\r | |
92 | \r | |
93 | If the Buffer is NULL, then ASSERT().\r | |
94 | \r | |
127010dd | 95 | @param Buffer A pointer to a 24-bit value that may be unaligned.\r |
e1f414b6 | 96 | @param Value 24-bit value to write to Buffer.\r |
97 | \r | |
5385a579 | 98 | @return The 24-bit value to write to Buffer.\r |
e1f414b6 | 99 | \r |
100 | **/\r | |
101 | UINT32\r | |
102 | EFIAPI\r | |
103 | WriteUnaligned24 (\r | |
2f88bd3a MK |
104 | OUT UINT32 *Buffer,\r |
105 | IN UINT32 Value\r | |
e1f414b6 | 106 | )\r |
107 | {\r | |
108 | ASSERT (Buffer != NULL);\r | |
109 | \r | |
110 | *Buffer = BitFieldWrite32 (*Buffer, 0, 23, Value);\r | |
111 | return Value;\r | |
112 | }\r | |
113 | \r | |
114 | /**\r | |
115 | Reads a 32-bit value from memory that may be unaligned.\r | |
116 | \r | |
117 | This function returns the 32-bit value pointed to by Buffer. The function\r | |
118 | guarantees that the read operation does not produce an alignment fault.\r | |
119 | \r | |
120 | If the Buffer is NULL, then ASSERT().\r | |
121 | \r | |
127010dd | 122 | @param Buffer A pointer to a 32-bit value that may be unaligned.\r |
e1f414b6 | 123 | \r |
5385a579 | 124 | @return The 32-bit value read from Buffer.\r |
e1f414b6 | 125 | \r |
126 | **/\r | |
127 | UINT32\r | |
128 | EFIAPI\r | |
129 | ReadUnaligned32 (\r | |
2f88bd3a | 130 | IN CONST UINT32 *Buffer\r |
e1f414b6 | 131 | )\r |
132 | {\r | |
133 | ASSERT (Buffer != NULL);\r | |
134 | \r | |
135 | return *Buffer;\r | |
136 | }\r | |
137 | \r | |
138 | /**\r | |
139 | Writes a 32-bit value to memory that may be unaligned.\r | |
140 | \r | |
141 | This function writes the 32-bit value specified by Value to Buffer. Value is\r | |
142 | returned. The function guarantees that the write operation does not produce\r | |
143 | an alignment fault.\r | |
144 | \r | |
145 | If the Buffer is NULL, then ASSERT().\r | |
146 | \r | |
127010dd | 147 | @param Buffer A pointer to a 32-bit value that may be unaligned.\r |
148 | @param Value The 32-bit value to write to Buffer.\r | |
e1f414b6 | 149 | \r |
5385a579 | 150 | @return The 32-bit value to write to Buffer.\r |
e1f414b6 | 151 | \r |
152 | **/\r | |
153 | UINT32\r | |
154 | EFIAPI\r | |
155 | WriteUnaligned32 (\r | |
2f88bd3a MK |
156 | OUT UINT32 *Buffer,\r |
157 | IN UINT32 Value\r | |
e1f414b6 | 158 | )\r |
159 | {\r | |
160 | ASSERT (Buffer != NULL);\r | |
161 | \r | |
162 | return *Buffer = Value;\r | |
163 | }\r | |
164 | \r | |
165 | /**\r | |
166 | Reads a 64-bit value from memory that may be unaligned.\r | |
167 | \r | |
168 | This function returns the 64-bit value pointed to by Buffer. The function\r | |
169 | guarantees that the read operation does not produce an alignment fault.\r | |
170 | \r | |
171 | If the Buffer is NULL, then ASSERT().\r | |
172 | \r | |
127010dd | 173 | @param Buffer A pointer to a 64-bit value that may be unaligned.\r |
e1f414b6 | 174 | \r |
5385a579 | 175 | @return The 64-bit value read from Buffer.\r |
e1f414b6 | 176 | \r |
177 | **/\r | |
178 | UINT64\r | |
179 | EFIAPI\r | |
180 | ReadUnaligned64 (\r | |
2f88bd3a | 181 | IN CONST UINT64 *Buffer\r |
e1f414b6 | 182 | )\r |
183 | {\r | |
184 | ASSERT (Buffer != NULL);\r | |
185 | \r | |
186 | return *Buffer;\r | |
187 | }\r | |
188 | \r | |
189 | /**\r | |
190 | Writes a 64-bit value to memory that may be unaligned.\r | |
191 | \r | |
192 | This function writes the 64-bit value specified by Value to Buffer. Value is\r | |
193 | returned. The function guarantees that the write operation does not produce\r | |
194 | an alignment fault.\r | |
195 | \r | |
196 | If the Buffer is NULL, then ASSERT().\r | |
197 | \r | |
127010dd | 198 | @param Buffer A pointer to a 64-bit value that may be unaligned.\r |
199 | @param Value The 64-bit value to write to Buffer.\r | |
e1f414b6 | 200 | \r |
5385a579 | 201 | @return The 64-bit value to write to Buffer.\r |
e1f414b6 | 202 | \r |
203 | **/\r | |
204 | UINT64\r | |
205 | EFIAPI\r | |
206 | WriteUnaligned64 (\r | |
2f88bd3a MK |
207 | OUT UINT64 *Buffer,\r |
208 | IN UINT64 Value\r | |
e1f414b6 | 209 | )\r |
210 | {\r | |
211 | ASSERT (Buffer != NULL);\r | |
212 | \r | |
213 | return *Buffer = Value;\r | |
214 | }\r |