Skip to content

Commit 0495e19

Browse files
authored
Update documentation
1 parent 4d91492 commit 0495e19

File tree

1 file changed

+20
-3
lines changed

1 file changed

+20
-3
lines changed

src/registers/hcr_el2.rs

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -77,9 +77,13 @@ register_bitfields! {u64,
7777
TICAB OFFSET(50) NUMBITS(1) [],
7878

7979
/// Trap ID group 4
80+
///
81+
/// Requires FEAT_EVT
8082
TID4 OFFSET(49) NUMBITS(1) [],
8183

8284
/// Granule Protection Fault routing control.
85+
///
86+
/// Requires FEAT_RME
8387
GPF OFFSET(48) NUMBITS(1) [],
8488

8589
/// Fault Injection Enable.
@@ -110,9 +114,13 @@ register_bitfields! {u64,
110114
AT OFFSET(44) NUMBITS(1) [],
111115

112116
/// Nested Virtualization.
117+
///
118+
/// Changes meaning depending on if FEAT_NV2 or FEAT_NV is implemented.
113119
NV1 OFFSET(43) NUMBITS(1) [],
114120

115121
/// Nested Virtualization.
122+
///
123+
/// Changes meaning depending on if FEAT_NV2 or FEAT_NV is implemented.
116124
NV OFFSET(42) NUMBITS(1) [],
117125

118126
/// Controls the use of instructions related to Pointer Authentication.
@@ -148,6 +156,8 @@ register_bitfields! {u64,
148156
/// TME.
149157
///
150158
/// Requires FEAT_TME.
159+
///
160+
/// Enables access to the TSTART, TCOMMIT, TTEST, and TCANCEL instructions at EL0 and EL1.
151161
TME OFFSET(39) NUMBITS(1) [],
152162

153163
/// Route synchronous External abort exceptions to EL2.
@@ -209,10 +219,12 @@ register_bitfields! {u64,
209219
EL1IsAarch64 = 1
210220
],
211221

212-
/// Trap Read of Virtual Memory registers.
222+
/// Trap Read of Virtual Memory control registers.
213223
TRVM OFFSET(30) NUMBITS(1) [],
214224

215225
/// HVC instruction Disable.
226+
///
227+
/// Requires EL3 _not_ implemented
216228
HCD OFFSET(29) NUMBITS(1) [],
217229

218230
/// Trap DC ZVA.
@@ -293,6 +305,7 @@ register_bitfields! {u64,
293305
DisableTrapTVM = 0,
294306
EnableTrapTVM = 1,
295307
],
308+
296309
/// Trap TLB Maintenance instructions.
297310
TTLB OFFSET(25) NUMBITS(1) [],
298311

@@ -302,8 +315,6 @@ register_bitfields! {u64,
302315
/// Trap Cache Maintenance to Coherency.
303316
TPCP OFFSET(23) NUMBITS(1) [],
304317

305-
306-
307318
/// Trap data or unified cache maintenance instructions that operate by Set/Way.
308319
///
309320
/// Traps execution of those cache maintenance instructions at EL1 to EL2, when
@@ -393,12 +404,18 @@ register_bitfields! {u64,
393404
TID1 OFFSET(16) NUMBITS(1) [],
394405

395406
/// Trap ID group 0.
407+
///
408+
/// Requires FEAT_AA32
396409
TID0 OFFSET(15) NUMBITS(1) [],
397410

398411
/// Trap WFE Instructions.
412+
///
413+
/// Additionally applies to WFET when FEAT_WFxT is implemented.
399414
TWE OFFSET(14) NUMBITS(1) [],
400415

401416
/// Trap WFI Instructions.
417+
///
418+
/// Additionally applies to WFIT when FEAT_WFxT is implemented.
402419
TWI OFFSET(13) NUMBITS(1) [],
403420

404421
/// Default Cacheability.

0 commit comments

Comments
 (0)