1 /* Target description support for GDB.
3 Copyright (C) 2006, 2007 Free Software Foundation, Inc.
5 Contributed by CodeSourcery.
7 This file is part of GDB.
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 2 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program; if not, write to the Free Software
21 Foundation, Inc., 51 Franklin Street, Fifth Floor,
22 Boston, MA 02110-1301, USA. */
24 #ifndef TARGET_DESCRIPTIONS_H
25 #define TARGET_DESCRIPTIONS_H 1
28 struct tdesc_arch_data;
34 /* Fetch the current target's description, and switch the current
35 architecture to one which incorporates that description. */
37 void target_find_description (void);
39 /* Discard any description fetched from the current target, and switch
40 the current architecture to one with no target description. */
42 void target_clear_description (void);
44 /* Return the global current target description. This should only be
45 used by gdbarch initialization code; most access should be through
46 an existing gdbarch. */
48 const struct target_desc *target_current_description (void);
50 /* Record architecture-specific functions to call for pseudo-register
51 support. If tdesc_use_registers is called and gdbarch_num_pseudo_regs
52 is greater than zero, then these should be called as well.
53 They are equivalent to the gdbarch methods with similar names,
54 except that they will only be called for pseudo registers. */
56 void set_tdesc_pseudo_register_name
57 (struct gdbarch *gdbarch, gdbarch_register_name_ftype *pseudo_name);
59 void set_tdesc_pseudo_register_type
60 (struct gdbarch *gdbarch, gdbarch_register_type_ftype *pseudo_type);
62 void set_tdesc_pseudo_register_reggroup_p
63 (struct gdbarch *gdbarch,
64 gdbarch_register_reggroup_p_ftype *pseudo_reggroup_p);
66 /* Update GDBARCH to use the target description for registers. Fixed
67 register assignments are taken from EARLY_DATA, which is freed.
68 All registers which have not been assigned fixed numbers are given
69 numbers above the current value of gdbarch_num_regs.
70 gdbarch_num_regs and various register-related predicates are updated to
71 refer to the target description. This function should only be called from
72 the architecture's gdbarch initialization routine, and only after
73 successfully validating the required registers. */
75 void tdesc_use_registers (struct gdbarch *gdbarch,
76 struct tdesc_arch_data *early_data);
78 /* Allocate initial data for validation of a target description during
79 gdbarch initialization. */
81 struct tdesc_arch_data *tdesc_data_alloc (void);
83 /* Clean up data allocated by tdesc_data_alloc. This should only
84 be called to discard the data; tdesc_use_registers takes ownership
85 of its EARLY_DATA argument. */
87 void tdesc_data_cleanup (void *data_untyped);
89 /* Search FEATURE for a register named NAME. Record REGNO and the
90 register in DATA; when tdesc_use_registers is called, REGNO will be
91 assigned to the register. 1 is returned if the register was found,
94 int tdesc_numbered_register (const struct tdesc_feature *feature,
95 struct tdesc_arch_data *data,
96 int regno, const char *name);
98 /* Search FEATURE for a register with any of the names from NAMES
99 (NULL-terminated). Record REGNO and the register in DATA; when
100 tdesc_use_registers is called, REGNO will be assigned to the
101 register. 1 is returned if the register was found, 0 if it was
104 int tdesc_numbered_register_choices (const struct tdesc_feature *feature,
105 struct tdesc_arch_data *data,
106 int regno, const char *const names[]);
109 /* Accessors for target descriptions. */
111 /* Return the BFD architecture associated with this target
112 description, or NULL if no architecture was specified. */
114 const struct bfd_arch_info *tdesc_architecture
115 (const struct target_desc *);
117 /* Return the string value of a property named KEY, or NULL if the
118 property was not specified. */
120 const char *tdesc_property (const struct target_desc *,
123 /* Return 1 if this target description describes any registers. */
125 int tdesc_has_registers (const struct target_desc *);
127 /* Return the feature with the given name, if present, or NULL if
128 the named feature is not found. */
130 const struct tdesc_feature *tdesc_find_feature (const struct target_desc *,
133 /* Return the name of FEATURE. */
135 const char *tdesc_feature_name (const struct tdesc_feature *feature);
137 /* Return the type associated with ID in the context of FEATURE, or
140 struct type *tdesc_named_type (const struct tdesc_feature *feature,
143 /* Return the name of register REGNO, from the target description or
144 from an architecture-provided pseudo_register_name method. */
146 const char *tdesc_register_name (int regno);
148 /* Check whether REGNUM is a member of REGGROUP using the target
149 description. Return -1 if the target description does not
152 int tdesc_register_in_reggroup_p (struct gdbarch *gdbarch, int regno,
153 struct reggroup *reggroup);
155 /* Methods for constructing a target description. */
157 struct target_desc *allocate_target_description (void);
158 struct cleanup *make_cleanup_free_target_description (struct target_desc *);
159 void set_tdesc_architecture (struct target_desc *,
160 const struct bfd_arch_info *);
161 void set_tdesc_property (struct target_desc *,
162 const char *key, const char *value);
164 struct tdesc_feature *tdesc_create_feature (struct target_desc *tdesc,
166 void tdesc_record_type (struct tdesc_feature *feature, struct type *type);
168 void tdesc_create_reg (struct tdesc_feature *feature, const char *name,
169 int regnum, int save_restore, const char *group,
170 int bitsize, const char *type);
172 #endif /* TARGET_DESCRIPTIONS_H */