esp.h

Go to the documentation of this file.

/* 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 */
#define ESP_DBG_STUBS_CODE_BUF_SIZE         32  /* TODO: move this info to esp_dbg_stubs_desc */
#define ESP_DBG_STUBS_STACK_MIN_SIZE        2048/* TODO: move this info to esp_dbg_stubs_desc */
 
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)
 
struct esp_dbg_stubs_desc {
    uint32_t tramp_addr;
    uint32_t min_stack_addr;
    uint32_t data_alloc;
    uint32_t data_free;
};
 
struct esp_dbg_stubs {
    uint32_t base;
    uint32_t entries[ESP_DBG_STUB_ENTRY_MAX];
    uint32_t entries_count;
    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 */