1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * Copyright (C) 2007,2008 Øyvind Harboe *
6 * oyvind.harboe@zylin.com *
8 * This program is free software; you can redistribute it and/or modify *
9 * it under the terms of the GNU General Public License as published by *
10 * the Free Software Foundation; either version 2 of the License, or *
11 * (at your option) any later version. *
13 * This program is distributed in the hope that it will be useful, *
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
16 * GNU General Public License for more details. *
18 * You should have received a copy of the GNU General Public License *
19 * along with this program. If not, see <http://www.gnu.org/licenses/>. *
20 ***************************************************************************/
22 #ifndef OPENOCD_TARGET_REGISTER_H
23 #define OPENOCD_TARGET_REGISTER_H
25 #include "helper/replacements.h"
26 #include "helper/types.h"
49 REG_TYPE_ARCH_DEFINED,
56 struct reg_data_type_vector {
57 struct reg_data_type *type;
61 struct reg_data_type_union_field {
63 struct reg_data_type *type;
64 struct reg_data_type_union_field *next;
67 struct reg_data_type_union {
68 struct reg_data_type_union_field *fields;
71 struct reg_data_type_bitfield {
77 struct reg_data_type_struct_field {
81 struct reg_data_type_bitfield *bitfield;
82 struct reg_data_type *type;
84 struct reg_data_type_struct_field *next;
87 struct reg_data_type_struct {
89 struct reg_data_type_struct_field *fields;
92 struct reg_data_type_flags_field {
94 struct reg_data_type_bitfield *bitfield;
95 struct reg_data_type_flags_field *next;
98 struct reg_data_type_flags {
100 struct reg_data_type_flags_field *fields;
103 enum reg_data_type_class {
104 REG_TYPE_CLASS_VECTOR,
105 REG_TYPE_CLASS_UNION,
106 REG_TYPE_CLASS_STRUCT,
107 REG_TYPE_CLASS_FLAGS,
110 struct reg_data_type {
113 enum reg_data_type_class type_class;
115 struct reg_data_type_vector *reg_type_vector;
116 struct reg_data_type_union *reg_type_union;
117 struct reg_data_type_struct *reg_type_struct;
118 struct reg_data_type_flags *reg_type_flags;
123 /* Canonical name of the register. */
125 /* Number that gdb uses to access this register. */
127 /* TODO. This should probably be const. */
128 struct reg_feature *feature;
129 /* TODO: When true, the caller will save this register before running any algorithm. */
131 /* Pointer to place where the value is stored, in the format understood by
132 * the binarybuffer.h functions. */
134 /* The stored value needs to be written to the target. */
136 /* When true, value is valid. */
138 /* When false, the register doesn't actually exist in the target. */
140 /* Hide the register from gdb and omit it in 'reg' cmd output */
142 /* Size of the register in bits. */
144 /* Used for generating XML description of registers. Can be set to NULL for
145 * targets that don't use that. */
146 struct reg_data_type *reg_data_type;
147 /* Used for generating XML description of registers. Can be set to NULL for
148 * targets that don't use that. */
150 /* Pointer to architecture-specific info for this register. */
152 const struct reg_arch_type *type;
157 struct reg_cache *next;
158 struct reg *reg_list;
162 struct reg_arch_type {
163 int (*get)(struct reg *reg);
164 int (*set)(struct reg *reg, uint8_t *buf);
167 struct reg *register_get_by_number(struct reg_cache *first,
168 uint32_t reg_num, bool search_all);
169 struct reg *register_get_by_name(struct reg_cache *first,
170 const char *name, bool search_all);
171 struct reg_cache **register_get_last_cache_p(struct reg_cache **first);
172 void register_unlink_cache(struct reg_cache **cache_p, const struct reg_cache *cache);
173 void register_cache_invalidate(struct reg_cache *cache);
175 void register_init_dummy(struct reg *reg);
177 #endif /* OPENOCD_TARGET_REGISTER_H */