freertos_diagnostics.h File Reference

Bounded explicit FreeRTOS trace sink without global storage. More...

#include <stdint.h>

Go to the source code of this file.

Enumerations
enum	nx_freertos_trace_kind_t { NX_FREERTOS_TRACE_SWITCH_IN = 1 , NX_FREERTOS_TRACE_CREATE , NX_FREERTOS_TRACE_DELETE }
	Maintained kernel trace identities; product interpretation is external. More...

Functions
void	nx_freertos_trace_event (nx_freertos_trace_kind_t event, uintptr_t identity, uint32_t value)
	Consume one bounded kernel trace event.

Detailed Description

Bounded explicit FreeRTOS trace sink without global storage.

Author

Nexus Team

Version

1.0.0

Date

2026-10-11

Copyright

Copyright (c) 2026 Nexus Team

Definition in file freertos_diagnostics.h.

Enumeration Type Documentation

nx_freertos_trace_kind_t

enum nx_freertos_trace_kind_t

Maintained kernel trace identities; product interpretation is external.

Enumerator
NX_FREERTOS_TRACE_SWITCH_IN
NX_FREERTOS_TRACE_CREATE
NX_FREERTOS_TRACE_DELETE

Definition at line 17 of file freertos_diagnostics.h.

Function Documentation

nx_freertos_trace_event()

void nx_freertos_trace_event	(	nx_freertos_trace_kind_t	event,
		uintptr_t	identity,
		uint32_t	value )

Consume one bounded kernel trace event.

Parameters

[in]	event	Maintained trace kind.
[in]	identity	Opaque task identity, never a dereference license.
[in]	value	Optional caller-defined numeric diagnostic.

Note

Application may override the weak no-op and write an explicit nx_diagnostic_ring_t. May run under kernel masks or configurable IRQ, so never block, allocate, format, transmit, acquire OS locks or call kernel services. The sink owns timestamp and lifetime; no buffer is provided automatically. Trace profile enables real kernel hooks.