1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
|
/* nanokernel.h - public API for VxMicro nanokernel */
/*
* Copyright (c) 1997-2015, Wind River Systems, Inc.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1) Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2) Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* 3) Neither the name of Wind River Systems nor the names of its contributors
* may be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef __NANOKERNEL_H__
#define __NANOKERNEL_H__
#include <stdint.h>
#include <toolchain.h> /* compiler specific configuration options */
#include <arch/private.h>
#include <kernel_version.h>
#include <clock_vars.h>
#include <drivers/rand32.h>
#ifdef __cplusplus
extern "C" {
#endif
typedef struct s_CCS *nano_context_id_t;
typedef void (*nano_fiber_entry_t)(int i1, int i2);
typedef int nano_context_type_t;
#define NANO_CTX_ISR (0)
#define NANO_CTX_FIBER (1)
#define NANO_CTX_TASK (2)
/* context APIs
*/
extern nano_context_id_t context_self_get(void);
extern nano_context_type_t context_type_get(void);
extern int _context_essential_check(tCCS *pCtx);
/* fiber APIs
*/
/* scheduling context independent method (when context is not known) */
void fiber_start(char *stack,
unsigned stack_size,
nano_fiber_entry_t entry,
int arg1,
int arg2,
unsigned prio,
unsigned options);
/* methods for fibers */
extern void fiber_fiber_start(char *pStack,
unsigned int stackSize,
nano_fiber_entry_t entry,
int arg1,
int arg2,
unsigned prio,
unsigned options);
extern void fiber_yield(void);
extern void fiber_abort(void);
/* methods for tasks */
extern void task_fiber_start(char *pStack,
unsigned int stackSize,
nano_fiber_entry_t entry,
int arg1,
int arg2,
unsigned prio,
unsigned options);
/* FIFO APIs
*/
extern void nano_fifo_init(struct nano_fifo *chan);
/* scheduling context independent methods (when context is not known) */
extern void nano_fifo_put(struct nano_fifo *chan, void *data);
extern void *nano_fifo_get(struct nano_fifo *chan);
extern void *nano_fifo_get_wait(struct nano_fifo *chan);
/* methods for ISRs */
extern void nano_isr_fifo_put(struct nano_fifo *chan, void *data);
extern void *nano_isr_fifo_get(struct nano_fifo *chan);
/* methods for fibers */
extern void nano_fiber_fifo_put(struct nano_fifo *chan, void *data);
extern void *nano_fiber_fifo_get(struct nano_fifo *chan);
extern void *nano_fiber_fifo_get_wait(struct nano_fifo *chan);
/* methods for tasks */
extern void nano_task_fifo_put(struct nano_fifo *chan, void *data);
extern void *nano_task_fifo_get(struct nano_fifo *chan);
extern void *nano_task_fifo_get_wait(struct nano_fifo *chan);
/* LIFO APIs
*/
extern void nano_lifo_init(struct nano_lifo *chan);
/* methods for ISRs */
extern void nano_isr_lifo_put(struct nano_lifo *chan, void *data);
extern void *nano_isr_lifo_get(struct nano_lifo *chan);
/* methods for fibers */
extern void nano_fiber_lifo_put(struct nano_lifo *chan, void *data);
extern void *nano_fiber_lifo_get(struct nano_lifo *chan);
extern void *nano_fiber_lifo_get_wait(struct nano_lifo *chan);
/* methods for tasks */
extern void nano_task_lifo_put(struct nano_lifo *chan, void *data);
extern void *nano_task_lifo_get(struct nano_lifo *chan);
extern void *nano_task_lifo_get_wait(struct nano_lifo *chan);
/* semaphore APIs
*/
extern void nano_sem_init(struct nano_sem *chan);
/* scheduling context independent methods (when context is not known) */
extern void nano_sem_give(struct nano_sem *chan);
extern void nano_sem_take_wait(struct nano_sem *chan);
/* methods for ISRs */
extern void nano_isr_sem_give(struct nano_sem *chan);
extern int nano_isr_sem_take(struct nano_sem *chan);
/* methods for fibers */
extern void nano_fiber_sem_give(struct nano_sem *chan);
extern int nano_fiber_sem_take(struct nano_sem *chan);
extern void nano_fiber_sem_take_wait(struct nano_sem *chan);
/* methods for tasks */
extern void nano_task_sem_give(struct nano_sem *chan);
extern int nano_task_sem_take(struct nano_sem *chan);
extern void nano_task_sem_take_wait(struct nano_sem *chan);
/* stack APIs
*/
extern void nano_stack_init(struct nano_stack *chan, uint32_t *data);
/* methods for ISRs */
extern void nano_isr_stack_push(struct nano_stack *chan, uint32_t data);
extern int nano_isr_stack_pop(struct nano_stack *chan, uint32_t *data);
/* methods for fibers */
extern void nano_fiber_stack_push(struct nano_stack *chan, uint32_t data);
extern int nano_fiber_stack_pop(struct nano_stack *chan, uint32_t *data);
extern uint32_t nano_fiber_stack_pop_wait(struct nano_stack *chan);
/* methods for tasks */
extern void nano_task_stack_push(struct nano_stack *chan, uint32_t data);
extern int nano_task_stack_pop(struct nano_stack *chan, uint32_t *data);
extern uint32_t nano_task_stack_pop_wait(struct nano_stack *chan);
/* context custom data APIs */
#ifdef CONFIG_CONTEXT_CUSTOM_DATA
extern void context_custom_data_set(void *value);
extern void *context_custom_data_get(void);
#endif /* CONFIG_CONTEXT_CUSTOM_DATA */
#if defined(CONFIG_NANOKERNEL)
/* nanokernel-only timers */
extern void nano_timer_init(struct nano_timer *chan, void *data);
/* methods for fibers */
extern void nano_fiber_timer_start(struct nano_timer *chan, int ticks);
extern void *nano_fiber_timer_test(struct nano_timer *chan);
extern void *nano_fiber_timer_wait(struct nano_timer *chan);
extern void nano_fiber_timer_stop(struct nano_timer *chan);
/* methods for tasks */
extern void nano_task_timer_start(struct nano_timer *chan, int ticks);
extern void *nano_task_timer_test(struct nano_timer *chan);
extern void *nano_task_timer_wait(struct nano_timer *chan);
extern void nano_task_timer_stop(struct nano_timer *chan);
/* methods for tasks and fibers for handling time and ticks */
extern int64_t nano_tick_get(void);
extern uint32_t nano_tick_get_32(void);
extern uint32_t nano_cycle_get_32(void);
extern int64_t nano_tick_delta(int64_t *reftime);
extern uint32_t nano_tick_delta_32(int64_t *reftime);
#endif /* CONFIG_NANOKERNEL */
/*
* Auto-initialization
*
* The SYS_PREKERNEL_INIT() macro is used to indicate that the specified
* routine be executed before the kernel initializes. All such routines
* are issued in order of highest priority level to lowest priority level.
* Values are 000 (highest priority) to 999 (lowest priority). If all
* three (3) digits are not supplied, unexpected results may occur, as
* the linker would interpret priority 19 as a lower priority than 2. To
* prevent that scenario, the proper priorities to specify would be 019
* and 002 respectively.
*
* Example:
* void my_library_init(void)
* {
* ...
* }
*
* SYS_PREKERNEL_INIT(my_library_init, 500);
*
*/
#define SYS_PREKERNEL_INIT(name, level) \
void (*__ctor_##name)(void) __prekernel_init_level(level) = name
extern uint32_t kernel_version_get(void);
#ifdef __cplusplus
}
#endif
#endif /* __NANOKERNEL_H__ */
|
