OrgZephyr/zephyr
OrgZephyr
/
zephyr
mirror of https://github.com/zephyrproject-rtos/zephyr.git
1
0
Fork 0
Code Issues Releases Wiki Activity
zephyr/include/kernel_includes.h

48 lines
992 B
C
Raw Normal View History

include: create kernel_includes.h header to hold kernel includes This commit creates a new header file (kernel_include.h) that contains all header files to be included by kernel_init.h. Signed-off-by: Ioannis Glaropoulos <Ioannis.Glaropoulos@nordicsemi.no>
2018-06-20 23:30:48 +08:00
/*
* Copyright (c) 2018 Intel Corporation
*
* SPDX-License-Identifier: Apache-2.0
*/
/**
* @file
*
* @brief Header files included by kernel.h.
*/
headers: Fix headers across the project Any word started with underscore followed by and uppercase letter or a second underscore is a reserved word according with C99. Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2018-09-15 01:43:44 +08:00
#ifndef ZEPHYR_INCLUDE_KERNEL_INCLUDES_H_
#define ZEPHYR_INCLUDE_KERNEL_INCLUDES_H_
include: create kernel_includes.h header to hold kernel includes This commit creates a new header file (kernel_include.h) that contains all header files to be included by kernel_init.h. Signed-off-by: Ioannis Glaropoulos <Ioannis.Glaropoulos@nordicsemi.no>
2018-06-20 23:30:48 +08:00
#include <stddef.h>
#include <zephyr/types.h>
#include <limits.h>
#include <toolchain.h>
#include <linker/sections.h>
cleanup: include/: move atomic.h to sys/atomic.h move atomic.h to sys/atomic.h and create a shim for backward-compatibility. No functional changes to the headers. A warning in the shim can be controlled with CONFIG_COMPAT_INCLUDES. Related to #16539 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-06-26 00:25:32 +08:00
#include <sys/atomic.h>
cleanup: include/: move misc/__assert.h to sys/__assert.h move misc/__assert.h to sys/__assert.h and create a shim for backward-compatibility. No functional changes to the headers. A warning in the shim can be controlled with CONFIG_COMPAT_INCLUDES. Related to #16539 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-06-26 22:33:39 +08:00
#include <sys/__assert.h>
include: create kernel_includes.h header to hold kernel includes This commit creates a new header file (kernel_include.h) that contains all header files to be included by kernel_init.h. Signed-off-by: Ioannis Glaropoulos <Ioannis.Glaropoulos@nordicsemi.no>
2018-06-20 23:30:48 +08:00
#include <sched_priq.h>
cleanup: include/: move misc/dlist.h to sys/dlist.h move misc/dlist.h to sys/dlist.h and create a shim for backward-compatibility. No functional changes to the headers. A warning in the shim can be controlled with CONFIG_COMPAT_INCLUDES. Related to #16539 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-06-26 22:33:41 +08:00
#include <sys/dlist.h>
cleanup: include/: move misc/slist.h to sys/slist.h move misc/slist.h to sys/slist.h and create a shim for backward-compatibility. No functional changes to the headers. A warning in the shim can be controlled with CONFIG_COMPAT_INCLUDES. Related to #16539 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-06-26 22:33:52 +08:00
#include <sys/slist.h>
cleanup: include/: move misc/sflist.h to sys/sflist.h move misc/sflist.h to sys/sflist.h and create a shim for backward-compatibility. No functional changes to the headers. A warning in the shim can be controlled with CONFIG_COMPAT_INCLUDES. Related to #16539 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-06-26 22:33:51 +08:00
#include <sys/sflist.h>
cleanup: include/: move misc/util.h to sys/util.h move misc/util.h to sys/util.h and create a shim for backward-compatibility. No functional changes to the headers. A warning in the shim can be controlled with CONFIG_COMPAT_INCLUDES. Related to #16539 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-06-26 22:33:55 +08:00
#include <sys/util.h>
cleanup: include/: move misc/mempool_base.h to sys/mempool_base.h move misc/mempool_base.h to sys/mempool_base.h and create a shim for backward-compatibility. No functional changes to the headers. A warning in the shim can be controlled with CONFIG_COMPAT_INCLUDES. Related to #16539 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-06-26 22:33:46 +08:00
#include <sys/mempool_base.h>
headers: Refactor kernel and arch headers. 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>
2019-10-24 23:08:21 +08:00
#include <kernel_structs.h>
kernel: Add k_mem_pool compatibility layer on top of k_heap Add a shim layer implementing the legacy k_mem_pool APIs backed by a k_heap instead of the original implementation. Signed-off-by: Andy Ross <andrew.j.ross@intel.com>
2020-04-04 06:39:25 +08:00
#ifdef CONFIG_MEM_POOL_HEAP_BACKEND
#include <mempool_heap.h>
#else
kernel: Refactor k_mem_pool APIs into a base and derived level Almost all of the k_mem_pool API is implemented in terms of three lower level primitives: K_MEM_POOL_DEFINE(), k_mem_pool_alloc() and k_mem_pool_free_id(). These are themselves implemented on top of the lower level sys_mem_pool abstraction. Make this layering explicit by splitting the low level out into its own files: mempool_sys.c/h. Signed-off-by: Andy Ross <andrew.j.ross@intel.com>
2020-04-01 00:23:11 +08:00
#include <mempool_sys.h>
kernel: Add k_mem_pool compatibility layer on top of k_heap Add a shim layer implementing the legacy k_mem_pool APIs backed by a k_heap instead of the original implementation. Signed-off-by: Andy Ross <andrew.j.ross@intel.com>
2020-04-04 06:39:25 +08:00
#endif
include: create kernel_includes.h header to hold kernel includes This commit creates a new header file (kernel_include.h) that contains all header files to be included by kernel_init.h. Signed-off-by: Ioannis Glaropoulos <Ioannis.Glaropoulos@nordicsemi.no>
2018-06-20 23:30:48 +08:00
#include <kernel_version.h>
#include <syscall.h>
cleanup: include/: move misc/printk.h to sys/printk.h move misc/printk.h to sys/printk.h and create a shim for backward-compatibility. No functional changes to the headers. A warning in the shim can be controlled with CONFIG_COMPAT_INCLUDES. Related to #16539 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-06-26 22:33:49 +08:00
#include <sys/printk.h>
include: create kernel_includes.h header to hold kernel includes This commit creates a new header file (kernel_include.h) that contains all header files to be included by kernel_init.h. Signed-off-by: Ioannis Glaropoulos <Ioannis.Glaropoulos@nordicsemi.no>
2018-06-20 23:30:48 +08:00
#include <arch/cpu.h>
cleanup: include/: move misc/rb.h to sys/rb.h move misc/rb.h to sys/rb.h and create a shim for backward-compatibility. No functional changes to the headers. A warning in the shim can be controlled with CONFIG_COMPAT_INCLUDES. Related to #16539 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-06-26 22:33:50 +08:00
#include <sys/rb.h>
kernel.h: Header hygine, move clock/timer handling The kernel.h file had a bunch of internal APIs for timeout/clock handling mixed in. Move these to sys_clock.h, which it always included (in a weird location, so move THAT to kernel_includes.h with everything else). Signed-off-by: Andy Ross <andrew.j.ross@intel.com>
2018-09-20 00:35:43 +08:00
#include <sys_clock.h>
kernel/work_q: Spinlockify Each work_q object gets a separate spinlock to synchronize access instead of the global lock. Note that there was a recursive lock condition in k_delayed_work_cancel(), so that's been split out into an internal unlocked version and the API entry point that wraps it with a lock. Signed-off-by: Andy Ross <andrew.j.ross@intel.com>
2018-07-25 02:26:43 +08:00
#include <spinlock.h>
kernel: consolidate error handling code * z_NanoFatalErrorHandler() is now moved to common kernel code and renamed z_fatal_error(). Arches dump arch-specific info before calling. * z_SysFatalErrorHandler() is now moved to common kernel code and renamed k_sys_fatal_error_handler(). It is now much simpler; the default policy is simply to lock interrupts and halt the system. If an implementation of this function returns, then the currently running thread is aborted. * New arch-specific APIs introduced: - z_arch_system_halt() simply powers off or halts the system. * We now have a standard set of fatal exception reason codes, namespaced under K_ERR_* * CONFIG_SIMPLE_FATAL_ERROR_HANDLER deleted * LOG_PANIC() calls moved to k_sys_fatal_error_handler() Signed-off-by: Andrew Boie <andrew.p.boie@intel.com>
2019-07-12 05:18:28 +08:00
#include <fatal.h>
kernel_includes: add irq.h A lot of code assumes kernel.h pulls in irq_lock(), guarantee this. Signed-off-by: Andrew Boie <andrew.p.boie@intel.com>
2019-10-05 09:17:19 +08:00
#include <irq.h>
kernel: move thread stack macros to new header kernel.h is enormous and this can be cleanly separated out. Signed-off-by: Andrew Boie <andrew.p.boie@intel.com>
2020-04-20 05:45:12 +08:00
#include <sys/thread_stack.h>
userspace: move mem domain defines This now has its own header instead of kernel.h. The code is unchanged other than a forward declaration of k_tid_t. Signed-off-by: Andrew Boie <andrew.p.boie@intel.com>
2020-08-20 03:12:07 +08:00
#include <app_memory/mem_domain.h>
include: create kernel_includes.h header to hold kernel includes This commit creates a new header file (kernel_include.h) that contains all header files to be included by kernel_init.h. Signed-off-by: Ioannis Glaropoulos <Ioannis.Glaropoulos@nordicsemi.no>
2018-06-20 23:30:48 +08:00
headers: Fix headers across the project Any word started with underscore followed by and uppercase letter or a second underscore is a reserved word according with C99. Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2018-09-15 01:43:44 +08:00
#endif /* ZEPHYR_INCLUDE_KERNEL_INCLUDES_H_ */