]>
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 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 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 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 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. The caller must either guarantee that Index and the data written
199 is valid, or the caller must set up exception handlers to catch the exceptions.
200 This function is only available on IA-32 and x64.
202 If StartBit is greater than 31, then ASSERT().
203 If EndBit is greater than 31, then ASSERT().
204 If EndBit is less than StartBit, then ASSERT().
206 @param Index The 32-bit MSR index to write.
207 @param StartBit The ordinal of the least significant bit in the bit field.
209 @param EndBit The ordinal of the most significant bit in the bit field.
211 @param Value New value of the bit field.
213 @return The lower 32-bit of the value written to the MSR.
218 AsmMsrBitFieldWrite32 (
225 ASSERT (EndBit
< sizeof (Value
) * 8);
226 ASSERT (StartBit
<= EndBit
);
227 return (UINT32
)AsmMsrBitFieldWrite64 (Index
, StartBit
, EndBit
, Value
);
231 Reads a bit field in a 64-bit MSR, performs a bitwise OR, and writes the
232 result back to the bit field in the 64-bit MSR.
234 Reads the 64-bit MSR specified by Index, performs a bitwise OR
235 between the read result and the value specified by OrData, and writes the
236 result to the 64-bit MSR specified by Index. The lower 32-bits of the value
237 written to the MSR are returned. Extra left bits in OrData are stripped. The
238 caller must either guarantee that Index and the data written is valid, or
239 the caller must set up exception handlers to catch the exceptions. This
240 function is only available on IA-32 and x64.
242 If StartBit is greater than 31, then ASSERT().
243 If EndBit is greater than 31, then ASSERT().
244 If EndBit is less than StartBit, then ASSERT().
246 @param Index The 32-bit MSR index to write.
247 @param StartBit The ordinal of the least significant bit in the bit field.
249 @param EndBit The ordinal of the most significant bit in the bit field.
251 @param OrData The value to OR with the read value from the MSR.
253 @return The lower 32-bit of the value written to the MSR.
265 ASSERT (EndBit
< sizeof (OrData
) * 8);
266 ASSERT (StartBit
<= EndBit
);
267 return (UINT32
)AsmMsrBitFieldOr64 (Index
, StartBit
, EndBit
, OrData
);
271 Reads a bit field in a 64-bit MSR, performs a bitwise AND, and writes the
272 result back to the bit field in the 64-bit MSR.
274 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
275 read result and the value specified by AndData, and writes the result to the
276 64-bit MSR specified by Index. The lower 32-bits of the value written to the
277 MSR are returned. Extra left bits in AndData are stripped. The caller must
278 either guarantee that Index and the data written is valid, or the caller must
279 set up exception handlers to catch the exceptions. This function is only
280 available on IA-32 and x64.
282 If StartBit is greater than 31, then ASSERT().
283 If EndBit is greater than 31, then ASSERT().
284 If EndBit is less than StartBit, then ASSERT().
286 @param Index The 32-bit MSR index to write.
287 @param StartBit The ordinal of the least significant bit in the bit field.
289 @param EndBit The ordinal of the most significant bit in the bit field.
291 @param AndData The value to AND with the read value from the MSR.
293 @return The lower 32-bit of the value written to the MSR.
298 AsmMsrBitFieldAnd32 (
305 ASSERT (EndBit
< sizeof (AndData
) * 8);
306 ASSERT (StartBit
<= EndBit
);
307 return (UINT32
)AsmMsrBitFieldAnd64 (Index
, StartBit
, EndBit
, AndData
);
311 Reads a bit field in a 64-bit MSR, performs a bitwise AND followed by a
312 bitwise OR, and writes the result back to the bit field in the
315 Reads the 64-bit MSR specified by Index, performs a bitwise AND followed by a
316 bitwise OR between the read result and the value specified by
317 AndData, and writes the result to the 64-bit MSR specified by Index. The
318 lower 32-bits of the value written to the MSR are returned. Extra left bits
319 in both AndData and OrData are stripped. The caller must either guarantee
320 that Index and the data written is valid, or the caller must set up exception
321 handlers to catch the exceptions. This function is only available on IA-32
324 If StartBit is greater than 31, then ASSERT().
325 If EndBit is greater than 31, then ASSERT().
326 If EndBit is less than StartBit, then ASSERT().
328 @param Index The 32-bit MSR index to write.
329 @param StartBit The ordinal of the least significant bit in the bit field.
331 @param EndBit The ordinal of the most significant bit in the bit field.
333 @param AndData The value to AND with the read value from the MSR.
334 @param OrData The value to OR with the result of the AND operation.
336 @return The lower 32-bit of the value written to the MSR.
341 AsmMsrBitFieldAndThenOr32 (
349 ASSERT (EndBit
< sizeof (AndData
) * 8);
350 ASSERT (StartBit
<= EndBit
);
351 return (UINT32
)AsmMsrBitFieldAndThenOr64 (
361 Reads a 64-bit MSR, performs a bitwise OR, and writes the result
362 back to the 64-bit MSR.
364 Reads the 64-bit MSR specified by Index, performs a bitwise OR
365 between the read result and the value specified by OrData, and writes the
366 result to the 64-bit MSR specified by Index. The value written to the MSR is
367 returned. No parameter checking is performed on Index or OrData, and some of
368 these may cause CPU exceptions. The caller must either guarantee that Index
369 and OrData are valid, or the caller must establish proper exception handlers.
370 This function is only available on IA-32 and x64.
372 @param Index The 32-bit MSR index to write.
373 @param OrData The value to OR with the read value from the MSR.
375 @return The value written back to the MSR.
385 return AsmWriteMsr64 (Index
, AsmReadMsr64 (Index
) | OrData
);
389 Reads a 64-bit MSR, performs a bitwise AND, and writes the result back to the
392 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
393 read result and the value specified by OrData, and writes the result to the
394 64-bit MSR specified by Index. The value written to the MSR is returned. No
395 parameter checking is performed on Index or OrData, and some of these may
396 cause CPU exceptions. The caller must either guarantee that Index and OrData
397 are valid, or the caller must establish proper exception handlers. This
398 function is only available on IA-32 and x64.
400 @param Index The 32-bit MSR index to write.
401 @param AndData The value to AND with the read value from the MSR.
403 @return The value written back to the MSR.
413 return AsmWriteMsr64 (Index
, AsmReadMsr64 (Index
) & AndData
);
417 Reads a 64-bit MSR, performs a bitwise AND followed by a bitwise
418 OR, and writes the result back to the 64-bit MSR.
420 Reads the 64-bit MSR specified by Index, performs a bitwise AND between read
421 result and the value specified by AndData, performs a bitwise OR
422 between the result of the AND operation and the value specified by OrData,
423 and writes the result to the 64-bit MSR specified by Index. The value written
424 to the MSR is returned. No parameter checking is performed on Index, AndData,
425 or OrData, and some of these may cause CPU exceptions. The caller must either
426 guarantee that Index, AndData, and OrData are valid, or the caller must
427 establish proper exception handlers. This function is only available on IA-32
430 @param Index The 32-bit MSR index to write.
431 @param AndData The value to AND with the read value from the MSR.
432 @param OrData The value to OR with the result of the AND operation.
434 @return The value written back to the MSR.
445 return AsmWriteMsr64 (Index
, (AsmReadMsr64 (Index
) & AndData
) | OrData
);
449 Reads a bit field of an MSR.
451 Reads the bit field in the 64-bit MSR. The bit field is specified by the
452 StartBit and the EndBit. The value of the bit field is returned. The caller
453 must either guarantee that Index is valid, or the caller must set up
454 exception handlers to catch the exceptions. This function is only available
457 If StartBit is greater than 63, then ASSERT().
458 If EndBit is greater than 63, then ASSERT().
459 If EndBit is less than StartBit, then ASSERT().
461 @param Index The 32-bit MSR index to read.
462 @param StartBit The ordinal of the least significant bit in the bit field.
464 @param EndBit The ordinal of the most significant bit in the bit field.
467 @return The value written back to the MSR.
472 AsmMsrBitFieldRead64 (
478 return BitFieldRead64 (AsmReadMsr64 (Index
), StartBit
, EndBit
);
482 Writes a bit field to an MSR.
484 Writes Value to a bit field in a 64-bit MSR. The bit field is specified by
485 the StartBit and the EndBit. All other bits in the destination MSR are
486 preserved. The MSR written is returned. The caller must either guarantee
487 that Index and the data written is valid, or the caller must set up exception
488 handlers to catch the exceptions. This function is only available on IA-32 and x64.
490 If StartBit is greater than 63, then ASSERT().
491 If EndBit is greater than 63, then ASSERT().
492 If EndBit is less than StartBit, then ASSERT().
494 @param Index The 32-bit MSR index to write.
495 @param StartBit The ordinal of the least significant bit in the bit field.
497 @param EndBit The ordinal of the most significant bit in the bit field.
499 @param Value New value of the bit field.
501 @return The value written back to the MSR.
506 AsmMsrBitFieldWrite64 (
513 return AsmWriteMsr64 (
515 BitFieldWrite64 (AsmReadMsr64 (Index
), StartBit
, EndBit
, Value
)
520 Reads a bit field in a 64-bit MSR, performs a bitwise OR, and
521 writes the result back to the bit field in the 64-bit MSR.
523 Reads the 64-bit MSR specified by Index, performs a bitwise OR
524 between the read result and the value specified by OrData, and writes the
525 result to the 64-bit MSR specified by Index. The value written to the MSR is
526 returned. Extra left bits in OrData are stripped. The caller must either
527 guarantee that Index and the data written is valid, or the caller must set up
528 exception handlers to catch the exceptions. This function is only available
531 If StartBit is greater than 63, then ASSERT().
532 If EndBit is greater than 63, then ASSERT().
533 If EndBit is less than StartBit, then ASSERT().
535 @param Index The 32-bit MSR index to write.
536 @param StartBit The ordinal of the least significant bit in the bit field.
538 @param EndBit The ordinal of the most significant bit in the bit field.
540 @param OrData The value to OR with the read value from the bit field.
542 @return The value written back to the MSR.
554 return AsmWriteMsr64 (
556 BitFieldOr64 (AsmReadMsr64 (Index
), StartBit
, EndBit
, OrData
)
561 Reads a bit field in a 64-bit MSR, performs a bitwise AND, and writes the
562 result back to the bit field in the 64-bit MSR.
564 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
565 read result and the value specified by AndData, and writes the result to the
566 64-bit MSR specified by Index. The value written to the MSR is returned.
567 Extra left bits in AndData are stripped. The caller must either guarantee
568 that Index and the data written is valid, or the caller must set up exception
569 handlers to catch the exceptions. This function is only available on IA-32
572 If StartBit is greater than 63, then ASSERT().
573 If EndBit is greater than 63, then ASSERT().
574 If EndBit is less than StartBit, then ASSERT().
576 @param Index The 32-bit MSR index to write.
577 @param StartBit The ordinal of the least significant bit in the bit field.
579 @param EndBit The ordinal of the most significant bit in the bit field.
581 @param AndData The value to AND with the read value from the bit field.
583 @return The value written back to the MSR.
588 AsmMsrBitFieldAnd64 (
595 return AsmWriteMsr64 (
597 BitFieldAnd64 (AsmReadMsr64 (Index
), StartBit
, EndBit
, AndData
)
602 Reads a bit field in a 64-bit MSR, performs a bitwise AND followed by a
603 bitwise OR, and writes the result back to the bit field in the
606 Reads the 64-bit MSR specified by Index, performs a bitwise AND followed by
607 a bitwise OR between the read result and the value specified by
608 AndData, and writes the result to the 64-bit MSR specified by Index. The
609 value written to the MSR is returned. Extra left bits in both AndData and
610 OrData are stripped. The caller must either guarantee that Index and the data
611 written is valid, or the caller must set up exception handlers to catch the
612 exceptions. This function is only available on IA-32 and x64.
614 If StartBit is greater than 63, then ASSERT().
615 If EndBit is greater than 63, then ASSERT().
616 If EndBit is less than StartBit, then ASSERT().
618 @param Index The 32-bit MSR index to write.
619 @param StartBit The ordinal of the least significant bit in the bit field.
621 @param EndBit The ordinal of the most significant bit in the bit field.
623 @param AndData The value to AND with the read value from the bit field.
624 @param OrData The value to OR with the result of the AND operation.
626 @return The value written back to the MSR.
631 AsmMsrBitFieldAndThenOr64 (
639 return AsmWriteMsr64 (
641 BitFieldAndThenOr64 (
642 AsmReadMsr64 (Index
),