VSF Documented
vsf_task.h
Go to the documentation of this file.
1/*****************************************************************************
2 * Copyright(C)2009-2022 by VSF Team *
3 * *
4 * Licensed under the Apache License, Version 2.0 (the "License"); *
5 * you may not use this file except in compliance with the License. *
6 * You may obtain a copy of the License at *
7 * *
8 * http://www.apache.org/licenses/LICENSE-2.0 *
9 * *
10 * Unless required by applicable law or agreed to in writing, software *
11 * distributed under the License is distributed on an "AS IS" BASIS, *
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
13 * See the License for the specific language governing permissions and *
14 * limitations under the License. *
15 * *
16 ****************************************************************************/
17
18#ifndef __VSF_KERNEL_TASK_H__
19#define __VSF_KERNEL_TASK_H__
20
21/*============================ INCLUDES ======================================*/
22
23#include "./kernel/vsf_kernel_cfg.h"
24
25#if VSF_USE_KERNEL == ENABLED && VSF_KERNEL_CFG_EDA_SUPPORT_TASK == ENABLED
26
27#include "service/vsf_service.h"
28#include "../vsf_eda.h"
29#include "./vsf_pt.h"
30#include "./vsf_fsm.h"
31
32#ifdef __cplusplus
33extern "C" {
34#endif
35
36/*============================ MACROS ========================================*/
37/*============================ MACROFIED FUNCTIONS ===========================*/
38
39#define __vsf_task_func(__name) vsf_task_func_##__name
40#define vsf_task_func(__name) __vsf_task_func(__name)
41
42#define __vsf_task(__name) task_cb_##__name
43#define vsf_task(__name) __vsf_task(__name)
44
45#if VSF_KERNEL_CFG_EDA_SUBCALL_HAS_RETURN_VALUE == ENABLED
46# define __implement_vsf_task(__name) \
47 fsm_rt_t vsf_task_func(__name)( uintptr_t local, \
48 vsf_evt_t evt) \
49 { \
50 vsf_task(__name) *vsf_pthis = \
51 *(vsf_task(__name) **) \
52 ((uintptr_t)local - sizeof(uintptr_t));
53
54# define vsf_task_begin()
55
56# define vsf_task_end() \
57 } return fsm_rt_on_going;
58
59# define vsf_task_state (vsf_this.fsm_state)
60
61#else
62# define __implement_vsf_task(__name) \
63 void vsf_task_func(__name)(__name *obj_ptr, vsf_evt_t evt) \
64 { \
65 vsf_task(__name) *vsf_pthis = &(obj_ptr->param);
66
67# define vsf_task_begin()
68# define vsf_task_end() } __vsf_eda_yield();
69
70# define vsf_task_state (vsf_this.fsm_state)
71#endif
72
73#define implement_vsf_task(__name) __implement_vsf_task(__name)
74#define imp_vsf_task(__name) implement_vsf_task(__name)
75
76#if VSF_KERNEL_CFG_EDA_SUPPORT_TIMER == ENABLED
77# define vsf_task_start vsf_teda_start
78#else
79# define vsf_task_start vsf_eda_start
80#endif
81
82#if VSF_KERNEL_CFG_EDA_SUBCALL_HAS_RETURN_VALUE == ENABLED
83# define __def_vsf_task(__name,...) \
84 struct task_cb_##__name { \
85 uint8_t fsm_state; \
86 __VA_ARGS__ \
87 }; \
88 struct __name { \
89 implement(vsf_task_t); \
90 implement_ex(task_cb_##__name, param); \
91 }; \
92 extern fsm_rt_t vsf_task_func_##__name( uintptr_t local, \
93 vsf_evt_t evt);
94
95#else
96# define __def_vsf_task(__name,...) \
97 typedef struct task_cb_##__name { \
98 uint8_t fsm_state; \
99 __VA_ARGS__ \
100 } task_cb_##__name; \
101 typedef struct __name { \
102 implement(vsf_task_t); \
103 implement_ex(task_cb_##__name, param); \
104 } __name; \
105 extern void vsf_task_func_##__name(struct __name *vsf_pthis, vsf_evt_t evt);
106#endif
107
108#define def_vsf_task(__name,...) __def_vsf_task(__name,__VA_ARGS__)
109#define define_vsf_task(__name,...) def_vsf_task(__name,__VA_ARGS__)
110#define end_def_vsf_task(...)
111#define end_define_vsf_task(...)
112
113#define __declare_vsf_task(__name) \
114 typedef struct __name __name; \
115 typedef struct task_cb_##__name task_cb_##__name;
116
117#define declare_vsf_task(__name) __declare_vsf_task(__name)
118#define dcl_vsf_task(__name) declare_vsf_task(__name)
119
120#define prepare_vsf_task(__name, __task) \
121 do {(__task)->fsm_state = 0; } while(0)
122
123#define prp_vsf_task(__name, __task) prepare_vsf_task(__name, __task)
124
125#if VSF_KERNEL_CFG_EDA_SUBCALL_HAS_RETURN_VALUE == ENABLED
126# define __init_vsf_task(__name, __task, __pri, ...) \
127 do { \
128 vsf_eda_cfg_t VSF_MACRO_SAFE_NAME(cfg) = { \
129 .fn.func = (uintptr_t)vsf_task_func(__name), \
130 .priority = (__pri), \
131 .target = (uintptr_t)&((__task)->param), \
132 .feature.is_subcall_has_return_value = true, \
133 __VA_ARGS__ \
134 }; \
135 prepare_vsf_task(__name, &((__task)->param)); \
136 vsf_task_start(&((__task)->use_as__vsf_task_t), \
137 &VSF_MACRO_SAFE_NAME(cfg)); \
138 } while(0)
139#else
140# define __init_vsf_task(__name, __task, __pri, ...) \
141 do { \
142 vsf_eda_cfg_t VSF_MACRO_SAFE_NAME(cfg) = { \
143 .fn.evthandler = (vsf_task_entry_t)vsf_task_func(__name), \
144 .priority = (__pri), \
145 .target = NULL, \
146 __VA_ARGS__ \
147 }; \
148 prepare_vsf_task(__name, &((__task)->param)); \
149 vsf_task_start(&((__task)->use_as__vsf_task_t), \
150 &VSF_MACRO_SAFE_NAME(cfg)); \
151 } while(0)
152#endif
153
154#define init_vsf_task(__name, __task, __pri, ...) \
155 __init_vsf_task(__name, (__task), (__pri), __VA_ARGS__)
156
157
158#if VSF_KERNEL_CFG_EDA_SUBCALL_HAS_RETURN_VALUE == ENABLED
159#define vsf_task_call_task(__name, __target, ...) \
160 __vsf_eda_call_task((vsf_task_entry_t)vsf_task_func(__name), \
161 (uintptr_t)(__target), (0, ##__VA_ARGS__))
162#endif
163
164#if VSF_KERNEL_CFG_EDA_SUBCALL_HAS_RETURN_VALUE == ENABLED
165# define vsf_task_call_sub(__name, __target, ...) \
166 if (VSF_ERR_NONE != __vsf_eda_call_eda( \
167 (vsf_task_entry_t)(__name), \
168 (__target), \
169 (0, ##__VA_ARGS))) { \
170 return fsm_rt_on_going; \
171 }
172# define vsf_eda_call_task vsf_task_call_task
173
174#elif VSF_KERNEL_CFG_EDA_SUPPORT_SUB_CALL == ENABLED
175# define vsf_task_call_sub(__name, __target, ...) \
176 if (VSF_ERR_NONE != __vsf_eda_call_eda( \
177 (vsf_task_entry_t)(__name), \
178 (__target), \
179 (0, ##__VA_ARGS))) { \
180 return ; \
181 }
182# define vsf_eda_call_task(__name, __target) \
183 vsf_eda_call_sub((vsf_task_entry_t)vsf_task_func(__name), (__target))
184#endif
185
186
187#if VSF_KERNEL_CFG_EDA_SUPPORT_SUB_CALL == ENABLED
188#define vsf_task_call_pt(__name, __target) \
189 vsf_task_call_sub(vsf_pt_func(__name), __target)
190#endif
191
192#define on_vsf_task_init() \
193 if (VSF_EVT_INIT == evt)
194
195#define on_vsf_task_fini() \
196 if (VSF_EVT_FINI == evt)
197
198#define on_vsf_task_evt(__evt) \
199 if ((__evt) == evt)
200
201
219#if VSF_KERNEL_CFG_EDA_SUBCALL_HAS_RETURN_VALUE == ENABLED
220# define vsf_task_wait_until(...) \
221 __VA_ARGS__ {} else { \
222 return fsm_rt_wait_for_evt; \
223 }
224
225#else
226# define vsf_task_wait_until(...) \
227 __VA_ARGS__ {} else { \
228 return ; \
229 }
230#endif
231
232/*============================ TYPES =========================================*/
233
234# if VSF_KERNEL_CFG_EDA_SUPPORT_TIMER == ENABLED
235typedef vsf_teda_t vsf_task_t;
236# else
237typedef vsf_eda_t vsf_task_t;
238# endif
239
240#if VSF_KERNEL_CFG_EDA_SUBCALL_HAS_RETURN_VALUE == ENABLED
241typedef fsm_rt_t (*vsf_task_entry_t)(uintptr_t target, vsf_evt_t evt);
242#else
243typedef vsf_eda_evthandler_t vsf_task_entry_t;
244#endif
245
246/*============================ GLOBAL VARIABLES ==============================*/
247/*============================ LOCAL VARIABLES ===============================*/
248/*============================ PROTOTYPES ====================================*/
249
250#if VSF_KERNEL_CFG_EDA_SUPPORT_SUB_CALL == ENABLED
251# if VSF_KERNEL_CFG_EDA_SUBCALL_HAS_RETURN_VALUE == ENABLED
252VSF_CAL_SECTION(".text.vsf.kernel.eda_task")
253extern fsm_rt_t __vsf_eda_call_task(vsf_task_entry_t entry,
254 uintptr_t param,
255 size_t local_size);
256# endif // VSF_KERNEL_CFG_EDA_SUBCALL_HAS_RETURN_VALUE
257#endif // VSF_KERNEL_CFG_EDA_SUPPORT_SUB_CALL
258
259#ifdef __cplusplus
260}
261#endif
262
263#endif
264#endif
265/* EOF */
VSF_CAL_SECTION
#define VSF_CAL_SECTION(__SEC)
Definition __compiler.h:181
vsf_eda_t
Definition vsf_eda.h:766
vsf_teda_t
Definition vsf_eda.h:834
uintptr_t
uint32_t uintptr_t
Definition stdint.h:38
vsf_evt_t
int16_t vsf_evt_t
Definition vsf_eda.h:654
vsf_eda_evthandler_t
void(* vsf_eda_evthandler_t)(vsf_eda_t *eda, vsf_evt_t evt)
Definition vsf_eda.h:656
vsf_fsm.h
fsm_rt_t
fsm_rt_t
Definition vsf_fsm.h:315
vsf_kernel_cfg.h
vsf_pt.h
vsf_service.h
vsf_task_entry_t
fsm_rt_t(* vsf_task_entry_t)(uintptr_t target, vsf_evt_t evt)
Definition vsf_task.h:241
vsf_task_t
vsf_teda_t vsf_task_t
Definition vsf_task.h:235
__vsf_eda_call_task
fsm_rt_t __vsf_eda_call_task(vsf_task_entry_t entry, uintptr_t param, size_t local_size)
Definition vsf_task.c:49
Generated by doxygen 1.9.8