]>
git.proxmox.com Git - mirror_edk2.git/blob - MdePkg/Library/BaseLib/X86Msr.c
2 IA-32/x64 MSR functions.
4 Copyright (c) 2006, Intel Corporation<BR>
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
16 #include <BaseLibInternals.h>
20 Returns the lower 32-bits of a Machine Specific Register(MSR).
22 Reads and returns the lower 32-bits of the MSR specified by Index.
23 No parameter checking is performed on Index, and some Index values may cause
24 CPU exceptions. The caller must either guarantee that Index is valid, or the
25 caller must set up exception handlers to catch the exceptions. This function
26 is only available on IA-32 and X64.
28 @param Index The 32-bit MSR index to read.
30 @return The lower 32 bits of the MSR identified by Index.
39 return (UINT32
)AsmReadMsr64 (Index
);
43 Zero-extend a 32-bit value and writes it to a Machine Specific Register(MSR).
45 Writes the 32-bit value specified by Value to the MSR specified by Index. The
46 upper 32-bits of the MSR write are set to zero. The 32-bit value written to
47 the MSR is returned. No parameter checking is performed on Index or Value,
48 and some of these may cause CPU exceptions. The caller must either guarantee
49 that Index and Value are valid, or the caller must establish proper exception
50 handlers. This function is only available on IA-32 and X64.
52 @param Index The 32-bit MSR index to write.
53 @param Value The 32-bit value to write to the MSR.
65 return (UINT32
)AsmWriteMsr64 (Index
, Value
);
69 Reads a 64-bit MSR, performs a bitwise inclusive OR on the lower 32-bits, and
70 writes the result back to the 64-bit MSR.
72 Reads the 64-bit MSR specified by Index, performs a bitwise inclusive OR
73 between the lower 32-bits of the read result and the value specified by
74 OrData, and writes the result to the 64-bit MSR specified by Index. The lower
75 32-bits of the value written to the MSR is returned. No parameter checking is
76 performed on Index or OrData, and some of these may cause CPU exceptions. The
77 caller must either guarantee that Index and OrData are valid, or the caller
78 must establish proper exception handlers. This function is only available on
81 @param Index The 32-bit MSR index to write.
82 @param OrData The value to OR with the read value from the MSR.
84 @return The lower 32-bit value written to the MSR.
94 return (UINT32
)AsmMsrOr64 (Index
, OrData
);
98 Reads a 64-bit MSR, performs a bitwise AND on the lower 32-bits, and writes
99 the result back to the 64-bit MSR.
101 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
102 lower 32-bits of the read result and the value specified by AndData, and
103 writes the result to the 64-bit MSR specified by Index. The lower 32-bits of
104 the value written to the MSR is returned. No parameter checking is performed
105 on Index or AndData, and some of these may cause CPU exceptions. The caller
106 must either guarantee that Index and AndData are valid, or the caller must
107 establish proper exception handlers. This function is only available on IA-32
110 @param Index The 32-bit MSR index to write.
111 @param AndData The value to AND with the read value from the MSR.
113 @return The lower 32-bit value written to the MSR.
123 return (UINT32
)AsmMsrAnd64 (Index
, AndData
);
127 Reads a 64-bit MSR, performs a bitwise AND followed by a bitwise inclusive OR
128 on the lower 32-bits, and writes the result back to the 64-bit MSR.
130 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
131 lower 32-bits of the read result and the value specified by AndData
132 preserving the upper 32-bits, performs a bitwise inclusive OR between the
133 result of the AND operation and the value specified by OrData, and writes the
134 result to the 64-bit MSR specified by Address. The lower 32-bits of the value
135 written to the MSR is returned. No parameter checking is performed on Index,
136 AndData, or OrData, and some of these may cause CPU exceptions. The caller
137 must either guarantee that Index, AndData, and OrData are valid, or the
138 caller must establish proper exception handlers. This function is only
139 available on IA-32 and X64.
141 @param Index The 32-bit MSR index to write.
142 @param AndData The value to AND with the read value from the MSR.
143 @param OrData The value to OR with the result of the AND operation.
145 @return The lower 32-bit value written to the MSR.
156 return (UINT32
)AsmMsrAndThenOr64 (Index
, AndData
, OrData
);
160 Reads a bit field of an MSR.
162 Reads the bit field in the lower 32-bits of a 64-bit MSR. The bit field is
163 specified by the StartBit and the EndBit. The value of the bit field is
164 returned. The caller must either guarantee that Index is valid, or the caller
165 must set up exception handlers to catch the exceptions. This function is only
166 available on IA-32 and X64.
168 If StartBit is greater than 31, then ASSERT().
169 If EndBit is greater than 31, then ASSERT().
170 If EndBit is less than StartBit, then ASSERT().
172 @param Index The 32-bit MSR index to read.
173 @param StartBit The ordinal of the least significant bit in the bit field.
175 @param EndBit The ordinal of the most significant bit in the bit field.
178 @return The bit field read from the MSR.
183 AsmMsrBitFieldRead32 (
189 return BitFieldRead32 (AsmReadMsr32 (Index
), StartBit
, EndBit
);
193 Writes a bit field to an MSR.
195 Writes Value to a bit field in the lower 32-bits of a 64-bit MSR. The bit
196 field is specified by the StartBit and the EndBit. All other bits in the
197 destination MSR are preserved. The lower 32-bits of the MSR written is
198 returned. Extra left bits in Value are stripped. The caller must either
199 guarantee that Index and the data written is valid, or the caller must set up
200 exception handlers to catch the exceptions. This function is only available
203 If StartBit is greater than 31, then ASSERT().
204 If EndBit is greater than 31, then ASSERT().
205 If EndBit is less than StartBit, then ASSERT().
207 @param Index The 32-bit MSR index to write.
208 @param StartBit The ordinal of the least significant bit in the bit field.
210 @param EndBit The ordinal of the most significant bit in the bit field.
212 @param Value New value of the bit field.
214 @return The lower 32-bit of the value written to the MSR.
219 AsmMsrBitFieldWrite32 (
226 ASSERT (EndBit
< sizeof (Value
) * 8);
227 ASSERT (StartBit
<= EndBit
);
228 return (UINT32
)AsmMsrBitFieldWrite64 (Index
, StartBit
, EndBit
, Value
);
232 Reads a bit field in a 64-bit MSR, performs a bitwise OR, and writes the
233 result back to the bit field in the 64-bit MSR.
235 Reads the 64-bit MSR specified by Index, performs a bitwise inclusive OR
236 between the read result and the value specified by OrData, and writes the
237 result to the 64-bit MSR specified by Index. The lower 32-bits of the value
238 written to the MSR are returned. Extra left bits in OrData are stripped. The
239 caller must either guarantee that Index and the data written is valid, or
240 the caller must set up exception handlers to catch the exceptions. This
241 function is only available on IA-32 and X64.
243 If StartBit is greater than 31, then ASSERT().
244 If EndBit is greater than 31, then ASSERT().
245 If EndBit is less than StartBit, then ASSERT().
247 @param Index The 32-bit MSR index to write.
248 @param StartBit The ordinal of the least significant bit in the bit field.
250 @param EndBit The ordinal of the most significant bit in the bit field.
252 @param OrData The value to OR with the read value from the MSR.
254 @return The lower 32-bit of the value written to the MSR.
266 ASSERT (EndBit
< sizeof (OrData
) * 8);
267 ASSERT (StartBit
<= EndBit
);
268 return (UINT32
)AsmMsrBitFieldOr64 (Index
, StartBit
, EndBit
, OrData
);
272 Reads a bit field in a 64-bit MSR, performs a bitwise AND, and writes the
273 result back to the bit field in the 64-bit MSR.
275 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
276 read result and the value specified by AndData, and writes the result to the
277 64-bit MSR specified by Index. The lower 32-bits of the value written to the
278 MSR are returned. Extra left bits in AndData are stripped. The caller must
279 either guarantee that Index and the data written is valid, or the caller must
280 set up exception handlers to catch the exceptions. This function is only
281 available on IA-32 and X64.
283 If StartBit is greater than 31, then ASSERT().
284 If EndBit is greater than 31, then ASSERT().
285 If EndBit is less than StartBit, then ASSERT().
287 @param Index The 32-bit MSR index to write.
288 @param StartBit The ordinal of the least significant bit in the bit field.
290 @param EndBit The ordinal of the most significant bit in the bit field.
292 @param AndData The value to AND with the read value from the MSR.
294 @return The lower 32-bit of the value written to the MSR.
299 AsmMsrBitFieldAnd32 (
306 ASSERT (EndBit
< sizeof (AndData
) * 8);
307 ASSERT (StartBit
<= EndBit
);
308 return (UINT32
)AsmMsrBitFieldAnd64 (Index
, StartBit
, EndBit
, AndData
);
312 Reads a bit field in a 64-bit MSR, performs a bitwise AND followed by a
313 bitwise inclusive OR, and writes the result back to the bit field in the
316 Reads the 64-bit MSR specified by Index, performs a bitwise AND followed by a
317 bitwise inclusive OR between the read result and the value specified by
318 AndData, and writes the result to the 64-bit MSR specified by Index. The
319 lower 32-bits of the value written to the MSR are returned. Extra left bits
320 in both AndData and OrData are stripped. The caller must either guarantee
321 that Index and the data written is valid, or the caller must set up exception
322 handlers to catch the exceptions. This function is only available on IA-32
325 If StartBit is greater than 31, then ASSERT().
326 If EndBit is greater than 31, then ASSERT().
327 If EndBit is less than StartBit, then ASSERT().
329 @param Index The 32-bit MSR index to write.
330 @param StartBit The ordinal of the least significant bit in the bit field.
332 @param EndBit The ordinal of the most significant bit in the bit field.
334 @param AndData The value to AND with the read value from the MSR.
335 @param OrData The value to OR with the result of the AND operation.
337 @return The lower 32-bit of the value written to the MSR.
342 AsmMsrBitFieldAndThenOr32 (
350 ASSERT (EndBit
< sizeof (AndData
) * 8);
351 ASSERT (StartBit
<= EndBit
);
352 return (UINT32
)AsmMsrBitFieldAndThenOr64 (
362 Reads a 64-bit MSR, performs a bitwise inclusive OR, and writes the result
363 back to the 64-bit MSR.
365 Reads the 64-bit MSR specified by Index, performs a bitwise inclusive OR
366 between the read result and the value specified by OrData, and writes the
367 result to the 64-bit MSR specified by Index. The value written to the MSR is
368 returned. No parameter checking is performed on Index or OrData, and some of
369 these may cause CPU exceptions. The caller must either guarantee that Index
370 and OrData are valid, or the caller must establish proper exception handlers.
371 This function is only available on IA-32 and X64.
373 @param Index The 32-bit MSR index to write.
374 @param OrData The value to OR with the read value from the MSR.
376 @return The value written back to the MSR.
386 return AsmWriteMsr64 (Index
, AsmReadMsr64 (Index
) | OrData
);
390 Reads a 64-bit MSR, performs a bitwise AND, and writes the result back to the
393 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
394 read result and the value specified by OrData, and writes the result to the
395 64-bit MSR specified by Index. The value written to the MSR is returned. No
396 parameter checking is performed on Index or OrData, and some of these may
397 cause CPU exceptions. The caller must either guarantee that Index and OrData
398 are valid, or the caller must establish proper exception handlers. This
399 function is only available on IA-32 and X64.
401 @param Index The 32-bit MSR index to write.
402 @param AndData The value to AND with the read value from the MSR.
404 @return The value written back to the MSR.
414 return AsmWriteMsr64 (Index
, AsmReadMsr64 (Index
) & AndData
);
418 Reads a 64-bit MSR, performs a bitwise AND followed by a bitwise inclusive
419 OR, and writes the result back to the 64-bit MSR.
421 Reads the 64-bit MSR specified by Index, performs a bitwise AND between read
422 result and the value specified by AndData, performs a bitwise inclusive OR
423 between the result of the AND operation and the value specified by OrData,
424 and writes the result to the 64-bit MSR specified by Index. The value written
425 to the MSR is returned. No parameter checking is performed on Index, AndData,
426 or OrData, and some of these may cause CPU exceptions. The caller must either
427 guarantee that Index, AndData, and OrData are valid, or the caller must
428 establish proper exception handlers. This function is only available on IA-32
431 @param Index The 32-bit MSR index to write.
432 @param AndData The value to AND with the read value from the MSR.
433 @param OrData The value to OR with the result of the AND operation.
435 @return The value written back to the MSR.
446 return AsmWriteMsr64 (Index
, (AsmReadMsr64 (Index
) & AndData
) | OrData
);
450 Reads a bit field of an MSR.
452 Reads the bit field in the 64-bit MSR. The bit field is specified by the
453 StartBit and the EndBit. The value of the bit field is returned. The caller
454 must either guarantee that Index is valid, or the caller must set up
455 exception handlers to catch the exceptions. This function is only available
458 If StartBit is greater than 63, then ASSERT().
459 If EndBit is greater than 63, then ASSERT().
460 If EndBit is less than StartBit, then ASSERT().
462 @param Index The 32-bit MSR index to read.
463 @param StartBit The ordinal of the least significant bit in the bit field.
465 @param EndBit The ordinal of the most significant bit in the bit field.
468 @return The value written back to the MSR.
473 AsmMsrBitFieldRead64 (
479 return BitFieldRead64 (AsmReadMsr64 (Index
), StartBit
, EndBit
);
483 Writes a bit field to an MSR.
485 Writes Value to a bit field in a 64-bit MSR. The bit field is specified by
486 the StartBit and the EndBit. All other bits in the destination MSR are
487 preserved. The MSR written is returned. Extra left bits in Value are
488 stripped. The caller must either guarantee that Index and the data written is
489 valid, or the caller must set up exception handlers to catch the exceptions.
490 This function is only available on IA-32 and X64.
492 If StartBit is greater than 63, then ASSERT().
493 If EndBit is greater than 63, then ASSERT().
494 If EndBit is less than StartBit, then ASSERT().
496 @param Index The 32-bit MSR index to write.
497 @param StartBit The ordinal of the least significant bit in the bit field.
499 @param EndBit The ordinal of the most significant bit in the bit field.
501 @param Value New value of the bit field.
503 @return The value written back to the MSR.
508 AsmMsrBitFieldWrite64 (
515 return AsmWriteMsr64 (
517 BitFieldWrite64 (AsmReadMsr64 (Index
), StartBit
, EndBit
, Value
)
522 Reads a bit field in a 64-bit MSR, performs a bitwise inclusive OR, and
523 writes the result back to the bit field in the 64-bit MSR.
525 Reads the 64-bit MSR specified by Index, performs a bitwise inclusive OR
526 between the read result and the value specified by OrData, and writes the
527 result to the 64-bit MSR specified by Index. The value written to the MSR is
528 returned. Extra left bits in OrData are stripped. The caller must either
529 guarantee that Index and the data written is valid, or the caller must set up
530 exception handlers to catch the exceptions. This function is only available
533 If StartBit is greater than 63, then ASSERT().
534 If EndBit is greater than 63, then ASSERT().
535 If EndBit is less than StartBit, then ASSERT().
537 @param Index The 32-bit MSR index to write.
538 @param StartBit The ordinal of the least significant bit in the bit field.
540 @param EndBit The ordinal of the most significant bit in the bit field.
542 @param OrData The value to OR with the read value from the bit field.
544 @return The value written back to the MSR.
556 return AsmWriteMsr64 (
558 BitFieldOr64 (AsmReadMsr64 (Index
), StartBit
, EndBit
, OrData
)
563 Reads a bit field in a 64-bit MSR, performs a bitwise AND, and writes the
564 result back to the bit field in the 64-bit MSR.
566 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
567 read result and the value specified by AndData, and writes the result to the
568 64-bit MSR specified by Index. The value written to the MSR is returned.
569 Extra left bits in AndData are stripped. The caller must either guarantee
570 that Index and the data written is valid, or the caller must set up exception
571 handlers to catch the exceptions. This function is only available on IA-32
574 If StartBit is greater than 63, then ASSERT().
575 If EndBit is greater than 63, then ASSERT().
576 If EndBit is less than StartBit, then ASSERT().
578 @param Index The 32-bit MSR index to write.
579 @param StartBit The ordinal of the least significant bit in the bit field.
581 @param EndBit The ordinal of the most significant bit in the bit field.
583 @param AndData The value to AND with the read value from the bit field.
585 @return The value written back to the MSR.
590 AsmMsrBitFieldAnd64 (
597 return AsmWriteMsr64 (
599 BitFieldAnd64 (AsmReadMsr64 (Index
), StartBit
, EndBit
, AndData
)
604 Reads a bit field in a 64-bit MSR, performs a bitwise AND followed by a
605 bitwise inclusive OR, and writes the result back to the bit field in the
608 Reads the 64-bit MSR specified by Index, performs a bitwise AND followed by
609 a bitwise inclusive OR between the read result and the value specified by
610 AndData, and writes the result to the 64-bit MSR specified by Index. The
611 value written to the MSR is returned. Extra left bits in both AndData and
612 OrData are stripped. The caller must either guarantee that Index and the data
613 written is valid, or the caller must set up exception handlers to catch the
614 exceptions. This function is only available on IA-32 and X64.
616 If StartBit is greater than 63, then ASSERT().
617 If EndBit is greater than 63, then ASSERT().
618 If EndBit is less than StartBit, then ASSERT().
620 @param Index The 32-bit MSR index to write.
621 @param StartBit The ordinal of the least significant bit in the bit field.
623 @param EndBit The ordinal of the most significant bit in the bit field.
625 @param AndData The value to AND with the read value from the bit field.
626 @param OrData The value to OR with the result of the AND operation.
628 @return The value written back to the MSR.
633 AsmMsrBitFieldAndThenOr64 (
641 return AsmWriteMsr64 (
643 BitFieldAndThenOr64 (
644 AsmReadMsr64 (Index
),