Event Recorder Setup

Functions that initialize and control the event recorder and configure event filtering. More...

Content
	Recording Control
	Defines for parameter recording of Event Recorder Setup functions.

Functions
uint32_t	EventRecorderInitialize (uint32_t recording, uint32_t start)
	Initialize Event Recorder.
uint32_t	EventRecorderEnable (uint32_t recording, uint32_t comp_start, uint32_t comp_end)
	Enable recording of events with specified level and component range.
uint32_t	EventRecorderDisable (uint32_t recording, uint32_t comp_start, uint32_t comp_end)
	Disable recording of events with specified level and component range.
uint32_t	EventRecorderStart (void)
	Start event recording.
uint32_t	EventRecorderStop (void)
	Stop event recording.

Description

Functions that initialize and control the event recorder and configure event filtering.

This section contains the functions that initialize and control the event recorder and configure event filtering.

Function Documentation

EventRecorderInitialize()

uint32_t EventRecorderInitialize	(	uint32_t	recording,
		uint32_t	start
	)

Initialize Event Recorder.

Parameters

[in]	recording	initial level mask for event record filter
[in]	start	initial recording setup (1=start, 0=stop)

Returns

status (1=Success, 0=Failure)

Call the function EventRecorderInitialize from the user code to set up the Event Recorder. The function initializes all buffers and configures the timer (if configured).

The parameter recording takes values from Recording Control.

Code Example

int main (void) {                               // main function
  
  HAL_Init();                                   // initialize hardware abstraction layer
  SystemClock_Config();                         // configure the system clock
  MemoryBus_Config();                           // configure the memory bus system
 
  EventRecorderInitialize (EventRecordAll, 1);  // initialize and start Event Recorder
 
  ...
}

EventRecorderEnable()

uint32_t EventRecorderEnable	(	uint32_t	recording,
		uint32_t	comp_start,
		uint32_t	comp_end
	)

Enable recording of events with specified level and component range.

Parameters

[in]	recording	level mask for event record filter
[in]	comp_start	first component number of range
[in]	comp_end	last Component number of range

Returns

status (1=Success, 0=Failure)

The function EventRecorderEnable configures the event filter for a software component.

The events will be generated for the event level recording and between the range specified with comp_start and comp_end.

The parameter recording takes values from Recording Control.

Multiple calls to EventRecorderEnable are permitted and enable the recording of different event messages.

Code Example

EventRecorderEnable (EventRecordAll, 0, 0xF);                    // record all events of component 0 - 15
  :
EventRecorderEnable (EventRecordError, 0x80, 0xFE);              // record 'Error' events of component 0x80 - 0xFE
EventRecorderEnable (EventRecordAPI+EventRecordOp, 0xC0, 0xC3);  // and record 'API' and 'Op' events of component groups 0xC0 - 0xC3

EventRecorderDisable()

uint32_t EventRecorderDisable	(	uint32_t	recording,
		uint32_t	comp_start,
		uint32_t	comp_end
	)

Disable recording of events with specified level and component range.

Parameters

[in]	recording	level mask for event record filter
[in]	comp_start	first component number of range
[in]	comp_end	last Component number of range

Returns

status (1=Success, 0=Failure)

The function EventRecorderDisable configures the event filter for a software component.

The events will be generated for the event level recording and between the range specified with comp_start and comp_end.

The parameter recording takes values from Recording Control.

Multiple calls to EventRecorderDisable are permitted and disable the recording of event messages.

Code Example

EventRecorderDisable (EventRecordDetail, 0, 0xFE);                 // stop recording 'Detail' events of component number 0 - 0xFE
  :
EventRecorderDisable (EventRecordAPI+EventRecordOp, 0x80, 0xBF);   // stop recording 'API' and 'Op' events of component number 0x80 - 0xFE
EventRecorderDisable (EventRecordAll, 0xC0, 0xCF);                 // stop recording all events of component number 0xC0 - 0xCF

EventRecorderStart()

uint32_t EventRecorderStart

(

void

)

Start event recording.

Returns

status (1=Success, 0=Failure)

The function EventRecorderStart enables the recording of the events that are configured for recording using EventRecorderEnable or EventRecorderInitialize

Code Example

EventRecorderStart ();        // start with the recording of events that pass filtering

EventRecorderStop()

uint32_t EventRecorderStop

(

void

)

Stop event recording.

Returns

status (1=Success, 0=Failure)

The function EventRecorderStop disables the recording of all events.

Code Example

EventRecorderStop ();        // stop the recording of any events