kernel_arch_interface.h

Go to the documentation of this file.

/*
 * Copyright (c) 2019 Intel Corporation.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_KERNEL_INCLUDE_KERNEL_ARCH_INTERFACE_H_
#define ZEPHYR_KERNEL_INCLUDE_KERNEL_ARCH_INTERFACE_H_
 
#include <zephyr/kernel.h>
#include <zephyr/arch/arch_interface.h>
 
#ifndef _ASMLANGUAGE
 
#ifdef __cplusplus
extern "C" {
#endif
 
#ifdef CONFIG_ARCH_HAS_CUSTOM_BUSY_WAIT
void arch_busy_wait(uint32_t usec_to_wait);
#endif /* CONFIG_ARCH_HAS_CUSTOM_BUSY_WAIT */
 
void arch_new_thread(struct k_thread *thread, k_thread_stack_t *stack,
                     char *stack_ptr, k_thread_entry_t entry,
                     void *p1, void *p2, void *p3);
 
#ifdef CONFIG_USE_SWITCH
static inline void arch_switch(void *switch_to, void **switched_from);
#endif /* CONFIG_USE_SWITCH */
 
#if !defined(CONFIG_USE_SWITCH) || defined(__DOXYGEN__)
#if defined(__DOXYGEN__)
int arch_swap(unsigned int key);
#endif /* __DOXYGEN__ */
 
static ALWAYS_INLINE void
arch_thread_return_value_set(struct k_thread *thread, unsigned int value);
#endif /* !CONFIG_USE_SWITCH || __DOXYGEN__ */
 
#ifdef CONFIG_ARCH_HAS_CUSTOM_SWAP_TO_MAIN
void arch_switch_to_main_thread(struct k_thread *main_thread, char *stack_ptr,
                                k_thread_entry_t _main);
#endif /* CONFIG_ARCH_HAS_CUSTOM_SWAP_TO_MAIN */
 
#if defined(CONFIG_FPU) && defined(CONFIG_FPU_SHARING)
int arch_float_disable(struct k_thread *thread);
 
int arch_float_enable(struct k_thread *thread, unsigned int options);
#endif /* CONFIG_FPU && CONFIG_FPU_SHARING */
 
#if defined(CONFIG_USERSPACE) && defined(CONFIG_ARCH_HAS_THREAD_PRIV_STACK_SPACE_GET)
int arch_thread_priv_stack_space_get(const struct k_thread *thread, size_t *stack_size,
                                     size_t *unused_ptr);
#endif /* CONFIG_USERSPACE && CONFIG_ARCH_HAS_THREAD_PRIV_STACK_SPACE_GET */
 
FUNC_NORETURN void arch_system_halt(unsigned int reason);
 
static inline bool arch_is_in_isr(void);
 
void arch_mem_map(void *virt, uintptr_t phys, size_t size, uint32_t flags);
 
void arch_mem_unmap(void *addr, size_t size);
 
int arch_page_phys_get(void *virt, uintptr_t *phys);
 
void arch_reserved_pages_update(void);
 
void arch_mem_page_out(void *addr, uintptr_t location);
 
void arch_mem_page_in(void *addr, uintptr_t phys);
 
void arch_mem_scratch(uintptr_t phys);
 
enum arch_page_location {
        ARCH_PAGE_LOCATION_PAGED_OUT,
 
        ARCH_PAGE_LOCATION_PAGED_IN,
 
        ARCH_PAGE_LOCATION_BAD
};
 
enum arch_page_location arch_page_location_get(void *addr, uintptr_t *location);
 
uintptr_t arch_page_info_get(void *addr, uintptr_t *location,
                             bool clear_accessed);
 
int arch_printk_char_out(int c);
 
#ifdef CONFIG_ARCH_HAS_THREAD_NAME_HOOK
int arch_thread_name_set(struct k_thread *thread, const char *str);
#endif /* CONFIG_ARCH_HAS_THREAD_NAME_HOOK */
 
static inline void arch_kernel_init(void);
 
static inline void arch_nop(void);
 
void arch_coredump_info_dump(const struct arch_esf *esf);
 
uint16_t arch_coredump_tgt_code_get(void);
 
#if defined(CONFIG_USERSPACE) || defined(__DOXYGEN__)
 
void arch_coredump_priv_stack_dump(struct k_thread *thread);
 
#endif /* CONFIG_USERSPACE || __DOXYGEN__ */
 
size_t arch_tls_stack_setup(struct k_thread *new_thread, char *stack_ptr);
 
/* Include arch-specific inline function implementation */
#include <kernel_arch_func.h>
 
#ifdef __cplusplus
}
#endif
 
#endif /* _ASMLANGUAGE */
 
#endif /* ZEPHYR_KERNEL_INCLUDE_KERNEL_ARCH_INTERFACE_H_ */