IDF master 1d7068e4b (#5257)

esp-dsp: master 7cc5073
esp-face: master 420fc7e
esp-rainmaker: f1b82c7
esp32-camera: master 7a06a7e
esp_littlefs: master b58f00c

tools/sdk/esp32/include/espcoredump/include/esp_core_dump.h

@@ -14,10 +14,11 @@
 #ifndef ESP_CORE_DUMP_H_
 #define ESP_CORE_DUMP_H_
 
+#include "sdkconfig.h"
 #include <stddef.h>
 #include "esp_err.h"
 #include "esp_private/panic_internal.h"
-#include "esp_core_dump_summary_extra_info.h"
+#include "esp_core_dump_summary_port.h"
 
 #ifdef __cplusplus
 extern "C" {
@@ -25,14 +26,7 @@ extern "C" {
 
 #define APP_ELF_SHA256_SZ (CONFIG_APP_RETRIEVE_LEN_ELF_SHA + 1)
 
-/**
- * @brief Backtrace information
- */
-typedef struct {
-    uint32_t bt[16];    /*!< Backtrace (array of PC) */
-    uint32_t depth;     /*!< Number of backtrace entries */
-    bool corrupted;     /*!< Status flag for backtrace is corrupt or not */
-} esp_core_dump_bt_info_t;
+#if CONFIG_ESP_COREDUMP_ENABLE_TO_FLASH && CONFIG_ESP_COREDUMP_DATA_FORMAT_ELF
 
 /**
  * @brief Core dump summary, Most meaningful contents of the core dump
@@ -48,6 +42,8 @@ typedef struct {
     esp_core_dump_summary_extra_info_t ex_info; /*!< Architecture specific extra data */
 } esp_core_dump_summary_t;
 
+#endif /* CONFIG_ESP_COREDUMP_ENABLE_TO_FLASH && CONFIG_ESP_COREDUMP_DATA_FORMAT_ELF */
+
 /**************************************************************************************/
 /******************************** EXCEPTION MODE API **********************************/
 /**************************************************************************************/
@@ -137,15 +133,32 @@ esp_err_t esp_core_dump_image_get(size_t* out_addr, size_t *out_size);
  */
 esp_err_t esp_core_dump_image_erase(void);
 
+#if CONFIG_ESP_COREDUMP_ENABLE_TO_FLASH && CONFIG_ESP_COREDUMP_DATA_FORMAT_ELF
+
 /**
- * @brief  Get the summary of a core dump. This function works only with ELF format core dumps.
+ * @brief  Get the summary of a core dump.
  *
  * @param  summary   Summary of the core dump
  *
  * @return ESP_OK on success, otherwise \see esp_err_t
+ *
+ * @note  This function works only if coredump is stored in flash and in ELF format
+ *
+ * Example usage:
+ * @code{c}
+ *  esp_core_dump_summary_t *summary = malloc(sizeof(esp_core_dump_summary_t));
+ *  if (summary) {
+ *      if (esp_core_dump_get_summary(summary) == ESP_OK) {
+ *          // Do stuff
+ *      }
+ *  }
+ *  free(summary);
+ * @endcode
  */
 esp_err_t esp_core_dump_get_summary(esp_core_dump_summary_t *summary);
 
+#endif /* CONFIG_ESP_COREDUMP_ENABLE_TO_FLASH && CONFIG_ESP_COREDUMP_DATA_FORMAT_ELF */
+
 #ifdef __cplusplus
 }
 #endif

tools/sdk/esp32/include/espcoredump/include/port/riscv/esp_core_dump_summary_port.h

@@ -12,6 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 #pragma once
+#include "sdkconfig.h"
 #include <stdint.h>
 
 #ifdef __cplusplus
@@ -19,6 +20,21 @@ extern "C"
 {
 #endif
 
+#if CONFIG_ESP_COREDUMP_ENABLE_TO_FLASH && CONFIG_ESP_COREDUMP_DATA_FORMAT_ELF
+
+/**
+ * @brief Backtrace information
+ *
+ * For RISCV, backtrace cannot be generated on device without including and parsing
+ * DWARF sections. Including these sections would increase the binary size so provide
+ * the stackdump that can be later used to generate backtrace with the help of GDB or by parsing the ELF file
+ * on the host machine
+ */
+typedef struct {
+    uint8_t stackdump[CONFIG_ESP_COREDUMP_SUMMARY_STACKDUMP_SIZE];    /*!< Stack dump of the crashing task. */
+    uint32_t dump_size;                                               /*!< Size (in bytes) of the stack dump */
+} esp_core_dump_bt_info_t;
+
 /**
  * @brief RISC-V architecture specific extra information
  */
@@ -27,9 +43,13 @@ typedef struct {
     uint32_t mtvec;       /* Machine Trap-Vector Base Address */
     uint32_t mcause;      /* Machine Trap Cause */
     uint32_t mtval;       /* Machine Trap Value */
-    uint32_t exc_a[8];    /*!< a register set when the exception caused */
+    uint32_t ra;          /* Return Address */
+    uint32_t sp;          /* Stack pointer */
+    uint32_t exc_a[8];    /* A0-A7 registers when the exception caused */
 } esp_core_dump_summary_extra_info_t;
 
+#endif /* CONFIG_ESP_COREDUMP_ENABLE_TO_FLASH && CONFIG_ESP_COREDUMP_DATA_FORMAT_ELF */
+
 #ifdef __cplusplus
 }
 #endif

tools/sdk/esp32/include/espcoredump/include/port/xtensa/esp_core_dump_summary_port.h

@@ -12,6 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 #pragma once
+#include "sdkconfig.h"
 #include <stdint.h>
 #include <xtensa/config/core-isa.h>
 
@@ -20,8 +21,21 @@ extern "C"
 {
 #endif
 
+#if CONFIG_ESP_COREDUMP_ENABLE_TO_FLASH && CONFIG_ESP_COREDUMP_DATA_FORMAT_ELF
+
 #define EPCx_REGISTER_COUNT XCHAL_NUM_INTLEVELS
 
+/**
+ * @brief Backtrace information.
+ *
+ * For Xtensa, backtrace can be generated on device due to windowed register ABI.
+ */
+typedef struct {
+    uint32_t bt[16];        /*!< Backtrace (array of PC) */
+    uint32_t depth;         /*!< Number of backtrace entries */
+    bool corrupted;         /*!< Status flag for backtrace is corrupt or not */
+} esp_core_dump_bt_info_t;
+
 /**
  * @brief Xtensa architecture specific extra information
  */
@@ -33,6 +47,8 @@ typedef struct {
     uint8_t epcx_reg_bits;              /*!< Bit mask of available EPCx registers */
 } esp_core_dump_summary_extra_info_t;
 
+#endif /* CONFIG_ESP_COREDUMP_ENABLE_TO_FLASH && CONFIG_ESP_COREDUMP_DATA_FORMAT_ELF */
+
 #ifdef __cplusplus
 }
 #endif