aboutsummaryrefslogtreecommitdiff
path: root/doc/openocd.texi
diff options
context:
space:
mode:
authorKoudai Iwahori <koudai@google.com>2022-10-04 04:21:35 -0700
committerAntonio Borneo <borneo.antonio@gmail.com>2023-01-15 14:51:44 +0000
commitd0436b0cdabb2106701222628d78932c973a1e62 (patch)
tree0055aa21084ebfa6dd8c6ecaa289e9a6d9105257 /doc/openocd.texi
parentd96dc47ef67e427cd64a07d9825fd297e3a81633 (diff)
downloadriscv-openocd-d0436b0cdabb2106701222628d78932c973a1e62.zip
riscv-openocd-d0436b0cdabb2106701222628d78932c973a1e62.tar.gz
riscv-openocd-d0436b0cdabb2106701222628d78932c973a1e62.tar.bz2
armv8: Add support of pointer authentication
When pointer authentication is enabled, some upper bits of the link register (LR[63:VA_SIZE]) are used to store a signature. Therefore, GDB need to remove the signature to get backtraces. GDB has support of pointer authentication. When pointer authenticaion is enabled, GDB requests 8-bytes mask to the target to remove the signature. mask[63:VA_SIZE] should be all set and mask[VA_SIZE-1:0] should be all cleared. GDB removes the signature by addr&~mask or addr|mask. I added a feature to provide the mask for pointer authentication. Signed-off-by: Koudai Iwahori <koudai@google.com> Change-Id: I56fbbf9cc23619b6536ecd326f350c8bf137f322 Reviewed-on: https://review.openocd.org/c/openocd/+/7248 Tested-by: jenkins Reviewed-by: Antonio Borneo <borneo.antonio@gmail.com>
Diffstat (limited to 'doc/openocd.texi')
-rw-r--r--doc/openocd.texi10
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/openocd.texi b/doc/openocd.texi
index c7fee3e..aa1707b 100644
--- a/doc/openocd.texi
+++ b/doc/openocd.texi
@@ -10297,6 +10297,16 @@ the target, the exception catch must be disabled again with @command{$target_nam
Issuing the command without options prints the current configuration.
@end deffn
+@deffn {Command} {$target_name pauth} [@option{off}|@option{on}]
+Enable or disable pointer authentication features.
+When pointer authentication is used on ARM cores, GDB asks GDB servers for an 8-bytes mask to remove signature bits added by pointer authentication.
+If this feature is enabled, OpenOCD provides GDB with an 8-bytes mask.
+Pointer authentication feature is broken until gdb 12.1, going to be fixed.
+Consider using a newer version of gdb if you want to enable pauth feature.
+The default configuration is @option{off}.
+@end deffn
+
+
@section EnSilica eSi-RISC Architecture
eSi-RISC is a highly configurable microprocessor architecture for embedded systems