COBS (Consistent Overhead Byte Stuffing)

COBS encoding and decoding functions with custom delimiter support More...

Functions
static size_t	cobs_max_encoded_len (size_t decoded_size, uint32_t flags)
	Calculate maximum encoded buffer size.
int	cobs_encode (struct net_buf *src, struct net_buf *dst, uint32_t flags)
	Standard COBS encoding.
int	cobs_decode (struct net_buf *src, struct net_buf *dst, uint32_t flags)
	Standard COBS decoding.

Detailed Description

COBS encoding and decoding functions with custom delimiter support

Provides functions for COBS encoding/decoding with configurable delimiters. The implementation handles both standard zero-delimited COBS and custom delimiter variants.

Function Documentation

cobs_decode()

int cobs_decode	(	struct net_buf *	src,
		struct net_buf *	dst,
		uint32_t	flags )

#include <zephyr/data/cobs.h>

Standard COBS decoding.

Parameters

src	Source buffer to decode
dst	Destination buffer for decoded data
flags	Decoding flags (reserved)

Return values

0	Success
-ENOMEM	Insufficient destination space
-EINVAL	Invalid COBS structure or parameters

cobs_encode()

int cobs_encode	(	struct net_buf *	src,
		struct net_buf *	dst,
		uint32_t	flags )

#include <zephyr/data/cobs.h>

Standard COBS encoding.

Parameters

src	Source buffer to decode
dst	Destination buffer for decoded data
flags	Decoding flags (reserved)

Return values

0	Success
-ENOMEM	Insufficient destination space
-EINVAL	Invalid COBS structure or parameters

cobs_max_encoded_len()

static size_t cobs_max_encoded_len ( size_t decoded_size, uint32_t flags )

inlinestatic

#include <zephyr/data/cobs.h>

Calculate maximum encoded buffer size.

Parameters

decoded_size	Size of input data to be encoded
flags	COBS_FLAG_TRAILING_DELIMITER to include termination byte in calculation

Returns

Required buffer size for worst-case encoding scenario