1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
|
/*++
Copyright (c) 2004 - 2006, Intel Corporation
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Module Name:
x86Msr.c
Abstract:
IA-32/x64 specific functions.
--*/
#include "BaseLibInternal.h"
/**
Returns the lower 32-bits of a Machine Specific Register(MSR).
Reads and returns the lower 32-bits of the MSR specified by Index.
No parameter checking is performed on Index, and some Index values may cause
CPU exceptions. The caller must either guarantee that Index is valid, or the
caller must set up exception handlers to catch the exceptions. This function
is only available on IA-32 and X64.
@param Index The 32-bit MSR index to read.
@return The lower 32 bits of the MSR identified by Index.
**/
UINT32
EFIAPI
AsmReadMsr32 (
IN UINT32 Index
)
{
return (UINT32)AsmReadMsr64 (Index);
}
/**
Zero-extend a 32-bit value and writes it to a Machine Specific Register(MSR).
Writes the 32-bit value specified by Value to the MSR specified by Index. The
upper 32-bits of the MSR write are set to zero. The 32-bit value written to
the MSR is returned. No parameter checking is performed on Index or Value,
and some of these may cause CPU exceptions. The caller must either guarantee
that Index and Value are valid, or the caller must establish proper exception
handlers. This function is only available on IA-32 and X64.
@param Index The 32-bit MSR index to write.
@param Value The 32-bit value to write to the MSR.
@return Value
**/
UINT32
EFIAPI
AsmWriteMsr32 (
IN UINT32 Index,
IN UINT32 Value
)
{
return (UINT32)AsmWriteMsr64 (Index, Value);
}
/**
Reads a 64-bit MSR, performs a bitwise inclusive OR on the lower 32-bits, and
writes the result back to the 64-bit MSR.
Reads the 64-bit MSR specified by Index, performs a bitwise inclusive OR
between the lower 32-bits of the read result and the value specified by
OrData, and writes the result to the 64-bit MSR specified by Index. The lower
32-bits of the value written to the MSR is returned. No parameter checking is
performed on Index or OrData, and some of these may cause CPU exceptions. The
caller must either guarantee that Index and OrData are valid, or the caller
must establish proper exception handlers. This function is only available on
IA-32 and X64.
@param Index The 32-bit MSR index to write.
@param OrData The value to OR with the read value from the MSR.
@return The lower 32-bit value written to the MSR.
**/
UINT32
EFIAPI
AsmMsrOr32 (
IN UINT32 Index,
IN UINT32 OrData
)
{
return (UINT32)AsmMsrOr64 (Index, OrData);
}
/**
Reads a 64-bit MSR, performs a bitwise AND on the lower 32-bits, and writes
the result back to the 64-bit MSR.
Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
lower 32-bits of the read result and the value specified by AndData, and
writes the result to the 64-bit MSR specified by Index. The lower 32-bits of
the value written to the MSR is returned. No parameter checking is performed
on Index or AndData, and some of these may cause CPU exceptions. The caller
must either guarantee that Index and AndData are valid, or the caller must
establish proper exception handlers. This function is only available on IA-32
and X64.
@param Index The 32-bit MSR index to write.
@param AndData The value to AND with the read value from the MSR.
@return The lower 32-bit value written to the MSR.
**/
UINT32
EFIAPI
AsmMsrAnd32 (
IN UINT32 Index,
IN UINT32 AndData
)
{
return (UINT32)AsmMsrAnd64 (Index, AndData);
}
/**
Reads a 64-bit MSR, performs a bitwise AND followed by a bitwise inclusive OR
on the lower 32-bits, and writes the result back to the 64-bit MSR.
Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
lower 32-bits of the read result and the value specified by AndData
preserving the upper 32-bits, performs a bitwise inclusive OR between the
result of the AND operation and the value specified by OrData, and writes the
result to the 64-bit MSR specified by Address. The lower 32-bits of the value
written to the MSR is returned. No parameter checking is performed on Index,
AndData, or OrData, and some of these may cause CPU exceptions. The caller
must either guarantee that Index, AndData, and OrData are valid, or the
caller must establish proper exception handlers. This function is only
available on IA-32 and X64.
@param Index The 32-bit MSR index to write.
@param AndData The value to AND with the read value from the MSR.
@param OrData The value to OR with the result of the AND operation.
@return The lower 32-bit value written to the MSR.
**/
UINT32
EFIAPI
AsmMsrAndThenOr32 (
IN UINT32 Index,
IN UINT32 AndData,
IN UINT32 OrData
)
{
return (UINT32)AsmMsrAndThenOr64 (Index, AndData, OrData);
}
/**
Reads a bit field of an MSR.
Reads the bit field in the lower 32-bits of a 64-bit MSR. The bit field is
specified by the StartBit and the EndBit. The value of the bit field is
returned. The caller must either guarantee that Index is valid, or the caller
must set up exception handlers to catch the exceptions. This function is only
available on IA-32 and X64.
If StartBit is greater than 31, then ASSERT().
If EndBit is greater than 31, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
@param Index The 32-bit MSR index to read.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..31.
@param EndBit The ordinal of the most significant bit in the bit field.
Range 0..31.
@return The bit field read from the MSR.
**/
UINT32
EFIAPI
AsmMsrBitFieldRead32 (
IN UINT32 Index,
IN UINTN StartBit,
IN UINTN EndBit
)
{
return BitFieldRead32 (AsmReadMsr32 (Index), StartBit, EndBit);
}
/**
Writes a bit field to an MSR.
Writes Value to a bit field in the lower 32-bits of a 64-bit MSR. The bit
field is specified by the StartBit and the EndBit. All other bits in the
destination MSR are preserved. The lower 32-bits of the MSR written is
returned. Extra left bits in Value are stripped. The caller must either
guarantee that Index and the data written is valid, or the caller must set up
exception handlers to catch the exceptions. This function is only available
on IA-32 and X64.
If StartBit is greater than 31, then ASSERT().
If EndBit is greater than 31, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
@param Index The 32-bit MSR index to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..31.
@param EndBit The ordinal of the most significant bit in the bit field.
Range 0..31.
@param Value New value of the bit field.
@return The lower 32-bit of the value written to the MSR.
**/
UINT32
EFIAPI
AsmMsrBitFieldWrite32 (
IN UINT32 Index,
IN UINTN StartBit,
IN UINTN EndBit,
IN UINT32 Value
)
{
ASSERT (EndBit < sizeof (Value) * 8);
ASSERT (StartBit <= EndBit);
return (UINT32)AsmMsrBitFieldWrite64 (Index, StartBit, EndBit, Value);
}
/**
Reads a bit field in a 64-bit MSR, performs a bitwise OR, and writes the
result back to the bit field in the 64-bit MSR.
Reads the 64-bit MSR specified by Index, performs a bitwise inclusive OR
between the read result and the value specified by OrData, and writes the
result to the 64-bit MSR specified by Index. The lower 32-bits of the value
written to the MSR are returned. Extra left bits in OrData are stripped. The
caller must either guarantee that Index and the data written is valid, or
the caller must set up exception handlers to catch the exceptions. This
function is only available on IA-32 and X64.
If StartBit is greater than 31, then ASSERT().
If EndBit is greater than 31, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
@param Index The 32-bit MSR index to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..31.
@param EndBit The ordinal of the most significant bit in the bit field.
Range 0..31.
@param OrData The value to OR with the read value from the MSR.
@return The lower 32-bit of the value written to the MSR.
**/
UINT32
EFIAPI
AsmMsrBitFieldOr32 (
IN UINT32 Index,
IN UINTN StartBit,
IN UINTN EndBit,
IN UINT32 OrData
)
{
ASSERT (EndBit < sizeof (OrData) * 8);
ASSERT (StartBit <= EndBit);
return (UINT32)AsmMsrBitFieldOr64 (Index, StartBit, EndBit, OrData);
}
/**
Reads a bit field in a 64-bit MSR, performs a bitwise AND, and writes the
result back to the bit field in the 64-bit MSR.
Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
read result and the value specified by AndData, and writes the result to the
64-bit MSR specified by Index. The lower 32-bits of the value written to the
MSR are returned. Extra left bits in AndData are stripped. The caller must
either guarantee that Index and the data written is valid, or the caller must
set up exception handlers to catch the exceptions. This function is only
available on IA-32 and X64.
If StartBit is greater than 31, then ASSERT().
If EndBit is greater than 31, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
@param Index The 32-bit MSR index to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..31.
@param EndBit The ordinal of the most significant bit in the bit field.
Range 0..31.
@param AndData The value to AND with the read value from the MSR.
@return The lower 32-bit of the value written to the MSR.
**/
UINT32
EFIAPI
AsmMsrBitFieldAnd32 (
IN UINT32 Index,
IN UINTN StartBit,
IN UINTN EndBit,
IN UINT32 AndData
)
{
ASSERT (EndBit < sizeof (AndData) * 8);
ASSERT (StartBit <= EndBit);
return (UINT32)AsmMsrBitFieldAnd64 (Index, StartBit, EndBit, AndData);
}
/**
Reads a bit field in a 64-bit MSR, performs a bitwise AND followed by a
bitwise inclusive OR, and writes the result back to the bit field in the
64-bit MSR.
Reads the 64-bit MSR specified by Index, performs a bitwise AND followed by a
bitwise inclusive OR between the read result and the value specified by
AndData, and writes the result to the 64-bit MSR specified by Index. The
lower 32-bits of the value written to the MSR are returned. Extra left bits
in both AndData and OrData are stripped. The caller must either guarantee
that Index and the data written is valid, or the caller must set up exception
handlers to catch the exceptions. This function is only available on IA-32
and X64.
If StartBit is greater than 31, then ASSERT().
If EndBit is greater than 31, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
@param Index The 32-bit MSR index to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..31.
@param EndBit The ordinal of the most significant bit in the bit field.
Range 0..31.
@param AndData The value to AND with the read value from the MSR.
@param OrData The value to OR with the result of the AND operation.
@return The lower 32-bit of the value written to the MSR.
**/
UINT32
EFIAPI
AsmMsrBitFieldAndThenOr32 (
IN UINT32 Index,
IN UINTN StartBit,
IN UINTN EndBit,
IN UINT32 AndData,
IN UINT32 OrData
)
{
ASSERT (EndBit < sizeof (AndData) * 8);
ASSERT (StartBit <= EndBit);
return (UINT32)AsmMsrBitFieldAndThenOr64 (
Index,
StartBit,
EndBit,
AndData,
OrData
);
}
/**
Reads a 64-bit MSR, performs a bitwise inclusive OR, and writes the result
back to the 64-bit MSR.
Reads the 64-bit MSR specified by Index, performs a bitwise inclusive OR
between the read result and the value specified by OrData, and writes the
result to the 64-bit MSR specified by Index. The value written to the MSR is
returned. No parameter checking is performed on Index or OrData, and some of
these may cause CPU exceptions. The caller must either guarantee that Index
and OrData are valid, or the caller must establish proper exception handlers.
This function is only available on IA-32 and X64.
@param Index The 32-bit MSR index to write.
@param OrData The value to OR with the read value from the MSR.
@return The value written back to the MSR.
**/
UINT64
EFIAPI
AsmMsrOr64 (
IN UINT32 Index,
IN UINT64 OrData
)
{
return AsmWriteMsr64 (Index, AsmReadMsr64 (Index) | OrData);
}
/**
Reads a 64-bit MSR, performs a bitwise AND, and writes the result back to the
64-bit MSR.
Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
read result and the value specified by OrData, and writes the result to the
64-bit MSR specified by Index. The value written to the MSR is returned. No
parameter checking is performed on Index or OrData, and some of these may
cause CPU exceptions. The caller must either guarantee that Index and OrData
are valid, or the caller must establish proper exception handlers. This
function is only available on IA-32 and X64.
@param Index The 32-bit MSR index to write.
@param AndData The value to AND with the read value from the MSR.
@return The value written back to the MSR.
**/
UINT64
EFIAPI
AsmMsrAnd64 (
IN UINT32 Index,
IN UINT64 AndData
)
{
return AsmWriteMsr64 (Index, AsmReadMsr64 (Index) & AndData);
}
/**
Reads a 64-bit MSR, performs a bitwise AND followed by a bitwise inclusive
OR, and writes the result back to the 64-bit MSR.
Reads the 64-bit MSR specified by Index, performs a bitwise AND between read
result and the value specified by AndData, performs a bitwise inclusive OR
between the result of the AND operation and the value specified by OrData,
and writes the result to the 64-bit MSR specified by Index. The value written
to the MSR is returned. No parameter checking is performed on Index, AndData,
or OrData, and some of these may cause CPU exceptions. The caller must either
guarantee that Index, AndData, and OrData are valid, or the caller must
establish proper exception handlers. This function is only available on IA-32
and X64.
@param Index The 32-bit MSR index to write.
@param AndData The value to AND with the read value from the MSR.
@param OrData The value to OR with the result of the AND operation.
@return The value written back to the MSR.
**/
UINT64
EFIAPI
AsmMsrAndThenOr64 (
IN UINT32 Index,
IN UINT64 AndData,
IN UINT64 OrData
)
{
return AsmWriteMsr64 (Index, (AsmReadMsr64 (Index) & AndData) | OrData);
}
/**
Reads a bit field of an MSR.
Reads the bit field in the 64-bit MSR. The bit field is specified by the
StartBit and the EndBit. The value of the bit field is returned. The caller
must either guarantee that Index is valid, or the caller must set up
exception handlers to catch the exceptions. This function is only available
on IA-32 and X64.
If StartBit is greater than 63, then ASSERT().
If EndBit is greater than 63, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
@param Index The 32-bit MSR index to read.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..63.
@param EndBit The ordinal of the most significant bit in the bit field.
Range 0..63.
@return The value written back to the MSR.
**/
UINT64
EFIAPI
AsmMsrBitFieldRead64 (
IN UINT32 Index,
IN UINTN StartBit,
IN UINTN EndBit
)
{
return BitFieldRead64 (AsmReadMsr64 (Index), StartBit, EndBit);
}
/**
Writes a bit field to an MSR.
Writes Value to a bit field in a 64-bit MSR. The bit field is specified by
the StartBit and the EndBit. All other bits in the destination MSR are
preserved. The MSR written is returned. Extra left bits in Value are
stripped. The caller must either guarantee that Index and the data written is
valid, or the caller must set up exception handlers to catch the exceptions.
This function is only available on IA-32 and X64.
If StartBit is greater than 63, then ASSERT().
If EndBit is greater than 63, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
@param Index The 32-bit MSR index to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..63.
@param EndBit The ordinal of the most significant bit in the bit field.
Range 0..63.
@param Value New value of the bit field.
@return The value written back to the MSR.
**/
UINT64
EFIAPI
AsmMsrBitFieldWrite64 (
IN UINT32 Index,
IN UINTN StartBit,
IN UINTN EndBit,
IN UINT64 Value
)
{
return AsmWriteMsr64 (
Index,
BitFieldWrite64 (AsmReadMsr64 (Index), StartBit, EndBit, Value)
);
}
/**
Reads a bit field in a 64-bit MSR, performs a bitwise inclusive OR, and
writes the result back to the bit field in the 64-bit MSR.
Reads the 64-bit MSR specified by Index, performs a bitwise inclusive OR
between the read result and the value specified by OrData, and writes the
result to the 64-bit MSR specified by Index. The value written to the MSR is
returned. Extra left bits in OrData are stripped. The caller must either
guarantee that Index and the data written is valid, or the caller must set up
exception handlers to catch the exceptions. This function is only available
on IA-32 and X64.
If StartBit is greater than 63, then ASSERT().
If EndBit is greater than 63, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
@param Index The 32-bit MSR index to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..63.
@param EndBit The ordinal of the most significant bit in the bit field.
Range 0..63.
@param OrData The value to OR with the read value from the bit field.
@return The value written back to the MSR.
**/
UINT64
EFIAPI
AsmMsrBitFieldOr64 (
IN UINT32 Index,
IN UINTN StartBit,
IN UINTN EndBit,
IN UINT64 OrData
)
{
return AsmWriteMsr64 (
Index,
BitFieldOr64 (AsmReadMsr64 (Index), StartBit, EndBit, OrData)
);
}
/**
Reads a bit field in a 64-bit MSR, performs a bitwise AND, and writes the
result back to the bit field in the 64-bit MSR.
Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
read result and the value specified by AndData, and writes the result to the
64-bit MSR specified by Index. The value written to the MSR is returned.
Extra left bits in AndData are stripped. The caller must either guarantee
that Index and the data written is valid, or the caller must set up exception
handlers to catch the exceptions. This function is only available on IA-32
and X64.
If StartBit is greater than 63, then ASSERT().
If EndBit is greater than 63, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
@param Index The 32-bit MSR index to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..63.
@param EndBit The ordinal of the most significant bit in the bit field.
Range 0..63.
@param AndData The value to AND with the read value from the bit field.
@return The value written back to the MSR.
**/
UINT64
EFIAPI
AsmMsrBitFieldAnd64 (
IN UINT32 Index,
IN UINTN StartBit,
IN UINTN EndBit,
IN UINT64 AndData
)
{
return AsmWriteMsr64 (
Index,
BitFieldAnd64 (AsmReadMsr64 (Index), StartBit, EndBit, AndData)
);
}
/**
Reads a bit field in a 64-bit MSR, performs a bitwise AND followed by a
bitwise inclusive OR, and writes the result back to the bit field in the
64-bit MSR.
Reads the 64-bit MSR specified by Index, performs a bitwise AND followed by
a bitwise inclusive OR between the read result and the value specified by
AndData, and writes the result to the 64-bit MSR specified by Index. The
value written to the MSR is returned. Extra left bits in both AndData and
OrData are stripped. The caller must either guarantee that Index and the data
written is valid, or the caller must set up exception handlers to catch the
exceptions. This function is only available on IA-32 and X64.
If StartBit is greater than 63, then ASSERT().
If EndBit is greater than 63, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
@param Index The 32-bit MSR index to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..63.
@param EndBit The ordinal of the most significant bit in the bit field.
Range 0..63.
@param AndData The value to AND with the read value from the bit field.
@param OrData The value to OR with the result of the AND operation.
@return The value written back to the MSR.
**/
UINT64
EFIAPI
AsmMsrBitFieldAndThenOr64 (
IN UINT32 Index,
IN UINTN StartBit,
IN UINTN EndBit,
IN UINT64 AndData,
IN UINT64 OrData
)
{
return AsmWriteMsr64 (
Index,
BitFieldAndThenOr64 (
AsmReadMsr64 (Index),
StartBit,
EndBit,
AndData,
OrData
)
);
}
|
