win_generic.h

Go to the documentation of this file.

/*****************************************************************************
 *   Copyright(C)2009-2022 by VSF Team                                       *
 *                                                                           *
 *  Licensed under the Apache License, Version 2.0 (the "License");          *
 *  you may not use this file except in compliance with the License.         *
 *  You may obtain a copy of the License at                                  *
 *                                                                           *
 *     http://www.apache.org/licenses/LICENSE-2.0                            *
 *                                                                           *
 *  Unless required by applicable law or agreed to in writing, software      *
 *  distributed under the License is distributed on an "AS IS" BASIS,        *
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
 *  See the License for the specific language governing permissions and      *
 *  limitations under the License.                                           *
 *                                                                           *
 ****************************************************************************/
 
#ifndef __WIN_GENERIC_H__
#define __WIN_GENERIC_H__
 
/*============================ INCLUDES ======================================*/
 
#include "hal/vsf_hal_cfg.h"
#include "utilities/vsf_utilities.h"
 
#undef __VSF_WIN_PUBLIC_CONST__
#if     defined(__VSF_ARCH_WIN_IMPLEMENT)
#   define __VSF_CLASS_IMPLEMENT__
#   define __VSF_WIN_PUBLIC_CONST__
#else
#   define __VSF_WIN_PUBLIC_CONST__     const
#endif
 
#include "utilities/ooc_class.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*============================ MACROS ========================================*/
 
#ifndef __LITTLE_ENDIAN
#   define __LITTLE_ENDIAN              1
#endif
#ifndef __BIG_ENDIAN
#   define __BIG_ENDIAN                 0
#endif
#ifndef __BYTE_ORDER
#   define __BYTE_ORDER                 __LITTLE_ENDIAN
#endif
 
#ifndef VSF_SYSTIMER_CFG_IMPL_MODE
#   define VSF_SYSTIMER_CFG_IMPL_MODE   VSF_SYSTIMER_IMPL_REQUEST_RESPONSE
#endif
 
#if     defined(__CPU_X86__)
// x86 stack alignment is 8bytes
#   define VSF_ARCH_STACK_ALIGN_BIT     3
#elif   defined(__CPU_X64__)
// x64 stack alignment is 16bytes
#   define VSF_ARCH_STACK_ALIGN_BIT     4
// longjmp in x64_win will issue exception if stack is switched to task thread
//  to support x64_win, please include setjmp_x64.asm from intel,
//  and with MACRO below, setjmp/longjmp in setjmp_x64.asm will be used
#   define VSF_ARCH_SETJMP              SetJumpUser
#   define VSF_ARCH_LONGJMP             LongJumpUser
#endif
#define VSF_ARCH_STACK_PAGE_SIZE        4096
#define VSF_ARCH_STACK_GUARDIAN_SIZE    4096
#define VSF_ARCH_PROVIDE_HEAP           ENABLED
#define VSF_ARCH_PROVIDE_ARGU           ENABLED
#define VSF_ARCH_PROVIDE_EXE            ENABLED
// there will be memory allocation before entering vsf.
//  if VSF_USE_LINUX is enabled, and if these memories are handled(realloc, etc),
//  there will be problem because of different process context in vsf linux subsystem.
#define VSF_ARCH_ALLOC_BEFORE_ENTRY
// define VSF_ARCH_LIMIT_NO_SET_STACK to remove dependency of setjmp/longjmp
//  and use stack of thread in windows for the best compatibility
//  note that VSF_ARCH_PRI_NUM MUST defined to 1 and VSF_ARCH_SWI_NUM to 0
//#define VSF_ARCH_LIMIT_NO_SET_STACK
 
#ifdef VSF_ARCH_LIMIT_NO_SET_STACK
#   define VSF_ARCH_PRI_NUM             1
#   define VSF_ARCH_SWI_NUM             0
#endif
 
// software interrupt provided by arch
#ifndef VSF_ARCH_SWI_NUM
#   define VSF_ARCH_SWI_NUM             32
#endif
#ifndef VSF_ARCH_PRI_NUM
#   define VSF_ARCH_PRI_NUM             64
#endif
 
#define VSF_ARCH_SYSTIMER_FREQ          (10 * 1000 * 1000)
 
#ifndef FAR
#   define FAR
#endif
#ifndef NEAR
#   define NEAR
#endif
 
