Zephyr API Documentation  3.6.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
kernel_arch_interface.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2019 Intel Corporation.
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6
17#ifndef ZEPHYR_KERNEL_INCLUDE_KERNEL_ARCH_INTERFACE_H_
18#define ZEPHYR_KERNEL_INCLUDE_KERNEL_ARCH_INTERFACE_H_
19
20#include <zephyr/kernel.h>
22
23#ifndef _ASMLANGUAGE
24
25#ifdef __cplusplus
26extern "C" {
27#endif
28
33#ifdef CONFIG_ARCH_HAS_CUSTOM_BUSY_WAIT
39void arch_busy_wait(uint32_t usec_to_wait);
40#endif /* CONFIG_ARCH_HAS_CUSTOM_BUSY_WAIT */
41
76void arch_new_thread(struct k_thread *thread, k_thread_stack_t *stack,
77 char *stack_ptr, k_thread_entry_t entry,
78 void *p1, void *p2, void *p3);
79
80#ifdef CONFIG_USE_SWITCH
131static inline void arch_switch(void *switch_to, void **switched_from);
132#else
145int arch_swap(unsigned int key);
146
155static ALWAYS_INLINE void
156arch_thread_return_value_set(struct k_thread *thread, unsigned int value);
157#endif /* CONFIG_USE_SWITCH */
158
159#ifdef CONFIG_ARCH_HAS_CUSTOM_SWAP_TO_MAIN
170void arch_switch_to_main_thread(struct k_thread *main_thread, char *stack_ptr,
171 k_thread_entry_t _main);
172#endif /* CONFIG_ARCH_HAS_CUSTOM_SWAP_TO_MAIN */
173
174#if defined(CONFIG_FPU) && defined(CONFIG_FPU_SHARING)
188int arch_float_disable(struct k_thread *thread);
189
208int arch_float_enable(struct k_thread *thread, unsigned int options);
209#endif /* CONFIG_FPU && CONFIG_FPU_SHARING */
210
219FUNC_NORETURN void arch_system_halt(unsigned int reason);
220
238static inline bool arch_is_in_isr(void);
239
284void arch_mem_map(void *virt, uintptr_t phys, size_t size, uint32_t flags);
285
312void arch_mem_unmap(void *addr, size_t size);
313
335int arch_page_phys_get(void *virt, uintptr_t *phys);
336
348
368void arch_mem_page_out(void *addr, uintptr_t location);
369
387void arch_mem_page_in(void *addr, uintptr_t phys);
388
404
411
414
418
447
532 bool clear_accessed);
533
559
566static inline void arch_kernel_init(void);
567
569static inline void arch_nop(void);
570
586void arch_coredump_info_dump(const z_arch_esf_t *esf);
587
592
611size_t arch_tls_stack_setup(struct k_thread *new_thread, char *stack_ptr);
612
615/* Include arch-specific inline function implementation */
616#include <kernel_arch_func.h>
617
618#ifdef __cplusplus
619}
620#endif
621
622#endif /* _ASMLANGUAGE */
623
624#endif /* ZEPHYR_KERNEL_INCLUDE_KERNEL_ARCH_INTERFACE_H_ */
struct z_thread_stack_element k_thread_stack_t
Typedef of struct z_thread_stack_element.
Definition: arch_interface.h:45
void(* k_thread_entry_t)(void *p1, void *p2, void *p3)
Thread entry point function type.
Definition: arch_interface.h:47
#define ALWAYS_INLINE
Definition: common.h:129
void arch_coredump_info_dump(const z_arch_esf_t *esf)
Architecture-specific handling during coredump.
uint16_t arch_coredump_tgt_code_get(void)
Get the target code specified by the architecture.
static bool arch_is_in_isr(void)
Test if the current context is in interrupt context.
static void arch_kernel_init(void)
Architecture-specific kernel initialization hook.
int arch_printk_char_out(int c)
Early boot console output hook.
static void arch_nop(void)
Do nothing and return.
void arch_reserved_pages_update(void)
Update page frame database with reserved pages.
void arch_mem_page_in(void *addr, uintptr_t phys)
Update all page tables for a paged-in data page.
void arch_mem_page_out(void *addr, uintptr_t location)
Update all page tables for a paged-out data page.
void arch_mem_map(void *virt, uintptr_t phys, size_t size, uint32_t flags)
Map physical memory into the virtual address space.
arch_page_location
Status of a particular page location.
Definition: kernel_arch_interface.h:408
enum arch_page_location arch_page_location_get(void *addr, uintptr_t *location)
Fetch location information about a page at a particular address.
void arch_mem_unmap(void *addr, size_t size)
Remove mappings for a provided virtual address range.
int arch_page_phys_get(void *virt, uintptr_t *phys)
Get the mapped physical memory address from virtual address.
uintptr_t arch_page_info_get(void *addr, uintptr_t *location, bool clear_accessed)
Retrieve page characteristics from the page table(s)
void arch_mem_scratch(uintptr_t phys)
Update current page tables for a temporary mapping.
@ ARCH_PAGE_LOCATION_BAD
The page is not mapped.
Definition: kernel_arch_interface.h:416
@ ARCH_PAGE_LOCATION_PAGED_OUT
The page has been evicted to the backing store.
Definition: kernel_arch_interface.h:410
@ ARCH_PAGE_LOCATION_PAGED_IN
The page is resident in memory.
Definition: kernel_arch_interface.h:413
FUNC_NORETURN void arch_system_halt(unsigned int reason)
Halt the system, optionally propagating a reason code.
void arch_switch_to_main_thread(struct k_thread *main_thread, char *stack_ptr, k_thread_entry_t _main)
Custom logic for entering main thread context at early boot.
int arch_float_disable(struct k_thread *thread)
Disable floating point context preservation.
static void arch_switch(void *switch_to, void **switched_from)
Cooperative context switch primitive.
int arch_float_enable(struct k_thread *thread, unsigned int options)
Enable floating point context preservation.
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)
Handle arch-specific logic for setting up new threads.
void arch_busy_wait(uint32_t usec_to_wait)
Architecture-specific implementation of busy-waiting.
size_t arch_tls_stack_setup(struct k_thread *new_thread, char *stack_ptr)
Setup Architecture-specific TLS area in stack.
Public kernel APIs.
flags
Definition: parser.h:96
__UINT32_TYPE__ uint32_t
Definition: stdint.h:90
__UINTPTR_TYPE__ uintptr_t
Definition: stdint.h:105
__UINT16_TYPE__ uint16_t
Definition: stdint.h:89
Thread Structure.
Definition: thread.h:259