mirror of
https://github.com/espressif/esp-idf.git
synced 2026-10-01 10:40:47 +03:00
docs(esp_trace): restructure tracing docs with esp_trace as master
Reorganize the tracing documentation so esp_trace is the master
component, with app_trace, SystemView, and Gcov referenced from it.
(cherry picked from commit 6c6490d54c)
This commit is contained in:
@@ -5,6 +5,9 @@
|
||||
*/
|
||||
#pragma once
|
||||
|
||||
#include <stdbool.h>
|
||||
#include <stddef.h>
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
@@ -36,9 +39,10 @@ typedef struct {
|
||||
/**
|
||||
* @brief Encoder name (required)
|
||||
*
|
||||
* Must match a registered encoder name. Built-in encoders:
|
||||
* - "sysview" - SEGGER SystemView protocol for FreeRTOS tracing
|
||||
* - "raw" - Pass-through for raw binary data
|
||||
* Must match the name of an encoder registered via ESP_TRACE_REGISTER_ENCODER().
|
||||
* The esp_trace component ships no encoder itself; encoders are provided by
|
||||
* external components (for example, espressif/esp_sysview registers a SystemView
|
||||
* encoder).
|
||||
*/
|
||||
const char *encoder_name;
|
||||
|
||||
@@ -55,6 +59,7 @@ typedef struct {
|
||||
*
|
||||
* Must match a registered transport name. Built-in transports:
|
||||
* - "apptrace" - Uses app_trace for JTAG or UART communication
|
||||
* - "usb_serial_jtag" - Streams trace data over the USB Serial JTAG peripheral
|
||||
*
|
||||
*/
|
||||
const char *transport_name;
|
||||
@@ -142,7 +147,7 @@ esp_trace_link_types_t esp_trace_get_link_type(esp_trace_handle_t handle);
|
||||
/**
|
||||
* @brief Panic flush the trace handle. This function is called from panic handler.
|
||||
*
|
||||
* @param handle The trace handle
|
||||
* @param info Panic info passed from the panic handler
|
||||
*/
|
||||
void esp_trace_panic_handler(const void *info);
|
||||
|
||||
|
||||
@@ -1,27 +1,38 @@
|
||||
/*
|
||||
* SPDX-FileCopyrightText: 2025 Espressif Systems (Shanghai) CO LTD
|
||||
* SPDX-FileCopyrightText: 2025-2026 Espressif Systems (Shanghai) CO LTD
|
||||
*
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
#pragma once
|
||||
|
||||
#include <stdint.h>
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/**
|
||||
* @brief Core trace system configuration.
|
||||
*
|
||||
* Reserved for future core-level trace configuration.
|
||||
*/
|
||||
typedef struct esp_trace_config {
|
||||
// Reserved for future use
|
||||
int reserved;
|
||||
int reserved; ///< Reserved for future use.
|
||||
} esp_trace_config_t;
|
||||
|
||||
/**
|
||||
* @brief Trace transport link type.
|
||||
*/
|
||||
typedef enum {
|
||||
ESP_TRACE_LINK_UNKNOWN = 0,
|
||||
ESP_TRACE_LINK_DEBUG_PROBE,
|
||||
ESP_TRACE_LINK_UART,
|
||||
ESP_TRACE_LINK_USB_SERIAL_JTAG,
|
||||
ESP_TRACE_LINK_UNKNOWN = 0, ///< Unknown or unavailable link type.
|
||||
ESP_TRACE_LINK_DEBUG_PROBE, ///< Debug probe link, for example JTAG through OpenOCD.
|
||||
ESP_TRACE_LINK_UART, ///< UART link.
|
||||
ESP_TRACE_LINK_USB_SERIAL_JTAG, ///< USB Serial JTAG link.
|
||||
} esp_trace_link_types_t;
|
||||
|
||||
/* Timeout constants for trace operations */
|
||||
/**
|
||||
* @brief Infinite timeout for trace operations.
|
||||
*/
|
||||
#define ESP_TRACE_TMO_INFINITE (UINT32_MAX)
|
||||
|
||||
#ifdef __cplusplus
|
||||
|
||||
Reference in New Issue
Block a user