esp-idf/components/app_trace/include/esp_sysview_trace.h

// Copyright 2018 Espressif Systems (Shanghai) PTE LTD
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at

//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#ifndef ESP_SYSVIEW_TRACE_H_
#define ESP_SYSVIEW_TRACE_H_

#ifdef __cplusplus
extern "C" {
#endif

#include <stdarg.h>
#include "esp_err.h"
#include "SEGGER_RTT.h" // SEGGER_RTT_ESP32_Flush
#include "esp_app_trace_util.h" // ESP_APPTRACE_TMO_INFINITE

/**
 * @brief Flushes remaining data in SystemView trace buffer to host.
 *
 * @param tmo  Timeout for operation (in us). Use ESP_APPTRACE_TMO_INFINITE to wait indefinetly.
 *
 * @return ESP_OK.
 */
static inline esp_err_t esp_sysview_flush(uint32_t tmo)
{
    SEGGER_RTT_ESP32_Flush(0, tmo);
    return ESP_OK;
}

/**
 * @brief vprintf-like function to sent log messages to the host.
 *
 * @param format  Address of format string.
 * @param args    List of arguments.
 *
 * @return Number of bytes written.
 */
int esp_sysview_vprintf(const char * format, va_list args);

/**
 * @brief  Starts SystemView heap tracing.
 *
 * @param tmo Timeout (in us) to wait for the host to be connected. Use -1 to wait forever.
 *
 * @return ESP_OK on success, ESP_ERR_TIMEOUT if operation has been timed out.
 */
esp_err_t esp_sysview_heap_trace_start(uint32_t tmo);

/**
 * @brief  Stops SystemView heap tracing.
 *
 * @return ESP_OK.
 */
esp_err_t esp_sysview_heap_trace_stop(void);

/**
 * @brief Sends heap allocation event to the host.
 *
 * @param addr      Address of allocated block.
 * @param size      Size of allocated block.
 * @param callers   Pointer to array with callstack addresses.
 *                  Array size must be CONFIG_HEAP_TRACING_STACK_DEPTH.
 */
void esp_sysview_heap_trace_alloc(void *addr, uint32_t size, const void *callers);

/**
 * @brief Sends heap de-allocation event to the host.
 *
 * @param addr      Address of de-allocated block.
 * @param callers   Pointer to array with callstack addresses.
 *                  Array size must be CONFIG_HEAP_TRACING_STACK_DEPTH.
 */
void esp_sysview_heap_trace_free(void *addr, const void *callers);

#ifdef __cplusplus
}
#endif

#endif //ESP_SYSVIEW_TRACE_H_