VSF Documented
vsf_pt.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_PT_H__
19#define __VSF_PT_H__
20
21/*============================ INCLUDES ======================================*/
22#include "./kernel/vsf_kernel_cfg.h"
23
24#if VSF_KERNEL_CFG_EDA_SUPPORT_PT == ENABLED && VSF_USE_KERNEL == ENABLED
25#include "../vsf_eda.h"
26#include "./__vsf_task_common.h"
27
28#ifdef __cplusplus
29extern "C" {
30#endif
31
32/*============================ MACROS ========================================*/
33/*============================ MACROFIED FUNCTIONS ===========================*/
34
35
36#if VSF_KERNEL_CFG_EDA_SUPPORT_SUB_CALL == ENABLED
37# define __implement_vsf_pt(__name) \
38 __implement_vsf_pt_common(__name, uintptr_t local) \
39 { \
40 __vsf_pt_common(__name) *vsf_pthis = \
41 *(__vsf_pt_common(__name) **) \
42 ((uintptr_t)local - sizeof(uintptr_t));
43
44# define __implement_vsf_pt_ex(__name, __func_name) \
45 __implement_vsf_pt_common( __func_name, uintptr_t local) \
46 { \
47 __vsf_pt_common(__name) *vsf_pthis = \
48 *(__vsf_pt_common(__name) **) \
49 ((uintptr_t)local - sizeof(uintptr_t));
50
51#else
52
53# define __implement_vsf_pt(__name) \
54 __implement_vsf_pt_common(__name, __name *obj_ptr) { \
55 __vsf_pt_common(__name) *vsf_pthis = &(obj_ptr->param);
56
57# define __implement_vsf_pt_ex(__name, __func_name) \
58 __implement_vsf_pt_common(__func_name, __name *obj_ptr) { \
59 __vsf_pt_common(__name) *vsf_pthis = &(obj_ptr->param);
60#endif
61
62#define __vsf_pt_state() (vsf_this.fsm_state)
63#define __vsf_pt_end() __vsf_pt_end_common()
64
65
66#define __vsf_pt_entry(__state, ...) \
67 __vsf_pt_entry_common(__state, __VA_ARGS__)
68#define vsf_pt_entry(...) \
69 __vsf_pt_entry(__vsf_pt_state(), __VA_ARGS__)
70
71#define __vsf_pt_begin(__state) __vsf_pt_begin_common(__state)
72
73
74#define vsf_pt_begin() VSF_UNUSED_PARAM(evt); \
75 __vsf_pt_begin(__vsf_pt_state())
76
77#define vsf_pt_end() __vsf_pt_end() }
78
79#define vsf_pt_wait_for_evt(__evt) __vsf_pt_wfe_common(__vsf_pt_state(), __evt)
80#define vsf_pt_wfe(__evt) vsf_pt_wait_for_evt(__evt)
81
82#define vsf_pt_yield() vsf_pt_entry(__vsf_eda_yield();)
83
84#if VSF_KERNEL_CFG_EDA_FAST_SUB_CALL == ENABLED
85# define vsf_pt_raw_next() __vsf_pt_raw_next_common(__vsf_pt_state())
86# define vsf_pt_raw_entry(...) __vsf_pt_raw_entry_common(__vsf_pt_state(), __VA_ARGS__)
87#endif
88
100#define vsf_pt_wait_until(...) \
101 vsf_pt_entry(); \
102 __VA_ARGS__ {} else { \
103 return ; \
104 }
105
106#if VSF_KERNEL_CFG_EDA_SUPPORT_SUB_CALL == ENABLED
107# define __vsf_pt_call_sub(__name, __target, ...) \
108 __vsf_eda_call_eda( (uintptr_t)(__name), \
109 (uintptr_t)(__target), \
110 (0, ##__VA_ARGS__))
111
112# if VSF_KERNEL_CFG_EDA_FAST_SUB_CALL == ENABLED
113# define vsf_pt_call_sub(__name, __target) \
114 vsf_pt_raw_next(); \
115 vsf_err_t VSF_MACRO_SAFE_NAME(ret) = \
116 __vsf_pt_call_sub(__name, (__target)); \
117 VSF_KERNEL_ASSERT(VSF_ERR_NONE == VSF_MACRO_SAFE_NAME(ret)); \
118 return ; \
119 vsf_pt_raw_entry();
120# else
121# define vsf_pt_call_sub(__name, __target) \
122 vsf_pt_entry(); \
123 if (VSF_ERR_NONE != __vsf_pt_call_sub(__name, (__target))) { \
124 return ; \
125 } \
126 vsf_pt_entry(return;);
127#endif
128
129
130# define vsf_pt_call_pt(__name, __target) \
131 (__target)->fsm_state = 0; \
132 vsf_pt_call_sub(vsf_pt_func(__name), (__target))
133
134#endif
135
136#define vsf_eda_call_pt(__name, __target) \
137 __vsf_pt_call_sub(vsf_pt_func(__name), (__target))
138
139#if VSF_KERNEL_CFG_EDA_SUBCALL_HAS_RETURN_VALUE == ENABLED
140# define __vsf_pt_call_task(__name, __target, ...) \
141 __vsf_eda_call_task((vsf_task_entry_t)(__name), \
142 (uintptr_t)(__target), \
143 (0, ##__VA_ARGS__))
144
145
146# define vsf_pt_call_task(__name, __target, __ret_addr, ...) \
147 do { \
148 fsm_rt_t VSF_MCONNECT3(__vsf_pt_call_task,__LINE__,tReturn); \
149 vsf_pt_entry(); \
150 VSF_MCONNECT3(__vsf_pt_call_task,__LINE__,tReturn) = \
151 __vsf_pt_call_task(vsf_task_func(__name), (__target), (0, ##__VA_ARGS__));\
152 if (fsm_rt_on_going == \
153 VSF_MCONNECT3(__vsf_pt_call_task,__LINE__,tReturn)) { \
154 return ; \
155 } \
156 if (NULL != (__ret_addr)) { \
157 *(__ret_addr) = \
158 VSF_MCONNECT3(__vsf_pt_call_task,__LINE__,tReturn); \
159 } \
160 } while(0)
161#endif
162
163#if VSF_KERNEL_CFG_EDA_SUPPORT_TIMER == ENABLED
164# define vsf_pt_start vsf_teda_start
165#else
166# define vsf_pt_start vsf_eda_start
167#endif
168
169
170
171#define implement_vsf_pt(__name) __implement_vsf_pt(__name)
172#define implement_vsf_pt_ex(__name, __FUNC_NAME) \
173 __implement_vsf_pt_ex(__name, __FUNC_NAME)
174
175#define imp_vsf_pt(__name) implement_vsf_pt(__name)
176#define imp_vsf_pt_ex(__name, __FUNC_NAME) \
177 implement_vsf_pt_ex(__name, __FUNC_NAME)
178
179#define __vsf_pt_func(__name) __vsf_pt_func_common(__name)
180#define vsf_pt_func(__name) __vsf_pt_func(__name)
181
182#define __vsf_pt(__name) __vsf_pt_common(__name)
183#define vsf_pt(__name) __vsf_pt(__name)
184
185#define __def_vsf_pt(__name,...) \
186 __def_vsf_pt_common(__name, \
187 uint8_t fsm_state; \
188 __VA_ARGS__)
189
190#define def_vsf_pt(__name,...) __def_vsf_pt(__name,__VA_ARGS__)
191#define end_def_vsf_pt(...)
192#define define_vsf_pt(__name,...) def_vsf_pt(__name,__VA_ARGS__)
193#define end_define_vsf_pt(...)
194
195
196
197#if VSF_KERNEL_CFG_EDA_SUPPORT_SUB_CALL == ENABLED
198# define __declare_vsf_pt(__name) \
199 __declare_vsf_pt_common(__name) \
200 __extern_vsf_pt_common(__name, uintptr_t local)
201#else
202# define __declare_vsf_pt(__name) \
203 __declare_vsf_pt_common(__name) \
204 __extern_vsf_pt_common(__name, __name *vsf_pthis)
205#endif
206
207#define declare_vsf_pt(__name) __declare_vsf_pt(__name)
208#define dcl_vsf_pt(__name) declare_vsf_pt(__name)
209
210#define __init_vsf_pt(__name, __pt, __pri, ...) \
211 do { \
212 vsf_eda_cfg_t VSF_MACRO_SAFE_NAME(cfg) = { \
213 .fn.evthandler = (vsf_pt_entry_t)__vsf_pt_func(__name), \
214 .priority = (__pri), \
215 .target = (uintptr_t)&((__pt)->param), \
216 __VA_ARGS__ \
217 }; \
218 (__pt)->param.fsm_state = 0; \
219 vsf_pt_start(&((__pt)->use_as__vsf_pt_t), \
220 &VSF_MACRO_SAFE_NAME(cfg)); \
221 } while(0)
222
223
224
225#if VSF_KERNEL_CFG_SUPPORT_THREAD == ENABLED \
226 && VSF_KERNEL_CFG_EDA_SUPPORT_SUB_CALL == ENABLED
227
228# if VSF_KERNEL_CFG_EDA_FAST_SUB_CALL == ENABLED
229# define vsf_pt_call_thread(__name, __target) \
230 vsf_eda_call_thread_prepare(__name, __target); \
231 vsf_pt_raw_next(); \
232 vsf_err_t VSF_MACRO_SAFE_NAME(ret) = \
233 vsf_eda_call_thread(__target); \
234 VSF_KERNEL_ASSERT(VSF_ERR_NONE == VSF_MACRO_SAFE_NAME(ret)); \
235 return ; \
236 vsf_pt_raw_entry();
237# else
238# define vsf_pt_call_thread(__name, __target) \
239 vsf_eda_call_thread_prepare(__name, __target); \
240 vsf_pt_entry(); \
241 if (VSF_ERR_NONE != vsf_eda_call_thread(__target)) { \
242 return ; \
243 } \
244 vsf_pt_entry(return;);
245# endif
246#endif
247
248#define init_vsf_pt(__name, __pt, __pri, ...) \
249 __init_vsf_pt(__name, __pt, __pri, __VA_ARGS__)
250
251/*============================ TYPES =========================================*/
252
253#if VSF_KERNEL_CFG_EDA_SUPPORT_TIMER == ENABLED
254typedef vsf_teda_t vsf_pt_t;
255#else
256typedef vsf_eda_t vsf_pt_t;
257#endif
258
259typedef vsf_eda_evthandler_t vsf_pt_entry_t;
260
261/*============================ GLOBAL VARIABLES ==============================*/
262/*============================ PROTOTYPES ====================================*/
263
264#ifdef __cplusplus
265}
266#endif
267
268#endif
269#endif
__vsf_task_common.h
vsf_eda_t
Definition vsf_eda.h:766
vsf_teda_t
Definition vsf_eda.h:834
vsf_eda_evthandler_t
void(* vsf_eda_evthandler_t)(vsf_eda_t *eda, vsf_evt_t evt)
Definition vsf_eda.h:656
vsf_kernel_cfg.h
vsf_pt_t
vsf_teda_t vsf_pt_t
Definition vsf_pt.h:254
vsf_pt_entry_t
vsf_eda_evthandler_t vsf_pt_entry_t
Definition vsf_pt.h:259
Generated by doxygen 1.9.8