build: add helper/types.h to config.h
[openocd.git] / 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, write to the *
20 * Free Software Foundation, Inc., *
21 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
22 ***************************************************************************/
23
24 #ifdef HAVE_CONFIG_H
25 #include "config.h"
26 #endif
27
28 #include "register.h"
29 #include <helper/log.h>
30
31 /**
32 * @file
33 * Holds utilities to work with register caches.
34 *
35 * OpenOCD uses machine registers internally, and exposes them by name
36 * to Tcl scripts. Sets of related registers are grouped into caches.
37 * For example, a CPU core will expose a set of registers, and there
38 * may be separate registers associated with debug or trace modules.
39 */
40
41 struct reg *register_get_by_name(struct reg_cache *first,
42 const char *name, bool search_all)
43 {
44 unsigned i;
45 struct reg_cache *cache = first;
46
47 while (cache) {
48 for (i = 0; i < cache->num_regs; i++) {
49 if (strcmp(cache->reg_list[i].name, name) == 0)
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_cache **register_get_last_cache_p(struct reg_cache **first)
63 {
64 struct reg_cache **cache_p = first;
65
66 if (*cache_p)
67 while (*cache_p)
68 cache_p = &((*cache_p)->next);
69 else
70 return first;
71
72 return cache_p;
73 }
74
75 /** Marks the contents of the register cache as invalid (and clean). */
76 void register_cache_invalidate(struct reg_cache *cache)
77 {
78 struct reg *reg = cache->reg_list;
79
80 for (unsigned n = cache->num_regs; n != 0; n--, reg++) {
81 reg->valid = 0;
82 reg->dirty = 0;
83 }
84 }
85
86 static int register_get_dummy_core_reg(struct reg *reg)
87 {
88 return ERROR_OK;
89 }
90
91 static int register_set_dummy_core_reg(struct reg *reg, uint8_t *buf)
92 {
93 reg->dirty = 1;
94 reg->valid = 1;
95
96 return ERROR_OK;
97 }
98
99 static const struct reg_arch_type dummy_type = {
100 .get = register_get_dummy_core_reg,
101 .set = register_set_dummy_core_reg,
102 };
103
104 void register_init_dummy(struct reg *reg)
105 {
106 reg->type = &dummy_type;
107 }