Document `struct reg` fields.
Change-Id: I286316079e2e4d4f09427a4ffbecadb48c5dc9d9 Signed-off-by: Tim Newsome <tim@sifive.com> Reviewed-on: http://openocd.zylin.com/4250 Tested-by: jenkins Reviewed-by: Liviu Ionescu <ilg@livius.net> Reviewed-by: Andreas Fritiofson <andreas.fritiofson@gmail.com>
This commit is contained in:
parent
0e02fe40c6
commit
1356be121e
|
@ -114,17 +114,32 @@ struct reg_data_type {
|
||||||
};
|
};
|
||||||
|
|
||||||
struct reg {
|
struct reg {
|
||||||
|
/* Canonical name of the register. */
|
||||||
const char *name;
|
const char *name;
|
||||||
|
/* Number that gdb uses to access this register. */
|
||||||
uint32_t number;
|
uint32_t number;
|
||||||
|
/* TODO. This should probably be const. */
|
||||||
struct reg_feature *feature;
|
struct reg_feature *feature;
|
||||||
|
/* TODO: When true, the caller will save this register before running any algorithm. */
|
||||||
bool caller_save;
|
bool caller_save;
|
||||||
|
/* Pointer to place where the value is stored, in the format understood by
|
||||||
|
* the binarybuffer.h functions. */
|
||||||
void *value;
|
void *value;
|
||||||
|
/* The stored value needs to be written to the target. */
|
||||||
bool dirty;
|
bool dirty;
|
||||||
|
/* When true, value is valid. */
|
||||||
bool valid;
|
bool valid;
|
||||||
|
/* When false, the register doesn't actually exist in the target. */
|
||||||
bool exist;
|
bool exist;
|
||||||
|
/* Size of the register in bits. */
|
||||||
uint32_t size;
|
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;
|
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;
|
const char *group;
|
||||||
|
/* Pointer to architecture-specific info for this register. */
|
||||||
void *arch_info;
|
void *arch_info;
|
||||||
const struct reg_arch_type *type;
|
const struct reg_arch_type *type;
|
||||||
};
|
};
|
||||||
|
|
Loading…
Reference in New Issue