target/register: Minor code cleanup
[fw/openocd] / src / target / register.c
index f26835bdea0815e9b5beb0ae4eb39a0745f2242c..638747560cb08f9c66762477c84ef0fa2220db6d 100644 (file)
  *   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.             *
+ *   along with this program.  If not, see <http://www.gnu.org/licenses/>. *
  ***************************************************************************/
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
 
 #include "register.h"
-#include "log.h"
+#include <helper/log.h>
+
+/**
+ * @file
+ * Holds utilities to work with register caches.
+ *
+ * OpenOCD uses machine registers internally, and exposes them by name
+ * to Tcl scripts.  Sets of related registers are grouped into caches.
+ * For example, a CPU core will expose a set of registers, and there
+ * may be separate registers associated with debug or trace modules.
+ */
+
+struct reg *register_get_by_number(struct reg_cache *first,
+               uint32_t reg_num, bool search_all)
+{
+       struct reg_cache *cache = first;
+
+       while (cache) {
+               for (unsigned int i = 0; i < cache->num_regs; i++) {
+                       if (!cache->reg_list[i].exist)
+                               continue;
+                       if (cache->reg_list[i].number == reg_num)
+                               return &(cache->reg_list[i]);
+               }
 
+               if (!search_all)
+                       break;
 
-struct reg_arch_type *reg_arch_types = NULL;
+               cache = cache->next;
+       }
+
+       return NULL;
+}
 
-struct regregister_get_by_name(struct reg_cache *first,
+struct reg *register_get_by_name(struct reg_cache *first,
                const char *name, bool search_all)
 {
-       int i;
        struct reg_cache *cache = first;
 
-       while (cache)
-       {
-               for (i = 0; i < cache->num_regs; i++)
-               {
+       while (cache) {
+               for (unsigned int i = 0; i < cache->num_regs; i++) {
+                       if (!cache->reg_list[i].exist)
+                               continue;
                        if (strcmp(cache->reg_list[i].name, name) == 0)
                                return &(cache->reg_list[i]);
                }
 
-               if (search_all)
-                       cache = cache->next;
-               else
+               if (!search_all)
                        break;
+
+               cache = cache->next;
        }
 
        return NULL;
 }
 
-struct reg_cache** register_get_last_cache_p(struct reg_cache **first)
+struct reg_cache **register_get_last_cache_p(struct reg_cache **first)
 {
        struct reg_cache **cache_p = first;
 
@@ -66,42 +93,25 @@ struct reg_cache** register_get_last_cache_p(struct reg_cache **first)
        return cache_p;
 }
 
-int register_reg_arch_type(int (*get)(struct reg *reg), int (*set)(struct reg *reg, uint8_t *buf))
+void register_unlink_cache(struct reg_cache **cache_p, const struct reg_cache *cache)
 {
-       struct reg_arch_type** arch_type_p = &reg_arch_types;
-       int id = 0;
-
-       if (*arch_type_p)
-       {
-               while (*arch_type_p)
-               {
-                       id = (*arch_type_p)->id;
-                       arch_type_p = &((*arch_type_p)->next);
-               }
-       }
-
-       (*arch_type_p) = malloc(sizeof(struct reg_arch_type));
-       (*arch_type_p)->id = id + 1;
-       (*arch_type_p)->set = set;
-       (*arch_type_p)->get = get;
-       (*arch_type_p)->next = NULL;
-
-       return id + 1;
+       while (*cache_p && *cache_p != cache)
+               cache_p = &((*cache_p)->next);
+       if (*cache_p)
+               *cache_p = cache->next;
 }
 
-struct reg_arch_type* register_get_arch_type(int id)
+/** Marks the contents of the register cache as invalid (and clean). */
+void register_cache_invalidate(struct reg_cache *cache)
 {
-       struct reg_arch_type *arch_type = reg_arch_types;
+       struct reg *reg = cache->reg_list;
 
-       while (arch_type)
-       {
-               if (arch_type->id == id)
-                       return arch_type;
-               arch_type = arch_type->next;
+       for (unsigned int n = cache->num_regs; n != 0; n--, reg++) {
+               if (!reg->exist)
+                       continue;
+               reg->valid = false;
+               reg->dirty = false;
        }
-       LOG_ERROR("BUG: encountered unregistered arch type 0x%08x", id);
-       exit(-1);
-       return NULL;
 }
 
 static int register_get_dummy_core_reg(struct reg *reg)
@@ -111,17 +121,18 @@ static int register_get_dummy_core_reg(struct reg *reg)
 
 static int register_set_dummy_core_reg(struct reg *reg, uint8_t *buf)
 {
-       reg->dirty = 1;
-       reg->valid = 1;
+       reg->dirty = true;
+       reg->valid = true;
 
        return ERROR_OK;
 }
 
+static const struct reg_arch_type dummy_type = {
+       .get = register_get_dummy_core_reg,
+       .set = register_set_dummy_core_reg,
+};
+
 void register_init_dummy(struct reg *reg)
 {
-       static int dummy_arch_type = -1;
-       if (dummy_arch_type == -1)
-               dummy_arch_type = register_reg_arch_type(register_get_dummy_core_reg, register_set_dummy_core_reg);
-
-       reg->arch_type = dummy_arch_type;
+       reg->type = &dummy_type;
 }