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
46 REG_TYPE_ARCH_DEFINED,
53 struct reg_data_type_vector {
54 struct reg_data_type *type;
58 struct reg_data_type_union_field {
60 struct reg_data_type *type;
61 struct reg_data_type_union_field *next;
64 struct reg_data_type_union {
65 struct reg_data_type_union_field *fields;
68 struct reg_data_type_bitfield {
74 struct reg_data_type_struct_field {
78 struct reg_data_type_bitfield *bitfield;
79 struct reg_data_type *type;
81 struct reg_data_type_struct_field *next;
84 struct reg_data_type_struct {
86 struct reg_data_type_struct_field *fields;
89 struct reg_data_type_flags_field {
91 struct reg_data_type_bitfield *bitfield;
92 struct reg_data_type_flags_field *next;
95 struct reg_data_type_flags {
97 struct reg_data_type_flags_field *fields;
100 enum reg_data_type_class {
101 REG_TYPE_CLASS_VECTOR,
102 REG_TYPE_CLASS_UNION,
103 REG_TYPE_CLASS_STRUCT,
104 REG_TYPE_CLASS_FLAGS,
107 struct reg_data_type {
110 enum reg_data_type_class type_class;
112 struct reg_data_type_vector *reg_type_vector;
113 struct reg_data_type_union *reg_type_union;
114 struct reg_data_type_struct *reg_type_struct;
115 struct reg_data_type_flags *reg_type_flags;
120 /* Canonical name of the register. */
122 /* Number that gdb uses to access this register. */
124 /* TODO. This should probably be const. */
125 struct reg_feature *feature;
126 /* TODO: When true, the caller will save this register before running any algorithm. */
128 /* Pointer to place where the value is stored, in the format understood by
129 * the binarybuffer.h functions. */
131 /* The stored value needs to be written to the target. */
133 /* When true, value is valid. */
135 /* When false, the register doesn't actually exist in the target. */
137 /* Hide the register from gdb and omit it in 'reg' cmd output */
139 /* Size of the register in bits. */
141 /* Used for generating XML description of registers. Can be set to NULL for
142 * targets that don't use that. */
143 struct reg_data_type *reg_data_type;
144 /* Used for generating XML description of registers. Can be set to NULL for
145 * targets that don't use that. */
147 /* Pointer to architecture-specific info for this register. */
149 const struct reg_arch_type *type;
154 struct reg_cache *next;
155 struct reg *reg_list;
159 struct reg_arch_type {
160 int (*get)(struct reg *reg);
161 int (*set)(struct reg *reg, uint8_t *buf);
164 struct reg *register_get_by_number(struct reg_cache *first,
165 uint32_t reg_num, bool search_all);
166 struct reg *register_get_by_name(struct reg_cache *first,
167 const char *name, bool search_all);
168 struct reg_cache **register_get_last_cache_p(struct reg_cache **first);
169 void register_unlink_cache(struct reg_cache **cache_p, const struct reg_cache *cache);
170 void register_cache_invalidate(struct reg_cache *cache);
172 void register_init_dummy(struct reg *reg);
174 #endif /* OPENOCD_TARGET_REGISTER_H */