pbuf.h File Reference

#include <zephyr/cache.h>
#include <zephyr/devicetree.h>

Go to the source code of this file.

Data Structures
struct	pbuf_cfg
	Control block of packet buffer. More...
struct	pbuf_data
	Data block of the packed buffer. More...
struct	pbuf
	Scure packed buffer. More...

Macros
#define	PBUF_PACKET_LEN_SZ   sizeof(uint32_t)
	Size of packet length field.
#define	PBUF_MAYBE_CONST   const
#define	PBUF_CFG_INIT(mem_addr, size, dcache_align, use_handshake)
	Macro for configuration initialization.
#define	PBUF_HEADER_OVERHEAD(dcache_align)    (MAX(dcache_align, _PBUF_IDX_SIZE) + _PBUF_IDX_SIZE)
	Macro calculates memory overhead taken by the header in shared memory.
#define	PBUF_DEFINE(name, mem_addr, size, dcache_align, use_handshake, compatibility)
	Statically define and initialize pbuf.

Functions
int	pbuf_tx_init (struct pbuf *pb)
	Initialize the Tx packet buffer.
int	pbuf_rx_init (struct pbuf *pb)
	Initialize the Rx packet buffer.
int	pbuf_write (struct pbuf *pb, const char *buf, uint16_t len)
	Write specified amount of data to the packet buffer.
int	pbuf_read (struct pbuf *pb, char *buf, uint16_t len)
	Read specified amount of data from the packet buffer.
uint32_t	pbuf_handshake_read (struct pbuf *pb)
	Read handshake word from pbuf.
void	pbuf_handshake_write (struct pbuf *pb, uint32_t value)
	Write handshake word to pbuf.
int	pbuf_get_initial_buf (struct pbuf *pb, volatile char **buf, uint16_t *len)
	Get first buffer from pbuf.