#include "hdlc_encoder.h"
#include <limits.h>
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include <stdio.h>
#include <string.h>
#include "hdlc_common.h"
#include "system/common.h"

Include dependency graph for hdlc_encoder.c:

Data Structures
struct	hdlc_encoder_t

Macros
#define	HDLC_TRY_PUT_BYTE(byte, frame, error_handling)

#define	HDLC_BIT_STUFF_ONES_LIMIT 5U

#define	SHIFT_IN_BIT(out_byte, bitorder, bit, bitpos) (bitorder) ? ((out_byte) \| ((bit) << (bitpos))) : ((out_byte) \| ((bit) << (7 - (bitpos))))

#define	ENCODER_TRY_FLUSH_BYTE_OUT(encoder, frame, error_handling)

#define	ENCODER_ZERO_PAD_AND_DRAIN(encoder, frame, error_handling)

Functions
static bool	hdlc_escape_if_needed (uint8_t byte, HDLC_FRAME_T *frame)

bool	hdlc_encode_byte (const uint8_t payload, const size_t payload_length, HDLC_FRAME_T frame)
	Encode payload using byte-escaping HDLC compatibility path.

static bool	hdlc_put_bit (hdlc_encoder_t encoder, bool bit, HDLC_FRAME_T frame)

static bool	hdlc_put_byte (hdlc_encoder_t encoder, uint8_t byte, HDLC_FRAME_T frame)

bool	hdlc_encode (const uint8_t payload, const size_t payload_length, HDLC_FRAME_T frame, bool lsb_first)
	Encode payload into an HDLC bit-stuffed frame.

Macro Definition Documentation

◆ ENCODER_TRY_FLUSH_BYTE_OUT

#define ENCODER_TRY_FLUSH_BYTE_OUT	(	encoder,
		frame,
		error_handling
	)

Value:

    do                                                                         \
    {                                                                          \
        if ((++(encoder)->out_bits_used) == CHAR_BIT)                          \
        {                                                                      \
            HDLC_TRY_PUT_BYTE(((encoder)->out_byte), (frame), error_handling); \
            (encoder)->out_bits_used = 0;                                      \
            (encoder)->out_byte      = 0;                                      \
        }                                                                      \
    } while (0)

Definition at line 114 of file hdlc_encoder.c.

◆ ENCODER_ZERO_PAD_AND_DRAIN

#define ENCODER_ZERO_PAD_AND_DRAIN	(	encoder,
		frame,
		error_handling
	)

Value:

    do                                                                     \
    {                                                                      \
        if ((encoder)->out_bits_used > 0)                                  \
        {                                                                  \
            HDLC_TRY_PUT_BYTE((encoder)->out_byte, frame, error_handling); \
            (encoder)->out_byte      = 0;                                  \
            (encoder)->ones_run      = 0;                                  \
            (encoder)->out_bits_used = 0;                                  \
        }                                                                  \
    } while (0)

Definition at line 125 of file hdlc_encoder.c.

◆ HDLC_BIT_STUFF_ONES_LIMIT

#define HDLC_BIT_STUFF_ONES_LIMIT 5U

Definition at line 39 of file hdlc_encoder.c.

◆ HDLC_TRY_PUT_BYTE

#define HDLC_TRY_PUT_BYTE	(	byte,
		frame,
		error_handling
	)

Value:

    do                                                 \
    {                                                  \
        if ((frame)->length + 1 > (frame)->capacity)   \
        {                                              \
            goto error_handling;                       \
        }                                              \
        (frame)->payload[(frame)->length++] = byte;    \
    } while (0)

Definition at line 29 of file hdlc_encoder.c.

◆ SHIFT_IN_BIT

#define SHIFT_IN_BIT	(	out_byte,
		bitorder,
		bit,
		bitpos
	)	(bitorder) ? ((out_byte) \| ((bit) << (bitpos))) : ((out_byte) \| ((bit) << (7 - (bitpos))))

Definition at line 111 of file hdlc_encoder.c.

Function Documentation

◆ hdlc_encode()

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

Encode payload into an HDLC bit-stuffed frame.

Parameters

payload	Input payload bytes.
payload_length	Number of payload bytes.
frame	Output frame descriptor and storage.
lsb_first	Bit order selector for bit-wise encoding.