88 lines
2.9 KiB
C
88 lines
2.9 KiB
C
/* SPDX-License-Identifier: GPL-2.0-or-later */
|
|
|
|
/***************************************************************************
|
|
* Espressif chips common target API for OpenOCD *
|
|
* Copyright (C) 2021 Espressif Systems Ltd. *
|
|
***************************************************************************/
|
|
|
|
#ifndef OPENOCD_TARGET_ESP_H
|
|
#define OPENOCD_TARGET_ESP_H
|
|
|
|
#include <stdint.h>
|
|
#include <helper/bits.h>
|
|
|
|
/* must be in sync with ESP-IDF version */
|
|
/** Size of the pre-compiled target buffer for stub trampoline.
|
|
* @note Must be in sync with ESP-IDF version */
|
|
#define ESP_DBG_STUBS_CODE_BUF_SIZE 32 /* TODO: move this info to esp_dbg_stubs_desc */
|
|
/** Size of the pre-compiled target buffer for stack.
|
|
* @note Must be in sync with ESP-IDF version */
|
|
#define ESP_DBG_STUBS_STACK_MIN_SIZE 2048/* TODO: move this info to esp_dbg_stubs_desc */
|
|
|
|
/**
|
|
* Debug stubs table entries IDs
|
|
*
|
|
* @note Must be in sync with ESP-IDF version
|
|
*/
|
|
enum esp_dbg_stub_id {
|
|
ESP_DBG_STUB_ENTRY_MAGIC_NUM,
|
|
ESP_DBG_STUB_TABLE_SIZE,
|
|
ESP_DBG_STUB_TABLE_START,
|
|
ESP_DBG_STUB_DESC = ESP_DBG_STUB_TABLE_START, /*< Stubs descriptor ID */
|
|
ESP_DBG_STUB_ENTRY_FIRST,
|
|
ESP_DBG_STUB_ENTRY_GCOV = ESP_DBG_STUB_ENTRY_FIRST, /*< GCOV stub ID */
|
|
ESP_DBG_STUB_CAPABILITIES,
|
|
/* add new stub entries here */
|
|
ESP_DBG_STUB_ENTRY_MAX,
|
|
};
|
|
|
|
#define ESP_DBG_STUB_MAGIC_NUM_VAL 0xFEEDBEEF
|
|
#define ESP_DBG_STUB_CAP_GCOV_THREAD BIT(0)
|
|
|
|
/**
|
|
* Debug stubs descriptor. ID: ESP_DBG_STUB_DESC
|
|
*
|
|
* @note Must be in sync with ESP-IDF version
|
|
*/
|
|
struct esp_dbg_stubs_desc {
|
|
/** Address of pre-compiled target buffer for stub trampoline.
|
|
* Size of the buffer is ESP_DBG_STUBS_CODE_BUF_SIZE
|
|
*/
|
|
uint32_t tramp_addr;
|
|
/** Pre-compiled target buffer's addr for stack. The size of the buffer is ESP_DBG_STUBS_STACK_MIN_SIZE.
|
|
* Target has the buffer which is used for the stack of onboard algorithms.
|
|
* If stack size required by algorithm exceeds ESP_DBG_STUBS_STACK_MIN_SIZE,
|
|
* it should be allocated using onboard function pointed by 'data_alloc' and
|
|
* freed by 'data_free'. They fit to the minimal stack. See below.
|
|
*/
|
|
uint32_t min_stack_addr;
|
|
/** Address of malloc-like function to allocate buffer on target. */
|
|
uint32_t data_alloc;
|
|
/** Address of free-like function to free buffer allocated with data_alloc. */
|
|
uint32_t data_free;
|
|
};
|
|
|
|
/**
|
|
* Debug stubs info.
|
|
*/
|
|
struct esp_dbg_stubs {
|
|
/** Address. */
|
|
uint32_t base;
|
|
/** Table contents. */
|
|
uint32_t entries[ESP_DBG_STUB_ENTRY_MAX];
|
|
/** Number of table entries. */
|
|
uint32_t entries_count;
|
|
/** Debug stubs decsriptor. */
|
|
struct esp_dbg_stubs_desc desc;
|
|
};
|
|
|
|
struct esp_common {
|
|
const struct esp_algorithm_hw *algo_hw;
|
|
struct esp_dbg_stubs dbg_stubs;
|
|
};
|
|
|
|
int esp_common_init(struct esp_common *esp, const struct esp_algorithm_hw *algo_hw);
|
|
int esp_dbgstubs_table_read(struct target *target, struct esp_dbg_stubs *dbg_stubs);
|
|
|
|
#endif /* OPENOCD_TARGET_ESP_H */
|