vsf simple stream

Data Structures
class	vsf_stream_op_t
class	vsf_stream_terminal_t
class	vsf_stream_t
class	vsf_stream_adapter_t
enum	vsf_stream_evt_t {   VSF_STREAM_ON_CONNECT ,   VSF_STREAM_ON_DISCONNECT ,   VSF_STREAM_ON_IN ,   VSF_STREAM_ON_RX = VSF_STREAM_ON_IN ,   VSF_STREAM_ON_OUT ,   VSF_STREAM_ON_TX = VSF_STREAM_ON_OUT }
typedef enum vsf_stream_evt_t	vsf_stream_evt_t
vsf_err_t	vsf_stream_init (vsf_stream_t *stream)
vsf_err_t	vsf_stream_fini (vsf_stream_t *stream)
uint_fast32_t	vsf_stream_write (vsf_stream_t *stream, uint8_t *buf, uint_fast32_t size)
uint_fast32_t	vsf_stream_read (vsf_stream_t *stream, uint8_t *buf, uint_fast32_t size)
void	vsf_stream_set_tx_threshold (vsf_stream_t *stream, uint_fast32_t threshold)
void	vsf_stream_set_rx_threshold (vsf_stream_t *stream, uint_fast32_t threshold)
uint_fast32_t	vsf_stream_get_buff_size (vsf_stream_t *stream)
uint_fast32_t	vsf_stream_get_data_size (vsf_stream_t *stream)
uint_fast32_t	vsf_stream_get_free_size (vsf_stream_t *stream)
uint_fast32_t	vsf_stream_get_wbuf (vsf_stream_t *stream, uint8_t **ptr)
uint_fast32_t	vsf_stream_get_rbuf (vsf_stream_t *stream, uint8_t **ptr)
void	vsf_stream_connect_rx (vsf_stream_t *stream)
void	vsf_stream_connect_tx (vsf_stream_t *stream)
void	vsf_stream_disconnect_rx (vsf_stream_t *stream)
void	vsf_stream_disconnect_tx (vsf_stream_t *stream)
bool	vsf_stream_is_rx_connected (vsf_stream_t *stream)
bool	vsf_stream_is_tx_connected (vsf_stream_t *stream)
uint_fast32_t	vsf_stream_adapter_evthandler (vsf_stream_t *stream, void *param, vsf_stream_evt_t evt)
void	vsf_stream_adapter_init (vsf_stream_adapter_t *adapter)
#define	VSF_STREAM_CFG_TICKTOCK   ENABLED
#define	VSF_STREAM_CFG_THRESHOLD   ENABLED
#define	__VSF_STREAM_ADAPTER_INIT(__STREAM_TX, __STREAM_RX, __THRESHOLD_TX, __THRESHOLD_RX)
#define	VSF_STREAM_ADAPTER_INIT0(__STREAM_TX, __STREAM_RX)
#define	VSF_STREAM_ADAPTER_INIT1(__STREAM_TX, __STREAM_RX, __THRESHOLD_TX)
#define	VSF_STREAM_ADAPTER_INIT2(__STREAM_TX, __STREAM_RX, __THRESHOLD_TX, __THRESHOLD_RX)
#define	VSF_STREAM_ADAPTER_INIT(__STREAM_TX, __STREAM_RX, ...)
#define	__declare_stream_adapter(__name)
#define	declare_stream_adapter(__name)
#define	dcl_stream_adapter(__name)
#define	__describe_stream_adapter(__name, __stream_tx, __stream_rx, __threshold_tx, __threshold_rx)
#define	describe_stream_adapter0(__name, __stream_tx, __stream_rx)
#define	describe_stream_adapter1(__name, __stream_tx, __stream_rx, __threshold_tx)
#define	describe_stream_adapter2(__name, __stream_tx, __stream_rx, __threshold_tx, __threshold_rx)
#define	describe_stream_adapter(__name, __stream_tx, __stream_rx, ...)
#define	VSF_STREAM_INIT(__stream)
#define	VSF_STREAM_FINI(__stream)
#define	VSF_STREAM_WRITE(__stream, __buf, __size)
#define	VSF_STREAM_READ(__stream, __buf, __size)
#define	VSF_STREAM_GET_BUFF_SIZE(__stream)
#define	VSF_STREAM_GET_DATA_SIZE(__stream)
#define	VSF_STREAM_GET_FREE_SIZE(__stream)
#define	VSF_STREAM_GET_WBUF(__stream, p)
#define	VSF_STREAM_GET_RBUF(__stream, p)
#define	VSF_STREAM_CONNECT_RX(__stream)
#define	VSF_STREAM_CONNECT_TX(__stream)
#define	VSF_STREAM_DISCONNECT_RX(__stream)
#define	VSF_STREAM_DISCONNECT_TX(__stream)
#define	VSF_STREAM_IS_RX_CONNECTED(__stream)
#define	VSF_STREAM_IS_TX_CONNECTED(__stream)
#define	VSF_STREAM_SET_RX_THRESHOLD(__stream, __thres)
#define	VSF_STREAM_SET_TX_THRESHOLD(__stream, __thres)

