trcKernelPort.h

/*
 * Trace Recorder for Tracealyzer v4.11.0
 * Copyright 2025 Percepio AB
 * www.percepio.com
 *
 * SPDX-License-Identifier: Apache-2.0
 *
 * For bare-metal use of Tracealyzer (no RTOS)
 */
 
#ifndef TRC_KERNEL_PORT_H
#define TRC_KERNEL_PORT_H
 
#include <trcDefines.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define TRC_USE_TRACEALYZER_RECORDER (TRC_CFG_USE_TRACEALYZER_RECORDER) /* Allows for disabling the recorder */
 
#if (TRC_USE_TRACEALYZER_RECORDER == 1)
    
#undef TRC_CFG_ENABLE_STACK_MONITOR
#define TRC_CFG_ENABLE_STACK_MONITOR 0
 
/*** Don't change the below definitions, unless you know what you are doing! ***/
 
#define TRACE_KERNEL_VERSION 0x1FF1
 
/* Dummy definitions, since no RTOS */
#define TRC_TICK_RATE_HZ 1 /* Must not be 0. */

#define TRACE_CPU_CLOCK_HZ TRC_CFG_CPU_CLOCK_HZ
 
#if (TRC_CFG_RECORDER_BUFFER_ALLOCATION == TRC_RECORDER_BUFFER_ALLOCATION_DYNAMIC)
#include <stdlib.h> /* Include malloc() */

#define TRC_KERNEL_PORT_HEAP_INIT(size)

#define TRC_KERNEL_PORT_HEAP_MALLOC(size) malloc(size)
#endif


#define TRC_PLATFORM_CFG "generic"

#define TRC_PLATFORM_CFG_MAJOR 1

#define TRC_PLATFORM_CFG_MINOR 0

#define TRC_PLATFORM_CFG_PATCH 0
 
#ifndef TRACE_ENTER_CRITICAL_SECTION
    #error "This hardware port has no definition for critical sections! See https://percepio.com/how-to-define-critical-sections-for-the-recorder/"
#endif
 
#define TRC_KERNEL_PORT_BUFFER_SIZE (sizeof(TraceTaskHandle_t) * (TRC_CFG_CORE_COUNT))

typedef struct TraceKernelPortDataBuffer    /* Aligned */
{
    uint8_t buffer[TRC_KERNEL_PORT_BUFFER_SIZE];
} TraceKernelPortDataBuffer_t;

traceResult xTraceKernelPortInitialize(TraceKernelPortDataBuffer_t* const pxBuffer);

traceResult xTraceKernelPortEnable(void);

#define xTraceKernelPortDelay(uiTicks) TRC_COMMA_EXPR_TO_STATEMENT_EXPR_2((void)uiTicks, TRC_SUCCESS)

#define xTraceKernelPortIsSchedulerSuspended() (0U)
 
/*************************************************************************/
/* KERNEL SPECIFIC OBJECT CONFIGURATION                                  */
/*************************************************************************/
 
/*******************************************************************************
 * The event codes - should match the offline config file.
 ******************************************************************************/
 
/*** Event codes for streaming - should match the Tracealyzer config file *****/
#define PSF_EVENT_NULL_EVENT                                0x00UL
 
#define PSF_EVENT_TRACE_START                               0x01UL
#define PSF_EVENT_TS_CONFIG                                 0x02UL
#define PSF_EVENT_OBJ_NAME                                  0x03UL
#define PSF_EVENT_TASK_PRIORITY                             0x04UL
#define PSF_EVENT_DEFINE_ISR                                0x05UL
 
#define PSF_EVENT_IFE_NEXT                                  0x08UL
#define PSF_EVENT_IFE_DIRECT                                0x09UL
 
#define PSF_EVENT_TASK_CREATE                               0x10UL
#define PSF_EVENT_TASK_DELETE                               0x11UL
#define PSF_EVENT_PROCESS_CREATE                            0x12UL
#define PSF_EVENT_PROCESS_DELETE                            0x13UL
#define PSF_EVENT_THREAD_CREATE                             0x14UL
#define PSF_EVENT_THREAD_DELETE                             0x15UL
 
#define PSF_EVENT_TASK_READY                                0x20UL
#define PSF_EVENT_ISR_BEGIN                                 0x21UL
#define PSF_EVENT_ISR_RESUME                                0x22UL
#define PSF_EVENT_TS_BEGIN                                  0x23UL
#define PSF_EVENT_TS_RESUME                                 0x24UL
#define PSF_EVENT_TASK_ACTIVATE                             0x25UL
 
#define PSF_EVENT_MALLOC                                    0x30UL
#define PSF_EVENT_FREE                                      0x31UL
#define PSF_EVENT_MALLOC_FAILED                             0x32UL
#define PSF_EVENT_FREE_FAILED                               0x33UL
 
#define PSF_EVENT_LOWPOWER_BEGIN                            0x38UL
#define PSF_EVENT_LOWPOWER_END                              0x39UL
 
#define PSF_EVENT_STATEMACHINE_STATE_CREATE                 0x40UL
#define PSF_EVENT_STATEMACHINE_CREATE                       0x41UL
#define PSF_EVENT_STATEMACHINE_STATECHANGE                  0x42UL
 
#define PSF_EVENT_INTERVAL_CHANNEL_CREATE                   0x43UL
#define PSF_EVENT_INTERVAL_START                            0x44UL
#define PSF_EVENT_INTERVAL_STOP                             0x45UL
#define PSF_EVENT_INTERVAL_CHANNEL_SET_CREATE               0x46UL
 
#define PSF_EVENT_EXTENSION_CREATE                          0x47UL
 
#define PSF_EVENT_HEAP_CREATE                               0x48UL
 
#define PSF_EVENT_COUNTER_CREATE                            0x49UL
#define PSF_EVENT_COUNTER_CHANGE                            0x4AUL
#define PSF_EVENT_COUNTER_LIMIT_EXCEEDED                    0x4BUL
 
#define PSF_EVENT_DEPENDENCY_REGISTER                       0x4CUL
 
#define PSF_EVENT_RUNNABLE_REGISTER                         0x4DUL
#define PSF_EVENT_RUNNABLE_START                            0x4EUL
#define PSF_EVENT_RUNNABLE_STOP                             0x4FUL
 
#define PSF_EVENT_USER_EVENT                                0x50UL
 
#define PSF_EVENT_USER_EVENT_FIXED                          0x58UL
 
#define TRC_EVENT_LAST_ID                                   (PSF_EVENT_USER_EVENT_FIXED + 8ul)
 
#endif
 
#ifdef __cplusplus
}
#endif
 
#endif