openocd: src/target: replace the GPL-2.0-or-later license tag

[fw/openocd] / src / target / register.h

diff --git a/src/target/register.h b/src/target/register.h
index f343b2b18eb02dfbafcc5672b025e8a02641d3c0..1e4f2e088988dd9e0e25d06f686a5e912ad14057 100644 (file)
--- a/src/target/register.h
+++ b/src/target/register.h
@@ -1,36 +1,30 @@
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+
 /***************************************************************************
  *   Copyright (C) 2005 by Dominic Rath                                    *
  *   Dominic.Rath@gmx.de                                                   *
  *                                                                         *
  *   Copyright (C) 2007,2008 Øyvind Harboe                                 *
  *   oyvind.harboe@zylin.com                                               *
- *                                                                         *
- *   This program is free software; you can redistribute it and/or modify  *
- *   it under the terms of the GNU General Public License as published by  *
- *   the Free Software Foundation; either version 2 of the License, or     *
- *   (at your option) any later version.                                   *
- *                                                                         *
- *   This program is distributed in the hope that it will be useful,       *
- *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
- *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
- *   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, see <http://www.gnu.org/licenses/>. *
  ***************************************************************************/
 
-#ifndef REGISTER_H
-#define REGISTER_H
+#ifndef OPENOCD_TARGET_REGISTER_H
+#define OPENOCD_TARGET_REGISTER_H
+
+#include "helper/replacements.h"
+#include "helper/types.h"
 
 struct target;
 
 enum reg_type {
+       REG_TYPE_BOOL,
        REG_TYPE_INT,
        REG_TYPE_INT8,
        REG_TYPE_INT16,
        REG_TYPE_INT32,
        REG_TYPE_INT64,
        REG_TYPE_INT128,
+       REG_TYPE_UINT,
        REG_TYPE_UINT8,
        REG_TYPE_UINT16,
        REG_TYPE_UINT32,
@@ -66,6 +60,7 @@ struct reg_data_type_union {
 struct reg_data_type_bitfield {
        uint32_t start;
        uint32_t end;
+       enum reg_type type;
 };
 
 struct reg_data_type_struct_field {
@@ -114,17 +109,34 @@ struct reg_data_type {
 };
 
 struct reg {
+       /* Canonical name of the register. */
        const char *name;
+       /* Number that gdb uses to access this register. */
        uint32_t number;
+       /* TODO. This should probably be const. */
        struct reg_feature *feature;
+       /* TODO: When true, the caller will save this register before running any algorithm. */
        bool caller_save;
-       void *value;
+       /* Pointer to place where the value is stored, in the format understood by
+        * the binarybuffer.h functions. */
+       uint8_t *value;
+       /* The stored value needs to be written to the target. */
        bool dirty;
+       /* When true, value is valid. */
        bool valid;
+       /* When false, the register doesn't actually exist in the target. */
        bool exist;
+       /* Hide the register from gdb and omit it in 'reg' cmd output */
+       bool hidden;
+       /* Size of the register in bits. */
        uint32_t size;
+       /* Used for generating XML description of registers. Can be set to NULL for
+        * targets that don't use that. */
        struct reg_data_type *reg_data_type;
+       /* Used for generating XML description of registers. Can be set to NULL for
+        * targets that don't use that. */
        const char *group;
+       /* Pointer to architecture-specific info for this register. */
        void *arch_info;
        const struct reg_arch_type *type;
 };
@@ -141,6 +153,8 @@ struct reg_arch_type {
        int (*set)(struct reg *reg, uint8_t *buf);
 };
 
+struct reg *register_get_by_number(struct reg_cache *first,
+               uint32_t reg_num, bool search_all);
 struct reg *register_get_by_name(struct reg_cache *first,
                const char *name, bool search_all);
 struct reg_cache **register_get_last_cache_p(struct reg_cache **first);
@@ -149,4 +163,4 @@ void register_cache_invalidate(struct reg_cache *cache);
 
 void register_init_dummy(struct reg *reg);
 
-#endif /* REGISTER_H */
+#endif /* OPENOCD_TARGET_REGISTER_H */