#include "msg_buf.h"
#include <stdlib.h>
#include "minmax.h"
#include "ptp_core.h"

Macros
#define	MSGB_DEBUG 0
	Message buffer debugging.

#define	RAW_MSG_TO_BLOCK(rmsg) ((PtpMsgBufBlock )(((uint8_t )(rmsg)) - (sizeof(PtpMsgBufBlock) - sizeof(RawPtpMessage))))
	Get block address by message address.

Functions
void	msgb_init (PtpMsgBuf buf, PtpMsgBufBlock pool, uint32_t n)

static PtpMsgBufBlock *	msgb_get_entry_by_tag (PtpMsgBuf *buf, uint32_t tag)

static void	msgb_free_block (PtpMsgBuf buf, PtpMsgBufBlock block)

RawPtpMessage *	msgb_alloc (PtpMsgBuf *buf, uint32_t tag, uint32_t ttl)

void	msgb_commit (PtpMsgBuf buf, RawPtpMessage msg)

void	msgb_free (PtpMsgBuf buf, RawPtpMessage msg)

static PtpMsgBufBlock *	msgb_get_oldest_block (PtpMsgBuf *buf)

RawPtpMessage *	msgb_get_oldest (PtpMsgBuf *buf)

static PtpMsgBufBlock *	msgb_get_block_by_uid (PtpMsgBuf *buf, uint32_t uid)

RawPtpMessage *	msgb_get_by_uid (PtpMsgBuf *buf, uint32_t uid)

static PtpMsgBufBlock *	msgb_get_sent_block_by_tag (PtpMsgBuf *buf, uint32_t tag)

RawPtpMessage *	msgb_get_sent_by_tag (PtpMsgBuf *buf, uint32_t tag)

static void	msgb_set_block_sent (PtpMsgBuf buf, PtpMsgBufBlock block)

void	msgb_set_sent (PtpMsgBuf buf, RawPtpMessage msg)

uint32_t	msgb_get_uid (const PtpMsgBuf buf, const RawPtpMessage msg)

void	msgb_tick (PtpMsgBuf *buf)

void	msgb_report (PtpMsgBuf *buf)

uint32_t	msgb_get_error (PtpMsgBuf *buf)

Macro Definition Documentation

◆ MSGB_DEBUG

#define MSGB_DEBUG 0

Message buffer debugging.

Definition at line 9 of file msg_buf.c.

◆ RAW_MSG_TO_BLOCK

#define RAW_MSG_TO_BLOCK ( rmsg ) ((PtpMsgBufBlock *)(((uint8_t *)(rmsg)) - (sizeof(PtpMsgBufBlock) - sizeof(RawPtpMessage))))

Get block address by message address.

Definition at line 96 of file msg_buf.c.

Function Documentation

◆ msgb_alloc()

RawPtpMessage * msgb_alloc	(	PtpMsgBuf *	buf,
		uint32_t	tag,
		uint32_t	ttl
	)

Allocate a block.

Parameters

buf	pointer to the PtpMsgBuf object
tag	unique tag
ttl	Time-to-Live in ticks

Returns: pointer to a RawPtpMessage object or NULL if there's a block already allocated with the current tag or the buffer is full

Definition at line 39 of file msg_buf.c.

◆ msgb_commit()

void msgb_commit	(	PtpMsgBuf *	buf,
		RawPtpMessage *	msg
	)

Commit a previous allocation, make the message available for later pulling.

Parameters

buf	pointer to the PtpMsgBuf object
msg	pointer to the allocated message

Definition at line 98 of file msg_buf.c.

◆ msgb_free()

void msgb_free	(	PtpMsgBuf *	buf,
		RawPtpMessage *	msg
	)

Release an allocated message block.

Parameters

buf	pointer to the PtpMsgBuf object
msg	pointer to the allocated message

Definition at line 115 of file msg_buf.c.

◆ msgb_free_block()

static void msgb_free_block	(	PtpMsgBuf *	buf,
		PtpMsgBufBlock *	block
	)

static

Release an allocated block.

Parameters

buf	pointer to the PtpMsgBuf object
block	pointer to a previously allocated block

Definition at line 109 of file msg_buf.c.

◆ msgb_get_block_by_uid()

static PtpMsgBufBlock * msgb_get_block_by_uid	(	PtpMsgBuf *	buf,
		uint32_t	uid
	)

static

Get block by its UID.

Parameters

buf	pointer to the PtpMsgBuf object
uid	uid of the message sought

Returns: message block with the UID or NULL if not found

Definition at line 160 of file msg_buf.c.

◆ msgb_get_by_uid()

RawPtpMessage * msgb_get_by_uid	(	PtpMsgBuf *	buf,
		uint32_t	uid
	)

Get message by its UID.

Parameters

buf	pointer to the PtpMsgBuf object
uid	uid of the message sought

