FreeRTOS Trace Fixes (#888)
* Updating the FreeRTOS/Demo/Posix_GCC Demo's Trace.dump file Creation * Updating the FreeRTOS-Plus/Demo/FreeRTOS_Plus_TCP_Echo_Posix Demo's Trace.dump file Creation Co-authored-by: Soren Ptak <skptak@amazon.com>pull/898/head
Soren Ptak
2 years ago
committed by
GitHub
parent
228f76cbe3
commit
1fc1e01fb6
@ -0,0 +1,320 @@
|
|||||||
|
/*
|
||||||
|
* Trace Recorder for Tracealyzer v4.6.0
|
||||||
|
* Copyright 2021 Percepio AB
|
||||||
|
* www.percepio.com
|
||||||
|
*
|
||||||
|
* SPDX-License-Identifier: Apache-2.0
|
||||||
|
*
|
||||||
|
* Main configuration parameters for the trace recorder library.
|
||||||
|
* More settings can be found in trcStreamingConfig.h and trcSnapshotConfig.h.
|
||||||
|
*/
|
||||||
|
|
||||||
|
#ifndef TRC_CONFIG_H
|
||||||
|
#define TRC_CONFIG_H
|
||||||
|
|
||||||
|
#ifdef __cplusplus
|
||||||
|
extern "C" {
|
||||||
|
#endif
|
||||||
|
|
||||||
|
/******************************************************************************
|
||||||
|
* Include of processor header file
|
||||||
|
*
|
||||||
|
* Here you may need to include the header file for your processor. This is
|
||||||
|
* required at least for the ARM Cortex-M port, that uses the ARM CMSIS API.
|
||||||
|
* Try that in case of build problems. Otherwise, remove the #error line below.
|
||||||
|
*****************************************************************************/
|
||||||
|
/*#error "Trace Recorder: Please include your processor's header file here and remove this line." */
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_HARDWARE_PORT
|
||||||
|
* @brief Specify what hardware port to use (i.e., the "timestamping driver").
|
||||||
|
*
|
||||||
|
* All ARM Cortex-M MCUs are supported by "TRC_HARDWARE_PORT_ARM_Cortex_M".
|
||||||
|
* This port uses the DWT cycle counter for Cortex-M3/M4/M7 devices, which is
|
||||||
|
* available on most such devices. In case your device don't have DWT support,
|
||||||
|
* you will get an error message opening the trace. In that case, you may
|
||||||
|
* force the recorder to use SysTick timestamping instead, using this define:
|
||||||
|
*
|
||||||
|
* #define TRC_CFG_ARM_CM_USE_SYSTICK
|
||||||
|
*
|
||||||
|
* For ARM Cortex-M0/M0+ devices, SysTick mode is used automatically.
|
||||||
|
*
|
||||||
|
* See trcHardwarePort.h for available ports and information on how to
|
||||||
|
* define your own port, if not already present.
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_HARDWARE_PORT TRC_HARDWARE_PORT_Win64
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_SCHEDULING_ONLY
|
||||||
|
* @brief Macro which should be defined as an integer value.
|
||||||
|
*
|
||||||
|
* If this setting is enabled (= 1), only scheduling events are recorded.
|
||||||
|
* If disabled (= 0), all events are recorded (unless filtered in other ways).
|
||||||
|
*
|
||||||
|
* Default value is 0 (= include additional events).
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_SCHEDULING_ONLY 0
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_INCLUDE_MEMMANG_EVENTS
|
||||||
|
* @brief Macro which should be defined as either zero (0) or one (1).
|
||||||
|
*
|
||||||
|
* This controls if malloc and free calls should be traced. Set this to zero (0)
|
||||||
|
* to exclude malloc/free calls, or one (1) to include such events in the trace.
|
||||||
|
*
|
||||||
|
* Default value is 1.
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_INCLUDE_MEMMANG_EVENTS 1
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_INCLUDE_USER_EVENTS
|
||||||
|
* @brief Macro which should be defined as either zero (0) or one (1).
|
||||||
|
*
|
||||||
|
* If this is zero (0), all code related to User Events is excluded in order
|
||||||
|
* to reduce code size. Any attempts of storing User Events are then silently
|
||||||
|
* ignored.
|
||||||
|
*
|
||||||
|
* User Events are application-generated events, like "printf" but for the
|
||||||
|
* trace log, generated using vTracePrint and vTracePrintF.
|
||||||
|
* The formatting is done on host-side, by Tracealyzer. User Events are
|
||||||
|
* therefore much faster than a console printf and can often be used
|
||||||
|
* in timing critical code without problems.
|
||||||
|
*
|
||||||
|
* Note: In streaming mode, User Events are used to provide error messages
|
||||||
|
* and warnings from the recorder (in case of incorrect configuration) for
|
||||||
|
* display in Tracealyzer. Disabling user events will also disable these
|
||||||
|
* warnings. You can however still catch them by calling xTraceErrorGetLast
|
||||||
|
* or by putting breakpoints in xTraceError and xTraceWarning.
|
||||||
|
*
|
||||||
|
* Default value is 1.
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_INCLUDE_USER_EVENTS 1
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_INCLUDE_ISR_TRACING
|
||||||
|
* @brief Macro which should be defined as either zero (0) or one (1).
|
||||||
|
*
|
||||||
|
* If this is zero (0), the code for recording Interrupt Service Routines is
|
||||||
|
* excluded, in order to reduce code size. This means that any calls to
|
||||||
|
* vTraceStoreISRBegin/vTraceStoreISREnd will be ignored.
|
||||||
|
* This does not completely disable ISR tracing, in cases where an ISR is
|
||||||
|
* calling a traced kernel service. These events will still be recorded and
|
||||||
|
* show up in anonymous ISR instances in Tracealyzer, with names such as
|
||||||
|
* "ISR sending to <queue name>".
|
||||||
|
* To disable such tracing, please refer to vTraceSetFilterGroup and
|
||||||
|
* vTraceSetFilterMask.
|
||||||
|
*
|
||||||
|
* Default value is 1.
|
||||||
|
*
|
||||||
|
* Note: tracing ISRs requires that you insert calls to vTraceStoreISRBegin
|
||||||
|
* and vTraceStoreISREnd in your interrupt handlers.
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_INCLUDE_ISR_TRACING 1
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_INCLUDE_READY_EVENTS
|
||||||
|
* @brief Macro which should be defined as either zero (0) or one (1).
|
||||||
|
*
|
||||||
|
* If one (1), events are recorded when tasks enter scheduling state "ready".
|
||||||
|
* This allows Tracealyzer to show the initial pending time before tasks enter
|
||||||
|
* the execution state, and present accurate response times.
|
||||||
|
* If zero (0), "ready events" are not created, which allows for recording
|
||||||
|
* longer traces in the same amount of RAM.
|
||||||
|
*
|
||||||
|
* Default value is 1.
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_INCLUDE_READY_EVENTS 1
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_INCLUDE_OSTICK_EVENTS
|
||||||
|
* @brief Macro which should be defined as either zero (0) or one (1).
|
||||||
|
*
|
||||||
|
* If this is one (1), events will be generated whenever the OS clock is
|
||||||
|
* increased. If zero (0), OS tick events are not generated, which allows for
|
||||||
|
* recording longer traces in the same amount of RAM.
|
||||||
|
*
|
||||||
|
* Default value is 1.
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_INCLUDE_OSTICK_EVENTS 1
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_ENABLE_STACK_MONITOR
|
||||||
|
* @brief If enabled (1), the recorder periodically reports the unused stack space of
|
||||||
|
* all active tasks.
|
||||||
|
* The stack monitoring runs in the Tracealyzer Control task, TzCtrl. This task
|
||||||
|
* is always created by the recorder when in streaming mode.
|
||||||
|
* In snapshot mode, the TzCtrl task is only used for stack monitoring and is
|
||||||
|
* not created unless this is enabled.
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_ENABLE_STACK_MONITOR 1
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_STACK_MONITOR_MAX_TASKS
|
||||||
|
* @brief Macro which should be defined as a non-zero integer value.
|
||||||
|
*
|
||||||
|
* This controls how many tasks that can be monitored by the stack monitor.
|
||||||
|
* If this is too small, some tasks will be excluded and a warning is shown.
|
||||||
|
*
|
||||||
|
* Default value is 10.
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_STACK_MONITOR_MAX_TASKS 10
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_STACK_MONITOR_MAX_REPORTS
|
||||||
|
* @brief Macro which should be defined as a non-zero integer value.
|
||||||
|
*
|
||||||
|
* This defines how many tasks that will be subject to stack usage analysis for
|
||||||
|
* each execution of the Tracealyzer Control task (TzCtrl). Note that the stack
|
||||||
|
* monitoring cycles between the tasks, so this does not affect WHICH tasks that
|
||||||
|
* are monitored, but HOW OFTEN each task stack is analyzed.
|
||||||
|
*
|
||||||
|
* This setting can be combined with TRC_CFG_CTRL_TASK_DELAY to tune the
|
||||||
|
* frequency of the stack monitoring. This is motivated since the stack analysis
|
||||||
|
* can take some time to execute.
|
||||||
|
* However, note that the stack analysis runs in a separate task (TzCtrl) that
|
||||||
|
* can be executed on low priority. This way, you can avoid that the stack
|
||||||
|
* analysis disturbs any time-sensitive tasks.
|
||||||
|
*
|
||||||
|
* Default value is 1.
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_STACK_MONITOR_MAX_REPORTS 1
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_CTRL_TASK_PRIORITY
|
||||||
|
* @brief The scheduling priority of the Tracealyzer Control (TzCtrl) task.
|
||||||
|
*
|
||||||
|
* In streaming mode, TzCtrl is used to receive start/stop commands from
|
||||||
|
* Tracealyzer and in some cases also to transmit the trace data (for stream
|
||||||
|
* ports that uses the internal buffer, like TCP/IP). For such stream ports,
|
||||||
|
* make sure the TzCtrl priority is high enough to ensure reliable periodic
|
||||||
|
* execution and transfer of the data, but low enough to avoid disturbing any
|
||||||
|
* time-sensitive functions.
|
||||||
|
*
|
||||||
|
* In Snapshot mode, TzCtrl is only used for the stack usage monitoring and is
|
||||||
|
* not created if stack monitoring is disabled. TRC_CFG_CTRL_TASK_PRIORITY should
|
||||||
|
* be low, to avoid disturbing any time-sensitive tasks.
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_CTRL_TASK_PRIORITY 1
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_CTRL_TASK_DELAY
|
||||||
|
* @brief The delay between loops of the TzCtrl task (see TRC_CFG_CTRL_TASK_PRIORITY),
|
||||||
|
* which affects the frequency of the stack monitoring.
|
||||||
|
*
|
||||||
|
* In streaming mode, this also affects the trace data transfer if you are using
|
||||||
|
* a stream port leveraging the internal buffer (like TCP/IP). A shorter delay
|
||||||
|
* increases the CPU load of TzCtrl somewhat, but may improve the performance of
|
||||||
|
* of the trace streaming, especially if the trace buffer is small.
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_CTRL_TASK_DELAY 2
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_CTRL_TASK_STACK_SIZE
|
||||||
|
* @brief The stack size of the Tracealyzer Control (TzCtrl) task.
|
||||||
|
* See TRC_CFG_CTRL_TASK_PRIORITY for further information about TzCtrl.
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_CTRL_TASK_STACK_SIZE 4096
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_RECORDER_BUFFER_ALLOCATION
|
||||||
|
* @brief Specifies how the recorder buffer is allocated (also in case of streaming, in
|
||||||
|
* port using the recorder's internal temporary buffer)
|
||||||
|
*
|
||||||
|
* Values:
|
||||||
|
* TRC_RECORDER_BUFFER_ALLOCATION_STATIC - Static allocation (internal)
|
||||||
|
* TRC_RECORDER_BUFFER_ALLOCATION_DYNAMIC - Malloc in vTraceEnable
|
||||||
|
* TRC_RECORDER_BUFFER_ALLOCATION_CUSTOM - Use vTraceSetRecorderDataBuffer
|
||||||
|
*
|
||||||
|
* Static and dynamic mode does the allocation for you, either in compile time
|
||||||
|
* (static) or in runtime (malloc).
|
||||||
|
* The custom mode allows you to control how and where the allocation is made,
|
||||||
|
* for details see TRC_ALLOC_CUSTOM_BUFFER and vTraceSetRecorderDataBuffer().
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_RECORDER_BUFFER_ALLOCATION TRC_RECORDER_BUFFER_ALLOCATION_STATIC
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_MAX_ISR_NESTING
|
||||||
|
* @brief Defines how many levels of interrupt nesting the recorder can handle, in
|
||||||
|
* case multiple ISRs are traced and ISR nesting is possible. If this
|
||||||
|
* is exceeded, the particular ISR will not be traced and the recorder then
|
||||||
|
* logs an error message. This setting is used to allocate an internal stack
|
||||||
|
* for keeping track of the previous execution context (4 byte per entry).
|
||||||
|
*
|
||||||
|
* This value must be a non-zero positive constant, at least 1.
|
||||||
|
*
|
||||||
|
* Default value: 8
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_MAX_ISR_NESTING 8
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_ISR_TAILCHAINING_THRESHOLD
|
||||||
|
* @brief Macro which should be defined as an integer value.
|
||||||
|
*
|
||||||
|
* If tracing multiple ISRs, this setting allows for accurate display of the
|
||||||
|
* context-switching also in cases when the ISRs execute in direct sequence.
|
||||||
|
*
|
||||||
|
* vTraceStoreISREnd normally assumes that the ISR returns to the previous
|
||||||
|
* context, i.e., a task or a preempted ISR. But if another traced ISR
|
||||||
|
* executes in direct sequence, Tracealyzer may incorrectly display a minimal
|
||||||
|
* fragment of the previous context in between the ISRs.
|
||||||
|
*
|
||||||
|
* By using TRC_CFG_ISR_TAILCHAINING_THRESHOLD you can avoid this. This is
|
||||||
|
* however a threshold value that must be measured for your specific setup.
|
||||||
|
* See http://percepio.com/2014/03/21/isr_tailchaining_threshold/
|
||||||
|
*
|
||||||
|
* The default setting is 0, meaning "disabled" and that you may get an
|
||||||
|
* extra fragments of the previous context in between tail-chained ISRs.
|
||||||
|
*
|
||||||
|
* Note: This setting has separate definitions in trcSnapshotConfig.h and
|
||||||
|
* trcStreamingConfig.h, since it is affected by the recorder mode.
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_ISR_TAILCHAINING_THRESHOLD 0
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_RECORDER_DATA_INIT
|
||||||
|
* @brief Macro which states wether the recorder data should have an initial value.
|
||||||
|
*
|
||||||
|
* In very specific cases where traced objects are created before main(),
|
||||||
|
* the recorder will need to be started even before that. In these cases,
|
||||||
|
* the recorder data would be initialized by vTraceEnable(TRC_INIT) but could
|
||||||
|
* then later be overwritten by the initialization value.
|
||||||
|
* If this is an issue for you, set TRC_CFG_RECORDER_DATA_INIT to 0.
|
||||||
|
* The following code can then be used before any traced objects are created:
|
||||||
|
*
|
||||||
|
* extern uint32_t RecorderEnabled;
|
||||||
|
* RecorderEnabled = 0;
|
||||||
|
* xTraceInitialize();
|
||||||
|
*
|
||||||
|
* After the clocks are properly initialized, use vTraceEnable(...) to start
|
||||||
|
* the tracing.
|
||||||
|
*
|
||||||
|
* Default value is 1.
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_RECORDER_DATA_INIT 1
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_RECORDER_DATA_ATTRIBUTE
|
||||||
|
* @brief When setting TRC_CFG_RECORDER_DATA_INIT to 0, you might also need to make
|
||||||
|
* sure certain recorder data is placed in a specific RAM section to avoid being
|
||||||
|
* zeroed out after initialization. Define TRC_CFG_RECORDER_DATA_ATTRIBUTE as
|
||||||
|
* that attribute.
|
||||||
|
*
|
||||||
|
* Example:
|
||||||
|
* #define TRC_CFG_RECORDER_DATA_ATTRIBUTE __attribute__((section(".bss.trace_recorder_data")))
|
||||||
|
*
|
||||||
|
* Default value is empty.
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_RECORDER_DATA_ATTRIBUTE
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_USE_TRACE_ASSERT
|
||||||
|
* @brief Enable or disable debug asserts. Information regarding any assert that is
|
||||||
|
* triggered will be in trcAssert.c.
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_USE_TRACE_ASSERT 1
|
||||||
|
|
||||||
|
#ifdef __cplusplus
|
||||||
|
}
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#endif /* _TRC_CONFIG_H */
|
||||||
@ -0,0 +1,69 @@
|
|||||||
|
/*
|
||||||
|
* Trace Recorder for Tracealyzer v4.6.0
|
||||||
|
* Copyright 2021 Percepio AB
|
||||||
|
* www.percepio.com
|
||||||
|
*
|
||||||
|
* SPDX-License-Identifier: Apache-2.0
|
||||||
|
*
|
||||||
|
* Kernel port configuration parameters for snapshot mode.
|
||||||
|
*/
|
||||||
|
|
||||||
|
#ifndef TRC_KERNEL_PORT_SNAPSHOT_CONFIG_H
|
||||||
|
#define TRC_KERNEL_PORT_SNAPSHOT_CONFIG_H
|
||||||
|
|
||||||
|
#ifdef __cplusplus
|
||||||
|
extern "C" {
|
||||||
|
#endif
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_NTASK, TRC_CFG_NISR, TRC_CFG_NQUEUE, TRC_CFG_NSEMAPHORE...
|
||||||
|
* @brief A group of macros which should be defined as integer values, zero or larger.
|
||||||
|
*
|
||||||
|
* These define the capacity of the Object Property Table, i.e., the maximum
|
||||||
|
* number of objects active at any given point, within each object class (e.g.,
|
||||||
|
* task, queue, semaphore, ...).
|
||||||
|
*
|
||||||
|
* If tasks or other objects are deleted in your system, this
|
||||||
|
* setting does not limit the total amount of objects created, only the number
|
||||||
|
* of objects that have been successfully created but not yet deleted.
|
||||||
|
*
|
||||||
|
* Using too small values will cause vTraceError to be called, which stores an
|
||||||
|
* error message in the trace that is shown when opening the trace file. The
|
||||||
|
* error message can also be retrieved using xTraceGetLastError.
|
||||||
|
*
|
||||||
|
* It can be wise to start with large values for these constants,
|
||||||
|
* unless you are very confident on these numbers. Then do a recording and
|
||||||
|
* check the actual usage by selecting View menu -> Trace Details ->
|
||||||
|
* Resource Usage -> Object Table.
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_NTASK 150
|
||||||
|
#define TRC_CFG_NISR 90
|
||||||
|
#define TRC_CFG_NQUEUE 90
|
||||||
|
#define TRC_CFG_NSEMAPHORE 90
|
||||||
|
#define TRC_CFG_NMUTEX 90
|
||||||
|
#define TRC_CFG_NTIMER 250
|
||||||
|
#define TRC_CFG_NEVENTGROUP 90
|
||||||
|
#define TRC_CFG_NSTREAMBUFFER 50
|
||||||
|
#define TRC_CFG_NMESSAGEBUFFER 50
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_NAME_LEN_TASK, TRC_CFG_NAME_LEN_QUEUE, ...
|
||||||
|
* @brief Macros that specify the maximum lengths (number of characters) for names of
|
||||||
|
* kernel objects, such as tasks and queues. If longer names are used, they will
|
||||||
|
* be truncated when stored in the recorder.
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_NAME_LEN_TASK 15
|
||||||
|
#define TRC_CFG_NAME_LEN_ISR 15
|
||||||
|
#define TRC_CFG_NAME_LEN_QUEUE 15
|
||||||
|
#define TRC_CFG_NAME_LEN_SEMAPHORE 15
|
||||||
|
#define TRC_CFG_NAME_LEN_MUTEX 15
|
||||||
|
#define TRC_CFG_NAME_LEN_TIMER 15
|
||||||
|
#define TRC_CFG_NAME_LEN_EVENTGROUP 15
|
||||||
|
#define TRC_CFG_NAME_LEN_STREAMBUFFER 15
|
||||||
|
#define TRC_CFG_NAME_LEN_MESSAGEBUFFER 15
|
||||||
|
|
||||||
|
#ifdef __cplusplus
|
||||||
|
}
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#endif /* TRC_KERNEL_PORT_SNAPSHOT_CONFIG_H */
|
||||||
@ -0,0 +1,245 @@
|
|||||||
|
/*
|
||||||
|
* Trace Recorder for Tracealyzer v4.6.0
|
||||||
|
* Copyright 2021 Percepio AB
|
||||||
|
* www.percepio.com
|
||||||
|
*
|
||||||
|
* SPDX-License-Identifier: Apache-2.0
|
||||||
|
*
|
||||||
|
* Configuration parameters for trace recorder library in snapshot mode.
|
||||||
|
* Read more at http://percepio.com/2016/10/05/rtos-tracing/
|
||||||
|
*/
|
||||||
|
|
||||||
|
#ifndef TRC_SNAPSHOT_CONFIG_H
|
||||||
|
#define TRC_SNAPSHOT_CONFIG_H
|
||||||
|
|
||||||
|
#ifdef __cplusplus
|
||||||
|
extern "C" {
|
||||||
|
#endif
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_SNAPSHOT_MODE
|
||||||
|
* @brief Macro which should be defined as one of:
|
||||||
|
* - TRC_SNAPSHOT_MODE_RING_BUFFER
|
||||||
|
* - TRC_SNAPSHOT_MODE_STOP_WHEN_FULL
|
||||||
|
* Default is TRC_SNAPSHOT_MODE_RING_BUFFER.
|
||||||
|
*
|
||||||
|
* With TRC_CFG_SNAPSHOT_MODE set to TRC_SNAPSHOT_MODE_RING_BUFFER, the
|
||||||
|
* events are stored in a ring buffer, i.e., where the oldest events are
|
||||||
|
* overwritten when the buffer becomes full. This allows you to get the last
|
||||||
|
* events leading up to an interesting state, e.g., an error, without having
|
||||||
|
* to store the whole run since startup.
|
||||||
|
*
|
||||||
|
* When TRC_CFG_SNAPSHOT_MODE is TRC_SNAPSHOT_MODE_STOP_WHEN_FULL, the
|
||||||
|
* recording is stopped when the buffer becomes full. This is useful for
|
||||||
|
* recording events following a specific state, e.g., the startup sequence.
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_SNAPSHOT_MODE TRC_SNAPSHOT_MODE_RING_BUFFER
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_EVENT_BUFFER_SIZE
|
||||||
|
* @brief Macro which should be defined as an integer value.
|
||||||
|
*
|
||||||
|
* This defines the capacity of the event buffer, i.e., the number of records
|
||||||
|
* it may store. Most events use one record (4 byte), although some events
|
||||||
|
* require multiple 4-byte records. You should adjust this to the amount of RAM
|
||||||
|
* available in the target system.
|
||||||
|
*
|
||||||
|
* Default value is 1000, which means that 4000 bytes is allocated for the
|
||||||
|
* event buffer.
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_EVENT_BUFFER_SIZE 50000
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_INCLUDE_FLOAT_SUPPORT
|
||||||
|
* @brief Macro which should be defined as either zero (0) or one (1).
|
||||||
|
*
|
||||||
|
* If this is zero (0), the support for logging floating point values in
|
||||||
|
* vTracePrintF is stripped out, in case floating point values are not used or
|
||||||
|
* supported by the platform used.
|
||||||
|
*
|
||||||
|
* Floating point values are only used in vTracePrintF and its subroutines, to
|
||||||
|
* allow for storing float (%f) or double (%lf) arguments.
|
||||||
|
*
|
||||||
|
* vTracePrintF can be used with integer and string arguments in either case.
|
||||||
|
*
|
||||||
|
* Default value is 0.
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_INCLUDE_FLOAT_SUPPORT 0
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_SYMBOL_TABLE_SIZE
|
||||||
|
* @brief Macro which should be defined as an integer value.
|
||||||
|
*
|
||||||
|
* This defines the capacity of the symbol table, in bytes. This symbol table
|
||||||
|
* stores User Events labels and names of deleted tasks, queues, or other kernel
|
||||||
|
* objects. If you don't use User Events or delete any kernel
|
||||||
|
* objects you set this to a very low value. The minimum recommended value is 4.
|
||||||
|
* A size of zero (0) is not allowed since a zero-sized array may result in a
|
||||||
|
* 32-bit pointer, i.e., using 4 bytes rather than 0.
|
||||||
|
*
|
||||||
|
* Default value is 800.
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_SYMBOL_TABLE_SIZE 8000
|
||||||
|
|
||||||
|
#if ( TRC_CFG_SYMBOL_TABLE_SIZE == 0 )
|
||||||
|
#error "TRC_CFG_SYMBOL_TABLE_SIZE may not be zero!"
|
||||||
|
#endif
|
||||||
|
|
||||||
|
/******************************************************************************
|
||||||
|
*** ADVANCED SETTINGS ********************************************************
|
||||||
|
******************************************************************************
|
||||||
|
* The remaining settings are not necessary to modify but allows for optimizing
|
||||||
|
* the recorder setup for your specific needs, e.g., to exclude events that you
|
||||||
|
* are not interested in, in order to get longer traces.
|
||||||
|
*****************************************************************************/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_HEAP_SIZE_BELOW_16M
|
||||||
|
* @brief An integer constant that can be used to reduce the buffer usage of memory
|
||||||
|
* allocation events (malloc/free). This value should be 1 if the heap size is
|
||||||
|
* below 16 MB (2^24 byte), and you can live with reported addresses showing the
|
||||||
|
* lower 24 bits only. If 0, you get the full 32-bit addresses.
|
||||||
|
*
|
||||||
|
* Default value is 0.
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_HEAP_SIZE_BELOW_16M 0
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_USE_IMPLICIT_IFE_RULES
|
||||||
|
* @brief Macro which should be defined as either zero (0) or one (1).
|
||||||
|
* Default is 1.
|
||||||
|
*
|
||||||
|
* Tracealyzer groups the events into "instances" based on Instance Finish
|
||||||
|
* Events (IFEs), produced either by default rules or calls to the recorder
|
||||||
|
* functions xTraceTaskInstanceFinishedNow and xTraceTaskInstanceFinishedNext.
|
||||||
|
*
|
||||||
|
* If TRC_CFG_USE_IMPLICIT_IFE_RULES is one (1), the default IFE rules is
|
||||||
|
* used, resulting in a "typical" grouping of events into instances.
|
||||||
|
* If these rules don't give appropriate instances in your case, you can
|
||||||
|
* override the default rules using xTraceTaskInstanceFinishedNow/Next for one
|
||||||
|
* or several tasks. The default IFE rules are then disabled for those tasks.
|
||||||
|
*
|
||||||
|
* If TRC_CFG_USE_IMPLICIT_IFE_RULES is zero (0), the implicit IFE rules are
|
||||||
|
* disabled globally. You must then call xTraceTaskInstanceFinishedNow or
|
||||||
|
* xTraceTaskInstanceFinishedNext to manually group the events into instances,
|
||||||
|
* otherwise the tasks will appear a single long instance.
|
||||||
|
*
|
||||||
|
* The default IFE rules count the following events as "instance finished":
|
||||||
|
* - Task delay, delay until
|
||||||
|
* - Task suspend
|
||||||
|
* - Blocking on "input" operations, i.e., when the task is waiting for the
|
||||||
|
* next a message/signal/event. But only if this event is blocking.
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_USE_IMPLICIT_IFE_RULES 1
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_USE_16BIT_OBJECT_HANDLES
|
||||||
|
* @brief Macro which should be defined as either zero (0) or one (1).
|
||||||
|
*
|
||||||
|
* If set to 0 (zero), the recorder uses 8-bit handles to identify kernel
|
||||||
|
* objects such as tasks and queues. This limits the supported number of
|
||||||
|
* concurrently active objects to 255 of each type (tasks, queues, mutexes,
|
||||||
|
* etc.) Note: 255, not 256, since handle 0 is reserved.
|
||||||
|
*
|
||||||
|
* If set to 1 (one), the recorder uses 16-bit handles to identify kernel
|
||||||
|
* objects such as tasks and queues. This limits the supported number of
|
||||||
|
* concurrent objects to 65535 of each type (object class). However, since the
|
||||||
|
* object property table is limited to 64 KB, the practical limit is about
|
||||||
|
* 3000 objects in total.
|
||||||
|
*
|
||||||
|
* Default is 0 (8-bit handles)
|
||||||
|
*
|
||||||
|
* NOTE: An object with handle above 255 will use an extra 4-byte record in
|
||||||
|
* the event buffer whenever the object is referenced. Moreover, some internal
|
||||||
|
* tables in the recorder gets slightly larger when using 16-bit handles.
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_USE_16BIT_OBJECT_HANDLES 1
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_USE_SEPARATE_USER_EVENT_BUFFER
|
||||||
|
* @brief Macro which should be defined as an integer value.
|
||||||
|
*
|
||||||
|
* Set TRC_CFG_USE_SEPARATE_USER_EVENT_BUFFER to 1 to enable the
|
||||||
|
* separate user event buffer (UB).
|
||||||
|
* In this mode, user events are stored separately from other events,
|
||||||
|
* e.g., RTOS events. Thereby you can get a much longer history of
|
||||||
|
* user events as they don't need to share the buffer space with more
|
||||||
|
* frequent events.
|
||||||
|
*
|
||||||
|
* The UB is typically used with the snapshot ring-buffer mode, so the
|
||||||
|
* recording can continue when the main buffer gets full. And since the
|
||||||
|
* main buffer then overwrites the earliest events, Tracealyzer displays
|
||||||
|
* "Unknown Actor" instead of task scheduling for periods with UB data only.
|
||||||
|
*
|
||||||
|
* In UB mode, user events are structured as UB channels, which contains
|
||||||
|
* a channel name and a default format string. Register a UB channel using
|
||||||
|
* xTraceRegisterUBChannel.
|
||||||
|
*
|
||||||
|
* Events and data arguments are written using vTraceUBEvent and
|
||||||
|
* vTraceUBData. They are designed to provide efficient logging of
|
||||||
|
* repeating events, using the same format string within each channel.
|
||||||
|
*
|
||||||
|
* Examples:
|
||||||
|
* TraceStringHandle_t chn1;
|
||||||
|
* TraceStringHandle_t fmt1;
|
||||||
|
* xTraceStringRegister("Channel 1", &chn1);
|
||||||
|
* xTraceStringRegister("Event!", &fmt1);
|
||||||
|
* traceUBChannel UBCh1 = xTraceRegisterUBChannel(chn1, fmt1);
|
||||||
|
*
|
||||||
|
* TraceStringHandle_t chn2;
|
||||||
|
* TraceStringHandle_t fmt2;
|
||||||
|
* xTraceStringRegister("Channel 2", &chn2);
|
||||||
|
* xTraceStringRegister("X: %d, Y: %d", &fmt2);
|
||||||
|
* traceUBChannel UBCh2 = xTraceRegisterUBChannel(chn2, fmt2);
|
||||||
|
*
|
||||||
|
* // Result in "[Channel 1] Event!"
|
||||||
|
* vTraceUBEvent(UBCh1);
|
||||||
|
*
|
||||||
|
* // Result in "[Channel 2] X: 23, Y: 19"
|
||||||
|
* vTraceUBData(UBCh2, 23, 19);
|
||||||
|
*
|
||||||
|
* You can also use the other user event functions, like xTracePrintF.
|
||||||
|
* as they are then rerouted to the UB instead of the main event buffer.
|
||||||
|
* vTracePrintF then looks up the correct UB channel based on the
|
||||||
|
* provided channel name and format string, or creates a new UB channel
|
||||||
|
* if no match is found. The format string should therefore not contain
|
||||||
|
* "random" messages but mainly format specifiers. Random strings should
|
||||||
|
* be stored using %s and with the string as an argument.
|
||||||
|
*
|
||||||
|
* // Creates a new UB channel ("Channel 2", "%Z: %d")
|
||||||
|
* xTracePrintF(chn2, "%Z: %d", value1);
|
||||||
|
*
|
||||||
|
* // Finds the existing UB channel
|
||||||
|
* xTracePrintF(chn2, "%Z: %d", value2);
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_USE_SEPARATE_USER_EVENT_BUFFER 1
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_SEPARATE_USER_EVENT_BUFFER_SIZE
|
||||||
|
* @brief Macro which should be defined as an integer value.
|
||||||
|
*
|
||||||
|
* This defines the capacity of the user event buffer (UB), in number of slots.
|
||||||
|
* A single user event can use multiple slots, depending on the arguments.
|
||||||
|
*
|
||||||
|
* Only applicable if TRC_CFG_USE_SEPARATE_USER_EVENT_BUFFER is 1.
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_SEPARATE_USER_EVENT_BUFFER_SIZE 200
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_UB_CHANNELS
|
||||||
|
* @brief Macro which should be defined as an integer value.
|
||||||
|
*
|
||||||
|
* This defines the number of User Event Buffer Channels (UB channels).
|
||||||
|
* These are used to structure the events when using the separate user
|
||||||
|
* event buffer, and contains both a User Event Channel (the name) and
|
||||||
|
* a default format string for the channel.
|
||||||
|
*
|
||||||
|
* Only applicable if TRC_CFG_USE_SEPARATE_USER_EVENT_BUFFER is 1.
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_UB_CHANNELS 32
|
||||||
|
|
||||||
|
#ifdef __cplusplus
|
||||||
|
}
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#endif /*TRC_SNAPSHOT_CONFIG_H*/
|
||||||
File diff suppressed because it is too large
Load Diff
@ -1,345 +0,0 @@
|
|||||||
/*******************************************************************************
|
|
||||||
* Trace Recorder Library for Tracealyzer v3.1.2
|
|
||||||
* Percepio AB, www.percepio.com
|
|
||||||
*
|
|
||||||
* trcSnapshotConfig.h
|
|
||||||
*
|
|
||||||
* Configuration parameters for trace recorder library in snapshot mode.
|
|
||||||
* Read more at http://percepio.com/2016/10/05/rtos-tracing/
|
|
||||||
*
|
|
||||||
* Terms of Use
|
|
||||||
* This file is part of the trace recorder library (RECORDER), which is the
|
|
||||||
* intellectual property of Percepio AB (PERCEPIO) and provided under a
|
|
||||||
* license as follows.
|
|
||||||
* The RECORDER may be used free of charge for the purpose of recording data
|
|
||||||
* intended for analysis in PERCEPIO products. It may not be used or modified
|
|
||||||
* for other purposes without explicit permission from PERCEPIO.
|
|
||||||
* You may distribute the RECORDER in its original source code form, assuming
|
|
||||||
* this text (terms of use, disclaimer, copyright notice) is unchanged. You are
|
|
||||||
* allowed to distribute the RECORDER with minor modifications intended for
|
|
||||||
* configuration or porting of the RECORDER, e.g., to allow using it on a
|
|
||||||
* specific processor, processor family or with a specific communication
|
|
||||||
* interface. Any such modifications should be documented directly below
|
|
||||||
* this comment block.
|
|
||||||
*
|
|
||||||
* Disclaimer
|
|
||||||
* The RECORDER is being delivered to you AS IS and PERCEPIO makes no warranty
|
|
||||||
* as to its use or performance. PERCEPIO does not and cannot warrant the
|
|
||||||
* performance or results you may obtain by using the RECORDER or documentation.
|
|
||||||
* PERCEPIO make no warranties, express or implied, as to noninfringement of
|
|
||||||
* third party rights, merchantability, or fitness for any particular purpose.
|
|
||||||
* In no event will PERCEPIO, its technology partners, or distributors be liable
|
|
||||||
* to you for any consequential, incidental or special damages, including any
|
|
||||||
* lost profits or lost savings, even if a representative of PERCEPIO has been
|
|
||||||
* advised of the possibility of such damages, or for any claim by any third
|
|
||||||
* party. Some jurisdictions do not allow the exclusion or limitation of
|
|
||||||
* incidental, consequential or special damages, or the exclusion of implied
|
|
||||||
* warranties or limitations on how long an implied warranty may last, so the
|
|
||||||
* above limitations may not apply to you.
|
|
||||||
*
|
|
||||||
* Tabs are used for indent in this file (1 tab = 4 spaces)
|
|
||||||
*
|
|
||||||
* Copyright Percepio AB, 2017.
|
|
||||||
* www.percepio.com
|
|
||||||
******************************************************************************/
|
|
||||||
|
|
||||||
#ifndef TRC_SNAPSHOT_CONFIG_H
|
|
||||||
#define TRC_SNAPSHOT_CONFIG_H
|
|
||||||
|
|
||||||
#define TRC_SNAPSHOT_MODE_RING_BUFFER (0x01)
|
|
||||||
#define TRC_SNAPSHOT_MODE_STOP_WHEN_FULL (0x02)
|
|
||||||
|
|
||||||
/******************************************************************************
|
|
||||||
* TRC_CFG_SNAPSHOT_MODE
|
|
||||||
*
|
|
||||||
* Macro which should be defined as one of:
|
|
||||||
* - TRC_SNAPSHOT_MODE_RING_BUFFER
|
|
||||||
* - TRC_SNAPSHOT_MODE_STOP_WHEN_FULL
|
|
||||||
* Default is TRC_SNAPSHOT_MODE_RING_BUFFER.
|
|
||||||
*
|
|
||||||
* With TRC_CFG_SNAPSHOT_MODE set to TRC_SNAPSHOT_MODE_RING_BUFFER, the
|
|
||||||
* events are stored in a ring buffer, i.e., where the oldest events are
|
|
||||||
* overwritten when the buffer becomes full. This allows you to get the last
|
|
||||||
* events leading up to an interesting state, e.g., an error, without having
|
|
||||||
* to store the whole run since startup.
|
|
||||||
*
|
|
||||||
* When TRC_CFG_SNAPSHOT_MODE is TRC_SNAPSHOT_MODE_STOP_WHEN_FULL, the
|
|
||||||
* recording is stopped when the buffer becomes full. This is useful for
|
|
||||||
* recording events following a specific state, e.g., the startup sequence.
|
|
||||||
*****************************************************************************/
|
|
||||||
#define TRC_CFG_SNAPSHOT_MODE TRC_SNAPSHOT_MODE_RING_BUFFER
|
|
||||||
|
|
||||||
/*******************************************************************************
|
|
||||||
* TRC_CFG_EVENT_BUFFER_SIZE
|
|
||||||
*
|
|
||||||
* Macro which should be defined as an integer value.
|
|
||||||
*
|
|
||||||
* This defines the capacity of the event buffer, i.e., the number of records
|
|
||||||
* it may store. Most events use one record (4 byte), although some events
|
|
||||||
* require multiple 4-byte records. You should adjust this to the amount of RAM
|
|
||||||
* available in the target system.
|
|
||||||
*
|
|
||||||
* Default value is 1000, which means that 4000 bytes is allocated for the
|
|
||||||
* event buffer.
|
|
||||||
******************************************************************************/
|
|
||||||
#define TRC_CFG_EVENT_BUFFER_SIZE 32000
|
|
||||||
|
|
||||||
/******************************************************************************
|
|
||||||
* TRC_CFG_INCLUDE_FLOAT_SUPPORT
|
|
||||||
*
|
|
||||||
* Macro which should be defined as either zero (0) or one (1).
|
|
||||||
*
|
|
||||||
* If this is zero (0), the support for logging floating point values in
|
|
||||||
* vTracePrintF is stripped out, in case floating point values are not used or
|
|
||||||
* supported by the platform used.
|
|
||||||
*
|
|
||||||
* Floating point values are only used in vTracePrintF and its subroutines, to
|
|
||||||
* allow for storing float (%f) or double (%lf) arguments.
|
|
||||||
*
|
|
||||||
* vTracePrintF can be used with integer and string arguments in either case.
|
|
||||||
*
|
|
||||||
* Default value is 0.
|
|
||||||
*****************************************************************************/
|
|
||||||
#define TRC_CFG_INCLUDE_FLOAT_SUPPORT 0
|
|
||||||
|
|
||||||
/*******************************************************************************
|
|
||||||
* TRC_CFG_SYMBOL_TABLE_SIZE
|
|
||||||
*
|
|
||||||
* Macro which should be defined as an integer value.
|
|
||||||
*
|
|
||||||
* This defines the capacity of the symbol table, in bytes. This symbol table
|
|
||||||
* stores User Events labels and names of deleted tasks, queues, or other kernel
|
|
||||||
* objects. If you don't use User Events or delete any kernel
|
|
||||||
* objects you set this to a very low value. The minimum recommended value is 4.
|
|
||||||
* A size of zero (0) is not allowed since a zero-sized array may result in a
|
|
||||||
* 32-bit pointer, i.e., using 4 bytes rather than 0.
|
|
||||||
*
|
|
||||||
* Default value is 800.
|
|
||||||
******************************************************************************/
|
|
||||||
#define TRC_CFG_SYMBOL_TABLE_SIZE 32000
|
|
||||||
|
|
||||||
#if (TRC_CFG_SYMBOL_TABLE_SIZE == 0)
|
|
||||||
#error "TRC_CFG_SYMBOL_TABLE_SIZE may not be zero!"
|
|
||||||
#endif
|
|
||||||
|
|
||||||
/******************************************************************************
|
|
||||||
* TRC_CFG_NAME_LEN_TASK, TRC_CFG_NAME_LEN_QUEUE, ...
|
|
||||||
*
|
|
||||||
* Macros that specify the maximum lengths (number of characters) for names of
|
|
||||||
* kernel objects, such as tasks and queues. If longer names are used, they will
|
|
||||||
* be truncated when stored in the recorder.
|
|
||||||
*****************************************************************************/
|
|
||||||
#define TRC_CFG_NAME_LEN_TASK 15
|
|
||||||
#define TRC_CFG_NAME_LEN_ISR 15
|
|
||||||
#define TRC_CFG_NAME_LEN_QUEUE 15
|
|
||||||
#define TRC_CFG_NAME_LEN_SEMAPHORE 15
|
|
||||||
#define TRC_CFG_NAME_LEN_MUTEX 15
|
|
||||||
#define TRC_CFG_NAME_LEN_TIMER 15
|
|
||||||
#define TRC_CFG_NAME_LEN_EVENTGROUP 15
|
|
||||||
#define TRC_CFG_NAME_LEN_STREAMBUFFER 15
|
|
||||||
#define TRC_CFG_NAME_LEN_MESSAGEBUFFER 15
|
|
||||||
|
|
||||||
/******************************************************************************
|
|
||||||
*** ADVANCED SETTINGS ********************************************************
|
|
||||||
******************************************************************************
|
|
||||||
* The remaining settings are not necessary to modify but allows for optimizing
|
|
||||||
* the recorder setup for your specific needs, e.g., to exclude events that you
|
|
||||||
* are not interested in, in order to get longer traces.
|
|
||||||
*****************************************************************************/
|
|
||||||
|
|
||||||
/******************************************************************************
|
|
||||||
* TRC_CFG_HEAP_SIZE_BELOW_16M
|
|
||||||
*
|
|
||||||
* An integer constant that can be used to reduce the buffer usage of memory
|
|
||||||
* allocation events (malloc/free). This value should be 1 if the heap size is
|
|
||||||
* below 16 MB (2^24 byte), and you can live with reported addresses showing the
|
|
||||||
* lower 24 bits only. If 0, you get the full 32-bit addresses.
|
|
||||||
*
|
|
||||||
* Default value is 0.
|
|
||||||
******************************************************************************/
|
|
||||||
#define TRC_CFG_HEAP_SIZE_BELOW_16M 0
|
|
||||||
|
|
||||||
/******************************************************************************
|
|
||||||
* TRC_CFG_USE_IMPLICIT_IFE_RULES
|
|
||||||
*
|
|
||||||
* Macro which should be defined as either zero (0) or one (1).
|
|
||||||
* Default is 1.
|
|
||||||
*
|
|
||||||
* Tracealyzer groups the events into "instances" based on Instance Finish
|
|
||||||
* Events (IFEs), produced either by default rules or calls to the recorder
|
|
||||||
* functions vTraceInstanceFinishedNow and vTraceInstanceFinishedNext.
|
|
||||||
*
|
|
||||||
* If TRC_CFG_USE_IMPLICIT_IFE_RULES is one (1), the default IFE rules is
|
|
||||||
* used, resulting in a "typical" grouping of events into instances.
|
|
||||||
* If these rules don't give appropriate instances in your case, you can
|
|
||||||
* override the default rules using vTraceInstanceFinishedNow/Next for one
|
|
||||||
* or several tasks. The default IFE rules are then disabled for those tasks.
|
|
||||||
*
|
|
||||||
* If TRC_CFG_USE_IMPLICIT_IFE_RULES is zero (0), the implicit IFE rules are
|
|
||||||
* disabled globally. You must then call vTraceInstanceFinishedNow or
|
|
||||||
* vTraceInstanceFinishedNext to manually group the events into instances,
|
|
||||||
* otherwise the tasks will appear a single long instance.
|
|
||||||
*
|
|
||||||
* The default IFE rules count the following events as "instance finished":
|
|
||||||
* - Task delay, delay until
|
|
||||||
* - Task suspend
|
|
||||||
* - Blocking on "input" operations, i.e., when the task is waiting for the
|
|
||||||
* next a message/signal/event. But only if this event is blocking.
|
|
||||||
*
|
|
||||||
* For details, see trcSnapshotKernelPort.h and look for references to the
|
|
||||||
* macro trcKERNEL_HOOKS_SET_TASK_INSTANCE_FINISHED.
|
|
||||||
*****************************************************************************/
|
|
||||||
#define TRC_CFG_USE_IMPLICIT_IFE_RULES 1
|
|
||||||
|
|
||||||
/******************************************************************************
|
|
||||||
* TRC_CFG_USE_16BIT_OBJECT_HANDLES
|
|
||||||
*
|
|
||||||
* Macro which should be defined as either zero (0) or one (1).
|
|
||||||
*
|
|
||||||
* If set to 0 (zero), the recorder uses 8-bit handles to identify kernel
|
|
||||||
* objects such as tasks and queues. This limits the supported number of
|
|
||||||
* concurrently active objects to 255 of each type (tasks, queues, mutexes,
|
|
||||||
* etc.) Note: 255, not 256, since handle 0 is reserved.
|
|
||||||
*
|
|
||||||
* If set to 1 (one), the recorder uses 16-bit handles to identify kernel
|
|
||||||
* objects such as tasks and queues. This limits the supported number of
|
|
||||||
* concurrent objects to 65535 of each type (object class). However, since the
|
|
||||||
* object property table is limited to 64 KB, the practical limit is about
|
|
||||||
* 3000 objects in total.
|
|
||||||
*
|
|
||||||
* Default is 0 (8-bit handles)
|
|
||||||
*
|
|
||||||
* NOTE: An object with handle above 255 will use an extra 4-byte record in
|
|
||||||
* the event buffer whenever the object is referenced. Moreover, some internal
|
|
||||||
* tables in the recorder gets slightly larger when using 16-bit handles.
|
|
||||||
*****************************************************************************/
|
|
||||||
#define TRC_CFG_USE_16BIT_OBJECT_HANDLES 0
|
|
||||||
|
|
||||||
/******************************************************************************
|
|
||||||
* TRC_CFG_USE_TRACE_ASSERT
|
|
||||||
*
|
|
||||||
* Macro which should be defined as either zero (0) or one (1).
|
|
||||||
* Default is 1.
|
|
||||||
*
|
|
||||||
* If this is one (1), the TRACE_ASSERT macro (used at various locations in the
|
|
||||||
* trace recorder) will verify that a relevant condition is true.
|
|
||||||
* If the condition is false, prvTraceError() will be called, which stops the
|
|
||||||
* recording and stores an error message that is displayed when opening the
|
|
||||||
* trace in Tracealyzer.
|
|
||||||
*
|
|
||||||
* This is used on several places in the recorder code for sanity checks on
|
|
||||||
* parameters. Can be switched off to reduce the footprint of the tracing, but
|
|
||||||
* we recommend to have it enabled initially.
|
|
||||||
*****************************************************************************/
|
|
||||||
#define TRC_CFG_USE_TRACE_ASSERT 1
|
|
||||||
|
|
||||||
/*******************************************************************************
|
|
||||||
* TRC_CFG_USE_SEPARATE_USER_EVENT_BUFFER
|
|
||||||
*
|
|
||||||
* Macro which should be defined as an integer value.
|
|
||||||
*
|
|
||||||
* Set TRC_CFG_USE_SEPARATE_USER_EVENT_BUFFER to 1 to enable the
|
|
||||||
* separate user event buffer (UB).
|
|
||||||
* In this mode, user events are stored separately from other events,
|
|
||||||
* e.g., RTOS events. Thereby you can get a much longer history of
|
|
||||||
* user events as they don't need to share the buffer space with more
|
|
||||||
* frequent events.
|
|
||||||
*
|
|
||||||
* The UB is typically used with the snapshot ring-buffer mode, so the
|
|
||||||
* recording can continue when the main buffer gets full. And since the
|
|
||||||
* main buffer then overwrites the earliest events, Tracealyzer displays
|
|
||||||
* "Unknown Actor" instead of task scheduling for periods with UB data only.
|
|
||||||
*
|
|
||||||
* In UB mode, user events are structured as UB channels, which contains
|
|
||||||
* a channel name and a default format string. Register a UB channel using
|
|
||||||
* xTraceRegisterUBChannel.
|
|
||||||
*
|
|
||||||
* Events and data arguments are written using vTraceUBEvent and
|
|
||||||
* vTraceUBData. They are designed to provide efficient logging of
|
|
||||||
* repeating events, using the same format string within each channel.
|
|
||||||
*
|
|
||||||
* Examples:
|
|
||||||
*
|
|
||||||
* traceString chn1 = xTraceRegisterString("Channel 1");
|
|
||||||
* traceString fmt1 = xTraceRegisterString("Event!");
|
|
||||||
* traceUBChannel UBCh1 = xTraceRegisterUBChannel(chn1, fmt1);
|
|
||||||
*
|
|
||||||
* traceString chn2 = xTraceRegisterString("Channel 2");
|
|
||||||
* traceString fmt2 = xTraceRegisterString("X: %d, Y: %d");
|
|
||||||
* traceUBChannel UBCh2 = xTraceRegisterUBChannel(chn2, fmt2);
|
|
||||||
*
|
|
||||||
* // Result in "[Channel 1] Event!"
|
|
||||||
* vTraceUBEvent(UBCh1);
|
|
||||||
*
|
|
||||||
* // Result in "[Channel 2] X: 23, Y: 19"
|
|
||||||
* vTraceUBData(UBCh2, 23, 19);
|
|
||||||
*
|
|
||||||
* You can also use the other user event functions, like vTracePrintF.
|
|
||||||
* as they are then rerouted to the UB instead of the main event buffer.
|
|
||||||
* vTracePrintF then looks up the correct UB channel based on the
|
|
||||||
* provided channel name and format string, or creates a new UB channel
|
|
||||||
* if no match is found. The format string should therefore not contain
|
|
||||||
* "random" messages but mainly format specifiers. Random strings should
|
|
||||||
* be stored using %s and with the string as an argument.
|
|
||||||
*
|
|
||||||
* // Creates a new UB channel ("Channel 2", "%Z: %d")
|
|
||||||
* vTracePrintF(chn2, "%Z: %d", value1);
|
|
||||||
*
|
|
||||||
* // Finds the existing UB channel
|
|
||||||
* vTracePrintF(chn2, "%Z: %d", value2);
|
|
||||||
|
|
||||||
******************************************************************************/
|
|
||||||
#define TRC_CFG_USE_SEPARATE_USER_EVENT_BUFFER 0
|
|
||||||
|
|
||||||
/*******************************************************************************
|
|
||||||
* TRC_CFG_SEPARATE_USER_EVENT_BUFFER_SIZE
|
|
||||||
*
|
|
||||||
* Macro which should be defined as an integer value.
|
|
||||||
*
|
|
||||||
* This defines the capacity of the user event buffer (UB), in number of slots.
|
|
||||||
* A single user event can use multiple slots, depending on the arguments.
|
|
||||||
*
|
|
||||||
* Only applicable if TRC_CFG_USE_SEPARATE_USER_EVENT_BUFFER is 1.
|
|
||||||
******************************************************************************/
|
|
||||||
#define TRC_CFG_SEPARATE_USER_EVENT_BUFFER_SIZE 200
|
|
||||||
|
|
||||||
/*******************************************************************************
|
|
||||||
* TRC_CFG_UB_CHANNELS
|
|
||||||
*
|
|
||||||
* Macro which should be defined as an integer value.
|
|
||||||
*
|
|
||||||
* This defines the number of User Event Buffer Channels (UB channels).
|
|
||||||
* These are used to structure the events when using the separate user
|
|
||||||
* event buffer, and contains both a User Event Channel (the name) and
|
|
||||||
* a default format string for the channel.
|
|
||||||
*
|
|
||||||
* Only applicable if TRC_CFG_USE_SEPARATE_USER_EVENT_BUFFER is 1.
|
|
||||||
******************************************************************************/
|
|
||||||
#define TRC_CFG_UB_CHANNELS 32
|
|
||||||
|
|
||||||
/*******************************************************************************
|
|
||||||
* TRC_CFG_ISR_TAILCHAINING_THRESHOLD
|
|
||||||
*
|
|
||||||
* Macro which should be defined as an integer value.
|
|
||||||
*
|
|
||||||
* If tracing multiple ISRs, this setting allows for accurate display of the
|
|
||||||
* context-switching also in cases when the ISRs execute in direct sequence.
|
|
||||||
*
|
|
||||||
* vTraceStoreISREnd normally assumes that the ISR returns to the previous
|
|
||||||
* context, i.e., a task or a preempted ISR. But if another traced ISR
|
|
||||||
* executes in direct sequence, Tracealyzer may incorrectly display a minimal
|
|
||||||
* fragment of the previous context in between the ISRs.
|
|
||||||
*
|
|
||||||
* By using TRC_CFG_ISR_TAILCHAINING_THRESHOLD you can avoid this. This is
|
|
||||||
* however a threshold value that must be measured for your specific setup.
|
|
||||||
* See http://percepio.com/2014/03/21/isr_tailchaining_threshold/
|
|
||||||
*
|
|
||||||
* The default setting is 0, meaning "disabled" and that you may get an
|
|
||||||
* extra fragments of the previous context in between tail-chained ISRs.
|
|
||||||
*
|
|
||||||
* Note: This setting has separate definitions in trcSnapshotConfig.h and
|
|
||||||
* trcStreamingConfig.h, since it is affected by the recorder mode.
|
|
||||||
******************************************************************************/
|
|
||||||
#define TRC_CFG_ISR_TAILCHAINING_THRESHOLD 0
|
|
||||||
|
|
||||||
#endif /*TRC_SNAPSHOT_CONFIG_H*/
|
|
||||||
@ -0,0 +1,320 @@
|
|||||||
|
/*
|
||||||
|
* Trace Recorder for Tracealyzer v4.6.0
|
||||||
|
* Copyright 2021 Percepio AB
|
||||||
|
* www.percepio.com
|
||||||
|
*
|
||||||
|
* SPDX-License-Identifier: Apache-2.0
|
||||||
|
*
|
||||||
|
* Main configuration parameters for the trace recorder library.
|
||||||
|
* More settings can be found in trcStreamingConfig.h and trcSnapshotConfig.h.
|
||||||
|
*/
|
||||||
|
|
||||||
|
#ifndef TRC_CONFIG_H
|
||||||
|
#define TRC_CONFIG_H
|
||||||
|
|
||||||
|
#ifdef __cplusplus
|
||||||
|
extern "C" {
|
||||||
|
#endif
|
||||||
|
|
||||||
|
/******************************************************************************
|
||||||
|
* Include of processor header file
|
||||||
|
*
|
||||||
|
* Here you may need to include the header file for your processor. This is
|
||||||
|
* required at least for the ARM Cortex-M port, that uses the ARM CMSIS API.
|
||||||
|
* Try that in case of build problems. Otherwise, remove the #error line below.
|
||||||
|
*****************************************************************************/
|
||||||
|
/*#error "Trace Recorder: Please include your processor's header file here and remove this line." */
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_HARDWARE_PORT
|
||||||
|
* @brief Specify what hardware port to use (i.e., the "timestamping driver").
|
||||||
|
*
|
||||||
|
* All ARM Cortex-M MCUs are supported by "TRC_HARDWARE_PORT_ARM_Cortex_M".
|
||||||
|
* This port uses the DWT cycle counter for Cortex-M3/M4/M7 devices, which is
|
||||||
|
* available on most such devices. In case your device don't have DWT support,
|
||||||
|
* you will get an error message opening the trace. In that case, you may
|
||||||
|
* force the recorder to use SysTick timestamping instead, using this define:
|
||||||
|
*
|
||||||
|
* #define TRC_CFG_ARM_CM_USE_SYSTICK
|
||||||
|
*
|
||||||
|
* For ARM Cortex-M0/M0+ devices, SysTick mode is used automatically.
|
||||||
|
*
|
||||||
|
* See trcHardwarePort.h for available ports and information on how to
|
||||||
|
* define your own port, if not already present.
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_HARDWARE_PORT TRC_HARDWARE_PORT_Win32
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_SCHEDULING_ONLY
|
||||||
|
* @brief Macro which should be defined as an integer value.
|
||||||
|
*
|
||||||
|
* If this setting is enabled (= 1), only scheduling events are recorded.
|
||||||
|
* If disabled (= 0), all events are recorded (unless filtered in other ways).
|
||||||
|
*
|
||||||
|
* Default value is 0 (= include additional events).
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_SCHEDULING_ONLY 0
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_INCLUDE_MEMMANG_EVENTS
|
||||||
|
* @brief Macro which should be defined as either zero (0) or one (1).
|
||||||
|
*
|
||||||
|
* This controls if malloc and free calls should be traced. Set this to zero (0)
|
||||||
|
* to exclude malloc/free calls, or one (1) to include such events in the trace.
|
||||||
|
*
|
||||||
|
* Default value is 1.
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_INCLUDE_MEMMANG_EVENTS 1
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_INCLUDE_USER_EVENTS
|
||||||
|
* @brief Macro which should be defined as either zero (0) or one (1).
|
||||||
|
*
|
||||||
|
* If this is zero (0), all code related to User Events is excluded in order
|
||||||
|
* to reduce code size. Any attempts of storing User Events are then silently
|
||||||
|
* ignored.
|
||||||
|
*
|
||||||
|
* User Events are application-generated events, like "printf" but for the
|
||||||
|
* trace log, generated using vTracePrint and vTracePrintF.
|
||||||
|
* The formatting is done on host-side, by Tracealyzer. User Events are
|
||||||
|
* therefore much faster than a console printf and can often be used
|
||||||
|
* in timing critical code without problems.
|
||||||
|
*
|
||||||
|
* Note: In streaming mode, User Events are used to provide error messages
|
||||||
|
* and warnings from the recorder (in case of incorrect configuration) for
|
||||||
|
* display in Tracealyzer. Disabling user events will also disable these
|
||||||
|
* warnings. You can however still catch them by calling xTraceErrorGetLast
|
||||||
|
* or by putting breakpoints in xTraceError and xTraceWarning.
|
||||||
|
*
|
||||||
|
* Default value is 1.
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_INCLUDE_USER_EVENTS 1
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_INCLUDE_ISR_TRACING
|
||||||
|
* @brief Macro which should be defined as either zero (0) or one (1).
|
||||||
|
*
|
||||||
|
* If this is zero (0), the code for recording Interrupt Service Routines is
|
||||||
|
* excluded, in order to reduce code size. This means that any calls to
|
||||||
|
* vTraceStoreISRBegin/vTraceStoreISREnd will be ignored.
|
||||||
|
* This does not completely disable ISR tracing, in cases where an ISR is
|
||||||
|
* calling a traced kernel service. These events will still be recorded and
|
||||||
|
* show up in anonymous ISR instances in Tracealyzer, with names such as
|
||||||
|
* "ISR sending to <queue name>".
|
||||||
|
* To disable such tracing, please refer to vTraceSetFilterGroup and
|
||||||
|
* vTraceSetFilterMask.
|
||||||
|
*
|
||||||
|
* Default value is 1.
|
||||||
|
*
|
||||||
|
* Note: tracing ISRs requires that you insert calls to vTraceStoreISRBegin
|
||||||
|
* and vTraceStoreISREnd in your interrupt handlers.
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_INCLUDE_ISR_TRACING 1
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_INCLUDE_READY_EVENTS
|
||||||
|
* @brief Macro which should be defined as either zero (0) or one (1).
|
||||||
|
*
|
||||||
|
* If one (1), events are recorded when tasks enter scheduling state "ready".
|
||||||
|
* This allows Tracealyzer to show the initial pending time before tasks enter
|
||||||
|
* the execution state, and present accurate response times.
|
||||||
|
* If zero (0), "ready events" are not created, which allows for recording
|
||||||
|
* longer traces in the same amount of RAM.
|
||||||
|
*
|
||||||
|
* Default value is 1.
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_INCLUDE_READY_EVENTS 1
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_INCLUDE_OSTICK_EVENTS
|
||||||
|
* @brief Macro which should be defined as either zero (0) or one (1).
|
||||||
|
*
|
||||||
|
* If this is one (1), events will be generated whenever the OS clock is
|
||||||
|
* increased. If zero (0), OS tick events are not generated, which allows for
|
||||||
|
* recording longer traces in the same amount of RAM.
|
||||||
|
*
|
||||||
|
* Default value is 1.
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_INCLUDE_OSTICK_EVENTS 1
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_ENABLE_STACK_MONITOR
|
||||||
|
* @brief If enabled (1), the recorder periodically reports the unused stack space of
|
||||||
|
* all active tasks.
|
||||||
|
* The stack monitoring runs in the Tracealyzer Control task, TzCtrl. This task
|
||||||
|
* is always created by the recorder when in streaming mode.
|
||||||
|
* In snapshot mode, the TzCtrl task is only used for stack monitoring and is
|
||||||
|
* not created unless this is enabled.
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_ENABLE_STACK_MONITOR 1
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_STACK_MONITOR_MAX_TASKS
|
||||||
|
* @brief Macro which should be defined as a non-zero integer value.
|
||||||
|
*
|
||||||
|
* This controls how many tasks that can be monitored by the stack monitor.
|
||||||
|
* If this is too small, some tasks will be excluded and a warning is shown.
|
||||||
|
*
|
||||||
|
* Default value is 10.
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_STACK_MONITOR_MAX_TASKS 10
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_STACK_MONITOR_MAX_REPORTS
|
||||||
|
* @brief Macro which should be defined as a non-zero integer value.
|
||||||
|
*
|
||||||
|
* This defines how many tasks that will be subject to stack usage analysis for
|
||||||
|
* each execution of the Tracealyzer Control task (TzCtrl). Note that the stack
|
||||||
|
* monitoring cycles between the tasks, so this does not affect WHICH tasks that
|
||||||
|
* are monitored, but HOW OFTEN each task stack is analyzed.
|
||||||
|
*
|
||||||
|
* This setting can be combined with TRC_CFG_CTRL_TASK_DELAY to tune the
|
||||||
|
* frequency of the stack monitoring. This is motivated since the stack analysis
|
||||||
|
* can take some time to execute.
|
||||||
|
* However, note that the stack analysis runs in a separate task (TzCtrl) that
|
||||||
|
* can be executed on low priority. This way, you can avoid that the stack
|
||||||
|
* analysis disturbs any time-sensitive tasks.
|
||||||
|
*
|
||||||
|
* Default value is 1.
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_STACK_MONITOR_MAX_REPORTS 1
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_CTRL_TASK_PRIORITY
|
||||||
|
* @brief The scheduling priority of the Tracealyzer Control (TzCtrl) task.
|
||||||
|
*
|
||||||
|
* In streaming mode, TzCtrl is used to receive start/stop commands from
|
||||||
|
* Tracealyzer and in some cases also to transmit the trace data (for stream
|
||||||
|
* ports that uses the internal buffer, like TCP/IP). For such stream ports,
|
||||||
|
* make sure the TzCtrl priority is high enough to ensure reliable periodic
|
||||||
|
* execution and transfer of the data, but low enough to avoid disturbing any
|
||||||
|
* time-sensitive functions.
|
||||||
|
*
|
||||||
|
* In Snapshot mode, TzCtrl is only used for the stack usage monitoring and is
|
||||||
|
* not created if stack monitoring is disabled. TRC_CFG_CTRL_TASK_PRIORITY should
|
||||||
|
* be low, to avoid disturbing any time-sensitive tasks.
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_CTRL_TASK_PRIORITY 1
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_CTRL_TASK_DELAY
|
||||||
|
* @brief The delay between loops of the TzCtrl task (see TRC_CFG_CTRL_TASK_PRIORITY),
|
||||||
|
* which affects the frequency of the stack monitoring.
|
||||||
|
*
|
||||||
|
* In streaming mode, this also affects the trace data transfer if you are using
|
||||||
|
* a stream port leveraging the internal buffer (like TCP/IP). A shorter delay
|
||||||
|
* increases the CPU load of TzCtrl somewhat, but may improve the performance of
|
||||||
|
* of the trace streaming, especially if the trace buffer is small.
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_CTRL_TASK_DELAY 2
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_CTRL_TASK_STACK_SIZE
|
||||||
|
* @brief The stack size of the Tracealyzer Control (TzCtrl) task.
|
||||||
|
* See TRC_CFG_CTRL_TASK_PRIORITY for further information about TzCtrl.
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_CTRL_TASK_STACK_SIZE 1024
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_RECORDER_BUFFER_ALLOCATION
|
||||||
|
* @brief Specifies how the recorder buffer is allocated (also in case of streaming, in
|
||||||
|
* port using the recorder's internal temporary buffer)
|
||||||
|
*
|
||||||
|
* Values:
|
||||||
|
* TRC_RECORDER_BUFFER_ALLOCATION_STATIC - Static allocation (internal)
|
||||||
|
* TRC_RECORDER_BUFFER_ALLOCATION_DYNAMIC - Malloc in vTraceEnable
|
||||||
|
* TRC_RECORDER_BUFFER_ALLOCATION_CUSTOM - Use vTraceSetRecorderDataBuffer
|
||||||
|
*
|
||||||
|
* Static and dynamic mode does the allocation for you, either in compile time
|
||||||
|
* (static) or in runtime (malloc).
|
||||||
|
* The custom mode allows you to control how and where the allocation is made,
|
||||||
|
* for details see TRC_ALLOC_CUSTOM_BUFFER and vTraceSetRecorderDataBuffer().
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_RECORDER_BUFFER_ALLOCATION TRC_RECORDER_BUFFER_ALLOCATION_STATIC
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_MAX_ISR_NESTING
|
||||||
|
* @brief Defines how many levels of interrupt nesting the recorder can handle, in
|
||||||
|
* case multiple ISRs are traced and ISR nesting is possible. If this
|
||||||
|
* is exceeded, the particular ISR will not be traced and the recorder then
|
||||||
|
* logs an error message. This setting is used to allocate an internal stack
|
||||||
|
* for keeping track of the previous execution context (4 byte per entry).
|
||||||
|
*
|
||||||
|
* This value must be a non-zero positive constant, at least 1.
|
||||||
|
*
|
||||||
|
* Default value: 8
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_MAX_ISR_NESTING 8
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_ISR_TAILCHAINING_THRESHOLD
|
||||||
|
* @brief Macro which should be defined as an integer value.
|
||||||
|
*
|
||||||
|
* If tracing multiple ISRs, this setting allows for accurate display of the
|
||||||
|
* context-switching also in cases when the ISRs execute in direct sequence.
|
||||||
|
*
|
||||||
|
* vTraceStoreISREnd normally assumes that the ISR returns to the previous
|
||||||
|
* context, i.e., a task or a preempted ISR. But if another traced ISR
|
||||||
|
* executes in direct sequence, Tracealyzer may incorrectly display a minimal
|
||||||
|
* fragment of the previous context in between the ISRs.
|
||||||
|
*
|
||||||
|
* By using TRC_CFG_ISR_TAILCHAINING_THRESHOLD you can avoid this. This is
|
||||||
|
* however a threshold value that must be measured for your specific setup.
|
||||||
|
* See http://percepio.com/2014/03/21/isr_tailchaining_threshold/
|
||||||
|
*
|
||||||
|
* The default setting is 0, meaning "disabled" and that you may get an
|
||||||
|
* extra fragments of the previous context in between tail-chained ISRs.
|
||||||
|
*
|
||||||
|
* Note: This setting has separate definitions in trcSnapshotConfig.h and
|
||||||
|
* trcStreamingConfig.h, since it is affected by the recorder mode.
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_ISR_TAILCHAINING_THRESHOLD 0
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_RECORDER_DATA_INIT
|
||||||
|
* @brief Macro which states wether the recorder data should have an initial value.
|
||||||
|
*
|
||||||
|
* In very specific cases where traced objects are created before main(),
|
||||||
|
* the recorder will need to be started even before that. In these cases,
|
||||||
|
* the recorder data would be initialized by vTraceEnable(TRC_INIT) but could
|
||||||
|
* then later be overwritten by the initialization value.
|
||||||
|
* If this is an issue for you, set TRC_CFG_RECORDER_DATA_INIT to 0.
|
||||||
|
* The following code can then be used before any traced objects are created:
|
||||||
|
*
|
||||||
|
* extern uint32_t RecorderEnabled;
|
||||||
|
* RecorderEnabled = 0;
|
||||||
|
* xTraceInitialize();
|
||||||
|
*
|
||||||
|
* After the clocks are properly initialized, use vTraceEnable(...) to start
|
||||||
|
* the tracing.
|
||||||
|
*
|
||||||
|
* Default value is 1.
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_RECORDER_DATA_INIT 1
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_RECORDER_DATA_ATTRIBUTE
|
||||||
|
* @brief When setting TRC_CFG_RECORDER_DATA_INIT to 0, you might also need to make
|
||||||
|
* sure certain recorder data is placed in a specific RAM section to avoid being
|
||||||
|
* zeroed out after initialization. Define TRC_CFG_RECORDER_DATA_ATTRIBUTE as
|
||||||
|
* that attribute.
|
||||||
|
*
|
||||||
|
* Example:
|
||||||
|
* #define TRC_CFG_RECORDER_DATA_ATTRIBUTE __attribute__((section(".bss.trace_recorder_data")))
|
||||||
|
*
|
||||||
|
* Default value is empty.
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_RECORDER_DATA_ATTRIBUTE
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_USE_TRACE_ASSERT
|
||||||
|
* @brief Enable or disable debug asserts. Information regarding any assert that is
|
||||||
|
* triggered will be in trcAssert.c.
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_USE_TRACE_ASSERT 0
|
||||||
|
|
||||||
|
#ifdef __cplusplus
|
||||||
|
}
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#endif /* _TRC_CONFIG_H */
|
||||||
@ -0,0 +1,116 @@
|
|||||||
|
/*
|
||||||
|
* Trace Recorder for Tracealyzer v4.6.0
|
||||||
|
* Copyright 2021 Percepio AB
|
||||||
|
* www.percepio.com
|
||||||
|
*
|
||||||
|
* SPDX-License-Identifier: Apache-2.0
|
||||||
|
*
|
||||||
|
* Configuration parameters for the kernel port.
|
||||||
|
* More settings can be found in trcKernelPortStreamingConfig.h and
|
||||||
|
* trcKernelPortSnapshotConfig.h.
|
||||||
|
*/
|
||||||
|
|
||||||
|
#ifndef TRC_KERNEL_PORT_CONFIG_H
|
||||||
|
#define TRC_KERNEL_PORT_CONFIG_H
|
||||||
|
|
||||||
|
#ifdef __cplusplus
|
||||||
|
extern "C" {
|
||||||
|
#endif
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_RECORDER_MODE
|
||||||
|
* @brief Specify what recording mode to use. Snapshot means that the data is saved in
|
||||||
|
* an internal RAM buffer, for later upload. Streaming means that the data is
|
||||||
|
* transferred continuously to the host PC.
|
||||||
|
*
|
||||||
|
* For more information, see http://percepio.com/2016/10/05/rtos-tracing/
|
||||||
|
* and the Tracealyzer User Manual.
|
||||||
|
*
|
||||||
|
* Values:
|
||||||
|
* TRC_RECORDER_MODE_SNAPSHOT
|
||||||
|
* TRC_RECORDER_MODE_STREAMING
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_RECORDER_MODE TRC_RECORDER_MODE_SNAPSHOT
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_FREERTOS_VERSION
|
||||||
|
* @brief Specify what version of FreeRTOS that is used (don't change unless using the
|
||||||
|
* trace recorder library with an older version of FreeRTOS).
|
||||||
|
*
|
||||||
|
* TRC_FREERTOS_VERSION_7_3_X If using FreeRTOS v7.3.X
|
||||||
|
* TRC_FREERTOS_VERSION_7_4_X If using FreeRTOS v7.4.X
|
||||||
|
* TRC_FREERTOS_VERSION_7_5_X If using FreeRTOS v7.5.X
|
||||||
|
* TRC_FREERTOS_VERSION_7_6_X If using FreeRTOS v7.6.X
|
||||||
|
* TRC_FREERTOS_VERSION_8_X_X If using FreeRTOS v8.X.X
|
||||||
|
* TRC_FREERTOS_VERSION_9_0_0 If using FreeRTOS v9.0.0
|
||||||
|
* TRC_FREERTOS_VERSION_9_0_1 If using FreeRTOS v9.0.1
|
||||||
|
* TRC_FREERTOS_VERSION_9_0_2 If using FreeRTOS v9.0.2
|
||||||
|
* TRC_FREERTOS_VERSION_10_0_0 If using FreeRTOS v10.0.0
|
||||||
|
* TRC_FREERTOS_VERSION_10_0_1 If using FreeRTOS v10.0.1
|
||||||
|
* TRC_FREERTOS_VERSION_10_1_0 If using FreeRTOS v10.1.0
|
||||||
|
* TRC_FREERTOS_VERSION_10_1_1 If using FreeRTOS v10.1.1
|
||||||
|
* TRC_FREERTOS_VERSION_10_2_0 If using FreeRTOS v10.2.0
|
||||||
|
* TRC_FREERTOS_VERSION_10_2_1 If using FreeRTOS v10.2.1
|
||||||
|
* TRC_FREERTOS_VERSION_10_3_0 If using FreeRTOS v10.3.0
|
||||||
|
* TRC_FREERTOS_VERSION_10_3_1 If using FreeRTOS v10.3.1
|
||||||
|
* TRC_FREERTOS_VERSION_10_4_0 If using FreeRTOS v10.4.0
|
||||||
|
* TRC_FREERTOS_VERSION_10_4_1 If using FreeRTOS v10.4.1 or later
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_FREERTOS_VERSION TRC_FREERTOS_VERSION_10_4_1
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_INCLUDE_EVENT_GROUP_EVENTS
|
||||||
|
* @brief Macro which should be defined as either zero (0) or one (1).
|
||||||
|
*
|
||||||
|
* If this is zero (0), the trace will exclude any "event group" events.
|
||||||
|
*
|
||||||
|
* Default value is 0 (excluded) since dependent on event_groups.c
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_INCLUDE_EVENT_GROUP_EVENTS 1
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_INCLUDE_TIMER_EVENTS
|
||||||
|
* @brief Macro which should be defined as either zero (0) or one (1).
|
||||||
|
*
|
||||||
|
* If this is zero (0), the trace will exclude any Timer events.
|
||||||
|
*
|
||||||
|
* Default value is 0 since dependent on timers.c
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_INCLUDE_TIMER_EVENTS 1
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_INCLUDE_PEND_FUNC_CALL_EVENTS
|
||||||
|
* @brief Macro which should be defined as either zero (0) or one (1).
|
||||||
|
*
|
||||||
|
* If this is zero (0), the trace will exclude any "pending function call"
|
||||||
|
* events, such as xTimerPendFunctionCall().
|
||||||
|
*
|
||||||
|
* Default value is 0 since dependent on timers.c
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_INCLUDE_PEND_FUNC_CALL_EVENTS 1
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_INCLUDE_STREAM_BUFFER_EVENTS
|
||||||
|
* @brief Macro which should be defined as either zero (0) or one (1).
|
||||||
|
*
|
||||||
|
* If this is zero (0), the trace will exclude any stream buffer or message
|
||||||
|
* buffer events.
|
||||||
|
*
|
||||||
|
* Default value is 0 since dependent on stream_buffer.c (new in FreeRTOS v10)
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_INCLUDE_STREAM_BUFFER_EVENTS 1
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_ACKNOWLEDGE_QUEUE_SET_SEND
|
||||||
|
* @brief When using FreeRTOS v10.3.0 or v10.3.1, please make sure that the trace
|
||||||
|
* point in prvNotifyQueueSetContainer() in queue.c is renamed from
|
||||||
|
* traceQUEUE_SEND to traceQUEUE_SET_SEND in order to tell them apart from
|
||||||
|
* other traceQUEUE_SEND trace points. Then set this to TRC_ACKNOWLEDGED.
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_ACKNOWLEDGE_QUEUE_SET_SEND 0 /* TRC_ACKNOWLEDGED */
|
||||||
|
|
||||||
|
#ifdef __cplusplus
|
||||||
|
}
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#endif /* TRC_KERNEL_PORT_CONFIG_H */
|
||||||
@ -0,0 +1,69 @@
|
|||||||
|
/*
|
||||||
|
* Trace Recorder for Tracealyzer v4.6.0
|
||||||
|
* Copyright 2021 Percepio AB
|
||||||
|
* www.percepio.com
|
||||||
|
*
|
||||||
|
* SPDX-License-Identifier: Apache-2.0
|
||||||
|
*
|
||||||
|
* Kernel port configuration parameters for snapshot mode.
|
||||||
|
*/
|
||||||
|
|
||||||
|
#ifndef TRC_KERNEL_PORT_SNAPSHOT_CONFIG_H
|
||||||
|
#define TRC_KERNEL_PORT_SNAPSHOT_CONFIG_H
|
||||||
|
|
||||||
|
#ifdef __cplusplus
|
||||||
|
extern "C" {
|
||||||
|
#endif
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_NTASK, TRC_CFG_NISR, TRC_CFG_NQUEUE, TRC_CFG_NSEMAPHORE...
|
||||||
|
* @brief A group of macros which should be defined as integer values, zero or larger.
|
||||||
|
*
|
||||||
|
* These define the capacity of the Object Property Table, i.e., the maximum
|
||||||
|
* number of objects active at any given point, within each object class (e.g.,
|
||||||
|
* task, queue, semaphore, ...).
|
||||||
|
*
|
||||||
|
* If tasks or other objects are deleted in your system, this
|
||||||
|
* setting does not limit the total amount of objects created, only the number
|
||||||
|
* of objects that have been successfully created but not yet deleted.
|
||||||
|
*
|
||||||
|
* Using too small values will cause vTraceError to be called, which stores an
|
||||||
|
* error message in the trace that is shown when opening the trace file. The
|
||||||
|
* error message can also be retrieved using xTraceGetLastError.
|
||||||
|
*
|
||||||
|
* It can be wise to start with large values for these constants,
|
||||||
|
* unless you are very confident on these numbers. Then do a recording and
|
||||||
|
* check the actual usage by selecting View menu -> Trace Details ->
|
||||||
|
* Resource Usage -> Object Table.
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_NTASK 150
|
||||||
|
#define TRC_CFG_NISR 90
|
||||||
|
#define TRC_CFG_NQUEUE 90
|
||||||
|
#define TRC_CFG_NSEMAPHORE 90
|
||||||
|
#define TRC_CFG_NMUTEX 90
|
||||||
|
#define TRC_CFG_NTIMER 250
|
||||||
|
#define TRC_CFG_NEVENTGROUP 90
|
||||||
|
#define TRC_CFG_NSTREAMBUFFER 50
|
||||||
|
#define TRC_CFG_NMESSAGEBUFFER 50
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_NAME_LEN_TASK, TRC_CFG_NAME_LEN_QUEUE, ...
|
||||||
|
* @brief Macros that specify the maximum lengths (number of characters) for names of
|
||||||
|
* kernel objects, such as tasks and queues. If longer names are used, they will
|
||||||
|
* be truncated when stored in the recorder.
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_NAME_LEN_TASK 15
|
||||||
|
#define TRC_CFG_NAME_LEN_ISR 15
|
||||||
|
#define TRC_CFG_NAME_LEN_QUEUE 15
|
||||||
|
#define TRC_CFG_NAME_LEN_SEMAPHORE 15
|
||||||
|
#define TRC_CFG_NAME_LEN_MUTEX 15
|
||||||
|
#define TRC_CFG_NAME_LEN_TIMER 15
|
||||||
|
#define TRC_CFG_NAME_LEN_EVENTGROUP 15
|
||||||
|
#define TRC_CFG_NAME_LEN_STREAMBUFFER 15
|
||||||
|
#define TRC_CFG_NAME_LEN_MESSAGEBUFFER 15
|
||||||
|
|
||||||
|
#ifdef __cplusplus
|
||||||
|
}
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#endif /* TRC_KERNEL_PORT_SNAPSHOT_CONFIG_H */
|
||||||
@ -0,0 +1,245 @@
|
|||||||
|
/*
|
||||||
|
* Trace Recorder for Tracealyzer v4.6.0
|
||||||
|
* Copyright 2021 Percepio AB
|
||||||
|
* www.percepio.com
|
||||||
|
*
|
||||||
|
* SPDX-License-Identifier: Apache-2.0
|
||||||
|
*
|
||||||
|
* Configuration parameters for trace recorder library in snapshot mode.
|
||||||
|
* Read more at http://percepio.com/2016/10/05/rtos-tracing/
|
||||||
|
*/
|
||||||
|
|
||||||
|
#ifndef TRC_SNAPSHOT_CONFIG_H
|
||||||
|
#define TRC_SNAPSHOT_CONFIG_H
|
||||||
|
|
||||||
|
#ifdef __cplusplus
|
||||||
|
extern "C" {
|
||||||
|
#endif
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_SNAPSHOT_MODE
|
||||||
|
* @brief Macro which should be defined as one of:
|
||||||
|
* - TRC_SNAPSHOT_MODE_RING_BUFFER
|
||||||
|
* - TRC_SNAPSHOT_MODE_STOP_WHEN_FULL
|
||||||
|
* Default is TRC_SNAPSHOT_MODE_RING_BUFFER.
|
||||||
|
*
|
||||||
|
* With TRC_CFG_SNAPSHOT_MODE set to TRC_SNAPSHOT_MODE_RING_BUFFER, the
|
||||||
|
* events are stored in a ring buffer, i.e., where the oldest events are
|
||||||
|
* overwritten when the buffer becomes full. This allows you to get the last
|
||||||
|
* events leading up to an interesting state, e.g., an error, without having
|
||||||
|
* to store the whole run since startup.
|
||||||
|
*
|
||||||
|
* When TRC_CFG_SNAPSHOT_MODE is TRC_SNAPSHOT_MODE_STOP_WHEN_FULL, the
|
||||||
|
* recording is stopped when the buffer becomes full. This is useful for
|
||||||
|
* recording events following a specific state, e.g., the startup sequence.
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_SNAPSHOT_MODE TRC_SNAPSHOT_MODE_RING_BUFFER
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_EVENT_BUFFER_SIZE
|
||||||
|
* @brief Macro which should be defined as an integer value.
|
||||||
|
*
|
||||||
|
* This defines the capacity of the event buffer, i.e., the number of records
|
||||||
|
* it may store. Most events use one record (4 byte), although some events
|
||||||
|
* require multiple 4-byte records. You should adjust this to the amount of RAM
|
||||||
|
* available in the target system.
|
||||||
|
*
|
||||||
|
* Default value is 1000, which means that 4000 bytes is allocated for the
|
||||||
|
* event buffer.
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_EVENT_BUFFER_SIZE 50000
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_INCLUDE_FLOAT_SUPPORT
|
||||||
|
* @brief Macro which should be defined as either zero (0) or one (1).
|
||||||
|
*
|
||||||
|
* If this is zero (0), the support for logging floating point values in
|
||||||
|
* vTracePrintF is stripped out, in case floating point values are not used or
|
||||||
|
* supported by the platform used.
|
||||||
|
*
|
||||||
|
* Floating point values are only used in vTracePrintF and its subroutines, to
|
||||||
|
* allow for storing float (%f) or double (%lf) arguments.
|
||||||
|
*
|
||||||
|
* vTracePrintF can be used with integer and string arguments in either case.
|
||||||
|
*
|
||||||
|
* Default value is 0.
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_INCLUDE_FLOAT_SUPPORT 0
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_SYMBOL_TABLE_SIZE
|
||||||
|
* @brief Macro which should be defined as an integer value.
|
||||||
|
*
|
||||||
|
* This defines the capacity of the symbol table, in bytes. This symbol table
|
||||||
|
* stores User Events labels and names of deleted tasks, queues, or other kernel
|
||||||
|
* objects. If you don't use User Events or delete any kernel
|
||||||
|
* objects you set this to a very low value. The minimum recommended value is 4.
|
||||||
|
* A size of zero (0) is not allowed since a zero-sized array may result in a
|
||||||
|
* 32-bit pointer, i.e., using 4 bytes rather than 0.
|
||||||
|
*
|
||||||
|
* Default value is 800.
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_SYMBOL_TABLE_SIZE 8000
|
||||||
|
|
||||||
|
#if ( TRC_CFG_SYMBOL_TABLE_SIZE == 0 )
|
||||||
|
#error "TRC_CFG_SYMBOL_TABLE_SIZE may not be zero!"
|
||||||
|
#endif
|
||||||
|
|
||||||
|
/******************************************************************************
|
||||||
|
*** ADVANCED SETTINGS ********************************************************
|
||||||
|
******************************************************************************
|
||||||
|
* The remaining settings are not necessary to modify but allows for optimizing
|
||||||
|
* the recorder setup for your specific needs, e.g., to exclude events that you
|
||||||
|
* are not interested in, in order to get longer traces.
|
||||||
|
*****************************************************************************/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_HEAP_SIZE_BELOW_16M
|
||||||
|
* @brief An integer constant that can be used to reduce the buffer usage of memory
|
||||||
|
* allocation events (malloc/free). This value should be 1 if the heap size is
|
||||||
|
* below 16 MB (2^24 byte), and you can live with reported addresses showing the
|
||||||
|
* lower 24 bits only. If 0, you get the full 32-bit addresses.
|
||||||
|
*
|
||||||
|
* Default value is 0.
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_HEAP_SIZE_BELOW_16M 0
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_USE_IMPLICIT_IFE_RULES
|
||||||
|
* @brief Macro which should be defined as either zero (0) or one (1).
|
||||||
|
* Default is 1.
|
||||||
|
*
|
||||||
|
* Tracealyzer groups the events into "instances" based on Instance Finish
|
||||||
|
* Events (IFEs), produced either by default rules or calls to the recorder
|
||||||
|
* functions xTraceTaskInstanceFinishedNow and xTraceTaskInstanceFinishedNext.
|
||||||
|
*
|
||||||
|
* If TRC_CFG_USE_IMPLICIT_IFE_RULES is one (1), the default IFE rules is
|
||||||
|
* used, resulting in a "typical" grouping of events into instances.
|
||||||
|
* If these rules don't give appropriate instances in your case, you can
|
||||||
|
* override the default rules using xTraceTaskInstanceFinishedNow/Next for one
|
||||||
|
* or several tasks. The default IFE rules are then disabled for those tasks.
|
||||||
|
*
|
||||||
|
* If TRC_CFG_USE_IMPLICIT_IFE_RULES is zero (0), the implicit IFE rules are
|
||||||
|
* disabled globally. You must then call xTraceTaskInstanceFinishedNow or
|
||||||
|
* xTraceTaskInstanceFinishedNext to manually group the events into instances,
|
||||||
|
* otherwise the tasks will appear a single long instance.
|
||||||
|
*
|
||||||
|
* The default IFE rules count the following events as "instance finished":
|
||||||
|
* - Task delay, delay until
|
||||||
|
* - Task suspend
|
||||||
|
* - Blocking on "input" operations, i.e., when the task is waiting for the
|
||||||
|
* next a message/signal/event. But only if this event is blocking.
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_USE_IMPLICIT_IFE_RULES 1
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_USE_16BIT_OBJECT_HANDLES
|
||||||
|
* @brief Macro which should be defined as either zero (0) or one (1).
|
||||||
|
*
|
||||||
|
* If set to 0 (zero), the recorder uses 8-bit handles to identify kernel
|
||||||
|
* objects such as tasks and queues. This limits the supported number of
|
||||||
|
* concurrently active objects to 255 of each type (tasks, queues, mutexes,
|
||||||
|
* etc.) Note: 255, not 256, since handle 0 is reserved.
|
||||||
|
*
|
||||||
|
* If set to 1 (one), the recorder uses 16-bit handles to identify kernel
|
||||||
|
* objects such as tasks and queues. This limits the supported number of
|
||||||
|
* concurrent objects to 65535 of each type (object class). However, since the
|
||||||
|
* object property table is limited to 64 KB, the practical limit is about
|
||||||
|
* 3000 objects in total.
|
||||||
|
*
|
||||||
|
* Default is 0 (8-bit handles)
|
||||||
|
*
|
||||||
|
* NOTE: An object with handle above 255 will use an extra 4-byte record in
|
||||||
|
* the event buffer whenever the object is referenced. Moreover, some internal
|
||||||
|
* tables in the recorder gets slightly larger when using 16-bit handles.
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_USE_16BIT_OBJECT_HANDLES 0
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_USE_SEPARATE_USER_EVENT_BUFFER
|
||||||
|
* @brief Macro which should be defined as an integer value.
|
||||||
|
*
|
||||||
|
* Set TRC_CFG_USE_SEPARATE_USER_EVENT_BUFFER to 1 to enable the
|
||||||
|
* separate user event buffer (UB).
|
||||||
|
* In this mode, user events are stored separately from other events,
|
||||||
|
* e.g., RTOS events. Thereby you can get a much longer history of
|
||||||
|
* user events as they don't need to share the buffer space with more
|
||||||
|
* frequent events.
|
||||||
|
*
|
||||||
|
* The UB is typically used with the snapshot ring-buffer mode, so the
|
||||||
|
* recording can continue when the main buffer gets full. And since the
|
||||||
|
* main buffer then overwrites the earliest events, Tracealyzer displays
|
||||||
|
* "Unknown Actor" instead of task scheduling for periods with UB data only.
|
||||||
|
*
|
||||||
|
* In UB mode, user events are structured as UB channels, which contains
|
||||||
|
* a channel name and a default format string. Register a UB channel using
|
||||||
|
* xTraceRegisterUBChannel.
|
||||||
|
*
|
||||||
|
* Events and data arguments are written using vTraceUBEvent and
|
||||||
|
* vTraceUBData. They are designed to provide efficient logging of
|
||||||
|
* repeating events, using the same format string within each channel.
|
||||||
|
*
|
||||||
|
* Examples:
|
||||||
|
* TraceStringHandle_t chn1;
|
||||||
|
* TraceStringHandle_t fmt1;
|
||||||
|
* xTraceStringRegister("Channel 1", &chn1);
|
||||||
|
* xTraceStringRegister("Event!", &fmt1);
|
||||||
|
* traceUBChannel UBCh1 = xTraceRegisterUBChannel(chn1, fmt1);
|
||||||
|
*
|
||||||
|
* TraceStringHandle_t chn2;
|
||||||
|
* TraceStringHandle_t fmt2;
|
||||||
|
* xTraceStringRegister("Channel 2", &chn2);
|
||||||
|
* xTraceStringRegister("X: %d, Y: %d", &fmt2);
|
||||||
|
* traceUBChannel UBCh2 = xTraceRegisterUBChannel(chn2, fmt2);
|
||||||
|
*
|
||||||
|
* // Result in "[Channel 1] Event!"
|
||||||
|
* vTraceUBEvent(UBCh1);
|
||||||
|
*
|
||||||
|
* // Result in "[Channel 2] X: 23, Y: 19"
|
||||||
|
* vTraceUBData(UBCh2, 23, 19);
|
||||||
|
*
|
||||||
|
* You can also use the other user event functions, like xTracePrintF.
|
||||||
|
* as they are then rerouted to the UB instead of the main event buffer.
|
||||||
|
* vTracePrintF then looks up the correct UB channel based on the
|
||||||
|
* provided channel name and format string, or creates a new UB channel
|
||||||
|
* if no match is found. The format string should therefore not contain
|
||||||
|
* "random" messages but mainly format specifiers. Random strings should
|
||||||
|
* be stored using %s and with the string as an argument.
|
||||||
|
*
|
||||||
|
* // Creates a new UB channel ("Channel 2", "%Z: %d")
|
||||||
|
* xTracePrintF(chn2, "%Z: %d", value1);
|
||||||
|
*
|
||||||
|
* // Finds the existing UB channel
|
||||||
|
* xTracePrintF(chn2, "%Z: %d", value2);
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_USE_SEPARATE_USER_EVENT_BUFFER 0
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_SEPARATE_USER_EVENT_BUFFER_SIZE
|
||||||
|
* @brief Macro which should be defined as an integer value.
|
||||||
|
*
|
||||||
|
* This defines the capacity of the user event buffer (UB), in number of slots.
|
||||||
|
* A single user event can use multiple slots, depending on the arguments.
|
||||||
|
*
|
||||||
|
* Only applicable if TRC_CFG_USE_SEPARATE_USER_EVENT_BUFFER is 1.
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_SEPARATE_USER_EVENT_BUFFER_SIZE 200
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def TRC_CFG_UB_CHANNELS
|
||||||
|
* @brief Macro which should be defined as an integer value.
|
||||||
|
*
|
||||||
|
* This defines the number of User Event Buffer Channels (UB channels).
|
||||||
|
* These are used to structure the events when using the separate user
|
||||||
|
* event buffer, and contains both a User Event Channel (the name) and
|
||||||
|
* a default format string for the channel.
|
||||||
|
*
|
||||||
|
* Only applicable if TRC_CFG_USE_SEPARATE_USER_EVENT_BUFFER is 1.
|
||||||
|
*/
|
||||||
|
#define TRC_CFG_UB_CHANNELS 32
|
||||||
|
|
||||||
|
#ifdef __cplusplus
|
||||||
|
}
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#endif /*TRC_SNAPSHOT_CONFIG_H*/
|
||||||
@ -1,378 +0,0 @@
|
|||||||
/*******************************************************************************
|
|
||||||
* Trace Recorder Library for Tracealyzer v3.1.2
|
|
||||||
* Percepio AB, www.percepio.com
|
|
||||||
*
|
|
||||||
* trcSnapshotConfig.h
|
|
||||||
*
|
|
||||||
* Configuration parameters for trace recorder library in snapshot mode.
|
|
||||||
* Read more at http://percepio.com/2016/10/05/rtos-tracing/
|
|
||||||
*
|
|
||||||
* Terms of Use
|
|
||||||
* This file is part of the trace recorder library (RECORDER), which is the
|
|
||||||
* intellectual property of Percepio AB (PERCEPIO) and provided under a
|
|
||||||
* license as follows.
|
|
||||||
* The RECORDER may be used free of charge for the purpose of recording data
|
|
||||||
* intended for analysis in PERCEPIO products. It may not be used or modified
|
|
||||||
* for other purposes without explicit permission from PERCEPIO.
|
|
||||||
* You may distribute the RECORDER in its original source code form, assuming
|
|
||||||
* this text (terms of use, disclaimer, copyright notice) is unchanged. You are
|
|
||||||
* allowed to distribute the RECORDER with minor modifications intended for
|
|
||||||
* configuration or porting of the RECORDER, e.g., to allow using it on a
|
|
||||||
* specific processor, processor family or with a specific communication
|
|
||||||
* interface. Any such modifications should be documented directly below
|
|
||||||
* this comment block.
|
|
||||||
*
|
|
||||||
* Disclaimer
|
|
||||||
* The RECORDER is being delivered to you AS IS and PERCEPIO makes no warranty
|
|
||||||
* as to its use or performance. PERCEPIO does not and cannot warrant the
|
|
||||||
* performance or results you may obtain by using the RECORDER or documentation.
|
|
||||||
* PERCEPIO make no warranties, express or implied, as to noninfringement of
|
|
||||||
* third party rights, merchantability, or fitness for any particular purpose.
|
|
||||||
* In no event will PERCEPIO, its technology partners, or distributors be liable
|
|
||||||
* to you for any consequential, incidental or special damages, including any
|
|
||||||
* lost profits or lost savings, even if a representative of PERCEPIO has been
|
|
||||||
* advised of the possibility of such damages, or for any claim by any third
|
|
||||||
* party. Some jurisdictions do not allow the exclusion or limitation of
|
|
||||||
* incidental, consequential or special damages, or the exclusion of implied
|
|
||||||
* warranties or limitations on how long an implied warranty may last, so the
|
|
||||||
* above limitations may not apply to you.
|
|
||||||
*
|
|
||||||
* Tabs are used for indent in this file (1 tab = 4 spaces)
|
|
||||||
*
|
|
||||||
* Copyright Percepio AB, 2017.
|
|
||||||
* www.percepio.com
|
|
||||||
******************************************************************************/
|
|
||||||
|
|
||||||
#ifndef TRC_SNAPSHOT_CONFIG_H
|
|
||||||
#define TRC_SNAPSHOT_CONFIG_H
|
|
||||||
|
|
||||||
#define TRC_SNAPSHOT_MODE_RING_BUFFER ( 0x01 )
|
|
||||||
#define TRC_SNAPSHOT_MODE_STOP_WHEN_FULL ( 0x02 )
|
|
||||||
|
|
||||||
/******************************************************************************
|
|
||||||
* TRC_CFG_SNAPSHOT_MODE
|
|
||||||
*
|
|
||||||
* Macro which should be defined as one of:
|
|
||||||
* - TRC_SNAPSHOT_MODE_RING_BUFFER
|
|
||||||
* - TRC_SNAPSHOT_MODE_STOP_WHEN_FULL
|
|
||||||
* Default is TRC_SNAPSHOT_MODE_RING_BUFFER.
|
|
||||||
*
|
|
||||||
* With TRC_CFG_SNAPSHOT_MODE set to TRC_SNAPSHOT_MODE_RING_BUFFER, the
|
|
||||||
* events are stored in a ring buffer, i.e., where the oldest events are
|
|
||||||
* overwritten when the buffer becomes full. This allows you to get the last
|
|
||||||
* events leading up to an interesting state, e.g., an error, without having
|
|
||||||
* to store the whole run since startup.
|
|
||||||
*
|
|
||||||
* When TRC_CFG_SNAPSHOT_MODE is TRC_SNAPSHOT_MODE_STOP_WHEN_FULL, the
|
|
||||||
* recording is stopped when the buffer becomes full. This is useful for
|
|
||||||
* recording events following a specific state, e.g., the startup sequence.
|
|
||||||
*****************************************************************************/
|
|
||||||
#define TRC_CFG_SNAPSHOT_MODE TRC_SNAPSHOT_MODE_RING_BUFFER
|
|
||||||
|
|
||||||
/*******************************************************************************
|
|
||||||
* TRC_CFG_EVENT_BUFFER_SIZE
|
|
||||||
*
|
|
||||||
* Macro which should be defined as an integer value.
|
|
||||||
*
|
|
||||||
* This defines the capacity of the event buffer, i.e., the number of records
|
|
||||||
* it may store. Most events use one record (4 byte), although some events
|
|
||||||
* require multiple 4-byte records. You should adjust this to the amount of RAM
|
|
||||||
* available in the target system.
|
|
||||||
*
|
|
||||||
* Default value is 1000, which means that 4000 bytes is allocated for the
|
|
||||||
* event buffer.
|
|
||||||
******************************************************************************/
|
|
||||||
#define TRC_CFG_EVENT_BUFFER_SIZE 32000
|
|
||||||
|
|
||||||
/*******************************************************************************
|
|
||||||
* TRC_CFG_NTASK, TRC_CFG_NISR, TRC_CFG_NQUEUE, TRC_CFG_NSEMAPHORE...
|
|
||||||
*
|
|
||||||
* A group of macros which should be defined as integer values, zero or larger.
|
|
||||||
*
|
|
||||||
* These define the capacity of the Object Property Table, i.e., the maximum
|
|
||||||
* number of objects active at any given point, within each object class (e.g.,
|
|
||||||
* task, queue, semaphore, ...).
|
|
||||||
*
|
|
||||||
* If tasks or other objects are deleted in your system, this
|
|
||||||
* setting does not limit the total amount of objects created, only the number
|
|
||||||
* of objects that have been successfully created but not yet deleted.
|
|
||||||
*
|
|
||||||
* Using too small values will cause vTraceError to be called, which stores an
|
|
||||||
* error message in the trace that is shown when opening the trace file. The
|
|
||||||
* error message can also be retrieved using xTraceGetLastError.
|
|
||||||
*
|
|
||||||
* It can be wise to start with large values for these constants,
|
|
||||||
* unless you are very confident on these numbers. Then do a recording and
|
|
||||||
* check the actual usage by selecting View menu -> Trace Details ->
|
|
||||||
* Resource Usage -> Object Table.
|
|
||||||
******************************************************************************/
|
|
||||||
#define TRC_CFG_NTASK 150
|
|
||||||
#define TRC_CFG_NISR 90
|
|
||||||
#define TRC_CFG_NQUEUE 90
|
|
||||||
#define TRC_CFG_NSEMAPHORE 90
|
|
||||||
#define TRC_CFG_NMUTEX 90
|
|
||||||
#define TRC_CFG_NTIMER 250
|
|
||||||
#define TRC_CFG_NEVENTGROUP 90
|
|
||||||
#define TRC_CFG_NSTREAMBUFFER 100
|
|
||||||
#define TRC_CFG_NMESSAGEBUFFER 100
|
|
||||||
|
|
||||||
|
|
||||||
/******************************************************************************
|
|
||||||
* TRC_CFG_INCLUDE_FLOAT_SUPPORT
|
|
||||||
*
|
|
||||||
* Macro which should be defined as either zero (0) or one (1).
|
|
||||||
*
|
|
||||||
* If this is zero (0), the support for logging floating point values in
|
|
||||||
* vTracePrintF is stripped out, in case floating point values are not used or
|
|
||||||
* supported by the platform used.
|
|
||||||
*
|
|
||||||
* Floating point values are only used in vTracePrintF and its subroutines, to
|
|
||||||
* allow for storing float (%f) or double (%lf) arguments.
|
|
||||||
*
|
|
||||||
* vTracePrintF can be used with integer and string arguments in either case.
|
|
||||||
*
|
|
||||||
* Default value is 0.
|
|
||||||
*****************************************************************************/
|
|
||||||
#define TRC_CFG_INCLUDE_FLOAT_SUPPORT 0
|
|
||||||
|
|
||||||
/*******************************************************************************
|
|
||||||
* TRC_CFG_SYMBOL_TABLE_SIZE
|
|
||||||
*
|
|
||||||
* Macro which should be defined as an integer value.
|
|
||||||
*
|
|
||||||
* This defines the capacity of the symbol table, in bytes. This symbol table
|
|
||||||
* stores User Events labels and names of deleted tasks, queues, or other kernel
|
|
||||||
* objects. If you don't use User Events or delete any kernel
|
|
||||||
* objects you set this to a very low value. The minimum recommended value is 4.
|
|
||||||
* A size of zero (0) is not allowed since a zero-sized array may result in a
|
|
||||||
* 32-bit pointer, i.e., using 4 bytes rather than 0.
|
|
||||||
*
|
|
||||||
* Default value is 800.
|
|
||||||
******************************************************************************/
|
|
||||||
#define TRC_CFG_SYMBOL_TABLE_SIZE 32000
|
|
||||||
|
|
||||||
#if ( TRC_CFG_SYMBOL_TABLE_SIZE == 0 )
|
|
||||||
#error "TRC_CFG_SYMBOL_TABLE_SIZE may not be zero!"
|
|
||||||
#endif
|
|
||||||
|
|
||||||
/******************************************************************************
|
|
||||||
* TRC_CFG_NAME_LEN_TASK, TRC_CFG_NAME_LEN_QUEUE, ...
|
|
||||||
*
|
|
||||||
* Macros that specify the maximum lengths (number of characters) for names of
|
|
||||||
* kernel objects, such as tasks and queues. If longer names are used, they will
|
|
||||||
* be truncated when stored in the recorder.
|
|
||||||
*****************************************************************************/
|
|
||||||
#define TRC_CFG_NAME_LEN_TASK 15
|
|
||||||
#define TRC_CFG_NAME_LEN_ISR 15
|
|
||||||
#define TRC_CFG_NAME_LEN_QUEUE 15
|
|
||||||
#define TRC_CFG_NAME_LEN_SEMAPHORE 15
|
|
||||||
#define TRC_CFG_NAME_LEN_MUTEX 15
|
|
||||||
#define TRC_CFG_NAME_LEN_TIMER 15
|
|
||||||
#define TRC_CFG_NAME_LEN_EVENTGROUP 15
|
|
||||||
#define TRC_CFG_NAME_LEN_STREAMBUFFER 15
|
|
||||||
#define TRC_CFG_NAME_LEN_MESSAGEBUFFER 15
|
|
||||||
|
|
||||||
/******************************************************************************
|
|
||||||
*** ADVANCED SETTINGS ********************************************************
|
|
||||||
******************************************************************************
|
|
||||||
* The remaining settings are not necessary to modify but allows for optimizing
|
|
||||||
* the recorder setup for your specific needs, e.g., to exclude events that you
|
|
||||||
* are not interested in, in order to get longer traces.
|
|
||||||
*****************************************************************************/
|
|
||||||
|
|
||||||
/******************************************************************************
|
|
||||||
* TRC_CFG_HEAP_SIZE_BELOW_16M
|
|
||||||
*
|
|
||||||
* An integer constant that can be used to reduce the buffer usage of memory
|
|
||||||
* allocation events (malloc/free). This value should be 1 if the heap size is
|
|
||||||
* below 16 MB (2^24 byte), and you can live with reported addresses showing the
|
|
||||||
* lower 24 bits only. If 0, you get the full 32-bit addresses.
|
|
||||||
*
|
|
||||||
* Default value is 0.
|
|
||||||
******************************************************************************/
|
|
||||||
#define TRC_CFG_HEAP_SIZE_BELOW_16M 0
|
|
||||||
|
|
||||||
/******************************************************************************
|
|
||||||
* TRC_CFG_USE_IMPLICIT_IFE_RULES
|
|
||||||
*
|
|
||||||
* Macro which should be defined as either zero (0) or one (1).
|
|
||||||
* Default is 1.
|
|
||||||
*
|
|
||||||
* Tracealyzer groups the events into "instances" based on Instance Finish
|
|
||||||
* Events (IFEs), produced either by default rules or calls to the recorder
|
|
||||||
* functions vTraceInstanceFinishedNow and vTraceInstanceFinishedNext.
|
|
||||||
*
|
|
||||||
* If TRC_CFG_USE_IMPLICIT_IFE_RULES is one (1), the default IFE rules is
|
|
||||||
* used, resulting in a "typical" grouping of events into instances.
|
|
||||||
* If these rules don't give appropriate instances in your case, you can
|
|
||||||
* override the default rules using vTraceInstanceFinishedNow/Next for one
|
|
||||||
* or several tasks. The default IFE rules are then disabled for those tasks.
|
|
||||||
*
|
|
||||||
* If TRC_CFG_USE_IMPLICIT_IFE_RULES is zero (0), the implicit IFE rules are
|
|
||||||
* disabled globally. You must then call vTraceInstanceFinishedNow or
|
|
||||||
* vTraceInstanceFinishedNext to manually group the events into instances,
|
|
||||||
* otherwise the tasks will appear a single long instance.
|
|
||||||
*
|
|
||||||
* The default IFE rules count the following events as "instance finished":
|
|
||||||
* - Task delay, delay until
|
|
||||||
* - Task suspend
|
|
||||||
* - Blocking on "input" operations, i.e., when the task is waiting for the
|
|
||||||
* next a message/signal/event. But only if this event is blocking.
|
|
||||||
*
|
|
||||||
* For details, see trcSnapshotKernelPort.h and look for references to the
|
|
||||||
* macro trcKERNEL_HOOKS_SET_TASK_INSTANCE_FINISHED.
|
|
||||||
*****************************************************************************/
|
|
||||||
#define TRC_CFG_USE_IMPLICIT_IFE_RULES 1
|
|
||||||
|
|
||||||
/******************************************************************************
|
|
||||||
* TRC_CFG_USE_16BIT_OBJECT_HANDLES
|
|
||||||
*
|
|
||||||
* Macro which should be defined as either zero (0) or one (1).
|
|
||||||
*
|
|
||||||
* If set to 0 (zero), the recorder uses 8-bit handles to identify kernel
|
|
||||||
* objects such as tasks and queues. This limits the supported number of
|
|
||||||
* concurrently active objects to 255 of each type (tasks, queues, mutexes,
|
|
||||||
* etc.) Note: 255, not 256, since handle 0 is reserved.
|
|
||||||
*
|
|
||||||
* If set to 1 (one), the recorder uses 16-bit handles to identify kernel
|
|
||||||
* objects such as tasks and queues. This limits the supported number of
|
|
||||||
* concurrent objects to 65535 of each type (object class). However, since the
|
|
||||||
* object property table is limited to 64 KB, the practical limit is about
|
|
||||||
* 3000 objects in total.
|
|
||||||
*
|
|
||||||
* Default is 0 (8-bit handles)
|
|
||||||
*
|
|
||||||
* NOTE: An object with handle above 255 will use an extra 4-byte record in
|
|
||||||
* the event buffer whenever the object is referenced. Moreover, some internal
|
|
||||||
* tables in the recorder gets slightly larger when using 16-bit handles.
|
|
||||||
*****************************************************************************/
|
|
||||||
#define TRC_CFG_USE_16BIT_OBJECT_HANDLES 0
|
|
||||||
|
|
||||||
/******************************************************************************
|
|
||||||
* TRC_CFG_USE_TRACE_ASSERT
|
|
||||||
*
|
|
||||||
* Macro which should be defined as either zero (0) or one (1).
|
|
||||||
* Default is 1.
|
|
||||||
*
|
|
||||||
* If this is one (1), the TRACE_ASSERT macro (used at various locations in the
|
|
||||||
* trace recorder) will verify that a relevant condition is true.
|
|
||||||
* If the condition is false, prvTraceError() will be called, which stops the
|
|
||||||
* recording and stores an error message that is displayed when opening the
|
|
||||||
* trace in Tracealyzer.
|
|
||||||
*
|
|
||||||
* This is used on several places in the recorder code for sanity checks on
|
|
||||||
* parameters. Can be switched off to reduce the footprint of the tracing, but
|
|
||||||
* we recommend to have it enabled initially.
|
|
||||||
*****************************************************************************/
|
|
||||||
#define TRC_CFG_USE_TRACE_ASSERT 1
|
|
||||||
|
|
||||||
/*******************************************************************************
|
|
||||||
* TRC_CFG_USE_SEPARATE_USER_EVENT_BUFFER
|
|
||||||
*
|
|
||||||
* Macro which should be defined as an integer value.
|
|
||||||
*
|
|
||||||
* Set TRC_CFG_USE_SEPARATE_USER_EVENT_BUFFER to 1 to enable the
|
|
||||||
* separate user event buffer (UB).
|
|
||||||
* In this mode, user events are stored separately from other events,
|
|
||||||
* e.g., RTOS events. Thereby you can get a much longer history of
|
|
||||||
* user events as they don't need to share the buffer space with more
|
|
||||||
* frequent events.
|
|
||||||
*
|
|
||||||
* The UB is typically used with the snapshot ring-buffer mode, so the
|
|
||||||
* recording can continue when the main buffer gets full. And since the
|
|
||||||
* main buffer then overwrites the earliest events, Tracealyzer displays
|
|
||||||
* "Unknown Actor" instead of task scheduling for periods with UB data only.
|
|
||||||
*
|
|
||||||
* In UB mode, user events are structured as UB channels, which contains
|
|
||||||
* a channel name and a default format string. Register a UB channel using
|
|
||||||
* xTraceRegisterUBChannel.
|
|
||||||
*
|
|
||||||
* Events and data arguments are written using vTraceUBEvent and
|
|
||||||
* vTraceUBData. They are designed to provide efficient logging of
|
|
||||||
* repeating events, using the same format string within each channel.
|
|
||||||
*
|
|
||||||
* Examples:
|
|
||||||
*
|
|
||||||
* traceString chn1 = xTraceRegisterString("Channel 1");
|
|
||||||
* traceString fmt1 = xTraceRegisterString("Event!");
|
|
||||||
* traceUBChannel UBCh1 = xTraceRegisterUBChannel(chn1, fmt1);
|
|
||||||
*
|
|
||||||
* traceString chn2 = xTraceRegisterString("Channel 2");
|
|
||||||
* traceString fmt2 = xTraceRegisterString("X: %d, Y: %d");
|
|
||||||
* traceUBChannel UBCh2 = xTraceRegisterUBChannel(chn2, fmt2);
|
|
||||||
*
|
|
||||||
* // Result in "[Channel 1] Event!"
|
|
||||||
* vTraceUBEvent(UBCh1);
|
|
||||||
*
|
|
||||||
* // Result in "[Channel 2] X: 23, Y: 19"
|
|
||||||
* vTraceUBData(UBCh2, 23, 19);
|
|
||||||
*
|
|
||||||
* You can also use the other user event functions, like vTracePrintF.
|
|
||||||
* as they are then rerouted to the UB instead of the main event buffer.
|
|
||||||
* vTracePrintF then looks up the correct UB channel based on the
|
|
||||||
* provided channel name and format string, or creates a new UB channel
|
|
||||||
* if no match is found. The format string should therefore not contain
|
|
||||||
* "random" messages but mainly format specifiers. Random strings should
|
|
||||||
* be stored using %s and with the string as an argument.
|
|
||||||
*
|
|
||||||
* // Creates a new UB channel ("Channel 2", "%Z: %d")
|
|
||||||
* vTracePrintF(chn2, "%Z: %d", value1);
|
|
||||||
*
|
|
||||||
* // Finds the existing UB channel
|
|
||||||
* vTracePrintF(chn2, "%Z: %d", value2);
|
|
||||||
*
|
|
||||||
******************************************************************************/
|
|
||||||
#define TRC_CFG_USE_SEPARATE_USER_EVENT_BUFFER 0
|
|
||||||
|
|
||||||
/*******************************************************************************
|
|
||||||
* TRC_CFG_SEPARATE_USER_EVENT_BUFFER_SIZE
|
|
||||||
*
|
|
||||||
* Macro which should be defined as an integer value.
|
|
||||||
*
|
|
||||||
* This defines the capacity of the user event buffer (UB), in number of slots.
|
|
||||||
* A single user event can use multiple slots, depending on the arguments.
|
|
||||||
*
|
|
||||||
* Only applicable if TRC_CFG_USE_SEPARATE_USER_EVENT_BUFFER is 1.
|
|
||||||
******************************************************************************/
|
|
||||||
#define TRC_CFG_SEPARATE_USER_EVENT_BUFFER_SIZE 200
|
|
||||||
|
|
||||||
/*******************************************************************************
|
|
||||||
* TRC_CFG_UB_CHANNELS
|
|
||||||
*
|
|
||||||
* Macro which should be defined as an integer value.
|
|
||||||
*
|
|
||||||
* This defines the number of User Event Buffer Channels (UB channels).
|
|
||||||
* These are used to structure the events when using the separate user
|
|
||||||
* event buffer, and contains both a User Event Channel (the name) and
|
|
||||||
* a default format string for the channel.
|
|
||||||
*
|
|
||||||
* Only applicable if TRC_CFG_USE_SEPARATE_USER_EVENT_BUFFER is 1.
|
|
||||||
******************************************************************************/
|
|
||||||
#define TRC_CFG_UB_CHANNELS 32
|
|
||||||
|
|
||||||
/*******************************************************************************
|
|
||||||
* TRC_CFG_ISR_TAILCHAINING_THRESHOLD
|
|
||||||
*
|
|
||||||
* Macro which should be defined as an integer value.
|
|
||||||
*
|
|
||||||
* If tracing multiple ISRs, this setting allows for accurate display of the
|
|
||||||
* context-switching also in cases when the ISRs execute in direct sequence.
|
|
||||||
*
|
|
||||||
* vTraceStoreISREnd normally assumes that the ISR returns to the previous
|
|
||||||
* context, i.e., a task or a preempted ISR. But if another traced ISR
|
|
||||||
* executes in direct sequence, Tracealyzer may incorrectly display a minimal
|
|
||||||
* fragment of the previous context in between the ISRs.
|
|
||||||
*
|
|
||||||
* By using TRC_CFG_ISR_TAILCHAINING_THRESHOLD you can avoid this. This is
|
|
||||||
* however a threshold value that must be measured for your specific setup.
|
|
||||||
* See http://percepio.com/2014/03/21/isr_tailchaining_threshold/
|
|
||||||
*
|
|
||||||
* The default setting is 0, meaning "disabled" and that you may get an
|
|
||||||
* extra fragments of the previous context in between tail-chained ISRs.
|
|
||||||
*
|
|
||||||
* Note: This setting has separate definitions in trcSnapshotConfig.h and
|
|
||||||
* trcStreamingConfig.h, since it is affected by the recorder mode.
|
|
||||||
******************************************************************************/
|
|
||||||
#define TRC_CFG_ISR_TAILCHAINING_THRESHOLD 0
|
|
||||||
|
|
||||||
#endif /*TRC_SNAPSHOT_CONFIG_H*/
|
|
||||||
Loading…
Reference in New Issue