vsf_pbuf_queue.c File Reference

#include "service/vsf_service_cfg.h"
#include "./vsf_pbuf_queue.h"

Macros
#define	__VSF_PBUF_QUEUE_CLASS_IMPLEMENT
#define	this   (*this_ptr)
#define	VSF_PBUF_QUEUE_CFG_RAISE_DAVL_EVT_ONCE   ENABLED
#define	__VSF_PBUF_QUEUE_USE_DEFAULT_ATOM_ACCESS
#define	VSF_PBUF_QUEUE_CFG_ATOM_ACCESS(...)    vsf_protect_region_simple(this.pregion, __VA_ARGS__)

Functions
vsf_err_t	vsf_stream_fifo_init (vsf_stream_fifo_t *obj_ptr, vsf_stream_fifo_cfg_t *cfg_ptr)
vsf_err_t	vsf_pbuf_queue_enqueue (vsf_stream_fifo_t *obj_ptr, vsf_pbuf_t *pblock)
vsf_pbuf_t *	vsf_pbuf_queue_peek (vsf_stream_fifo_t *obj_ptr)
vsf_pbuf_t *	vsf_pbuf_queue_dequeue (vsf_stream_fifo_t *obj_ptr)
vsf_err_t	vsf_pbuf_queue_data_available_event_register (vsf_stream_fifo_t *obj_ptr, vsf_stream_dat_rdy_evt_t tEventHandling)
vsf_err_t	vsf_pbuf_queue_data_drain_event_register (vsf_stream_fifo_t *obj_ptr, vsf_stream_dat_drn_evt_t tEventHandling)

Macro Definition Documentation

__VSF_PBUF_QUEUE_CLASS_IMPLEMENT

#define __VSF_PBUF_QUEUE_CLASS_IMPLEMENT

this

#define this   (*this_ptr)

VSF_PBUF_QUEUE_CFG_RAISE_DAVL_EVT_ONCE

#define VSF_PBUF_QUEUE_CFG_RAISE_DAVL_EVT_ONCE   ENABLED

__VSF_PBUF_QUEUE_USE_DEFAULT_ATOM_ACCESS

#define __VSF_PBUF_QUEUE_USE_DEFAULT_ATOM_ACCESS

VSF_PBUF_QUEUE_CFG_ATOM_ACCESS

#define VSF_PBUF_QUEUE_CFG_ATOM_ACCESS

(

...

)

vsf_protect_region_simple(this.pregion, __VA_ARGS__)

Note

By default, the driver tries to make all APIs thread-safe, in the ! case when you want to disable it, please use following macro to ! disable it: ! ! #define VSF_PBUF_QUEUE_CFG_ATOM_ACCESS(...) VA_ARGS ! ! ! NOTE: This macro should be defined in app_cfg.h or vsf_cfg.h

Function Documentation

vsf_stream_fifo_init()

vsf_err_t vsf_stream_fifo_init	(	vsf_stream_fifo_t *	obj_ptr,
		vsf_stream_fifo_cfg_t *	cfg_ptr
	)

vsf_pbuf_queue_enqueue()

vsf_err_t vsf_pbuf_queue_enqueue	(	vsf_stream_fifo_t *	obj_ptr,
		vsf_pbuf_t *	pblock
	)

raise data ready event

vsf_pbuf_queue_peek()

vsf_pbuf_t * vsf_pbuf_queue_peek

(

vsf_stream_fifo_t *

obj_ptr

)

vsf_pbuf_queue_dequeue()

vsf_pbuf_t * vsf_pbuf_queue_dequeue

(

vsf_stream_fifo_t *

obj_ptr

)

raise data drain event

vsf_pbuf_queue_data_available_event_register()

vsf_err_t vsf_pbuf_queue_data_available_event_register	(	vsf_stream_fifo_t *	obj_ptr,
		vsf_stream_dat_rdy_evt_t	tEventHandling
	)

vsf_pbuf_queue_data_drain_event_register()

vsf_err_t vsf_pbuf_queue_data_drain_event_register	(	vsf_stream_fifo_t *	obj_ptr,
		vsf_stream_dat_drn_evt_t	tEventHandling
	)