vsf_pbuf_queue.h

Go to the documentation of this file.

/*****************************************************************************
 *   Copyright(C)2009-2022 by VSF Team                                       *
 *                                                                           *
 *  Licensed under the Apache License, Version 2.0 (the "License");          *
 *  you may not use this file except in compliance with the License.         *
 *  You may obtain a copy of the License at                                  *
 *                                                                           *
 *     http://www.apache.org/licenses/LICENSE-2.0                            *
 *                                                                           *
 *  Unless required by applicable law or agreed to in writing, software      *
 *  distributed under the License is distributed on an "AS IS" BASIS,        *
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
 *  See the License for the specific language governing permissions and      *
 *  limitations under the License.                                           *
 *                                                                           *
 ****************************************************************************/
 
#ifndef __VSF_PBUF_QUEUE_H__
#define __VSF_PBUF_QUEUE_H__
 
/*============================ INCLUDES ======================================*/
#include "service/vsf_service_cfg.h"
 
#if VSF_USE_STREAM == ENABLED
 
#include "../interface.h"
 
#include "../pbuf/vsf_pbuf.h"
 
#define __PLOOC_CLASS_USE_STRICT_TEMPLATE__
 
#if     defined(__VSF_PBUF_QUEUE_CLASS_IMPLEMENT)
#   define __PLOOC_CLASS_IMPLEMENT__
#   undef __VSF_PBUF_QUEUE_CLASS_IMPLEMENT
#elif   defined(__VSF_PBUF_QUEUE_CLASS_INHERIT__)
#   define __PLOOC_CLASS_INHERIT__
#   undef __VSF_PBUF_QUEUE_CLASS_INHERIT__
#endif
 
#include "utilities/ooc_class.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*============================ MACROS ========================================*/
/*============================ MACROFIED FUNCTIONS ===========================*/
/*============================ TYPES =========================================*/
 
declare_class(vsf_stream_fifo_t)
 
typedef struct vsf_stream_fifo_cfg_t {
    vsf_stream_dat_rdy_evt_t        tDataReadyEventHandling;
    vsf_stream_dat_drn_evt_t        tDataDrainEventHandling;
    struct {
        uint32_t                    : 16;
        uint32_t                    chDataReadyThreshold : 8;
        uint32_t                    chDataDrainThreshold : 8;
    };
#if !defined(VSF_PBUF_QUEUE_CFG_ATOM_ACCESS)
    vsf_protect_region_t *pregion;         
#endif
}vsf_stream_fifo_cfg_t;
 
 
def_class(vsf_stream_fifo_t,
    which(
        vsf_stream_tx_t TX;
        vsf_stream_rx_t RX;
    ),
    private_member(
        implement(vsf_slist_queue_t)
        union {
            vsf_stream_fifo_cfg_t cfg;
            struct {
                vsf_stream_dat_rdy_evt_t    tDataReadyEventHandling;
                vsf_stream_dat_drn_evt_t    tDataDrainEventHandling;
 
                vsf_stream_status_t Status;
 
        #if !defined(VSF_PBUF_QUEUE_CFG_ATOM_ACCESS)
                vsf_protect_region_t *pregion;     
        #endif
            };
        };
    )
)
 
end_def_class(vsf_stream_fifo_t)
 
 
/*============================ GLOBAL VARIABLES ==============================*/
/*============================ PROTOTYPES ====================================*/
extern
vsf_err_t vsf_stream_fifo_init( vsf_stream_fifo_t *obj_ptr,
                                vsf_stream_fifo_cfg_t *cfg_ptr);
 
extern
vsf_err_t vsf_pbuf_queue_enqueue(vsf_stream_fifo_t *obj_ptr, vsf_pbuf_t *pblock);
 
extern
vsf_pbuf_t * vsf_pbuf_queue_dequeue(vsf_stream_fifo_t *obj_ptr);
 
VSF_CAL_SECTION(".text.vsf.service.stream.pbuf_queue.vsf_pbuf_queue_peek")
extern
vsf_pbuf_t * vsf_pbuf_queue_peek(vsf_stream_fifo_t *obj_ptr);
 
extern
vsf_err_t vsf_pbuf_queue_data_available_event_register(
    vsf_stream_fifo_t *obj_ptr, vsf_stream_dat_rdy_evt_t tEventHandling);
 
extern
vsf_err_t vsf_pbuf_queue_data_drain_event_register(
    vsf_stream_fifo_t *obj_ptr, vsf_stream_dat_drn_evt_t tEventHandling);
 
#ifdef __cplusplus
}
#endif
 
#endif
#endif
/* EOF */