#include "hdlc_decoder.h"
#include <limits.h>
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include "hdlc_common.h"
#include "system/common.h"

Include dependency graph for hdlc_decoder.c:

Go to the source code of this file.

Data Structures
struct	hdlc_decoder_t

Macros
#define	HDLC_BIT_STUFF_ONES_LIMIT 5U

#define	HDLC_DEC_BYTE_IDX(raw_bit_index) (1 + ((raw_bit_index) / CHAR_BIT))

#define	HDLC_DEC_BIT_IDX(raw_bit_index) ((raw_bit_index) % CHAR_BIT)

#define	HDLC_DEC_BIT_POS(decoder)

#define	HDLC_DEC_GET_OUT_BIT(decoder) (frame->payload[HDLC_DEC_BYTE_IDX((decoder)->raw_bit_index)] >> HDLC_DEC_BIT_POS((decoder)) & 1)

Enumerations
enum	hdlc_decoder_bit_type_t { HDLC_BIT_OK , HDLC_BIT_EOF , HDLC_BIT_ERR }

Functions
bool	hdlc_decode_byte (const HDLC_FRAME_T frame, uint8_t payload, const size_t out_capacity, size_t *payload_length)
	Decode a byte-escaped HDLC frame compatibility path.

static hdlc_decoder_bit_type_t	hdlc_get_bit (hdlc_decoder_t decoder, const HDLC_FRAME_T frame, uint8_t *out_bit)

static hdlc_decoder_bit_type_t	hdlc_get_byte (hdlc_decoder_t decoder, const HDLC_FRAME_T frame, uint8_t *byte)

bool	hdlc_decode (const HDLC_FRAME_T frame, uint8_t payload, const size_t out_capacity, size_t *payload_length, bool lsb_first)
	Decode an HDLC bit-stuffed frame.

void	hdlc_decode_stats_snapshot (hdlc_decode_stats_t *out_stats)
	Copy cumulative HDLC decode statistics.

void	hdlc_decode_stats_reset (void)
	Reset cumulative HDLC decode statistics.

Variables
static hdlc_decode_stats_t	hdlc_decode_stats = {0}

Macro Definition Documentation

◆ HDLC_BIT_STUFF_ONES_LIMIT

#define HDLC_BIT_STUFF_ONES_LIMIT 5U

Definition at line 27 of file hdlc_decoder.c.

◆ HDLC_DEC_BIT_IDX

#define HDLC_DEC_BIT_IDX ( raw_bit_index ) ((raw_bit_index) % CHAR_BIT)

Definition at line 104 of file hdlc_decoder.c.

◆ HDLC_DEC_BIT_POS

#define HDLC_DEC_BIT_POS ( decoder )

Value:

((decoder)->lsb_first ? (HDLC_DEC_BIT_IDX((decoder)->raw_bit_index)) \

: ((7 - HDLC_DEC_BIT_IDX((decoder)->raw_bit_index))))

HDLC_DEC_BIT_IDX

#define HDLC_DEC_BIT_IDX(raw_bit_index)

Definition hdlc_decoder.c:104

Definition at line 105 of file hdlc_decoder.c.

◆ HDLC_DEC_BYTE_IDX

#define HDLC_DEC_BYTE_IDX ( raw_bit_index ) (1 + ((raw_bit_index) / CHAR_BIT))

Definition at line 103 of file hdlc_decoder.c.

◆ HDLC_DEC_GET_OUT_BIT

#define HDLC_DEC_GET_OUT_BIT ( decoder ) (frame->payload[HDLC_DEC_BYTE_IDX((decoder)->raw_bit_index)] >> HDLC_DEC_BIT_POS((decoder)) & 1)

Definition at line 108 of file hdlc_decoder.c.

Enumeration Type Documentation

◆ hdlc_decoder_bit_type_t

enum hdlc_decoder_bit_type_t

Enumerator
HDLC_BIT_OK
HDLC_BIT_EOF
HDLC_BIT_ERR

Definition at line 36 of file hdlc_decoder.c.

Function Documentation

◆ hdlc_decode()

bool hdlc_decode	(	const HDLC_FRAME_T *	frame,
		uint8_t *	payload,
		const size_t	out_capacity,
		size_t *	payload_length,
		bool	lsb_first
	)

Decode an HDLC bit-stuffed frame.

Parameters

frame	Input HDLC frame.
payload	Output payload buffer.
out_capacity	Capacity of `payload` in bytes.
payload_length	Output payload length.
lsb_first	Bit order selector matching encoder/PIO path.