RKH
rkhsma_prio.h
Go to the documentation of this file.
1 /*
2  * --------------------------------------------------------------------------
3  *
4  * Framework RKH
5  * -------------
6  *
7  * State-machine framework for reactive embedded systems
8  *
9  * Copyright (C) 2010 Leandro Francucci.
10  * All rights reserved. Protected by international copyright laws.
11  *
12  *
13  * RKH is free software: you can redistribute it and/or modify it under the
14  * terms of the GNU General Public License as published by the Free Software
15  * Foundation, either version 3 of the License, or (at your option) any
16  * later version.
17  *
18  * RKH is distributed in the hope that it will be useful, but WITHOUT ANY
19  * WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
21  * more details.
22  *
23  * You should have received a copy of the GNU General Public License along
24  * with RKH, see copying.txt file.
25  *
26  * Contact information:
27  * RKH web site: http://sourceforge.net/projects/rkh-reactivesys/
28  * e-mail: francuccilea@gmail.com
29  * ---------------------------------------------------------------------------
30  */
31 
39 /* -------------------------- Development history -------------------------- */
40 /*
41  * 2017.05.15 LeFr v2.4.05 ---
42  */
43 
44 /* -------------------------------- Authors -------------------------------- */
45 /*
46  * LeFr Leandro Francucci francuccilea@gmail.com
47  */
48 
49 /* --------------------------------- Notes --------------------------------- */
50 /* --------------------------------- Module -------------------------------- */
51 #ifndef __RKHSMA_PRIO_H__
52 #define __RKHSMA_PRIO_H__
53 
54 /* ----------------------------- Include files ----------------------------- */
55 #include "rkhcfg.h"
56 #include "rkhtype.h"
57 
58 /* ---------------------- External C language linkage ---------------------- */
59 #ifdef __cplusplus
60 extern "C" {
61 #endif
62 
63 /* --------------------------------- Macros -------------------------------- */
68 void rkh_smaPrio_init(void);
69 
74 rbool_t rkh_smaPrio_isNotReady(void);
75 
80 rbool_t rkh_smaPrio_isReady(void);
81 
92 void rkh_smaPrio_setReady(rui8_t prio);
93 
104 void rkh_smaPrio_setUnready(rui8_t prio);
105 
117 rui8_t rkh_smaPrio_findHighest(void);
118 
119 /* -------------------------------- Constants ------------------------------ */
120 /* ------------------------------- Data types ------------------------------ */
121 /* -------------------- External C language linkage end -------------------- */
122 #ifdef __cplusplus
123 }
124 #endif
125 
126 /* ------------------------------ Module end ------------------------------- */
127 #endif
128 
129 /* ------------------------------ End of file ------------------------------ */
rkh_smaPrio_setUnready
void rkh_smaPrio_setUnready(rui8_t prio)
Removing an active object from the ready list.
rkhcfg.h
RKH user configurations.
rkh_smaPrio_isNotReady
rbool_t rkh_smaPrio_isNotReady(void)
Evaluates to true if all active objects are not ready to run.
rkh_smaPrio_findHighest
rui8_t rkh_smaPrio_findHighest(void)
Finding the highest priority active object ready to run.
rkh_smaPrio_init
void rkh_smaPrio_init(void)
Initializes the native priority mechanism for active object scheduling.
rkh_smaPrio_isReady
rbool_t rkh_smaPrio_isReady(void)
Evaluates to true if any active object is ready to run.
rkh_smaPrio_setReady
void rkh_smaPrio_setReady(rui8_t prio)
Making an active object ready-to-run inserting it into the ready list.
rkhtype.h
Defines the data types that uses RKH.