vsf_fifo_stream.h File Reference

#include "service/vsf_service_cfg.h"
#include "utilities/ooc_class.h"

Go to the source code of this file.

Data Structures
class	vsf_byte_fifo_t
class	vsf_fifo_stream_t

Macros
#define	vsf_fifo_stream_size_t   uint32_t
#define	__VSF_FIFO_STREAM_INIT(__BUFFER, __SIZE)
#define	VSF_FIFO_STREAM_INIT(__BUFFER, __SIZE)    __VSF_FIFO_STREAM_INIT((__BUFFER), (__SIZE))
#define	__vsf_fifo_stream_type(__name)   __name##_fifo_stream_t
#define	vsf_fifo_stream_type(__name)   __vsf_fifo_stream_type(__name)
#define	__declare_fifo_stream(__name)    vsf_dcl_class(vsf_fifo_stream_type(__name))
#define	__define_fifo_stream(__name, __size)
#define	declare_fifo_stream(__name)    __declare_fifo_stream(__name)
#define	dcl_fifo_stream(__name)    declare_fifo_stream(__name)
#define	define_fifo_stream(__name, __size)    __define_fifo_stream(__name, (__size))
#define	def_fifo_stream(__name, __size)    define_fifo_stream(__name, (__size))
#define	__describe_fifo_stream(__name, __size)
#define	describe_fifo_stream(__name, __size)    __describe_fifo_stream(__name, (__size))

Functions
vsf_err_t	vsf_byte_fifo_init (vsf_byte_fifo_t *fifo)
uint_fast32_t	vsf_byte_fifo_write (vsf_byte_fifo_t *fifo, uint8_t *data, uint_fast32_t size)
uint_fast32_t	vsf_byte_fifo_read (vsf_byte_fifo_t *fifo, uint8_t *data, uint_fast32_t size)
uint_fast32_t	vsf_byte_fifo_peek (vsf_byte_fifo_t *fifo, uint8_t *data, uint_fast32_t size)
uint_fast32_t	vsf_byte_fifo_get_wbuf (vsf_byte_fifo_t *fifo, uint8_t **data)
uint_fast32_t	vsf_byte_fifo_get_rbuf (vsf_byte_fifo_t *fifo, uint8_t **data)
uint_fast32_t	vsf_byte_fifo_get_buff_length (vsf_byte_fifo_t *fifo)
uint_fast32_t	vsf_byte_fifo_get_data_length (vsf_byte_fifo_t *fifo)
uint_fast32_t	vsf_byte_fifo_get_avail_length (vsf_byte_fifo_t *fifo)

Variables
const vsf_stream_op_t	vsf_fifo_stream_op

Macro Definition Documentation

vsf_fifo_stream_size_t

#define vsf_fifo_stream_size_t   uint32_t

__VSF_FIFO_STREAM_INIT

#define __VSF_FIFO_STREAM_INIT	(		__BUFFER,
			__SIZE
	)

Value:

            .op                 = &vsf_fifo_stream_op,                          \
            .buffer             = (__BUFFER),                                   \
            .size               = (__SIZE),

VSF_FIFO_STREAM_INIT

#define VSF_FIFO_STREAM_INIT	(		__BUFFER,
			__SIZE
	)		__VSF_FIFO_STREAM_INIT((__BUFFER), (__SIZE))

__vsf_fifo_stream_type

#define __vsf_fifo_stream_type

(

__name

)

__name##_fifo_stream_t

vsf_fifo_stream_type

#define vsf_fifo_stream_type

(

__name

)

__vsf_fifo_stream_type(__name)

__declare_fifo_stream

#define __declare_fifo_stream

(

__name

)

vsf_dcl_class(vsf_fifo_stream_type(__name))

__define_fifo_stream

#define __define_fifo_stream	(		__name,
			__size
	)

Value:

            vsf_class(vsf_fifo_stream_type(__name)) {                           \
                public_member(                                                  \
                    implement(vsf_fifo_stream_t)                                \
                    uint8_t __buffer[__size];                                   \
                )                                                               \
            };

declare_fifo_stream

#define declare_fifo_stream

(

__name

)

__declare_fifo_stream(__name)

dcl_fifo_stream

#define dcl_fifo_stream

(

__name

)

declare_fifo_stream(__name)

define_fifo_stream

#define define_fifo_stream	(		__name,
			__size
	)		__define_fifo_stream(__name, (__size))

def_fifo_stream

#define def_fifo_stream	(		__name,
			__size
	)		define_fifo_stream(__name, (__size))

__describe_fifo_stream

#define __describe_fifo_stream	(		__name,
			__size
	)

Value:

            declare_fifo_stream(__name)                                         \
            define_fifo_stream(__name, (__size))                                \
            vsf_fifo_stream_type(__name) __name = {                             \
                VSF_FIFO_STREAM_INIT(__name.__buffer, (__size))                 \
            };

describe_fifo_stream

#define describe_fifo_stream	(		__name,
			__size
	)		__describe_fifo_stream(__name, (__size))

Function Documentation

vsf_byte_fifo_init()

vsf_err_t vsf_byte_fifo_init ( vsf_byte_fifo_t *  fifo )

extern

vsf_byte_fifo_write()

uint_fast32_t vsf_byte_fifo_write ( vsf_byte_fifo_t *  fifo, uint8_t *  data, uint_fast32_t  size  )

extern

vsf_byte_fifo_read()

uint_fast32_t vsf_byte_fifo_read ( vsf_byte_fifo_t *  fifo, uint8_t *  data, uint_fast32_t  size  )

extern

vsf_byte_fifo_peek()

uint_fast32_t vsf_byte_fifo_peek ( vsf_byte_fifo_t *  fifo, uint8_t *  data, uint_fast32_t  size  )

extern

vsf_byte_fifo_get_wbuf()

uint_fast32_t vsf_byte_fifo_get_wbuf ( vsf_byte_fifo_t *  fifo, uint8_t **  data  )

extern

vsf_byte_fifo_get_rbuf()

uint_fast32_t vsf_byte_fifo_get_rbuf ( vsf_byte_fifo_t *  fifo, uint8_t **  data  )

extern

vsf_byte_fifo_get_buff_length()

uint_fast32_t vsf_byte_fifo_get_buff_length ( vsf_byte_fifo_t *  fifo )

extern

vsf_byte_fifo_get_data_length()

uint_fast32_t vsf_byte_fifo_get_data_length ( vsf_byte_fifo_t *  fifo )

extern

vsf_byte_fifo_get_avail_length()

uint_fast32_t vsf_byte_fifo_get_avail_length ( vsf_byte_fifo_t *  fifo )

extern

Variable Documentation

vsf_fifo_stream_op

const vsf_stream_op_t vsf_fifo_stream_op

extern