X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=src%2Ftarget%2Fregister.h;h=7c53d6e16deb531c82879001f494f98df69a7da7;hp=e6ea09c6e5fd69b8891bf9e43ae60ee4b775c3ed;hb=HEAD;hpb=41638e0a09909340532ee1549fe020a703ca84f0 diff --git a/src/target/register.h b/src/target/register.h index e6ea09c6e5..1e4f2e0889 100644 --- a/src/target/register.h +++ b/src/target/register.h @@ -1,72 +1,166 @@ +/* SPDX-License-Identifier: GPL-2.0-or-later */ + /*************************************************************************** * Copyright (C) 2005 by Dominic Rath * * Dominic.Rath@gmx.de * * * - * Copyright (C) 2007,2008 Øyvind Harboe * + * Copyright (C) 2007,2008 Øyvind Harboe * * oyvind.harboe@zylin.com * - * * - * This program is free software; you can redistribute it and/or modify * - * it under the terms of the GNU General Public License as published by * - * the Free Software Foundation; either version 2 of the License, or * - * (at your option) any later version. * - * * - * This program is distributed in the hope that it will be useful, * - * but WITHOUT ANY WARRANTY; without even the implied warranty of * - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * - * GNU General Public License for more details. * - * * - * You should have received a copy of the GNU General Public License * - * along with this program; if not, write to the * - * Free Software Foundation, Inc., * - * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * ***************************************************************************/ -#ifndef REGISTER_H -#define REGISTER_H - -#include "types.h" -#include "target.h" - -struct target_s; - -typedef struct bitfield_desc_s -{ - char *name; - int num_bits; -} bitfield_desc_t; - -typedef struct reg_s -{ - char *name; - void *value; - int dirty; - int valid; - u32 size; - bitfield_desc_t *bitfield_desc; - int num_bitfields; + +#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; - int arch_type; -} reg_t; - -typedef struct reg_cache_s -{ - char *name; - struct reg_cache_s *next; - reg_t *reg_list; - int num_regs; -} reg_cache_t; - -typedef struct reg_arch_type_s -{ - int id; - int (*get)(reg_t *reg); - int (*set)(reg_t *reg, u8 *buf); - struct reg_arch_type_s *next; -} reg_arch_type_t; - -extern reg_t* register_get_by_name(reg_cache_t *first, char *name, int search_all); -extern reg_cache_t** register_get_last_cache_p(reg_cache_t **first); -extern int register_reg_arch_type(int (*get)(reg_t *reg), int (*set)(reg_t *reg, u8 *buf)); -extern reg_arch_type_t* register_get_arch_type(int id); -extern void register_init_dummy(reg_t *reg); - -#endif /* REGISTER_H */ + const struct reg_arch_type *type; +}; + +struct reg_cache { + const char *name; + struct reg_cache *next; + struct reg *reg_list; + unsigned 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 */