Telemetry support. More...

Collaboration diagram for Telemetry:

Topics
	VCU Telemetry
	VCU telemetry support.

Data Structures
struct	tm_group_data
	Telemetry group data. More...

struct	tm_data
	Telemetry data. More...

struct	tm_group
	Telemetry publishing group. More...

Macros
#define	TM_DATA_DECLARE(name, type)
	Declare a telemetry data, useful for header files.

#define	TM_DATA_DEFINE(_name, _type, _addr)
	Define a telemetry data.

#define	TM_ALIAS_DECLARE(name, alias)
	Declare a telemetry data alias, useful for header files.

#define	TM_ALIAS_DEFINE(_name, _alias, _addr)
	Define a telemetry data alias.

#define	TM_GROUP_DATA(data, ...)
	Specify a telemetry data to be aggregated and published by a telemetry group. Used in TM_GROUP_DEFINE.

#define	TM_GROUP_DEFINE(_name, _period, _min_separation, _watermark, _flag, _publish, _user_data, ...)
	Define a telemetry group to aggregrate and publish telementry data.

#define	TM_DATA_GET(name)
	Get the value of telemetry data using its name.

#define	TM_DATA_UPDATE(name, value)
	Update telemetry data using its name and value.

Typedefs
typedef void(*	tm_publish_t) (uint32_t addr, const void data, size_t size, void user_data)
	Function to publish the data.

Enumerations
enum	tm_data_type { TM_DATA_TYPE_NORMAL = 0 , TM_DATA_TYPE_ALIAS }
	Telemetry data type. More...

Functions
int	tm_data_get (uint32_t addr, void *value)
	Get telemetry data using its address and pointer to value.

int	tm_data_update (uint32_t addr, const void *value)
	Update telemetry data using its address and pointer to value.

void	tm_data_notify_lock (const struct tm_data *data)
	Notify the telemetry groups that this data has been updated. Must be called while holding the lock.

void	tm_group_copy (struct tm_group *group)
	Copy the data in the telemetry data to the group's publishing buffer.

Detailed Description

Telemetry support.

Macro Definition Documentation

◆ TM_ALIAS_DECLARE

#define TM_ALIAS_DECLARE	(		name,
			alias )

#include <nturt/telemetry.h>

Value:

typedef _TM_DATA_TYPE(alias) _TM_DATA_TYPE(name); \

extern struct tm_data name

tm_data

Telemetry data.

Definition telemetry.h:251

tm_data::name

const char * name

Definition telemetry.h:262

Declare a telemetry data alias, useful for header files.

Parameters

[in]	name	Name of the alias.
[in]	alias	Telemetry data that this alias refers to.

◆ TM_ALIAS_DEFINE

#define TM_ALIAS_DEFINE	(	_name,
		_alias,
		_addr )

#include <nturt/telemetry.h>

Value:

  TM_ALIAS_DECLARE(_name, _alias);            \
                                              \
  STRUCT_SECTION_ITERABLE(tm_data, _name) = { \
      .type = TM_DATA_TYPE_ALIAS,             \
      .addr = _addr,                          \
      .alias = &_alias,                       \
  };

Define a telemetry data alias.

Parameters

[in]	_name	Name of the alias.
[in]	_alias	Telemetry data that this alias refers to.
[in]	_addr	Address of the alias.

◆ TM_DATA_DECLARE

#define TM_DATA_DECLARE	(		name,
			type )

#include <nturt/telemetry.h>

Value:

typedef type _TM_DATA_TYPE(name); \

extern struct tm_data name

Declare a telemetry data, useful for header files.

Parameters

[in]	name	Name of the data.
[in]	type	Type of the data.

◆ TM_DATA_DEFINE

#define TM_DATA_DEFINE	(	_name,
		_type,
		_addr )

#include <nturt/telemetry.h>

Value:

  TM_DATA_DECLARE(_name, _type);              \
                                              \
  STRUCT_SECTION_ITERABLE(tm_data, _name) = { \
      .type = TM_DATA_TYPE_NORMAL,            \
      .addr = _addr,                          \
      .name = STRINGIFY(_name),               \
      .size = sizeof(_type),                  \
      .data = &(_type){0},                    \
  };

Define a telemetry data.

Parameters

[in]	_name	Name of the data.
[in]	_type	Type of the data.
[in]	_addr	Address of the data.

◆ TM_DATA_GET

#define TM_DATA_GET ( name )

#include <nturt/telemetry.h>

Value:

  ({                                                                      \
    struct tm_data *__data = &name;                                       \
    if (__data->type == TM_DATA_TYPE_ALIAS) {                             \
      __data = __data->alias;                                             \
    }                                                                     \
                                                                          \
    k_spinlock_key_t key = k_spin_lock(&__data->lock);                    \
    _TM_DATA_TYPE(name) __value = *((_TM_DATA_TYPE(name) *)__data->data); \
    k_spin_unlock(&__data->lock, key);                                    \
                                                                          \
    __value;                                                              \
  })

Get the value of telemetry data using its name.

Parameters

[in] name Name of the telemetry data.

Returns: Value of the telemetry data.

◆ TM_DATA_UPDATE

#define TM_DATA_UPDATE	(		name,
			value )

#include <nturt/telemetry.h>

