TRC tags¶

Overview¶

Declaration of API to modify TRC tags from prologues. More…

// global functions

te_errno tapi_tags_add_tag(const char* tag, const char* value);
te_errno tapi_tags_add_linux_mm(const char* ta, const char* prefix);
te_errno tapi_tags_add_net_pci_tags(const char* ta, const char* if_name);
te_errno tapi_tags_add_firmwareversion_tag(const char* ta, const char* if_name, const char* tag_prefix);
te_errno tapi_tags_add_phy_tags(const char* iut_ta, const char* iut_if_name, const char* tst_ta, const char* tst_if_name, const char* tag_prefix);

// macros

#define TE_CFG_TRC_TAGS_FMT

Detailed Documentation¶

Declaration of API to modify TRC tags from prologues.

Global Functions¶

te_errno tapi_tags_add_tag(const char* tag, const char* value)

Modify the set of defined TRC tags for tests by adding a new tag to the configurator database. This function should be used to pass the TRC tag from the root prologue only to the tester.

Parameters:

tag	Tag name.
value	Tag value for TRC tags expressions (can be `NULL`).

Returns:

Status code.

te_errno tapi_tags_add_linux_mm(const char* ta, const char* prefix)

Add Linux kernel TRC tag with major and minor numbers suitable for comparison.

This function should be used to pass the TRC tag from the root prologue only to the tester.

Parameters:

ta	Test agent name.
prefix	Tag name prefix or `NULL`

Returns:

Status code.

te_errno tapi_tags_add_net_pci_tags(const char* ta, const char* if_name)

Add PCI device tags of the network interface.

This function should be used to pass the TRC tag from the root prologue only to the tester.

Parameters:

ta	Test agent name.
if_name	Network interface name.

Returns:

Status code.

te_errno tapi_tags_add_firmwareversion_tag(const char* ta, const char* if_name, const char* tag_prefix)

Add firmware version tag of the network interface.

This function should be used to pass the TRC tag from the root prologue only to the tester.

Parameters:

ta	Test agent name.
if_name	Network interface name.
tag_prefix	Tag name prefix or `NULL`.

Returns:

Status code.

te_errno tapi_tags_add_phy_tags(const char* iut_ta, const char* iut_if_name, const char* tst_ta, const char* tst_if_name, const char* tag_prefix)

Add PHY tags of the network interface.

Adds such PHY tags as:

"sp-" - IUT speed state
"port-" - IUT port mode status.

This function should be used to pass the TRC tag from the root prologue only to the tester.

Note

TST TA and interface name can be used to compare with IUT configuration to ensure that the TST and IUT configuration (speed and port mode parameters) values are synchronized correctly. If TST values are NULL, the comparison will be skipped. TST input data is optional.

Parameters:

iut_ta	IUT agent name.
iut_if_name	IUT network interface name.
tst_ta	TST agent name or `NULL`.
tst_if_name	TST network interface name or `NULL`.
tag_prefix	Tag name prefix or `NULL`.

Returns:

Status code.

View page source