Returns: message with the UID or NULL if not found

Definition at line 170 of file msg_buf.c.

◆ msgb_get_entry_by_tag()

static PtpMsgBufBlock * msgb_get_entry_by_tag	(	PtpMsgBuf *	buf,
		uint32_t	tag
	)

static

Retrieve entry by tag.

Parameters

buf	pointer to PtpMsgBuf object
tag	block tag

Returns: corresponding allocated entry if found OR NULL

Definition at line 27 of file msg_buf.c.

◆ msgb_get_error()

uint32_t msgb_get_error ( PtpMsgBuf * buf )

Read and clear last error.

Parameters

buf	pointer to the PtpMsgBuf object

Returns: error code

Definition at line 253 of file msg_buf.c.

◆ msgb_get_oldest()

RawPtpMessage * msgb_get_oldest ( PtpMsgBuf * buf )

Get oldest message from the buffer. (i.e. sequential reading)

Parameters

buf	pointer to the PtpMsgBuf object

Returns: pointer to the oldest message or NULL if the buffer is empty

Definition at line 143 of file msg_buf.c.

◆ msgb_get_oldest_block()

static PtpMsgBufBlock * msgb_get_oldest_block ( PtpMsgBuf * buf )

static

Get oldest block from the buffer. (i.e. sequential reading)

Parameters

buf	pointer to the PtpMsgBuf object

Returns: pointer to the oldest block or NULL if the buffer is empty

Definition at line 127 of file msg_buf.c.

◆ msgb_get_sent_block_by_tag()

static PtpMsgBufBlock * msgb_get_sent_block_by_tag	(	PtpMsgBuf *	buf,
		uint32_t	tag
	)

static

Get sent block by tag.

Parameters

buf	pointer to the PtpMsgBuf object
uid	uid of the message sought

Returns: sent message block with the tag or NULL if not found

Definition at line 187 of file msg_buf.c.

◆ msgb_get_sent_by_tag()

RawPtpMessage * msgb_get_sent_by_tag	(	PtpMsgBuf *	buf,
		uint32_t	tag
	)

Get sent message by tag.

Parameters

buf	pointer to the PtpMsgBuf object
tag	tag of the message sought

Returns: message with the tag or NULL if not found

Definition at line 197 of file msg_buf.c.

◆ msgb_get_uid()

uint32_t msgb_get_uid	(	const PtpMsgBuf *	buf,
		const RawPtpMessage *	msg
	)

Get the UID of an allocated message.

Parameters

buf	pointer to PtpMsgBuf object
msg	pointer to an allocated message

Returns: message UID

Definition at line 221 of file msg_buf.c.

◆ msgb_init()

void msgb_init	(	PtpMsgBuf *	buf,
		PtpMsgBufBlock *	pool,
		uint32_t	n
	)

Initialize PTP message buffer.

Parameters

buf	pointer to an empty (non-initialized) PtpMsgBuf object
pool	pointer to an allocated pool for n pieces of PtpMsgBufEntry
n	number of supported elements

Definition at line 12 of file msg_buf.c.

◆ msgb_report()

void msgb_report ( PtpMsgBuf * buf )

Report the message buffer state.

Parameters

buf	pointer to the PtpMsgBuf object

Definition at line 240 of file msg_buf.c.

◆ msgb_set_block_sent()

static void msgb_set_block_sent	(	PtpMsgBuf *	buf,
		PtpMsgBufBlock *	block
	)

static

Set sent flag in a block.

Parameters

buf	pointer to PtpMsgBuf object
block	pointer to a block

Definition at line 212 of file msg_buf.c.

◆ msgb_set_sent()

void msgb_set_sent	(	PtpMsgBuf *	buf,
		RawPtpMessage *	msg
	)

Set sent flag for a message.

Parameters

buf	pointer to PtpMsgBuf object
msg	pointer to an allocated message

Definition at line 216 of file msg_buf.c.

◆ msgb_tick()

void msgb_tick ( PtpMsgBuf * buf )

Tick the storage.

Parameters

buf	pointer to the PtpMsgBuf object

Definition at line 226 of file msg_buf.c.

Macros

Functions

Macro Definition Documentation

◆ MSGB_DEBUG

◆ RAW_MSG_TO_BLOCK

Function Documentation

◆ msgb_alloc()

◆ msgb_commit()

◆ msgb_free()

◆ msgb_free_block()

◆ msgb_get_block_by_uid()

◆ msgb_get_by_uid()

◆ msgb_get_entry_by_tag()

◆ msgb_get_error()

◆ msgb_get_oldest()

◆ msgb_get_oldest_block()

◆ msgb_get_sent_block_by_tag()

◆ msgb_get_sent_by_tag()

◆ msgb_get_uid()

◆ msgb_init()

◆ msgb_report()

◆ msgb_set_block_sent()

◆ msgb_set_sent()

◆ msgb_tick()