rkhfwk_rdygrp.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 site: http://vortexmakes.com/que-es/
 *  RKH GitHub: https://github.com/vortexmakes/RKH
 *  RKH Sourceforge: https://sourceforge.net/projects/rkh-reactivesys/
 *  e-mail: lf@vortexmakes.com
 *  ---------------------------------------------------------------------------
 */
 
/* -------------------------- Development history -------------------------- */
/*
 *  2018.08.07  LeFr  v3.1.00  Initial version
 */
 
/* -------------------------------- Authors -------------------------------- */
/*
 *  LeFr  Leandro Francucci  lf@vortexmakes.com
 */
 
/* --------------------------------- Notes --------------------------------- */
/* --------------------------------- Module -------------------------------- */
#ifndef __RKHFWK_RDYGRP_H__
#define __RKHFWK_RDYGRP_H__
 
/* ----------------------------- Include files ----------------------------- */
#include "rkhitl.h"
 
/* ---------------------- External C language linkage ---------------------- */
#ifdef __cplusplus
extern "C" {
#endif
 
/* --------------------------------- Macros -------------------------------- */
/* -------------------------------- Constants ------------------------------ */
#if RKH_CFG_FWK_MAX_SMA <= 8
    #define RKH_NUM_RDYGRP      1
#elif RKH_CFG_FWK_MAX_SMA > 8 && RKH_CFG_FWK_MAX_SMA <= 16
    #define RKH_NUM_RDYGRP      2
#elif RKH_CFG_FWK_MAX_SMA > 16 && RKH_CFG_FWK_MAX_SMA <= 24
    #define RKH_NUM_RDYGRP      3
#elif RKH_CFG_FWK_MAX_SMA > 24 && RKH_CFG_FWK_MAX_SMA <= 32
    #define RKH_NUM_RDYGRP      4
#elif RKH_CFG_FWK_MAX_SMA > 32 && RKH_CFG_FWK_MAX_SMA <= 40
    #define RKH_NUM_RDYGRP      5
#elif RKH_CFG_FWK_MAX_SMA > 40 && RKH_CFG_FWK_MAX_SMA <= 48
    #define RKH_NUM_RDYGRP      6
#elif RKH_CFG_FWK_MAX_SMA > 48 && RKH_CFG_FWK_MAX_SMA <= 56
    #define RKH_NUM_RDYGRP      7
#elif RKH_CFG_FWK_MAX_SMA > 56 && RKH_CFG_FWK_MAX_SMA <= 64
    #define RKH_NUM_RDYGRP      8
#endif
 
/* ------------------------------- Data types ------------------------------ */
typedef struct
{
    rui8_t grp;
 
    rui8_t tbl[RKH_NUM_RDYGRP];
} RKHRdyGrp;
 
typedef struct RdyCbArg RdyCbArg;
struct RdyCbArg
{
    rui8_t aoRdyPrio;
};
 
/* -------------------------- External variables --------------------------- */
/* -------------------------- Function prototypes -------------------------- */
void rkh_rdygrp_init(RKHRdyGrp *const me);
 
rbool_t rkh_rdygrp_isReady(RKHRdyGrp *const me);
 
void rkh_rdygrp_setReady(RKHRdyGrp *const me, rui8_t prio);
 
void rkh_rdygrp_setUnready(RKHRdyGrp *const me, rui8_t prio);
 
rui8_t rkh_rdygrp_findHighest(RKHRdyGrp *const me);
 
rui8_t rkh_rdygrp_traverse(RKHRdyGrp *const me, void (*rdyCb)(RdyCbArg *), 
                           RdyCbArg *rdyCbArg);
 
/* -------------------- External C language linkage end -------------------- */
#ifdef __cplusplus
}
#endif
 
/* ------------------------------ Module end ------------------------------- */
#endif
 
/* ------------------------------ End of file ------------------------------ */