Skip to content

Commit a9f9a43

Browse files
committed
Added details about Event Recorder configuration (documentation)
1 parent 9111224 commit a9f9a43

1 file changed

Lines changed: 8 additions & 3 deletions

File tree

DoxyGen/General/src/cmsis_freertos.txt

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -167,8 +167,10 @@ settings.
167167

168168
\subsection native_freertos_er Add Event Recorder Visibility
169169
- To use the Event Recorder together with FreeRTOS, add the software component <b>\::Compiler:Event Recorder</b> to your project.
170-
- Edit \ref native_freertos_config "FreeRTOSConfig.h" and add Event Recorder configuration definitions (see \ref cmsis_freertos_evr_config)
171-
- Call <b>EvrFreeRTOSSetup();</b> in your application code (ideally in \c main()).
170+
- Open \ref native_freertos_config "FreeRTOSConfig.h" and
171+
- verify the header file \b freertos_evr.h is included
172+
- add Event Recorder configuration definitions (see \ref cmsis_freertos_evr_config)
173+
- Call <b>EvrFreeRTOSSetup()</b> in your application code (ideally in \c main()).
172174
- If you are using simulation mode, add an initialization file with the following content:
173175
\code
174176
MAP 0xE0001000, 0xE0001007 READ WRITE
@@ -249,7 +251,10 @@ Stream Buffer functions | configEVR_LEVEL_STREAMBUFFER | Define e
249251

250252
\subsection cmsis_freertos_er Add Event Recorder Visibility
251253
- To use the Event Recorder together with FreeRTOS, add the software component <b>\::Compiler:Event Recorder</b> to your project.
252-
- Call <b>osKernelInitialize</b> in your application code (ideally in \c main()) to setup Event Recorder according to configuration settings.
254+
- Open \ref native_freertos_config "FreeRTOSConfig.h" and
255+
- verify the header file \b freertos_evr.h is included
256+
- modify Event Recorder configuration definitions (see \ref cmsis_freertos_evr_config) to change default configuration
257+
- Call <b>osKernelInitialize()</b> in your application code (ideally in \c main()) to setup Event Recorder according to configuration settings.
253258
- If you are using simulation mode, add an initialization file with the following content:
254259
\code
255260
MAP 0xE0001000, 0xE0001007 READ WRITE

0 commit comments

Comments
 (0)