src/target/espressif/esp_xtensa.c

   1 // SPDX-License-Identifier: GPL-2.0-or-later
   2
   3 /***************************************************************************
   4  *   Espressif Xtensa target API for OpenOCD                               *
   5  *   Copyright (C) 2019 Espressif Systems Ltd.                             *
   6  ***************************************************************************/
   7
   8 #ifdef HAVE_CONFIG_H
   9 #include <config.h>
  10 #endif
  11
  12 #include <stdbool.h>
  13 #include <stdint.h>
  14 #include <target/smp.h>
  15 #include "esp_xtensa_apptrace.h"
  16 #include <target/register.h>
  17 #include "esp_xtensa.h"
  18 #include "esp_semihosting.h"
  19
  20 #define ESP_XTENSA_DBGSTUBS_UPDATE_DATA_ENTRY(_e_) \
  21         do { \
  22                 uint32_t __internal_val = (_e_); \
  23                 if (!xtensa_data_addr_valid(target, __internal_val)) { \
  24                         LOG_ERROR("No valid stub data entry found (0x%" PRIx32 ")!", __internal_val); \
  25                         return; \
  26                 } \
  27         } while (0)
  28
  29 #define ESP_XTENSA_DBGSTUBS_UPDATE_CODE_ENTRY(_e_) \
  30         do { \
  31                 uint32_t __internal_val = (_e_); \
  32                 if (__internal_val == 0) { \
  33                         LOG_ERROR("No valid stub code entry found (0x%" PRIx32 ")!", __internal_val); \
  34                         return; \
  35                 } \
  36         } while (0)
  37
  38 static void esp_xtensa_dbgstubs_info_update(struct target *target);
  39 static void esp_xtensa_dbgstubs_addr_check(struct target *target);
  40
  41 static int esp_xtensa_dbgstubs_restore(struct target *target)
  42 {
  43         struct esp_xtensa_common *esp_xtensa = target_to_esp_xtensa(target);
  44
  45         if (esp_xtensa->esp.dbg_stubs.base == 0)
  46                 return ERROR_OK;
  47
  48         LOG_TARGET_INFO(target, "Restore debug stubs address %" PRIx32, esp_xtensa->esp.dbg_stubs.base);
  49         int res = esp_xtensa_apptrace_status_reg_write(target, esp_xtensa->esp.dbg_stubs.base);
  50         if (res != ERROR_OK) {
  51                 LOG_ERROR("Failed to write trace status (%d)!", res);
  52                 return res;
  53         }
  54         return ERROR_OK;
  55 }
  56 int esp_xtensa_on_halt(struct target *target)
  57 {
  58         /* debug stubs can be used in HALTED state only, so it is OK to get info about them here */
  59         esp_xtensa_dbgstubs_info_update(target);
  60         return ERROR_OK;
  61 }
  62
  63 int esp_xtensa_init_arch_info(struct target *target,
  64         struct esp_xtensa_common *esp_xtensa,
  65         struct xtensa_debug_module_config *dm_cfg,
  66         const struct esp_semihost_ops *semihost_ops)
  67 {
  68         int ret = xtensa_init_arch_info(target, &esp_xtensa->xtensa, dm_cfg);
  69         if (ret != ERROR_OK)
  70                 return ret;
  71         esp_xtensa->semihost.ops = (struct esp_semihost_ops *)semihost_ops;
  72         esp_xtensa->apptrace.hw = &esp_xtensa_apptrace_hw;
  73         return ERROR_OK;
  74 }
  75
  76 int esp_xtensa_target_init(struct command_context *cmd_ctx, struct target *target)
  77 {
  78         return xtensa_target_init(cmd_ctx, target);
  79 }
  80
  81 void esp_xtensa_target_deinit(struct target *target)
  82 {
  83         LOG_DEBUG("start");
  84
  85         if (target_was_examined(target)) {
  86                 int ret = esp_xtensa_dbgstubs_restore(target);
  87                 if (ret != ERROR_OK)
  88                         return;
  89         }
  90         xtensa_target_deinit(target);
  91         free(target_to_esp_xtensa(target));     /* same as free(xtensa) */
  92 }
  93
  94 int esp_xtensa_arch_state(struct target *target)
  95 {
  96         return ERROR_OK;
  97 }
  98
  99 int esp_xtensa_poll(struct target *target)
 100 {
 101         struct xtensa *xtensa = target_to_xtensa(target);
 102         struct esp_xtensa_common *esp_xtensa_common = target_to_esp_xtensa(target);
 103
 104         int ret = xtensa_poll(target);
 105
 106         if (xtensa_dm_power_status_get(&xtensa->dbg_mod) & PWRSTAT_COREWASRESET(xtensa)) {
 107                 LOG_TARGET_DEBUG(target, "Clear debug stubs info");
 108                 memset(&esp_xtensa_common->esp.dbg_stubs, 0, sizeof(esp_xtensa_common->esp.dbg_stubs));
 109         }
 110         if (target->state != TARGET_DEBUG_RUNNING)
 111                 esp_xtensa_dbgstubs_addr_check(target);
 112         return ret;
 113 }
 114
 115 static void esp_xtensa_dbgstubs_addr_check(struct target *target)
 116 {
 117         struct esp_xtensa_common *esp_xtensa = target_to_esp_xtensa(target);
 118         uint32_t vec_addr = 0;
 119
 120         if (esp_xtensa->esp.dbg_stubs.base != 0)
 121                 return;
 122
 123         int res = esp_xtensa_apptrace_status_reg_read(target, &vec_addr);
 124         if (res != ERROR_OK) {
 125                 LOG_ERROR("Failed to read debug stubs address location (%d)!", res);
 126                 return;
 127         }
 128         if (xtensa_data_addr_valid(target, vec_addr)) {
 129                 LOG_TARGET_INFO(target, "Detected debug stubs @ %" PRIx32, vec_addr);
 130                 res = esp_xtensa_apptrace_status_reg_write(target, 0);
 131                 if (res != ERROR_OK)
 132                         LOG_ERROR("Failed to clear debug stubs address location (%d)!", res);
 133                 esp_xtensa->esp.dbg_stubs.base = vec_addr;
 134         }
 135 }
 136
 137 static void esp_xtensa_dbgstubs_info_update(struct target *target)
 138 {
 139         struct esp_xtensa_common *esp_xtensa = target_to_esp_xtensa(target);
 140
 141         if (esp_xtensa->esp.dbg_stubs.base == 0 || esp_xtensa->esp.dbg_stubs.entries_count != 0)
 142                 return;
 143
 144         int res = esp_dbgstubs_table_read(target, &esp_xtensa->esp.dbg_stubs);
 145         if (res != ERROR_OK)
 146                 return;
 147         if (esp_xtensa->esp.dbg_stubs.entries_count == 0)
 148                 return;
 149
 150         /* read debug stubs descriptor */
 151         ESP_XTENSA_DBGSTUBS_UPDATE_DATA_ENTRY(esp_xtensa->esp.dbg_stubs.entries[ESP_DBG_STUB_DESC]);
 152         res = target_read_buffer(target, esp_xtensa->esp.dbg_stubs.entries[ESP_DBG_STUB_DESC],
 153                 sizeof(struct esp_dbg_stubs_desc),
 154                 (uint8_t *)&esp_xtensa->esp.dbg_stubs.desc);
 155         if (res != ERROR_OK) {
 156                 LOG_ERROR("Failed to read debug stubs descriptor (%d)!", res);
 157                 return;
 158         }
 159         ESP_XTENSA_DBGSTUBS_UPDATE_CODE_ENTRY(esp_xtensa->esp.dbg_stubs.desc.tramp_addr);
 160         ESP_XTENSA_DBGSTUBS_UPDATE_DATA_ENTRY(esp_xtensa->esp.dbg_stubs.desc.min_stack_addr);
 161         ESP_XTENSA_DBGSTUBS_UPDATE_CODE_ENTRY(esp_xtensa->esp.dbg_stubs.desc.data_alloc);
 162         ESP_XTENSA_DBGSTUBS_UPDATE_CODE_ENTRY(esp_xtensa->esp.dbg_stubs.desc.data_free);
 163 }
 164
 165 int esp_xtensa_breakpoint_add(struct target *target, struct breakpoint *breakpoint)
 166 {
 167         return xtensa_breakpoint_add(target, breakpoint);
 168         /* flash breakpoints will be handled in another patch */
 169 }
 170
 171 int esp_xtensa_breakpoint_remove(struct target *target, struct breakpoint *breakpoint)
 172 {
 173         return xtensa_breakpoint_remove(target, breakpoint);
 174         /* flash breakpoints will be handled in another patch */
 175 }