UBX Modem Configuration

Expected usage of configuration interface: More...

Topics
	UBX_CFG_KEY_I2C
	UBX_CFG_KEY_I2CINPROT
	UBX_CFG_KEY_I2COUTPROT
	UBX_CFG_KEY_MSGOUT
	UBX_CFG_KEY_NAVSPG
	UBX_CFG_KEY_PM
	UBX_CFG_KEY_RATE
	UBX_CFG_KEY_SIGNAL
	UBX_CFG_KEY_TP
	UBX_CFG_KEY_TXREADY
	UBX_CFG_KEY_UART1

Data Structures
struct	ubx_cfg_val
	Configuration value structure as returned by parser. More...

Macros
#define	UBX_CFG_VALUE_APPEND(buf, key, value)
	Macro to append a configuration value to a buffer.

Functions
static void	ubx_msg_prepare_valset (struct net_buf_simple *buf, uint8_t layers)
	Helper to prepare the common CFG-VALSET message.
static void	ubx_msg_prepare_valget (struct net_buf_simple *buf, uint8_t layer, uint8_t offset)
	Helper to prepare the common CFG-VALGET message.
static int	ubx_cfg_val_parse (const uint8_t **ptr, size_t *remaining, struct ubx_cfg_val *cfg)
	Iteratively parse configuration values from a buffer.

Detailed Description

Expected usage of configuration interface:

struct ubx_msg_cfg_valset_v0 *valset;
NET_BUF_SIMPLE_DEFINE(cfg_buf, 32);
 
ubx_msg_prepare_valset(&cfg_buf, UBX_MSG_CFG_VALSET_LAYERS_RAM | UBX_MSG_CFG_VALSET_LAYERS_BBR);
UBX_CFG_VALUE_APPEND(&cfg_buf, UBX_CFG_KEY_RATE_MEAS, fix_interval_ms);
UBX_CFG_VALUE_APPEND(&cfg_buf, UBX_CFG_KEY_RATE_NAV, 1);
ubx_msg_finalise(&cfg_buf);

Macro Definition Documentation

UBX_CFG_VALUE_APPEND

#define UBX_CFG_VALUE_APPEND	(		buf,
			key,
			value )

#include <infuse/gnss/ubx/cfg.h>

Value:

        net_buf_simple_add_le32(buf, key);                                                         \
        switch (key & _UBX_CFG_KEY_SIZE_MASK) {                                                    \
        case _UBX_CFG_KEY_SIZE_1BIT_:                                                              \
                net_buf_simple_add_u8(buf, value ? 0x01 : 0x00);                                   \
                break;                                                                             \
        case _UBX_CFG_KEY_SIZE_1BYTE:                                                              \
                net_buf_simple_add_u8(buf, value);                                                 \
                break;                                                                             \
        case _UBX_CFG_KEY_SIZE_2BYTE:                                                              \
                net_buf_simple_add_le16(buf, value);                                               \
                break;                                                                             \
        case _UBX_CFG_KEY_SIZE_4BYTE:                                                              \
                net_buf_simple_add_le32(buf, value);                                               \
                break;                                                                             \
        default:                                                                                   \
                net_buf_simple_add_le64(buf, value);                                               \
                break;                                                                             \
        }

Macro to append a configuration value to a buffer.

Implemented as a macro to allow the type of value to be preserved. As key should always be a compile time constant, only the chosen branch should ever be present in the output binary.

Parameters

buf	Buffer to append value to
key	UBX configuration value key
value	Value

Function Documentation

ubx_cfg_val_parse()

static int ubx_cfg_val_parse ( const uint8_t ** ptr, size_t * remaining, struct ubx_cfg_val * cfg )

inlinestatic

#include <infuse/gnss/ubx/cfg.h>

Iteratively parse configuration values from a buffer.

Expected usage:

struct ubx_cfg_val cfg_val;
uint8_t *val_ptr = &buffer;
uint16_t val_len = buffer_len;
 
while (ubx_cfg_val_parse(&val_ptr, &val_len, &cfg_val) == 0) {
    Handle cfg_val here...
}

Parameters

ptr	Pointer to configuration buffer to parse
remaining
cfg

Returns

int

ubx_msg_prepare_valget()

static void ubx_msg_prepare_valget ( struct net_buf_simple * buf, uint8_t layer, uint8_t offset )

inlinestatic

#include <infuse/gnss/ubx/cfg.h>

Helper to prepare the common CFG-VALGET message.

Parameters

buf	Buffer to prepare
layer	Layer to query configuration for
offset	Start value offset for query

ubx_msg_prepare_valset()

static void ubx_msg_prepare_valset ( struct net_buf_simple * buf, uint8_t layers )

inlinestatic

#include <infuse/gnss/ubx/cfg.h>

Helper to prepare the common CFG-VALSET message.

Parameters

buf	Buffer to prepare
layers	Layers to set configuration values on