openocd: prevent jimtcl error message while testing commands

[fw/openocd] / src / target / register.h

diff --git a/src/target/register.h b/src/target/register.h
index d3b2c31c23b8e39a33ce080775cf2f9206c8e2f7..a7705f76e089bed004be1ce7c3a704d30b28a0c8 100644 (file)
--- a/src/target/register.h
+++ b/src/target/register.h
@@ -22,15 +22,20 @@
 #ifndef OPENOCD_TARGET_REGISTER_H
 #define OPENOCD_TARGET_REGISTER_H
 
+#include "helper/replacements.h"
+#include "helper/types.h"
+
 struct target;
 
 enum reg_type {
+       REG_TYPE_BOOL,
        REG_TYPE_INT,
        REG_TYPE_INT8,
        REG_TYPE_INT16,
        REG_TYPE_INT32,
        REG_TYPE_INT64,
        REG_TYPE_INT128,
+       REG_TYPE_UINT,
        REG_TYPE_UINT8,
        REG_TYPE_UINT16,
        REG_TYPE_UINT32,
@@ -66,6 +71,7 @@ struct reg_data_type_union {
 struct reg_data_type_bitfield {
        uint32_t start;
        uint32_t end;
+       enum reg_type type;
 };
 
 struct reg_data_type_struct_field {
@@ -114,17 +120,34 @@ 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;
-       void *value;
+       /* Pointer to place where the value is stored, in the format understood by
+        * the binarybuffer.h functions. */
+       uint8_t *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;
+       /* Hide the register from gdb and omit it in 'reg' cmd output */
+       bool hidden;
+       /* 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;
 };
@@ -141,6 +164,8 @@ struct reg_arch_type {
        int (*set)(struct reg *reg, uint8_t *buf);
 };
 
+struct reg *register_get_by_number(struct reg_cache *first,
+               uint32_t reg_num, bool search_all);
 struct reg *register_get_by_name(struct reg_cache *first,
                const char *name, bool search_all);
 struct reg_cache **register_get_last_cache_p(struct reg_cache **first);