Detailed Description

Macro Definition Documentation

VSF_STREAM_CFG_TICKTOCK

#define VSF_STREAM_CFG_TICKTOCK   ENABLED

vsf stream ticktock configuration, can be ENABLED or DISABLE. Default value is ENABLED, it can be predefined in vsf_usr_cfg*.h

VSF_STREAM_CFG_THRESHOLD

#define VSF_STREAM_CFG_THRESHOLD   ENABLED

vsf stream threshold configuration, can be ENABLED or DISABLE. Default value is ENABLED, it can be predefined in vsf_usr_cfg*.h

__VSF_STREAM_ADAPTER_INIT

#define __VSF_STREAM_ADAPTER_INIT	(		__STREAM_TX,
			__STREAM_RX,
			__THRESHOLD_TX,
			__THRESHOLD_RX )

Value:

            .stream_tx          = (vsf_stream_t *)(__STREAM_TX),                \
            .stream_rx          = (vsf_stream_t *)(__STREAM_RX),                \
            .threshold_tx       = (__THRESHOLD_TX),                             \
            .threshold_rx       = (__THRESHOLD_RX),

VSF_STREAM_ADAPTER_INIT0

#define VSF_STREAM_ADAPTER_INIT0	(		__STREAM_TX,
			__STREAM_RX )

Value:

            __VSF_STREAM_ADAPTER_INIT((__STREAM_TX), (__STREAM_RX), 0, 0)

VSF_STREAM_ADAPTER_INIT1

#define VSF_STREAM_ADAPTER_INIT1	(		__STREAM_TX,
			__STREAM_RX,
			__THRESHOLD_TX )

Value:

            __VSF_STREAM_ADAPTER_INIT((__STREAM_TX), (__STREAM_RX), (__THRESHOLD_TX), 0)

VSF_STREAM_ADAPTER_INIT2

#define VSF_STREAM_ADAPTER_INIT2	(		__STREAM_TX,
			__STREAM_RX,
			__THRESHOLD_TX,
			__THRESHOLD_RX )

Value:

            __VSF_STREAM_ADAPTER_INIT((__STREAM_TX), (__STREAM_RX), (__THRESHOLD_TX), (__THRESHOLD_RX))

VSF_STREAM_ADAPTER_INIT

#define VSF_STREAM_ADAPTER_INIT	(		__STREAM_TX,
			__STREAM_RX,
			... )

Value:

            __PLOOC_EVAL(VSF_STREAM_ADAPTER_INIT, __VA_ARGS__)((__STREAM_TX), (__STREAM_RX), ##__VA_ARGS__)

__declare_stream_adapter

#define __declare_stream_adapter

(

__name

)

Value:

            vsf_dcl_class(vsf_stream_adapter_t)

declare_stream_adapter

#define declare_stream_adapter

(

__name

)

Value:

            __declare_stream_adapter(__name)

dcl_stream_adapter

#define dcl_stream_adapter

(

__name

)

Value:

            declare_stream_adapter(__name)

__describe_stream_adapter

#define __describe_stream_adapter	(		__name,
			__stream_tx,
			__stream_rx,
			__threshold_tx,
			__threshold_rx )

Value:

            vsf_stream_adapter_t __name = {                                     \
                VSF_STREAM_ADAPTER_INIT((__stream_tx), (__stream_rx), (__threshold_tx), (__threshold_rx))\
            };

