sframe: doc: update documentation for pauth key in SFrame FDE
authorIndu Bhagat <indu.bhagat@oracle.com>
Thu, 22 Dec 2022 17:58:21 +0000 (09:58 -0800)
committerIndu Bhagat <indu.bhagat@oracle.com>
Thu, 22 Dec 2022 17:58:21 +0000 (09:58 -0800)
ChangeLog:

* libsframe/doc/sframe-spec.texi

libsframe/doc/sframe-spec.texi

index fa66d801dd3a2cb315b8ba17a8501624ad87e060..345b8f9303689e364be777f961ee704cbd45382a 100644 (file)
@@ -398,10 +398,16 @@ The info word is a bitfield split into three parts.  From MSB to LSB:
 
 @multitable {Bit offset} {@code{isroot}} {Length of variable-length data for this type (some kinds only).}
 @headitem Bit offset @tab Name @tab Description
-@item 7--5
+@item 7--6
 @tab @code{unused}
 @tab Unused bits.
 
+@item 5
+@tab @code{pauth_key}
+@tab Specify which key is used for signing the return addresses in the SFrame
+FDE.  Two possible values: SFRAME_AARCH64_PAUTH_KEY_A (0) or
+SFRAME_AARCH64_PAUTH_KEY_B (1).
+
 @item 4
 @tab @code{fdetype}
 @tab SFRAME_FDE_TYPE_PCMASK (1) or SFRAME_FDE_TYPE_PCINC (0). @xref{The SFrame FDE types}.