VSF Documented
vsf_arch_abstraction.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_ARCH_ABSTRACTION_H__
19#define __VSF_ARCH_ABSTRACTION_H__
20
21/*============================ INCLUDES ======================================*/
22
23#include "hal/vsf_hal_cfg.h"
24#include "utilities/vsf_utilities.h"
25
26#ifdef __cplusplus
27extern "C" {
28#endif
29
30/*============================ MACROS ========================================*/
31
34#define VSF_SYSTIMER_IMPL_NONE 0
35#define VSF_SYSTIMER_IMPL_REQUEST_RESPONSE 1
36#define VSF_SYSTIMER_IMPL_WITH_NORMAL_TIMER 2
37#define VSF_SYSTIMER_IMPL_WITH_COMP_TIMER 3
38#define VSF_SYSTIMER_IMPL_TICK_MODE 4
40
41/*============================ MACROFIED FUNCTIONS ===========================*/
42
43#ifndef VSF_ARCH_ASSERT
44# define VSF_ARCH_ASSERT(...) VSF_ASSERT(__VA_ARGS__)
45#endif
46
47/*============================ TYPES =========================================*/
48
49/*\note generic prototypes MUST be defined before including the arch header. */
50typedef void vsf_irq_handler_t(void *p);
51typedef vsf_irq_handler_t vsf_swi_handler_t;
52
53typedef uintalu_t vsf_protect_t;
54typedef struct vsf_protect_region_t {
55 vsf_protect_t (*enter)(void);
56 void (*leave)(vsf_protect_t orig);
57} vsf_protect_region_t;
58
59typedef struct vsf_arch_text_region_t vsf_arch_text_region_t;
60struct vsf_arch_text_region_t {
61 vsf_arch_text_region_t *next;
62 uintptr_t start;
63 uintptr_t size;
64};
65
66/*============================ GLOBAL VARIABLES ==============================*/
67
68extern const vsf_protect_region_t vsf_protect_region_int;
69extern const vsf_protect_region_t vsf_protect_region_none;
70
71/*============================ LOCAL VARIABLES ===============================*/
72
73#ifdef __cplusplus
74}
75#endif
76
77/*============================ INCLUDES ======================================*/
78
79#if !defined(VSF_ARCH_HEADER)
81# if defined(__RTOS__)
82# define VSF_ARCH_HEADER "./rtos/rtos_generic.h"
83# elif defined(__CPU_GENERIC__)
84# if defined(__MACOS__)
85# define VSF_ARCH_HEADER "./generic/macos/macos_generic.h"
86# elif defined(__LINUX__)
87# define VSF_ARCH_HEADER "./generic/linux/linux_generic.h"
88# else
89# error not supported generic arch
90# endif
91# elif (defined(__ARM_ARCH_PROFILE) && __ARM_ARCH_PROFILE == 'M') || __TARGET_PROFILE_M
92# define VSF_ARCH_HEADER "./arm/cortex-m/cortex_m_generic.h"
93# elif defined(__ARM_ARCH_PROFILE) && __ARM_ARCH_PROFILE == 'A' || __TARGET_PROFILE_A
94# define VSF_ARCH_HEADER "./arm/cortex-a/cortex_a_generic.h"
95# elif defined(__ARM_ARCH_PROFILE) && __ARM_ARCH_PROFILE == 'R' || __TARGET_PROFILE_R
96# define VSF_ARCH_HEADER "./arm/cortex-r/cortex_r_generic.h"
97// check __WIN__ before __LINUX__ because some software(like SDL2) will define __LINUX__
98# elif (defined(__CPU_X86__) || defined(__CPU_X64__)) && defined(__WIN__)
99# define VSF_ARCH_HEADER "./x86/win/win_generic.h"
100# elif (defined(__CPU_X86__) || defined(__CPU_X64__) || defined(__CPU_WEBASSEMBLY__)) && defined(__LINUX__)
101# define VSF_ARCH_HEADER "./generic/linux/linux_generic.h"
102# elif defined(__CPU_MCS51__)
103# define VSF_ARCH_HEADER "./mcs51/mcs51_generic.h"
104# elif defined(__CPU_RV__) || defined(__CPU_RISCV__)
105# define VSF_ARCH_HEADER "./rv/rv_generic.h"
106# elif defined(__CPU_ARM9__)
107# define VSF_ARCH_HEADER "./arm/arm9/arm9_generic.h"
108# else
109# warning no supported architecture found, use default arch template!
110# define VSF_ARCH_HEADER "./template/template_generic.h"
111# endif
112#endif
113#include VSF_ARCH_HEADER
114
115#ifdef __cplusplus
116extern "C" {
117#endif
118
119/*============================ MACROS ========================================*/
120
121#ifndef VSF_ARCH_SWI_NUM
122# define VSF_ARCH_SWI_NUM 0
123#endif
124#ifndef VSF_DEV_SWI_NUM
125# define VSF_DEV_SWI_NUM 0
126#endif
127
128#ifndef __BYTE_ORDER
129# error "__BYTE_ORDER MUST be defined in arch"
130#endif
131
132#define VSF_SWI_NUM (VSF_ARCH_SWI_NUM + VSF_DEV_SWI_NUM)
133
134#define ___constant_swab16(__x) ((uint16_t)( \
135 (((uint16_t)(__x) & (uint16_t)0x00FFU) << 8) | \
136 (((uint16_t)(__x) & (uint16_t)0xFF00U) >> 8)))
137
138#define ___constant_swab32(__x) ((uint32_t)( \
139 (((uint32_t)(__x) & (uint32_t)0x000000ffUL) << 24) | \
140 (((uint32_t)(__x) & (uint32_t)0x0000ff00UL) << 8) | \
141 (((uint32_t)(__x) & (uint32_t)0x00ff0000UL) >> 8) | \
142 (((uint32_t)(__x) & (uint32_t)0xff000000UL) >> 24)))
143
144#define ___constant_swab64(__x) ((uint64_t)( \
145 (((uint64_t)(__x) & (uint64_t)0x00000000000000ffULL) << 56) | \
146 (((uint64_t)(__x) & (uint64_t)0x000000000000ff00ULL) << 40) | \
147 (((uint64_t)(__x) & (uint64_t)0x0000000000ff0000ULL) << 24) | \
148 (((uint64_t)(__x) & (uint64_t)0x00000000ff000000ULL) << 8) | \
149 (((uint64_t)(__x) & (uint64_t)0x000000ff00000000ULL) >> 8) | \
150 (((uint64_t)(__x) & (uint64_t)0x0000ff0000000000ULL) >> 24) | \
151 (((uint64_t)(__x) & (uint64_t)0x00ff000000000000ULL) >> 40) | \
152 (((uint64_t)(__x) & (uint64_t)0xff00000000000000ULL) >> 56)))
153
154#define bswap16 bswap_16
155#define bswap32 bswap_32
156#define bswap64 bswap_64
157#if __BYTE_ORDER == __BIG_ENDIAN
158# ifndef htobe16
159# define htobe16
160# endif
161# ifndef htole16
162# define htole16 bswap_16
163# endif
164# ifndef be16toh
165# define be16toh
166# endif
167# ifndef le16toh
168# define le16toh bswap_16
169# endif
170# ifndef htobe32
171# define htobe32
172# endif
173# ifndef htole32
174# define htole32 bswap_32
175# endif
176# ifndef be32toh
177# define be32toh
178# endif
179# ifndef le32toh
180# define le32toh bswap_32
181# endif
182# ifndef htobe64
183# define htobe64
184# endif
185# ifndef htole64
186# define htole64 bswap_64
187# endif
188# ifndef be64toh
189# define be64toh
190# endif
191# ifndef le64toh
192# define le64toh bswap_64
193# endif
194
195# define cpu_to_le16 bswap_16
196# define cpu_to_le32 bswap_32
197# define cpu_to_le64 bswap_64
198# define le16_to_cpu bswap_16
199# define le32_to_cpu bswap_32
200# define le64_to_cpu bswap_64
201# define cpu_to_be16
202# define cpu_to_be32
203# define cpu_to_be64
204# define be16_to_cpu
205# define be32_to_cpu
206# define be64_to_cpu
207
208# define __constant_cpu_to_le16 ___constant_swab16
209# define __constant_le16_to_cpu ___constant_swab16
210# define __constant_cpu_to_le32 ___constant_swab32
211# define __constant_le32_to_cpu ___constant_swab32
212# define __constant_cpu_to_le64 ___constant_swab64
213# define __constant_le64_to_cpu ___constant_swab64
214# define __constant_cpu_to_be16
215# define __constant_be16_to_cpu
216# define __constant_cpu_to_be32
217# define __constant_be32_to_cpu
218# define __constant_cpu_to_be64
219# define __constant_be64_to_cpu
220#else
221# ifndef htobe16
222# define htobe16 bswap_16
223# endif
224# ifndef htole16
225# define htole16
226# endif
227# ifndef be16toh
228# define be16toh bswap_16
229# endif
230# ifndef le16toh
231# define le16toh
232# endif
233# ifndef htobe32
234# define htobe32 bswap_32
235# endif
236# ifndef htole32
237# define htole32
238# endif
239# ifndef be32toh
240# define be32toh bswap_32
241# endif
242# ifndef le32toh
243# define le32toh
244# endif
245# ifndef htobe64
246# define htobe64 bswap_64
247# endif
248# ifndef htole64
249# define htole64
250# endif
251# ifndef be64toh
252# define be64toh bswap_64
253# endif
254# ifndef le64toh
255# define le64toh
256# endif
257
258# define cpu_to_le16
259# define cpu_to_le32
260# define cpu_to_le64
261# define le16_to_cpu
262# define le32_to_cpu
263# define le64_to_cpu
264# define cpu_to_be16 bswap_16
265# define cpu_to_be32 bswap_32
266# define cpu_to_be64 bswap_64
267# define be16_to_cpu bswap_16
268# define be32_to_cpu bswap_32
269# define be64_to_cpu bswap_64
270
271# define __constant_cpu_to_le16
272# define __constant_le16_to_cpu
273# define __constant_cpu_to_le32
274# define __constant_le32_to_cpu
275# define __constant_cpu_to_le64
276# define __constant_le64_to_cpu
277# define __constant_cpu_to_be16 ___constant_swab16
278# define __constant_be16_to_cpu ___constant_swab16
279# define __constant_cpu_to_be32 ___constant_swab32
280# define __constant_be32_to_cpu ___constant_swab32
281# define __constant_cpu_to_be64 ___constant_swab64
282# define __constant_be64_to_cpu ___constant_swab64
283#endif
284
285#define DECLARE_ENDIAN_FUNC(__bitlen) \
286extern uint_fast##__bitlen##_t cpu_to_le##__bitlen##p(uint##__bitlen##_t *); \
287extern uint_fast##__bitlen##_t cpu_to_be##__bitlen##p(uint##__bitlen##_t *); \
288extern uint_fast##__bitlen##_t le##__bitlen##_to_cpup(uint##__bitlen##_t *); \
289extern uint_fast##__bitlen##_t be##__bitlen##_to_cpup(uint##__bitlen##_t *); \
290extern void cpu_to_le##__bitlen##s(uint##__bitlen##_t *); \
291extern void cpu_to_be##__bitlen##s(uint##__bitlen##_t *); \
292extern void le##__bitlen##_to_cpus(uint##__bitlen##_t *); \
293extern void be##__bitlen##_to_cpus(uint##__bitlen##_t *); \
294extern uint_fast##__bitlen##_t get_unaligned_cpu##__bitlen(const void *); \
295extern uint_fast##__bitlen##_t get_unaligned_le##__bitlen(const void *); \
296extern uint_fast##__bitlen##_t get_unaligned_be##__bitlen(const void *); \
297extern void put_unaligned_cpu##__bitlen(uint_fast##__bitlen##_t, void *); \
298extern void put_unaligned_le##__bitlen(uint_fast##__bitlen##_t, void *); \
299extern void put_unaligned_be##__bitlen(uint_fast##__bitlen##_t, void *);
300
301#define __vsf_protect_region(__region) \
302 for (vsf_protect_t VSF_MACRO_SAFE_NAME(protect_status), \
303 VSF_MACRO_SAFE_NAME(local_cnt) = 1; \
304 (((__region) != NULL) && VSF_MACRO_SAFE_NAME(local_cnt)--) ? \
305 ((VSF_MACRO_SAFE_NAME(protect_status) = (__region)->enter()), true) : false;\
306 (__region)->leave(VSF_MACRO_SAFE_NAME(protect_status)))
307#define vsf_protect_region(__region) __vsf_protect_region(__region)
308#define vsf_protect_region_exit(__region) continue
309
310#define vsf_protect_region_simple(__region, ...) \
311 do { \
312 if (__region != NULL) { \
313 vsf_protect_t VSF_MACRO_SAFE_NAME(protect_status) = (__region)->enter();\
314 __VA_ARGS__; \
315 (__region)->leave(VSF_MACRO_SAFE_NAME(protect_status)); \
316 } \
317 } while (0);
318
323// Usage:
324// __vsf_interrupt_safe(code)
325#ifndef __vsf_interrupt_safe
326# if (!defined(__STDC_VERSION__) || __STDC_VERSION__ < 199901L) && !defined(__cplusplus)
327# define __vsf_interrupt_safe(__code) \
328 { \
329 vsf_gint_state_t VSF_MACRO_SAFE_NAME(gint_state) = vsf_disable_interrupt();\
330 __code; \
331 vsf_set_interrupt(VSF_MACRO_SAFE_NAME(gint_state)); \
332 }
333# else
334# define __vsf_interrupt_safe(...) \
335 { \
336 vsf_gint_state_t VSF_MACRO_SAFE_NAME(gint_state) = vsf_disable_interrupt();\
337 __VA_ARGS__; \
338 vsf_set_interrupt(VSF_MACRO_SAFE_NAME(gint_state)); \
339 }
340# endif
341#endif
342
343// Usage:
344// vsf_interrupt_safe() {
345// code
346// }
347#ifndef vsf_interrupt_safe
348# define vsf_interrupt_safe() vsf_protect_region(&vsf_protect_region_int)
349#endif
350
351
352// Usage:
353// vsf_interrupt_safe_simple(
354// code
355// )
356#ifndef vsf_interrupt_safe_simple
357
358# define vsf_interrupt_safe_simple(...) \
359 vsf_protect_region_simple(&vsf_protect_region_int, __VA_ARGS__)
360
361#endif
362
363
364#define vsf_protect_interrupt() vsf_disable_interrupt()
365#define vsf_unprotect_interrupt(__state) vsf_set_interrupt(__state)
366#define vsf_protect_none() (0)
367#define vsf_unprotect_none(__state) VSF_UNUSED_PARAM(__state)
368
369#define vsf_protect_int vsf_protect_interrupt
370#define vsf_unprotect_int vsf_unprotect_interrupt
371
372#define __vsf_protect(__type) vsf_protect_##__type
373#define __vsf_unprotect(__type) vsf_unprotect_##__type
374#define vsf_protect(__type) __vsf_protect(__type)
375#define vsf_unprotect(__type) __vsf_unprotect(__type)
376
377// atom
378
379#ifndef vsf_atom64_op
380# define vsf_atom64_op(__ptr, ...) \
381 ({ \
382 vsf_protect_t VSF_MACRO_SAFE_NAME(orig) = vsf_protect_int(); \
383 int64_t _ = (*(int64_t *)(__ptr)); \
384 *(int64_t *)(__ptr) = (__VA_ARGS__); \
385 vsf_unprotect_int(VSF_MACRO_SAFE_NAME(orig)); \
386 _; \
387 })
388#endif
389
390#ifndef vsf_atom32_op
391# define vsf_atom32_op(__ptr, ...) \
392 ({ \
393 vsf_protect_t VSF_MACRO_SAFE_NAME(orig) = vsf_protect_int(); \
394 int32_t _ = (*(int32_t *)(__ptr)); \
395 *(int32_t *)(__ptr) = (__VA_ARGS__); \
396 vsf_unprotect_int(VSF_MACRO_SAFE_NAME(orig)); \
397 _; \
398 })
399#endif
400
401#ifndef vsf_atom16_op
402# define vsf_atom16_op(__ptr, ...) \
403 ({ \
404 vsf_protect_t VSF_MACRO_SAFE_NAME(orig) = vsf_protect_int(); \
405 int16_t _ = (*(int16_t *)(__ptr)); \
406 *(int16_t *)(__ptr) = (__VA_ARGS__); \
407 vsf_unprotect_int(VSF_MACRO_SAFE_NAME(orig)); \
408 _; \
409 })
410#endif
411
412#ifndef vsf_atom8_op
413# define vsf_atom8_op(__ptr, ...) \
414 ({ \
415 vsf_protect_t VSF_MACRO_SAFE_NAME(orig) = vsf_protect_int(); \
416 int8_t _ = (*(int8_t *)(__ptr)); \
417 *(int8_t *)(__ptr) = (__VA_ARGS__); \
418 vsf_unprotect_int(VSF_MACRO_SAFE_NAME(orig)); \
419 _; \
420 })
421#endif
422
423#ifndef vsf_atom_add
424# define vsf_atom_add(__bitlen, __ptr, __value) \
425 VSF_MCONNECT(vsf_atom, __bitlen, _op)((__ptr), _ + (__value))
426#endif
427#ifndef vsf_atom_dec
428# define vsf_atom_dec(__bitlen, __ptr, __value) \
429 vsf_atom_add(__bitlen, (__ptr), - (__value))
430#endif
431#ifndef vsf_atom_or
432# define vsf_atom_or(__bitlen, __ptr, __value) \
433 VSF_MCONNECT(vsf_atom, __bitlen, _op)((__ptr), _ | (__value))
434#endif
435#ifndef vsf_atom_and
436# define vsf_atom_and(__bitlen, __ptr, __value) \
437 VSF_MCONNECT(vsf_atom, __bitlen, _op)((__ptr), _ & (__value))
438#endif
439#ifndef vsf_atom_xor
440# define vsf_atom_xor(__bitlen, __ptr, __value) \
441 VSF_MCONNECT(vsf_atom, __bitlen, _op)((__ptr), _ ^ (__value))
442#endif
443#ifndef vsf_atom_xchg
444# define vsf_atom_xchg(__bitlen, __ptr, __new_value) \
445 VSF_MCONNECT(vsf_atom, __bitlen, _op)((__ptr), (__new_value))
446#endif
447
448// host invoke
449#define vsf_arch_host_invoke_ctx_t(__name) VSF_MCONNECT(__name, _ctx_t)
450#define declare_vsf_arch_host_invoke(__name) \
451 typedef struct vsf_arch_host_invoke_ctx_t(__name) \
452 vsf_arch_host_invoke_ctx_t(__name); \
453 typedef struct VSF_MCONNECT(__name, _t) VSF_MCONNECT(__name, _t); \
454 extern void VSF_MCONNECT(__name, _callback_t) \
455 (vsf_arch_host_invoke_ctx_t(__name) *ctx); \
456 extern VSF_MCONNECT(__name, _t) VSF_MCONNECT(__name, _instance);
457#define dcl_vsf_arch_host_invoke declare_vsf_arch_host_invoke
458#define define_vsf_arch_host_invoke(__name, ...) \
459 typedef struct vsf_arch_host_invoke_ctx_t(__name) { \
460 int __dummy; \
461 __VA_ARGS__ \
462 } vsf_arch_host_invoke_ctx_t(__name); \
463 typedef struct VSF_MCONNECT(__name, _t) { \
464 implement(vsf_arch_irq_thread_t); \
465 vsf_arch_irq_request_t request; \
466 vsf_eda_t *caller; \
467 vsf_arch_host_invoke_ctx_t(__name) ctx; \
468 } VSF_MCONNECT(__name, _t);
469#define def_vsf_arch_host_invoke define_vsf_arch_host_invoke
470#define implement_vsf_arch_host_invoke(__name) \
471 VSF_MCONNECT(__name, _t) VSF_MCONNECT(__name, _instance); \
472 extern void VSF_MCONNECT(__name, _callback_t) \
473 (vsf_arch_host_invoke_ctx_t(__name) *ctx); \
474 static void VSF_MCONNECT(__name, _thread)(void *arg) \
475 { \
476 vsf_eda_t *caller; \
477 VSF_MCONNECT(__name, _t) *ctx = arg; \
478 __vsf_arch_irq_set_background(&ctx->use_as__vsf_arch_irq_thread_t); \
479 while (1) { \
480 __vsf_arch_irq_request_pend(&ctx->request); \
481 VSF_MCONNECT(__name, _callback_t)(&ctx->ctx); \
482 \
483 __vsf_arch_irq_start(&ctx->use_as__vsf_arch_irq_thread_t); \
484 caller = ctx->caller; \
485 if (caller != NULL) { \
486 ctx->caller = NULL; \
487 vsf_eda_post_evt(caller, VSF_EVT_USER); \
488 } \
489 __vsf_arch_irq_end(&ctx->use_as__vsf_arch_irq_thread_t, false); \
490 } \
491 } \
492 void VSF_MCONNECT(__name, _callback_t)(vsf_arch_host_invoke_ctx_t(__name) *_)
493#define imp_vsf_arch_host_invoke implement_vsf_arch_host_invoke
494#define initialize_vsf_arch_host_invoke(__name, __priority) \
495 do { \
496 memset(&VSF_MCONNECT(__name, _instance), 0, \
497 sizeof(VSF_MCONNECT(__name, _t))); \
498 __vsf_arch_irq_request_init(&VSF_MCONNECT(__name, _instance).request);\
499 __vsf_arch_irq_init( \
500 &VSF_MCONNECT(__name, _instance).use_as__vsf_arch_irq_thread_t,\
501 VSF_STR(__name), VSF_MCONNECT(__name, _thread), (__priority));\
502 } while (0)
503#define init_vsf_arch_host_invoke initialize_vsf_arch_host_invoke
504#define vsf_arch_host_invoke_nb(__name, __eda_ptr, __ctx_ptr) \
505 do { \
506 VSF_MCONNECT(__name, _instance).ctx = *(__ctx_ptr); \
507 VSF_MCONNECT(__name, _instance).caller = (__eda_ptr); \
508 __vsf_arch_irq_request_send(&VSF_MCONNECT(__name, _instance).request);\
509 } while (0)
510#define vsf_arch_host_invoke_get_result_nb(__name, __ctx_ptr) \
511 do { \
512 *(__ctx_ptr) = VSF_MCONNECT(__name, _instance).ctx; \
513 } while (0)
514#define vsf_arch_host_invoke_in_thread(__name, __ctx_ptr) \
515 do { \
516 vsf_eda_t VSF_MACRO_SAFE_NAME(eda) = vsf_eda_get_cur(); \
517 VSF_ARCH_ASSERT(VSF_MACRO_SAFE_NAME(eda) != NULL); \
518 vsf_arch_host_invoke_nb(__name, VSF_MACRO_SAFE_NAME(eda), (__ctx_ptr));\
519 vsf_thread_wfe(VSF_EVT_USER); \
520 vsf_arch_host_invoke_get_result_nb(__name, __ctx_ptr); \
521 } while (0)
522
523/*============================ PROTOTYPES ====================================*/
524
525#if VSF_ARCH_PROVIDE_HEAP == ENABLED
526extern void * vsf_arch_heap_malloc(uint_fast32_t size, uint_fast32_t alignment);
527extern void * vsf_arch_heap_realloc(void *buffer, uint_fast32_t size);
528extern void vsf_arch_heap_free(void *buffer);
529extern unsigned int vsf_arch_heap_alignment(void);
530extern uint_fast32_t vsf_arch_heap_size(void *buffer);
531# if VSF_ARCH_HEAP_HAS_STATISTICS == ENABLED
532typedef struct vsf_arch_heap_statistics_t {
533 uint32_t all_size;
534 uint32_t used_size;
535} vsf_arch_heap_statistics_t;
536extern void vsf_arch_heap_statistics(vsf_arch_heap_statistics_t *statistics);
537# endif
538#endif
539
540/*----------------------------------------------------------------------------*
541 * Architecture Infrastructure *
542 *----------------------------------------------------------------------------*/
543
544#ifndef VSF_FFS32
545// returns the first bits(start from 0) which is '1'
546// if all bits are 0s, -1 is returned
547extern int_fast8_t vsf_ffs32(uint_fast32_t);
548#endif
549
550#ifndef VSF_FFZ32
551extern int_fast8_t vsf_ffz32(uint_fast32_t);
552#endif
553
554#ifndef VSF_MSB32
555extern int_fast8_t vsf_msb32(uint_fast32_t);
556#endif
557
558#ifndef VSF_CLZ32
559extern uint_fast8_t vsf_clz32(uint_fast32_t);
560#endif
561
562#if VSF_APPLET_USE_ARCH == ENABLED
563typedef struct vsf_arch_vplt_t {
564 vsf_vplt_info_t info;
565
566 VSF_APPLET_VPLT_ENTRY_FUNC_DEF(bswap_16);
567 VSF_APPLET_VPLT_ENTRY_FUNC_DEF(bswap_32);
568 VSF_APPLET_VPLT_ENTRY_FUNC_DEF(bswap_64);
569} vsf_arch_vplt_t;
570# ifndef __VSF_APPLET__
571extern __VSF_VPLT_DECORATOR__ vsf_arch_vplt_t vsf_arch_vplt;
572# endif
573#endif
574
575#if defined(__VSF_APPLET__) && (defined(__VSF_APPLET_LIB__) || defined(__VSF_APPLET_ARCH_LIB__))\
576 && VSF_APPLET_CFG_ABI_PATCH != ENABLED && VSF_APPLET_USE_ARCH == ENABLED
577
578#ifndef VSF_APPLET_ARCH_VPLT
579# define VSF_APPLET_ARCH_VPLT \
580 ((vsf_arch_vplt_t *)(((vsf_vplt_t *)vsf_vplt((void *)0))->arch_vplt))
581#endif
582
583#define VSF_APPLET_ARCH_ENTRY(__NAME) \
584 VSF_APPLET_VPLT_ENTRY_FUNC_ENTRY(VSF_APPLET_ARCH_VPLT, __NAME)
585#define VSF_APPLET_ARCH_IMP(...) \
586 VSF_APPLET_VPLT_ENTRY_FUNC_IMP(VSF_APPLET_ARCH_VPLT, __VA_ARGS__)
587
588VSF_APPLET_ARCH_IMP(bswap_16, uint_fast16_t, uint_fast16_t value) {
589 VSF_APPLET_VPLT_ENTRY_FUNC_TRACE();
590 return VSF_APPLET_ARCH_ENTRY(bswap_16)(value);
591}
592VSF_APPLET_ARCH_IMP(bswap_32, uint_fast32_t, uint_fast32_t value) {
593 VSF_APPLET_VPLT_ENTRY_FUNC_TRACE();
594 return VSF_APPLET_ARCH_ENTRY(bswap_32)(value);
595}
596VSF_APPLET_ARCH_IMP(bswap_64, uint_fast64_t, uint_fast64_t value) {
597 VSF_APPLET_VPLT_ENTRY_FUNC_TRACE();
598 return VSF_APPLET_ARCH_ENTRY(bswap_64)(value);
599}
600
601#else
602
603extern uint_fast16_t bswap_16(uint_fast16_t);
604extern uint_fast32_t bswap_32(uint_fast32_t);
605#ifdef UINT64_MAX
606extern uint_fast64_t bswap_64(uint_fast64_t);
607#endif
608
609DECLARE_ENDIAN_FUNC(16)
610DECLARE_ENDIAN_FUNC(32)
611#ifdef UINT64_MAX
612DECLARE_ENDIAN_FUNC(64)
613#endif
614
615#endif
616
617/*----------------------------------------------------------------------------*
618 * SWI *
619 *----------------------------------------------------------------------------*/
620
621extern vsf_err_t vsf_swi_init( uint_fast8_t idx,
622 vsf_arch_prio_t priority,
623 vsf_swi_handler_t *handler,
624 void *param);
625extern void vsf_swi_trigger(uint_fast8_t idx);
626
630extern void vsf_arch_swi_trigger(uint_fast8_t idx);
631
632/*----------------------------------------------------------------------------*
633 * System Timer *
634 *----------------------------------------------------------------------------*/
635
636#ifdef VSF_SYSTIMER_CFG_IMPL_MODE
637extern vsf_err_t vsf_systimer_start(void);
638extern vsf_systimer_tick_t vsf_systimer_get(void);
639extern bool vsf_systimer_set(vsf_systimer_tick_t due);
640extern void vsf_systimer_set_idle(void);
641extern bool vsf_systimer_is_due(vsf_systimer_tick_t due);
642extern void vsf_systimer_prio_set(vsf_arch_prio_t priority);
643extern uint32_t vsf_systimer_get_freq(void);
644
645extern vsf_systimer_tick_t vsf_systimer_us_to_tick(uint_fast32_t time_us);
646extern vsf_systimer_tick_t vsf_systimer_ms_to_tick(uint_fast32_t time_ms);
647extern vsf_systimer_tick_t vsf_systimer_tick_to_ms(vsf_systimer_tick_t tick);
648extern vsf_systimer_tick_t vsf_systimer_tick_to_us(vsf_systimer_tick_t tick);
649#endif
650
651
652/*----------------------------------------------------------------------------*
653 * Interrupt *
654 *----------------------------------------------------------------------------*/
655
656extern vsf_arch_prio_t vsf_set_base_priority(vsf_arch_prio_t priority);
657extern vsf_arch_prio_t vsf_get_base_priority(void);
658
659extern int vsf_get_interrupt_id(void);
660extern vsf_gint_state_t vsf_get_interrupt(void);
661extern vsf_gint_state_t vsf_set_interrupt(vsf_gint_state_t level);
662extern vsf_gint_state_t vsf_disable_interrupt(void);
663extern vsf_gint_state_t vsf_enable_interrupt(void);
664
665// Use dedicated arch related APIs instead of vsf_irq_XXX APIs below.
666// vsf_irq_XXX APIs are only used when there is no dedicated arch,
667// eg: embassy-vsf support in Windows/Unix-Like systems implemented by hal_distbus.
668
669extern void vsf_irq_enable(int irqn);
670extern void vsf_irq_disable(int irqn);
671extern bool vsf_irq_is_enabled(int irqn);
672extern void vsf_irq_pend(int irqn);
673extern void vsf_irq_unpend(int irqn);
674extern bool vsf_irq_is_pending(int irqn);
675extern void vsf_irq_set_priority(int irqn, uint32_t priority);
676extern uint32_t vsf_irq_get_priority(int irqn);
677
678extern void vsf_arch_sleep(uint_fast32_t mode);
679extern void vsf_arch_reset(void);
680extern void vsf_arch_shutdown(void);
681// vsf_arch_main is only used in some special arch, eg: wasm
682// and normally used with VSF_ARCH_ENTRY_NO_PENDING
683extern void vsf_arch_main(void);
684
685#ifdef __cplusplus
686}
687#endif
688
689#endif
690/* EOF */
vsf_err_t
vsf_err_t
Definition __type.h:42
uintalu_t
uint_fast8_t uintalu_t
Definition type.h:88
bool
bool
Definition type.h:60
vsf_arch_prio_t
vsf_arch_prio_t
Definition cortex_a_generic.h:88
vsf_systimer_tick_t
uint64_t vsf_systimer_tick_t
Definition cortex_a_generic.h:73
vsf_systimer_prio_set
void vsf_systimer_prio_set(vsf_arch_prio_t priority)
Definition cortex_m_generic.c:244
vsf_systimer_get
vsf_systimer_tick_t vsf_systimer_get(void)
Definition linux_generic.c:402
vsf_systimer_set_idle
void vsf_systimer_set_idle(void)
Definition linux_generic.c:398
vsf_systimer_tick_to_us
vsf_systimer_tick_t vsf_systimer_tick_to_us(vsf_systimer_tick_t tick)
Definition linux_generic.c:445
vsf_systimer_is_due
bool vsf_systimer_is_due(vsf_systimer_tick_t due)
Definition linux_generic.c:430
vsf_systimer_ms_to_tick
vsf_systimer_tick_t vsf_systimer_ms_to_tick(uint_fast32_t time_ms)
Definition linux_generic.c:440
vsf_systimer_us_to_tick
vsf_systimer_tick_t vsf_systimer_us_to_tick(uint_fast32_t time_us)
Definition linux_generic.c:435
vsf_systimer_tick_to_ms
vsf_systimer_tick_t vsf_systimer_tick_to_ms(vsf_systimer_tick_t tick)
Definition linux_generic.c:450
vsf_systimer_start
vsf_err_t vsf_systimer_start(void)
Definition linux_generic.c:390
vsf_systimer_set
bool vsf_systimer_set(vsf_systimer_tick_t due)
Definition linux_generic.c:409
uintptr_t
uint32_t uintptr_t
Definition stdint.h:38
uint_fast8_t
unsigned char uint_fast8_t
Definition stdint.h:23
uint32_t
unsigned uint32_t
Definition stdint.h:9
uint_fast32_t
unsigned int uint_fast32_t
Definition stdint.h:27
uint_fast16_t
unsigned short uint_fast16_t
Definition stdint.h:25
uint_fast64_t
unsigned long long uint_fast64_t
Definition stdint.h:29
int_fast8_t
char int_fast8_t
Definition stdint.h:22
vsf_arch_heap_statistics_t
Definition vsf_arch_abstraction.h:532
vsf_arch_heap_statistics_t::used_size
uint32_t used_size
Definition vsf_arch_abstraction.h:534
vsf_arch_heap_statistics_t::all_size
uint32_t all_size
Definition vsf_arch_abstraction.h:533
vsf_arch_text_region_t
Definition vsf_arch_abstraction.h:60
vsf_arch_text_region_t::next
vsf_arch_text_region_t * next
Definition vsf_arch_abstraction.h:61
vsf_arch_text_region_t::size
uintptr_t size
Definition vsf_arch_abstraction.h:63
vsf_arch_text_region_t::start
uintptr_t start
Definition vsf_arch_abstraction.h:62
vsf_arch_vplt_t
Definition vsf_arch_abstraction.h:563
vsf_arch_vplt_t::VSF_APPLET_VPLT_ENTRY_FUNC_DEF
VSF_APPLET_VPLT_ENTRY_FUNC_DEF(bswap_64)
vsf_arch_vplt_t::info
vsf_vplt_info_t info
Definition vsf_arch_abstraction.h:564
vsf_arch_vplt_t::VSF_APPLET_VPLT_ENTRY_FUNC_DEF
VSF_APPLET_VPLT_ENTRY_FUNC_DEF(bswap_16)
vsf_arch_vplt_t::VSF_APPLET_VPLT_ENTRY_FUNC_DEF
VSF_APPLET_VPLT_ENTRY_FUNC_DEF(bswap_32)
vsf_protect_region_t
Definition vsf_arch_abstraction.h:54
vsf_protect_region_t::leave
void(* leave)(vsf_protect_t orig)
Definition vsf_arch_abstraction.h:56
vsf_protect_region_t::enter
vsf_protect_t(* enter)(void)
Definition vsf_arch_abstraction.h:55
vsf_vplt_info_t
Definition vsf_cfg.h:95
bswap_32
uint_fast32_t bswap_32(uint_fast32_t)
Definition cortex_a_generic.c:160
vsf_swi_init
vsf_err_t vsf_swi_init(uint_fast8_t idx, vsf_arch_prio_t priority, vsf_swi_handler_t *handler, void *param)
Definition vsf_arch_abstraction.c:511
vsf_protect_region_int
const vsf_protect_region_t vsf_protect_region_int
Definition vsf_arch_abstraction.c:191
vsf_clz32
uint_fast8_t vsf_clz32(uint_fast32_t)
Definition vsf_arch_abstraction.c:343
vsf_irq_is_pending
bool vsf_irq_is_pending(int irqn)
Definition cortex_m_generic.c:142
vsf_protect_t
uintalu_t vsf_protect_t
Definition vsf_arch_abstraction.h:53
vsf_ffs32
int_fast8_t vsf_ffs32(uint_fast32_t)
Definition vsf_arch_abstraction.c:412
vsf_protect_region_none
const vsf_protect_region_t vsf_protect_region_none
Definition vsf_arch_abstraction.c:196
vsf_arch_shutdown
void vsf_arch_shutdown(void)
Definition cortex_m_generic.c:461
vsf_arch_heap_free
void vsf_arch_heap_free(void *buffer)
Definition linux_generic.c:566
vsf_arch_heap_alignment
unsigned int vsf_arch_heap_alignment(void)
Definition linux_generic.c:572
vsf_arch_reset
void vsf_arch_reset(void)
Definition cortex_m_generic.c:455
DECLARE_ENDIAN_FUNC
#define DECLARE_ENDIAN_FUNC(__bitlen)
Definition vsf_arch_abstraction.h:285
vsf_arch_heap_malloc
void * vsf_arch_heap_malloc(uint_fast32_t size, uint_fast32_t alignment)
Definition linux_generic.c:518
vsf_irq_pend
void vsf_irq_pend(int irqn)
Definition cortex_m_generic.c:130
vsf_irq_get_priority
uint32_t vsf_irq_get_priority(int irqn)
Definition cortex_m_generic.c:154
vsf_disable_interrupt
vsf_gint_state_t vsf_disable_interrupt(void)
Definition arm9_generic.c:176
vsf_swi_handler_t
vsf_irq_handler_t vsf_swi_handler_t
Definition vsf_arch_abstraction.h:51
vsf_get_base_priority
vsf_arch_prio_t vsf_get_base_priority(void)
Definition cortex_m_generic.c:321
vsf_irq_unpend
void vsf_irq_unpend(int irqn)
Definition cortex_m_generic.c:136
vsf_get_interrupt
vsf_gint_state_t vsf_get_interrupt(void)
Definition arm9_generic.c:164
vsf_irq_enable
void vsf_irq_enable(int irqn)
Definition cortex_m_generic.c:112
vsf_arch_main
void vsf_arch_main(void)
vsf_arch_heap_realloc
void * vsf_arch_heap_realloc(void *buffer, uint_fast32_t size)
Definition linux_generic.c:541
vsf_irq_is_enabled
bool vsf_irq_is_enabled(int irqn)
Definition cortex_m_generic.c:124
vsf_swi_trigger
void vsf_swi_trigger(uint_fast8_t idx)
Definition vsf_arch_abstraction.c:469
vsf_irq_handler_t
void vsf_irq_handler_t(void *p)
Definition vsf_arch_abstraction.h:50
vsf_arch_heap_statistics
void vsf_arch_heap_statistics(vsf_arch_heap_statistics_t *statistics)
Definition common.c:108
vsf_arch_sleep
void vsf_arch_sleep(uint_fast32_t mode)
Definition cortex_m_generic.c:439
vsf_arch_vplt
__VSF_VPLT_DECORATOR__ vsf_arch_vplt_t vsf_arch_vplt
Definition vsf_arch_abstraction.c:1100
vsf_arch_swi_trigger
void vsf_arch_swi_trigger(uint_fast8_t idx)
trigger a software interrupt !
Definition cortex_m_generic.c:301
bswap_16
uint_fast16_t bswap_16(uint_fast16_t)
Definition cortex_a_generic.c:155
vsf_irq_set_priority
void vsf_irq_set_priority(int irqn, uint32_t priority)
Definition cortex_m_generic.c:148
vsf_enable_interrupt
vsf_gint_state_t vsf_enable_interrupt(void)
Definition arm9_generic.c:181
vsf_arch_heap_size
uint_fast32_t vsf_arch_heap_size(void *buffer)
Definition linux_generic.c:577
vsf_set_base_priority
vsf_arch_prio_t vsf_set_base_priority(vsf_arch_prio_t priority)
Definition cortex_m_generic.c:326
vsf_msb32
int_fast8_t vsf_msb32(uint_fast32_t)
Definition vsf_arch_abstraction.c:378
vsf_irq_disable
void vsf_irq_disable(int irqn)
Definition cortex_m_generic.c:118
vsf_get_interrupt_id
int vsf_get_interrupt_id(void)
Definition cortex_m_generic.c:429
vsf_set_interrupt
vsf_gint_state_t vsf_set_interrupt(vsf_gint_state_t level)
Definition arm9_generic.c:169
vsf_ffz32
int_fast8_t vsf_ffz32(uint_fast32_t)
Definition vsf_arch_abstraction.c:447
value
vk_av_control_value_t value
Definition vsf_audio.h:171
__VSF_VPLT_DECORATOR__
#define __VSF_VPLT_DECORATOR__
Definition vsf_cfg.h:93
VSF_APPLET_VPLT_ENTRY_FUNC_TRACE
#define VSF_APPLET_VPLT_ENTRY_FUNC_TRACE()
Definition vsf_cfg.h:165
vsf_hal_cfg.h
alignment
uint_fast32_t alignment
Definition vsf_heap.h:147
size
uint32_t size
Definition vsf_memfs.h:50
vsf_utilities.h
Generated from commit: vsfteam/vsf@3f091ef