describe_stream_adapter0

#define describe_stream_adapter0	(		__name,
			__stream_tx,
			__stream_rx )

Value:

            __describe_stream_adapter(__name, (__stream_tx), (__stream_rx), 0, 0)

describe_stream_adapter1

#define describe_stream_adapter1	(		__name,
			__stream_tx,
			__stream_rx,
			__threshold_tx )

Value:

            __describe_stream_adapter(__name, (__stream_tx), (__stream_rx), (__threshold_tx), 0)

describe_stream_adapter2

#define describe_stream_adapter2	(		__name,
			__stream_tx,
			__stream_rx,
			__threshold_tx,
			__threshold_rx )

Value:

            __describe_stream_adapter(__name, (__stream_tx), (__stream_rx), (__threshold_tx), __threshold_rx)

describe_stream_adapter

#define describe_stream_adapter	(		__name,
			__stream_tx,
			__stream_rx,
			... )

Value:

            __PLOOC_EVAL(describe_stream_adapter, __VA_ARGS__)(__name, (__stream_tx), (__stream_rx), ##__VA_ARGS__)

VSF_STREAM_INIT

#define VSF_STREAM_INIT

(

__stream

)

Value:

vsf_stream_init((vsf_stream_t *)(__stream))

VSF_STREAM_FINI

#define VSF_STREAM_FINI

(

__stream

)

Value:

vsf_stream_fini((vsf_stream_t *)(__stream))

VSF_STREAM_WRITE

#define VSF_STREAM_WRITE	(		__stream,
			__buf,
			__size )

Value:

vsf_stream_write((vsf_stream_t *)(__stream), (__buf), (__size))

VSF_STREAM_READ

#define VSF_STREAM_READ	(		__stream,
			__buf,
			__size )

Value:

vsf_stream_read((vsf_stream_t *)(__stream), (__buf), (__size))

VSF_STREAM_GET_BUFF_SIZE

#define VSF_STREAM_GET_BUFF_SIZE

(

__stream

)

Value:

vsf_stream_get_buff_size((vsf_stream_t *)(__stream))

VSF_STREAM_GET_DATA_SIZE

#define VSF_STREAM_GET_DATA_SIZE

(

__stream

)

Value:

vsf_stream_get_data_size((vsf_stream_t *)(__stream))

VSF_STREAM_GET_FREE_SIZE

#define VSF_STREAM_GET_FREE_SIZE

(

__stream

)

Value:

vsf_stream_get_free_size((vsf_stream_t *)(__stream))

VSF_STREAM_GET_WBUF

#define VSF_STREAM_GET_WBUF	(		__stream,
			p )

Value:

vsf_stream_get_wbuf((vsf_stream_t *)(__stream), (p))

VSF_STREAM_GET_RBUF

#define VSF_STREAM_GET_RBUF	(		__stream,
			p )

Value:

vsf_stream_get_rbuf((vsf_stream_t *)(__stream), (p))

VSF_STREAM_CONNECT_RX

#define VSF_STREAM_CONNECT_RX

(

__stream

)

Value:

vsf_stream_connect_rx((vsf_stream_t *)(__stream))

VSF_STREAM_CONNECT_TX

#define VSF_STREAM_CONNECT_TX

(

__stream

)

Value:

vsf_stream_connect_tx((vsf_stream_t *)(__stream))

VSF_STREAM_DISCONNECT_RX

#define VSF_STREAM_DISCONNECT_RX

(

__stream

)

Value:

vsf_stream_disconnect_rx((vsf_stream_t *)(__stream))

VSF_STREAM_DISCONNECT_TX

#define VSF_STREAM_DISCONNECT_TX

(

__stream

)

Value:

vsf_stream_disconnect_tx((vsf_stream_t *)(__stream))

VSF_STREAM_IS_RX_CONNECTED

#define VSF_STREAM_IS_RX_CONNECTED

(

__stream

)

Value:

vsf_stream_is_rx_connected((vsf_stream_t *)(__stream))

VSF_STREAM_IS_TX_CONNECTED

#define VSF_STREAM_IS_TX_CONNECTED

(

__stream

)

Value:

vsf_stream_is_tx_connected((vsf_stream_t *)(__stream))

