register.h

Go to the documentation of this file.

/* SPDX-License-Identifier: GPL-2.0-or-later */
 
/***************************************************************************
 *   Copyright (C) 2005 by Dominic Rath                                    *
 *   Dominic.Rath@gmx.de                                                   *
 *                                                                         *
 *   Copyright (C) 2007,2008 Øyvind Harboe                                 *
 *   oyvind.harboe@zylin.com                                               *
 ***************************************************************************/
 
#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,
    REG_TYPE_UINT64,
    REG_TYPE_UINT128,
    REG_TYPE_CODE_PTR,
    REG_TYPE_DATA_PTR,
    REG_TYPE_FLOAT,
    REG_TYPE_IEEE_SINGLE,
    REG_TYPE_IEEE_DOUBLE,
    REG_TYPE_ARCH_DEFINED,
};
 
struct reg_feature {
    const char *name;
};
 
struct reg_data_type_vector {
    struct reg_data_type *type;
    uint32_t count;
};
 
struct reg_data_type_union_field {
    const char *name;
    struct reg_data_type *type;
    struct reg_data_type_union_field *next;
};
 
struct reg_data_type_union {
    struct reg_data_type_union_field *fields;
};
 
struct reg_data_type_bitfield {
    uint32_t start;
    uint32_t end;
    enum reg_type type;
};
 
struct reg_data_type_struct_field {
    const char *name;
    bool use_bitfields;
    union {
        struct reg_data_type_bitfield *bitfield;
        struct reg_data_type *type;
    };
    struct reg_data_type_struct_field *next;
};
 
struct reg_data_type_struct {
    uint32_t size;
    struct reg_data_type_struct_field *fields;
};
 
struct reg_data_type_flags_field {
    const char *name;
    struct reg_data_type_bitfield *bitfield;
    struct reg_data_type_flags_field *next;
};
 
struct reg_data_type_flags {
    uint32_t size;
    struct reg_data_type_flags_field *fields;
};
 
enum reg_data_type_class {
    REG_TYPE_CLASS_VECTOR,
    REG_TYPE_CLASS_UNION,
    REG_TYPE_CLASS_STRUCT,
    REG_TYPE_CLASS_FLAGS,
};
 
struct reg_data_type {
    enum reg_type type;
    const char *id;
    enum reg_data_type_class type_class;
    union {
        struct reg_data_type_vector *reg_type_vector;
        struct reg_data_type_union *reg_type_union;
        struct reg_data_type_struct *reg_type_struct;
        struct reg_data_type_flags *reg_type_flags;
    };
};
 
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. */
    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;
};
 
struct reg_cache {
    const char *name;
    struct reg_cache *next;
    struct reg *reg_list;
    unsigned int num_regs;
};
 
struct reg_arch_type {
    int (*get)(struct reg *reg);
    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);
void register_unlink_cache(struct reg_cache **cache_p, const struct reg_cache *cache);
void register_cache_invalidate(struct reg_cache *cache);
 
void register_init_dummy(struct reg *reg);
 
#endif /* OPENOCD_TARGET_REGISTER_H */