From: Tim Newsome Date: Sun, 8 Oct 2017 19:03:25 +0000 (-0700) Subject: Document `struct reg` fields. X-Git-Tag: v0.11.0-rc1~1330 X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=commitdiff_plain;h=1356be121ef97509a3318c62380930689b0b3f76 Document `struct reg` fields. Change-Id: I286316079e2e4d4f09427a4ffbecadb48c5dc9d9 Signed-off-by: Tim Newsome Reviewed-on: http://openocd.zylin.com/4250 Tested-by: jenkins Reviewed-by: Liviu Ionescu Reviewed-by: Andreas Fritiofson --- diff --git a/src/target/register.h b/src/target/register.h index d3b2c31c23..dc18e9a899 100644 --- a/src/target/register.h +++ b/src/target/register.h @@ -114,17 +114,32 @@ struct reg_data_type { }; struct reg { + /* Canonical name of the register. */ const char *name; + /* Number that gdb uses to access this register. */ uint32_t number; + /* TODO. This should probably be const. */ struct reg_feature *feature; + /* TODO: When true, the caller will save this register before running any algorithm. */ bool caller_save; + /* Pointer to place where the value is stored, in the format understood by + * the binarybuffer.h functions. */ void *value; + /* The stored value needs to be written to the target. */ bool dirty; + /* When true, value is valid. */ bool valid; + /* When false, the register doesn't actually exist in the target. */ bool exist; + /* Size of the register in bits. */ uint32_t size; + /* Used for generating XML description of registers. Can be set to NULL for + * targets that don't use that. */ struct reg_data_type *reg_data_type; + /* Used for generating XML description of registers. Can be set to NULL for + * targets that don't use that. */ const char *group; + /* Pointer to architecture-specific info for this register. */ void *arch_info; const struct reg_arch_type *type; };