VSF_STREAM_SET_RX_THRESHOLD

#define VSF_STREAM_SET_RX_THRESHOLD	(		__stream,
			__thres )

Value:

vsf_stream_set_rx_threshold((vsf_stream_t *)(__stream), (__thres))

VSF_STREAM_SET_TX_THRESHOLD

#define VSF_STREAM_SET_TX_THRESHOLD	(		__stream,
			__thres )

Value:

vsf_stream_set_tx_threshold((vsf_stream_t *)(__stream), (__thres))

Typedef Documentation

vsf_stream_evt_t

typedef enum vsf_stream_evt_t vsf_stream_evt_t

vsf stream event

Enumeration Type Documentation

vsf_stream_evt_t

enum vsf_stream_evt_t

vsf stream event

Enumerator
VSF_STREAM_ON_CONNECT	stream on connect event
VSF_STREAM_ON_DISCONNECT	stream on disconnect event
VSF_STREAM_ON_IN	stream on in event
VSF_STREAM_ON_RX	stream on rx event
VSF_STREAM_ON_OUT	stream on out event
VSF_STREAM_ON_TX	stream on tx event

Function Documentation

vsf_stream_init()

vsf_err_t vsf_stream_init ( vsf_stream_t * stream )

extern

initialization function, must be called before other APIs.

Parameters

stream

stream instance, cannot be NULL.

vsf_stream_fini()

vsf_err_t vsf_stream_fini ( vsf_stream_t * stream )

extern

vsf_stream_write()

uint_fast32_t vsf_stream_write ( vsf_stream_t * stream, uint8_t * buf, uint_fast32_t size )

extern

write function, must be called after init.

Parameters

stream	stream instance, cannot be NULL.
buf	buffer pointer, point to a buffer or NULL
size	write size(bytes), if buffer is NULL, then increase stream size.

vsf_stream_read()

uint_fast32_t vsf_stream_read ( vsf_stream_t * stream, uint8_t * buf, uint_fast32_t size )

extern

read function, must be called after init.

Parameters

stream	stream instance, cannot be NULL.
buf	buffer pointer, point to a buffer or NULL
size	read size(bytes), if buffer is NULL, then decrease stream size

vsf_stream_set_tx_threshold()

void vsf_stream_set_tx_threshold ( vsf_stream_t * stream, uint_fast32_t threshold )

extern

vsf_stream_set_rx_threshold()

void vsf_stream_set_rx_threshold ( vsf_stream_t * stream, uint_fast32_t threshold )

extern

vsf_stream_get_buff_size()

uint_fast32_t vsf_stream_get_buff_size ( vsf_stream_t * stream )

extern

vsf_stream_get_data_size()

uint_fast32_t vsf_stream_get_data_size ( vsf_stream_t * stream )

extern

vsf_stream_get_free_size()

uint_fast32_t vsf_stream_get_free_size ( vsf_stream_t * stream )

extern

vsf_stream_get_wbuf()

uint_fast32_t vsf_stream_get_wbuf ( vsf_stream_t * stream, uint8_t ** ptr )

extern

vsf_stream_get_rbuf()

uint_fast32_t vsf_stream_get_rbuf ( vsf_stream_t * stream, uint8_t ** ptr )

extern

vsf_stream_connect_rx()

void vsf_stream_connect_rx ( vsf_stream_t * stream )

extern

vsf_stream_connect_tx()

void vsf_stream_connect_tx ( vsf_stream_t * stream )

extern

vsf_stream_disconnect_rx()

void vsf_stream_disconnect_rx ( vsf_stream_t * stream )

extern

vsf_stream_disconnect_tx()

void vsf_stream_disconnect_tx ( vsf_stream_t * stream )

extern

vsf_stream_is_rx_connected()

bool vsf_stream_is_rx_connected ( vsf_stream_t * stream )

extern

vsf_stream_is_tx_connected()

bool vsf_stream_is_tx_connected ( vsf_stream_t * stream )

extern

vsf_stream_adapter_evthandler()

uint_fast32_t vsf_stream_adapter_evthandler ( vsf_stream_t * stream, void * param, vsf_stream_evt_t evt )

extern

vsf_stream_adapter_init()

void vsf_stream_adapter_init ( vsf_stream_adapter_t * adapter )

extern