/*============================ MACROFIED FUNCTIONS ===========================*/
 
// for trace
#ifndef VSF_ARCH_TRACE_FUNC
#   define VSF_ARCH_TRACE_FUNC(...)         __vsf_arch_trace(0, __VA_ARGS__)
#endif
 
#ifndef vsf_arch_trace
#   if VSF_ARCH_PRI_NUM == 1 && VSF_ARCH_SWI_NUM == 0
#       define vsf_arch_trace(__header, __color, ...)
#   else
#       define vsf_arch_trace(__header, __color, ...)                           \
        do {                                                                    \
            vsf_arch_irq_thread_t *__irq_thread =                               \
                        __vsf_arch_get_cur_irq_thread();                        \
            __vsf_arch_trace_lock();                                            \
                VSF_ARCH_TRACE_FUNC("%s[%s]: ", (__color), (__header));         \
                if (__irq_thread != NULL) {                                     \
                    VSF_ARCH_TRACE_FUNC("%s(%d) %lld ",                         \
                        __irq_thread->name, (int)__irq_thread->thread_id,       \
                        __vsf_systimer_get());                                  \
                } else {                                                        \
                }                                                               \
                VSF_ARCH_TRACE_FUNC(__VA_ARGS__);                               \
            __vsf_arch_trace_unlock();                                          \
        } while (0)
#   endif
#endif
 
#define __VSF_ARCH_PRI(__N, __UNUSED)                                           \
            VSF_ARCH_PRIO_##__N = (__N),                                        \
            vsf_arch_prio_##__N = (__N),
 
#define vsf_arch_wakeup()
 
/*============================ TYPES =========================================*/
 
// avoid to use windows.h, fix if any conflicts
typedef void *                      VSF_WIN_HANDLE;
typedef unsigned long               VSF_WIN_DWORD;
typedef unsigned int                VSF_WIN_UINT;
typedef unsigned char               VSF_WIN_BYTE;
typedef char *                      VSF_WIN_LPSTR;
#ifdef __CPU_X64__
typedef unsigned long long          VSF_WIN_ULONG_PTR, *VSF_WIN_PULONG_PTR;
#else
typedef unsigned long               VSF_WIN_ULONG_PTR, *VSF_WIN_PULONG_PTR;
#endif
typedef VSF_WIN_ULONG_PTR           VSF_WIN_DWORD_PTR, *VSF_WIN_PDWORD_PTR;
 
#ifndef VSF_ARCH_SYSTIMER_TICK_T
#   define VSF_ARCH_SYSTIMER_TICK_T uint64_t
#endif
typedef VSF_ARCH_SYSTIMER_TICK_T    vsf_systimer_tick_t;
 
typedef enum vsf_arch_prio_t {
    VSF_ARCH_PRIO_INVALID = -1,
    vsf_arch_prio_invalid = -1,
    VSF_MREPEAT(VSF_ARCH_PRI_NUM, __VSF_ARCH_PRI, __UNUSED)
    vsf_arch_prio_highest = VSF_ARCH_PRI_NUM - 1,
} vsf_arch_prio_t;
 
typedef void (*vsf_arch_irq_entry_t)(void*);
 
vsf_class(vsf_arch_irq_request_t) {
    private_member(
        VSF_WIN_HANDLE event;
        bool is_inited;
    )
};
 
typedef volatile bool vsf_gint_state_t;
 
/*============================ INCLUDES ======================================*/
 
#if VSF_ARCH_PRI_NUM == 1 && VSF_ARCH_SWI_NUM == 0
#   include "hal/arch/common/arch_without_thread_suspend/vsf_arch_without_thread_suspend_template.h"
#else
#   define VSF_ARCH_NO_DISABLE_INTERRUPT_BEFORE_SLEEP
#endif
 
/*============================ TYPES =========================================*/
 
#if VSF_ARCH_PRI_NUM == 1 && VSF_ARCH_SWI_NUM == 0
vsf_class(vsf_arch_irq_thread_t) {
    private_member(
        implement(vsf_arch_irq_thread_common_t)
        VSF_WIN_HANDLE thread;
        VSF_WIN_DWORD thread_id;
    )
};
#else
typedef enum vsf_arch_irq_state_t {
    VSF_ARCH_IRQ_STATE_IDLE,
    VSF_ARCH_IRQ_STATE_ACTIVE,
    VSF_ARCH_IRQ_STATE_FOREGROUND,
    VSF_ARCH_IRQ_STATE_BACKGROUND,
} vsf_arch_irq_state_t;
 
