src/target/register.c

   1 /***************************************************************************
   2  *   Copyright (C) 2005 by Dominic Rath                                    *
   3  *   Dominic.Rath@gmx.de                                                   *
   4  *                                                                         *
   5  *   Copyright (C) 2007,2008 Øyvind Harboe                                 *
   6  *   oyvind.harboe@zylin.com                                               *
   7  *                                                                         *
   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.                                   *
  12  *                                                                         *
  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.                          *
  17  *                                                                         *
  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  ***************************************************************************/
  21
  22 #ifdef HAVE_CONFIG_H
  23 #include "config.h"
  24 #endif
  25
  26 #include "register.h"
  27 #include <helper/log.h>
  28
  29 /**
  30  * @file
  31  * Holds utilities to work with register caches.
  32  *
  33  * OpenOCD uses machine registers internally, and exposes them by name
  34  * to Tcl scripts.  Sets of related registers are grouped into caches.
  35  * For example, a CPU core will expose a set of registers, and there
  36  * may be separate registers associated with debug or trace modules.
  37  */
  38
  39 struct reg *register_get_by_number(struct reg_cache *first,
  40                 uint32_t reg_num, bool search_all)
  41 {
  42         unsigned i;
  43         struct reg_cache *cache = first;
  44
  45         while (cache) {
  46                 for (i = 0; i < cache->num_regs; i++) {
  47                         if (cache->reg_list[i].exist == false)
  48                                 continue;
  49                         if (cache->reg_list[i].number == reg_num)
  50                                 return &(cache->reg_list[i]);
  51                 }
  52
  53                 if (search_all)
  54                         cache = cache->next;
  55                 else
  56                         break;
  57         }
  58
  59         return NULL;
  60 }
  61
  62 struct reg *register_get_by_name(struct reg_cache *first,
  63                 const char *name, bool search_all)
  64 {
  65         unsigned i;
  66         struct reg_cache *cache = first;
  67
  68         while (cache) {
  69                 for (i = 0; i < cache->num_regs; i++) {
  70                         if (cache->reg_list[i].exist == false)
  71                                 continue;
  72                         if (strcmp(cache->reg_list[i].name, name) == 0)
  73                                 return &(cache->reg_list[i]);
  74                 }
  75
  76                 if (search_all)
  77                         cache = cache->next;
  78                 else
  79                         break;
  80         }
  81
  82         return NULL;
  83 }
  84
  85 struct reg_cache **register_get_last_cache_p(struct reg_cache **first)
  86 {
  87         struct reg_cache **cache_p = first;
  88
  89         if (*cache_p)
  90                 while (*cache_p)
  91                         cache_p = &((*cache_p)->next);
  92         else
  93                 return first;
  94
  95         return cache_p;
  96 }
  97
  98 void register_unlink_cache(struct reg_cache **cache_p, const struct reg_cache *cache)
  99 {
 100         while (*cache_p && *cache_p != cache)
 101                 cache_p = &((*cache_p)->next);
 102         if (*cache_p)
 103                 *cache_p = cache->next;
 104 }
 105
 106 /** Marks the contents of the register cache as invalid (and clean). */
 107 void register_cache_invalidate(struct reg_cache *cache)
 108 {
 109         struct reg *reg = cache->reg_list;
 110
 111         for (unsigned n = cache->num_regs; n != 0; n--, reg++) {
 112                 if (reg->exist == false)
 113                         continue;
 114                 reg->valid = false;
 115                 reg->dirty = false;
 116         }
 117 }
 118
 119 static int register_get_dummy_core_reg(struct reg *reg)
 120 {
 121         return ERROR_OK;
 122 }
 123
 124 static int register_set_dummy_core_reg(struct reg *reg, uint8_t *buf)
 125 {
 126         reg->dirty = true;
 127         reg->valid = true;
 128
 129         return ERROR_OK;
 130 }
 131
 132 static const struct reg_arch_type dummy_type = {
 133         .get = register_get_dummy_core_reg,
 134         .set = register_set_dummy_core_reg,
 135 };
 136
 137 void register_init_dummy(struct reg *reg)
 138 {
 139         reg->type = &dummy_type;
 140 }