Package flags

Macros
#define	CBPRINTF_PACKAGE_CONST_CHAR_RO   BIT(0)
	Assume that const char pointer is pointing to read only (constant) strings.
#define	CBPRINTF_PACKAGE_ADD_RO_STR_POS   BIT(1)
	Append locations (within the package) of read-only string pointers.
#define	CBPRINTF_PACKAGE_ADD_RW_STR_POS   BIT(2)
	Append locations (within the package) of read-write string pointers.
#define	CBPRINTF_PACKAGE_FIRST_RO_STR_CNT(n)    (n << Z_CBPRINTF_PACKAGE_FIRST_RO_STR_OFFSET)
	Indicate that n first string format arguments are char pointers to read-only location.
#define	CBPRINTF_PACKAGE_ADD_STRING_IDXS    (CBPRINTF_PACKAGE_ADD_RO_STR_POS | CBPRINTF_PACKAGE_CONST_CHAR_RO)
	Append indexes of read-only string arguments in the package.
#define	CBPRINTF_PACKAGE_ARGS_ARE_TAGGED   BIT(6)
	Indicate the incoming arguments are tagged.

Detailed Description

Macro Definition Documentation

CBPRINTF_PACKAGE_ADD_RO_STR_POS

#define CBPRINTF_PACKAGE_ADD_RO_STR_POS   BIT(1)

#include <include/zephyr/sys/cbprintf.h>

Append locations (within the package) of read-only string pointers.

CBPRINTF_PACKAGE_ADD_RW_STR_POS

#define CBPRINTF_PACKAGE_ADD_RW_STR_POS   BIT(2)

#include <include/zephyr/sys/cbprintf.h>

Append locations (within the package) of read-write string pointers.

When this flag is not used then read-write strings are appended to the package.

CBPRINTF_PACKAGE_ADD_STRING_IDXS

#define CBPRINTF_PACKAGE_ADD_STRING_IDXS    (CBPRINTF_PACKAGE_ADD_RO_STR_POS | CBPRINTF_PACKAGE_CONST_CHAR_RO)

#include <include/zephyr/sys/cbprintf.h>

Append indexes of read-only string arguments in the package.

When used, package contains locations of read-only string arguments. Package with that information can be converted to fully self-contain package using cbprintf_fsc_package.

CBPRINTF_PACKAGE_ARGS_ARE_TAGGED

#define CBPRINTF_PACKAGE_ARGS_ARE_TAGGED   BIT(6)

#include <include/zephyr/sys/cbprintf.h>

Indicate the incoming arguments are tagged.

When set, this indicates that the incoming arguments are tagged, and need to be processed accordingly.

CBPRINTF_PACKAGE_CONST_CHAR_RO

#define CBPRINTF_PACKAGE_CONST_CHAR_RO   BIT(0)

#include <include/zephyr/sys/cbprintf.h>

Assume that const char pointer is pointing to read only (constant) strings.

Flag is valid only for CBPRINTF_STATIC_PACKAGE.

CBPRINTF_PACKAGE_FIRST_RO_STR_CNT

#define CBPRINTF_PACKAGE_FIRST_RO_STR_CNT

(

n

)

(n << Z_CBPRINTF_PACKAGE_FIRST_RO_STR_OFFSET)

#include <include/zephyr/sys/cbprintf.h>

Indicate that n first string format arguments are char pointers to read-only location.

Runtime algorithm (address analysis) is skipped for those strings.

Parameters

n	Number of string arguments considered as read-only.