Value:

  do {                                                \
    struct tm_data *__data = &name;                   \
    if (__data->type == TM_DATA_TYPE_ALIAS) {         \
      __data = __data->alias;                         \
    }                                                 \
                                                      \
    K_SPINLOCK(&__data->lock) {                       \
      *((_TM_DATA_TYPE(name) *)__data->data) = value; \
      tm_data_notify_lock(__data);                    \
    }                                                 \
                                                      \
  } while (0)

Update telemetry data using its name and value.

Parameters

[in]	name	Name of the telemetry data.
[in]	value	New value of the telemetry data.

◆ TM_GROUP_DATA

#define TM_GROUP_DATA	(		data,
			... )

#include <nturt/telemetry.h>

Value:

(data, (COND_CODE_1(__VA_OPT__(1), (__VA_ARGS__), (0))))

Specify a telemetry data to be aggregated and published by a telemetry group. Used in TM_GROUP_DEFINE.

Parameters

[in]	data	Telemetry data to be aggregated and published.
[in]	...	Optional flags of the data, the same ones and rules as AGG_MEMBER.

◆ TM_GROUP_DEFINE

#define TM_GROUP_DEFINE	(	_name,
		_period,
		_min_separation,
		_watermark,
		_flag,
		_publish,
		_user_data,
		... )

#include <nturt/telemetry.h>

Value:

  _TM_AGG_PUBLISH_DEFINE(_name,                                             \
                         FOR_EACH(_TM_GROUP_DATA_DATA, (, ), __VA_ARGS__)); \
                                                                            \
  STRUCT_SECTION_ITERABLE(tm_group, _name) = {                              \
      .agg = AGG_INITIALIZER(                                               \
          _name.agg, _name, _period, _min_separation, _watermark, _flag,    \
          _TM_AGG_PUBLISH(_name), _user_data,                               \
          FOR_EACH(_TM_GROUP_DATA_FLAGS, (, ), __VA_ARGS__)),               \
      .publish = _publish,                                                  \
      .num_data = NUM_VA_ARGS(__VA_ARGS__),                                 \
      .datas =                                                              \
          (struct tm_group_data[]){                                         \
              FOR_EACH_FIXED_ARG(                                           \
                  _TM_GROUP_DATA, (, ), _name,                              \
                  FOR_EACH(_TM_GROUP_DATA_DATA, (, ), __VA_ARGS__)),        \
          },                                                                \
  }

Define a telemetry group to aggregrate and publish telementry data.

Parameters

[in]	_name	Name of the telemetry group.
[in]	_period	Period of data publishing.
[in]	_min_separation	Minimum separation time between two data publishing.
[in]	_watermark	Watermark to wait for late-arriving members.
[in]	_flag	Flag of the aggregation. The same ones and rules as `flag` in AGG_DEFINE.
[in]	_publish	Function to publish the data, must be of type tm_publish_t.
[in]	_user_data	Pointer to custom data for the callback.
[in]	...	Data to be aggregated and published, must be specified by TM_GROUP_DATA.

Typedef Documentation

◆ tm_publish_t

typedef void(* tm_publish_t) (uint32_t addr, const void *data, size_t size, void *user_data)

#include <nturt/telemetry.h>

Function to publish the data.

Parameters

[in]	addr	Address of the data.
[in]	data	Pointer to the data to be published.
[in]	size	Size of the data to be published.
[in]	user_data	Pointer to custom data for callback functions.

Enumeration Type Documentation

◆ tm_data_type

enum tm_data_type

#include <nturt/telemetry.h>

Telemetry data type.

Enumerator
TM_DATA_TYPE_NORMAL
TM_DATA_TYPE_ALIAS

Function Documentation

◆ tm_data_get()

int tm_data_get	(	uint32_t	addr,
		void *	value )

#include <nturt/telemetry.h>

Get telemetry data using its address and pointer to value.

Parameters

[in]	addr	Address of the telemetry data.
[out]	value	Pointer to store the retrieved value.

Return values

0	For success.
-ENOENT	If the data does not exist.

◆ tm_data_notify_lock()

void tm_data_notify_lock ( const struct tm_data * data )

#include <nturt/telemetry.h>

Notify the telemetry groups that this data has been updated. Must be called while holding the lock.

Parameters

[in] data Pointer to tm_data.

Warning: Internal use only.

◆ tm_data_update()

int tm_data_update	(	uint32_t	addr,
		const void *	value )

#include <nturt/telemetry.h>

Update telemetry data using its address and pointer to value.

Parameters

[in]	addr	Address of the telemetry data.
[in]	value	Pointer to the new value of the telemetry data.

Return values

0	For success.
-ENOENT	If the data does not exist.

◆ tm_group_copy()

void tm_group_copy ( struct tm_group * group )

#include <nturt/telemetry.h>

Copy the data in the telemetry data to the group's publishing buffer.

Parameters

[in] group Pointer to tm_group.

Warning: Internal use only.

Topics

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ TM_ALIAS_DECLARE

◆ TM_ALIAS_DEFINE

◆ TM_DATA_DECLARE

◆ TM_DATA_DEFINE

◆ TM_DATA_GET

◆ TM_DATA_UPDATE

◆ TM_GROUP_DATA

◆ TM_GROUP_DEFINE

Typedef Documentation

◆ tm_publish_t

Enumeration Type Documentation

◆ tm_data_type

Function Documentation

◆ tm_data_get()

◆ tm_data_notify_lock()

◆ tm_data_update()

◆ tm_group_copy()