rkhqueue.h

Go to the documentation of this file.

/*
 *  --------------------------------------------------------------------------
 *
 *                                Framework RKH
 *                                -------------
 *
 *            State-machine framework for reactive embedded systems
 *
 *                      Copyright (C) 2010 Leandro Francucci.
 *          All rights reserved. Protected by international copyright laws.
 *
 *
 *  RKH is free software: you can redistribute it and/or modify it under the
 *  terms of the GNU General Public License as published by the Free Software
 *  Foundation, either version 3 of the License, or (at your option) any
 *  later version.
 *
 *  RKH is distributed in the hope that it will be useful, but WITHOUT ANY
 *  WARRANTY; without even the implied warranty of MERCHANTABILITY or
 *  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 *  more details.
 *
 *  You should have received a copy of the GNU General Public License along
 *  with RKH, see copying.txt file.
 *
 *  Contact information:
 *  RKH web site:   http://sourceforge.net/projects/rkh-reactivesys/
 *  e-mail:         francuccilea@gmail.com
 *  ---------------------------------------------------------------------------
 */

/* -------------------------- Development history -------------------------- */
/*
 *  2017.17.05  LeFr  v2.4.05  Initial version
 */

/* -------------------------------- Authors -------------------------------- */
/*
 *  LeFr  Leandro Francucci  francuccilea@gmail.com
 */

/* --------------------------------- Notes --------------------------------- */
/* --------------------------------- Module -------------------------------- */
#ifndef __RKHQUEUE_H__
#define __RKHQUEUE_H__

/* ----------------------------- Include files ----------------------------- */
#include "rkhcfg.h"
#include "rkhtype.h"

/* ---------------------- External C language linkage ---------------------- */
#ifdef __cplusplus
extern "C" {
#endif

/* --------------------------------- Macros -------------------------------- */
#define RKH_QUEUE_IS_EMPTY(q) \
    (rbool_t)(rkh_queue_get_num((RKH_QUEUE_T *)(q)) == 0)

/* -------------------------------- Constants ------------------------------ */
/* ------------------------------- Data types ------------------------------ */
#if RKH_CFG_QUE_SIZEOF_NELEM == 8
typedef rui8_t RKH_QUENE_T;
#elif RKH_CFG_QUE_SIZEOF_NELEM == 16
typedef rui16_t RKH_QUENE_T;
#elif RKH_CFG_QUE_SIZEOF_NELEM == 32
typedef rui32_t RKH_QUENE_T;
#else
typedef rui8_t RKH_QUENE_T;
#endif

typedef enum
{
    RKH_QUE_OK, RKH_QUE_EMPTY, RKH_QUE_FULL
} RKH_QUECODE_T;

typedef struct RKH_QINFO_T
{
    rui16_t nputs;      /*  # of put requests */
    rui16_t ngets;      /*  # of get requests */
    rui16_t nreads;     /*  # of queue read requests */
    rui16_t nempty;     /*  # of queue empty retrieves */
    rui16_t nfull;      /*  # of queue full retrieves */
} RKH_QUEI_T;

typedef struct RKH_QUEUE_T
{
    RKH_QUENE_T nelems;

    RKH_QUENE_T qty;

    void **pout;

    void **pin;

    const void **pstart;

    void **pend;

    const struct RKH_SMA_T *sma;

#if RKH_CFG_QUE_GET_LWMARK_EN == RKH_ENABLED
    RKH_QUENE_T nmin;
#endif

#if RKH_CFG_QUE_GET_INFO_EN == RKH_ENABLED
    RKH_QUEI_T rqi;
#endif
} RKH_QUEUE_T;

/* -------------------------- External variables --------------------------- */
/* -------------------------- Function prototypes -------------------------- */
void rkh_queue_init(RKH_QUEUE_T *q, const void * *sstart, RKH_QUENE_T ssize,
                 void *sma);

rbool_t rkh_queue_is_full(RKH_QUEUE_T *q);

RKH_QUENE_T rkh_queue_get_num(RKH_QUEUE_T *q);

RKH_QUENE_T rkh_queue_get_lwm(RKH_QUEUE_T *q);

void *rkh_queue_get(RKH_QUEUE_T *q);

void rkh_queue_put_fifo(RKH_QUEUE_T *q, const void *pe);

void rkh_queue_put_lifo(RKH_QUEUE_T *q, const void *pe);

void rkh_queue_deplete(RKH_QUEUE_T *q);

ruint rkh_queue_read(RKH_QUEUE_T *q, void *pe);

void rkh_queue_get_info(RKH_QUEUE_T *q, RKH_QUEI_T *pqi);

void rkh_queue_clear_info(RKH_QUEUE_T *q);

/* -------------------- External C language linkage end -------------------- */
#ifdef __cplusplus
}
#endif

/* ------------------------------ Module end ------------------------------- */
#endif

/* ------------------------------ End of file ------------------------------ */