vsf_class(vsf_arch_irq_thread_t) {
    public_member(
        const char name[32];
 
        __VSF_WIN_PUBLIC_CONST__ vsf_dlist_node_t irq_node;
        __VSF_WIN_PUBLIC_CONST__ vsf_dlist_node_t rdy_node;
        __VSF_WIN_PUBLIC_CONST__ VSF_WIN_HANDLE thread;
        __VSF_WIN_PUBLIC_CONST__ VSF_WIN_DWORD thread_id;
        __VSF_WIN_PUBLIC_CONST__ vsf_arch_prio_t priority;
        __VSF_WIN_PUBLIC_CONST__ vsf_arch_irq_thread_t *prev;     // call stack
        __VSF_WIN_PUBLIC_CONST__ vsf_arch_irq_state_t state;
        __VSF_WIN_PUBLIC_CONST__ vsf_arch_irq_request_t *reply;
    )
};
#endif
#undef __VSF_WIN_PUBLIC_CONST__
 
/*============================ GLOBAL VARIABLES ==============================*/
/*============================ LOCAL VARIABLES ===============================*/
/*============================ PROTOTYPES ====================================*/
 
// this API is implement in driver
extern int __vsf_arch_trace(int level, const char *format, ...);
 
extern bool __vsf_arch_before_entry(void);
 
extern void __vsf_arch_irq_sleep(uint_fast32_t ms);
extern int vsf_arch_argu(char ***argv);
extern void * vsf_arch_alloc_exe(uint_fast32_t size);
extern void vsf_arch_free_exe(void *ptr);
 
extern void __vsf_arch_irq_request_init(vsf_arch_irq_request_t *request);
extern void __vsf_arch_irq_request_fini(vsf_arch_irq_request_t *request);
extern void __vsf_arch_irq_request_pend(vsf_arch_irq_request_t *request);
extern void __vsf_arch_irq_request_send(vsf_arch_irq_request_t *request);
 
extern vsf_arch_irq_thread_t * __vsf_arch_irq_get_cur(void);
extern void __vsf_arch_irq_init(vsf_arch_irq_thread_t *irq_thread, char *name,
    vsf_arch_irq_entry_t entry, vsf_arch_prio_t priority);
extern void __vsf_arch_irq_fini(vsf_arch_irq_thread_t *irq_thread);
extern void __vsf_arch_irq_set_background(vsf_arch_irq_thread_t *irq_thread);
extern void __vsf_arch_irq_start(vsf_arch_irq_thread_t *irq_thread);
extern void __vsf_arch_irq_end(vsf_arch_irq_thread_t *irq_thread, bool is_terminate);
 
#ifdef VSF_ARCH_LIMIT_NO_SET_STACK
extern void __vsf_arch_irq_exit(vsf_arch_irq_thread_t *irq_thread);
extern vsf_err_t __vsf_arch_irq_restart(vsf_arch_irq_thread_t *irq_thread,
                    vsf_arch_irq_request_t *request_pending);
#endif
 
// for trace only
extern vsf_systimer_tick_t __vsf_systimer_get(void);
 
#ifndef VSF_ARCH_LIMIT_NO_SET_STACK
static VSF_CAL_ALWAYS_INLINE void vsf_arch_set_stack(uintptr_t stack, uint32_t stack_size)
{
#if     defined(__CPU_X86__)
    __asm__("movl %0, %%esp" : : "r"(stack));
#elif   defined(__CPU_X64__)
    __asm__("movq %0, %%rsp" : : "r"(stack));
#endif
}
 
static VSF_CAL_ALWAYS_INLINE uintptr_t vsf_arch_get_stack(void)
{
    uintptr_t stack;
#if     defined(__CPU_X86__)
    __asm__("movl %%esp, %0" : "=r"(stack) :);
#elif   defined(__CPU_X64__)
    __asm__("movq %%esp, %0" : "=r"(stack) :);
#endif
    return stack;
}
#endif
 
#ifdef __cplusplus
}
#endif
 
#endif
/* EOF */