#include <parameter.h>

Public Attributes
uint8_t	offset

enum kfsw_param_type	type

uint16_t	capacity

uint32_t	flags

const char *	name

const char *	unit

const char *	description

void *	value

union kfsw_param_scalar	default_value

const char *	default_text

kfsw_param_validator_t	validate

kfsw_param_changed_t	changed

kfsw_param_text_validator_t	validate_text

kfsw_param_text_changed_t	changed_text

kfsw_param_data_validator_t	validate_data

kfsw_param_data_changed_t	changed_data

const uint8_t *	default_data

kfsw_param_sample_t	sample

Detailed Description

One parameter definition.

The definition, its strings and its storage must stay valid while the service runs. Defaults are copied into storage at init. Validators and change callbacks run under the parameter lock, so they must not call the parameter API.

Member Data Documentation

◆ capacity

uint16_t kfsw_param_definition::capacity

Storage in bytes: for a KFSW_PARAM_STRING the capacity with its terminator, for a KFSW_PARAM_DATA the element count.

Left zero for a scalar, whose width comes from its type.

◆ default_data

const uint8_t* kfsw_param_definition::default_data

Compiled default for a KFSW_PARAM_DATA; NULL means all zero.

◆ default_text

const char* kfsw_param_definition::default_text

Compiled default for a KFSW_PARAM_STRING; NULL means empty.

◆ offset

uint8_t kfsw_param_definition::offset

Byte offset within the table; unique inside it.

The documentation for this struct was generated from the following file: