mirror of
https://github.com/zephyrproject-rtos/zephyr
synced 2025-09-01 23:43:30 +00:00
This commit refactors kernel and arch headers to establish a boundary between private and public interface headers. The refactoring strategy used in this commit is detailed in the issue This commit introduces the following major changes: 1. Establish a clear boundary between private and public headers by removing "kernel/include" and "arch/*/include" from the global include paths. Ideally, only kernel/ and arch/*/ source files should reference the headers in these directories. If these headers must be used by a component, these include paths shall be manually added to the CMakeLists.txt file of the component. This is intended to discourage applications from including private kernel and arch headers either knowingly and unknowingly. - kernel/include/ (PRIVATE) This directory contains the private headers that provide private kernel definitions which should not be visible outside the kernel and arch source code. All public kernel definitions must be added to an appropriate header located under include/. - arch/*/include/ (PRIVATE) This directory contains the private headers that provide private architecture-specific definitions which should not be visible outside the arch and kernel source code. All public architecture- specific definitions must be added to an appropriate header located under include/arch/*/. - include/ AND include/sys/ (PUBLIC) This directory contains the public headers that provide public kernel definitions which can be referenced by both kernel and application code. - include/arch/*/ (PUBLIC) This directory contains the public headers that provide public architecture-specific definitions which can be referenced by both kernel and application code. 2. Split arch_interface.h into "kernel-to-arch interface" and "public arch interface" divisions. - kernel/include/kernel_arch_interface.h * provides private "kernel-to-arch interface" definition. * includes arch/*/include/kernel_arch_func.h to ensure that the interface function implementations are always available. * includes sys/arch_interface.h so that public arch interface definitions are automatically included when including this file. - arch/*/include/kernel_arch_func.h * provides architecture-specific "kernel-to-arch interface" implementation. * only the functions that will be used in kernel and arch source files are defined here. - include/sys/arch_interface.h * provides "public arch interface" definition. * includes include/arch/arch_inlines.h to ensure that the architecture-specific public inline interface function implementations are always available. - include/arch/arch_inlines.h * includes architecture-specific arch_inlines.h in include/arch/*/arch_inline.h. - include/arch/*/arch_inline.h * provides architecture-specific "public arch interface" inline function implementation. * supersedes include/sys/arch_inline.h. 3. Refactor kernel and the existing architecture implementations. - Remove circular dependency of kernel and arch headers. The following general rules should be observed: * Never include any private headers from public headers * Never include kernel_internal.h in kernel_arch_data.h * Always include kernel_arch_data.h from kernel_arch_func.h * Never include kernel.h from kernel_struct.h either directly or indirectly. Only add the kernel structures that must be referenced from public arch headers in this file. - Relocate syscall_handler.h to include/ so it can be used in the public code. This is necessary because many user-mode public codes reference the functions defined in this header. - Relocate kernel_arch_thread.h to include/arch/*/thread.h. This is necessary to provide architecture-specific thread definition for 'struct k_thread' in kernel.h. - Remove any private header dependencies from public headers using the following methods: * If dependency is not required, simply omit * If dependency is required, - Relocate a portion of the required dependencies from the private header to an appropriate public header OR - Relocate the required private header to make it public. This commit supersedes #20047, addresses #19666, and fixes #3056. Signed-off-by: Stephanos Ioannidis <root@stephanos.io>
182 lines
3.7 KiB
C
182 lines
3.7 KiB
C
/*
|
|
* Copyright (c) 2018 Intel Corporation
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
#include <kernel.h>
|
|
#include <sys/atomic.h>
|
|
#include <cmsis_os.h>
|
|
|
|
#define TOTAL_CMSIS_THREAD_PRIORITIES (osPriorityRealtime - osPriorityIdle + 1)
|
|
|
|
static inline int _is_thread_cmsis_inactive(struct k_thread *thread)
|
|
{
|
|
u8_t state = thread->base.thread_state;
|
|
|
|
return state & (_THREAD_PRESTART | _THREAD_DEAD);
|
|
}
|
|
|
|
static inline s32_t zephyr_to_cmsis_priority(u32_t z_prio)
|
|
{
|
|
return(osPriorityRealtime - z_prio);
|
|
}
|
|
|
|
static inline u32_t cmsis_to_zephyr_priority(s32_t c_prio)
|
|
{
|
|
return(osPriorityRealtime - c_prio);
|
|
}
|
|
|
|
static void zephyr_thread_wrapper(void *arg1, void *arg2, void *arg3)
|
|
{
|
|
void * (*fun_ptr)(void *) = arg3;
|
|
|
|
fun_ptr(arg1);
|
|
}
|
|
|
|
/**
|
|
* @brief Create a new thread.
|
|
*/
|
|
osThreadId osThreadCreate(const osThreadDef_t *thread_def, void *arg)
|
|
{
|
|
struct k_thread *cm_thread;
|
|
u32_t prio;
|
|
k_tid_t tid;
|
|
u32_t stacksz;
|
|
|
|
k_thread_stack_t
|
|
(*stk_ptr)[K_THREAD_STACK_LEN(CONFIG_CMSIS_THREAD_MAX_STACK_SIZE)];
|
|
|
|
if ((thread_def == NULL) || (thread_def->instances == 0)) {
|
|
return NULL;
|
|
}
|
|
|
|
BUILD_ASSERT_MSG(
|
|
CONFIG_NUM_PREEMPT_PRIORITIES >= TOTAL_CMSIS_THREAD_PRIORITIES,
|
|
"Configure NUM_PREEMPT_PRIORITIES to at least"
|
|
" TOTAL_CMSIS_THREAD_PRIORITIES");
|
|
|
|
__ASSERT(thread_def->stacksize <= CONFIG_CMSIS_THREAD_MAX_STACK_SIZE,
|
|
"invalid stack size\n");
|
|
|
|
if (k_is_in_isr()) {
|
|
return NULL;
|
|
}
|
|
|
|
__ASSERT((thread_def->tpriority >= osPriorityIdle) &&
|
|
(thread_def->tpriority <= osPriorityRealtime),
|
|
"invalid priority\n");
|
|
|
|
stacksz = thread_def->stacksize;
|
|
if (stacksz == 0U) {
|
|
stacksz = CONFIG_CMSIS_THREAD_MAX_STACK_SIZE;
|
|
}
|
|
|
|
k_poll_signal_init(thread_def->poll_signal);
|
|
k_poll_event_init(thread_def->poll_event, K_POLL_TYPE_SIGNAL,
|
|
K_POLL_MODE_NOTIFY_ONLY, thread_def->poll_signal);
|
|
|
|
cm_thread = thread_def->cm_thread;
|
|
atomic_dec((atomic_t *)&thread_def->instances);
|
|
stk_ptr = thread_def->stack_mem;
|
|
prio = cmsis_to_zephyr_priority(thread_def->tpriority);
|
|
k_thread_custom_data_set((void *)thread_def);
|
|
|
|
tid = k_thread_create(&cm_thread[thread_def->instances],
|
|
stk_ptr[thread_def->instances], stacksz,
|
|
(k_thread_entry_t)zephyr_thread_wrapper,
|
|
(void *)arg, NULL, thread_def->pthread,
|
|
prio, 0, K_NO_WAIT);
|
|
|
|
return ((osThreadId)tid);
|
|
}
|
|
|
|
/**
|
|
* @brief Return the thread ID of the current running thread.
|
|
*/
|
|
osThreadId osThreadGetId(void)
|
|
{
|
|
if (k_is_in_isr()) {
|
|
return NULL;
|
|
}
|
|
|
|
return (osThreadId)k_current_get();
|
|
}
|
|
|
|
/**
|
|
* @brief Get current priority of an active thread.
|
|
*/
|
|
osPriority osThreadGetPriority(osThreadId thread_id)
|
|
{
|
|
k_tid_t thread = (k_tid_t)thread_id;
|
|
u32_t priority;
|
|
|
|
if ((thread_id == NULL) || (k_is_in_isr())) {
|
|
return osPriorityError;
|
|
}
|
|
|
|
priority = k_thread_priority_get(thread);
|
|
return zephyr_to_cmsis_priority(priority);
|
|
}
|
|
|
|
/**
|
|
* @brief Change priority of an active thread.
|
|
*/
|
|
osStatus osThreadSetPriority(osThreadId thread_id, osPriority priority)
|
|
{
|
|
if (thread_id == NULL) {
|
|
return osErrorParameter;
|
|
}
|
|
|
|
if (k_is_in_isr()) {
|
|
return osErrorISR;
|
|
}
|
|
|
|
if (priority < osPriorityIdle || priority > osPriorityRealtime) {
|
|
return osErrorValue;
|
|
}
|
|
|
|
if (_is_thread_cmsis_inactive((k_tid_t)thread_id)) {
|
|
return osErrorResource;
|
|
}
|
|
|
|
k_thread_priority_set((k_tid_t)thread_id,
|
|
cmsis_to_zephyr_priority(priority));
|
|
|
|
return osOK;
|
|
}
|
|
|
|
/**
|
|
* @brief Terminate execution of a thread.
|
|
*/
|
|
osStatus osThreadTerminate(osThreadId thread_id)
|
|
{
|
|
if (thread_id == NULL) {
|
|
return osErrorParameter;
|
|
}
|
|
|
|
if (k_is_in_isr()) {
|
|
return osErrorISR;
|
|
}
|
|
|
|
if (_is_thread_cmsis_inactive((k_tid_t)thread_id)) {
|
|
return osErrorResource;
|
|
}
|
|
|
|
k_thread_abort((k_tid_t)thread_id);
|
|
return osOK;
|
|
}
|
|
|
|
/**
|
|
* @brief Pass control to next thread that is in READY state.
|
|
*/
|
|
osStatus osThreadYield(void)
|
|
{
|
|
if (k_is_in_isr()) {
|
|
return osErrorISR;
|
|
}
|
|
|
|
k_yield();
|
|
return osOK;
|
|
}
|