kernel: remove nano/micro wording and usage

Also remove some old cflags referencing directories that do not exist
anymore.
Also replace references to legacy APIs in doxygen documentation of
various functions.

Change-Id: I8fce3d1fe0f4defc44e6eb0ae09a4863e33a39db
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
This commit is contained in:
Anas Nashif 2016-12-18 09:42:55 -05:00 committed by Anas Nashif
commit cb888e6805
30 changed files with 68 additions and 88 deletions

View file

@ -40,7 +40,7 @@ const NANO_ESF _default_esf = {
/**
*
* @brief Nanokernel fatal error handler
* @brief Kernel fatal error handler
*
* This routine is called when fatal error conditions are detected by software
* and is responsible only for reporting the error. Once reported, it then

View file

@ -16,15 +16,14 @@
/**
* @file
* @brief ARCv2 nano kernel structure member offset definition file
* @brief ARCv2 kernel structure member offset definition file
*
* This module is responsible for the generation of the absolute symbols whose
* value represents the member offsets for various ARCv2 nanokernel
* structures.
* value represents the member offsets for various ARCv2 kernel structures.
*
* All of the absolute symbols defined by this module will be present in the
* final microkernel or nanokernel ELF image (due to the linker's reference to
* the _OffsetAbsSyms symbol).
* final kernel ELF image (due to the linker's reference to the _OffsetAbsSyms
* symbol).
*
* INTERNAL
* It is NOT necessary to define the offset for every member of a structure.

View file

@ -41,9 +41,9 @@ GDATA(_kernel)
*
* @brief Initiate a cooperative context switch
*
* The _Swap() routine is invoked by various nanokernel services to effect
* The _Swap() routine is invoked by various kernel services to effect
* a cooperative context switch. Prior to invoking _Swap(), the caller
* disables interrupts via nanoCpuIntLock() and the return 'key' is passed as a
* disables interrupts via irq_lock() and the return 'key' is passed as a
* parameter to _Swap(). The key is in fact the value stored in the register
* operand of a CLRI instruction.
*

View file

@ -18,8 +18,7 @@
* @file
* @brief New thread creation for ARCv2
*
* Core nanokernel fiber related primitives for the ARCv2 processor
* architecture.
* Core thread related primitives for the ARCv2 processor architecture.
*/
#include <nanokernel.h>

View file

@ -16,7 +16,7 @@
/**
* @file
* @brief ARC nanokernel declarations to start a task
* @brief ARC declarations to start a task
*
* ARC-specific parts of start_task().
*

View file

@ -18,7 +18,7 @@
* @file
* @brief Interrupt helper functions (ARC)
*
* This file contains private nanokernel structures definitions and various
* This file contains private kernel structures definitions and various
* other definitions for the ARCv2 processor architecture.
*/

View file

@ -68,7 +68,7 @@ SECTION_FUNC(TEXT, _CpuIdleInit)
*
* @brief Get the kernel idle setting
*
* Returns the nanokernel idle setting, in ticks. Only called by __systick().
* Returns the kernel idle setting, in ticks. Only called by __systick().
*
* @return the requested number of ticks for the kernel to be idle
*
@ -86,7 +86,7 @@ SECTION_FUNC(TEXT, _NanoIdleValGet)
*
* @brief Clear the kernel idle setting
*
* Sets the nanokernel idle setting to 0. Only called by __systick().
* Sets the kernel idle setting to 0. Only called by __systick().
*
* @return N/A
*
@ -107,8 +107,8 @@ SECTION_FUNC(TEXT, _NanoIdleValClear)
*
* @brief Power save idle routine for ARM Cortex-M
*
* This function will be called by the nanokernel idle loop or possibly within
* an implementation of _sys_power_save_idle in the microkernel when the
* This function will be called by the ernel idle loop or possibly within
* an implementation of _sys_power_save_idle in the kernel when the
* '_sys_power_save_flag' variable is non-zero. The ARM 'wfi' instruction
* will be issued, causing a low-power consumption sleep mode.
*
@ -143,16 +143,12 @@ SECTION_FUNC(TEXT, k_cpu_idle)
*
* @brief Atomically re-enable interrupts and enter low power mode
*
* This function is utilized by the nanokernel object "wait" APIs for tasks,
* e.g. nano_task_lifo_get(), nano_task_sem_take(),
* nano_task_stack_pop(), and nano_task_fifo_get().
*
* INTERNAL
* The requirements for k_cpu_atomic_idle() are as follows:
* 1) The enablement of interrupts and entering a low-power mode needs to be
* atomic, i.e. there should be no period of time where interrupts are
* enabled before the processor enters a low-power mode. See the comments
* in nano_task_lifo_get(), for example, of the race condition that occurs
* in k_lifo_get(), for example, of the race condition that occurs
* if this requirement is not met.
*
* 2) After waking up from the low-power mode, the interrupt lockout state

View file

@ -16,7 +16,7 @@
/**
* @file
* @brief Nanokernel fatal error handler for ARM Cortex-M
* @brief Kernel fatal error handler for ARM Cortex-M
*
* This module provides the _NanoFatalErrorHandler() routine for ARM Cortex-M.
*/
@ -60,7 +60,7 @@ const NANO_ESF _default_esf = {
/**
*
* @brief Nanokernel fatal error handler
* @brief Kernel fatal error handler
*
* This routine is called when fatal error conditions are detected by software
* and is responsible only for reporting the error. Once reported, it then

View file

@ -18,7 +18,7 @@
* @file
* @brief ARM Cortex-M interrupt initialization
*
* The ARM Cortex-M architecture provides its own fiber_abort() to deal with
* The ARM Cortex-M architecture provides its own k_thread_abort() to deal with
* different CPU modes (handler vs thread) when a fiber aborts. When its entry
* point returns or when it aborts itself, the CPU is in thread mode and must
* call _Swap() (which triggers a service call), but when in handler mode, the

View file

@ -16,15 +16,14 @@
/**
* @file
* @brief ARM nano kernel structure member offset definition file
* @brief ARM kernel structure member offset definition file
*
* This module is responsible for the generation of the absolute symbols whose
* value represents the member offsets for various ARM nanokernel
* structures.
* value represents the member offsets for various ARM kernel structures.
*
* All of the absolute symbols defined by this module will be present in the
* final microkernel or nanokernel ELF image (due to the linker's reference to
* the _OffsetAbsSyms symbol).
* final kernel ELF image (due to the linker's reference to the _OffsetAbsSyms
* symbol).
*
* INTERNAL
* It is NOT necessary to define the offset for every member of a structure.

View file

@ -243,7 +243,7 @@ _context_switch:
*
* @brief Initiate a cooperative context switch
*
* The _Swap() routine is invoked by various nanokernel services to effect
* The _Swap() routine is invoked by various kernel services to effect
* a cooperative context context switch. Prior to invoking _Swap(), the caller
* disables interrupts via irq_lock() and the return 'key' is passed as a
* parameter to _Swap(). The 'key' actually represents the BASEPRI register

View file

@ -18,12 +18,10 @@
* @file
* @brief New thread creation for ARM Cortex-M
*
* Core nanokernel fiber related primitives for the ARM Cortex-M processor
* architecture.
* Core thread related primitives for the ARM Cortex-M processor architecture.
*/
#include <nanokernel.h>
#include <arch/cpu.h>
#include <toolchain.h>
#include <kernel_structs.h>
#include <wait_q.h>

View file

@ -16,7 +16,7 @@
/**
* @file
* @brief ARM nanokernel declarations to start a task
* @brief ARM kernel declarations to start a task
*
* ARM-specific parts of start_task().
*

View file

@ -21,7 +21,7 @@
*
* @brief Power save idle routine
*
* This function will be called by the nanokernel idle loop or possibly within
* This function will be called by the kernel idle loop or possibly within
* an implementation of _sys_power_save_idle in the microkernel when the
* '_sys_power_save_flag' variable is non-zero.
*
@ -39,16 +39,12 @@ void k_cpu_idle(void)
*
* @brief Atomically re-enable interrupts and enter low power mode
*
* This function is utilized by the nanokernel object "wait" APIs for tasks,
* e.g. nano_task_lifo_get(), nano_task_sem_take(),
* nano_task_stack_pop(), and nano_task_fifo_get().
*
* INTERNAL
* The requirements for k_cpu_atomic_idle() are as follows:
* 1) The enablement of interrupts and entering a low-power mode needs to be
* atomic, i.e. there should be no period of time where interrupts are
* enabled before the processor enters a low-power mode. See the comments
* in nano_task_lifo_get(), for example, of the race condition that
* in k_lifo_get(), for example, of the race condition that
* occurs if this requirement is not met.
*
* 2) After waking up from the low-power mode, the interrupt lockout state

View file

@ -112,7 +112,7 @@ SECTION_FUNC(TEXT, __start)
#ifdef CONFIG_INIT_STACKS
/* Pre-populate all bytes in _interrupt_stack with 0xAA
* nano_init.c enforces that the _interrupt_stack pointer
* init.c enforces that the _interrupt_stack pointer
* and CONFIG_ISR_STACK_SIZE are a multiple of STACK_ALIGN (4) */
movhi r1, %hi(_interrupt_stack)
ori r1, r1, %lo(_interrupt_stack)
@ -151,6 +151,6 @@ SECTION_FUNC(TEXT, __start)
*/
/* Jump into C domain. _PrepC zeroes BSS, copies rw data into RAM,
* and then enters nanokernel _Cstart */
* and then enters _Cstart */
call _PrepC

View file

@ -43,7 +43,7 @@ const NANO_ESF _default_esf = {
/**
*
* @brief Nanokernel fatal error handler
* @brief Kernel fatal error handler
*
* This routine is called when a fatal error condition is detected by either
* hardware or software.

View file

@ -16,15 +16,15 @@
/**
* @file
* @brief Nios II nano kernel structure member offset definition file
* @brief Nios II kernel structure member offset definition file
*
* This module is responsible for the generation of the absolute symbols whose
* value represents the member offsets for various Nios II nanokernel
* value represents the member offsets for various Nios II kernel
* structures.
*
* All of the absolute symbols defined by this module will be present in the
* final microkernel or nanokernel ELF image (due to the linker's reference to
* the _OffsetAbsSyms symbol).
* final kernel ELF image (due to the linker's reference to the _OffsetAbsSyms
* symbol).
*
* INTERNAL
* It is NOT necessary to define the offset for every member of a structure.

View file

@ -16,9 +16,8 @@
/**
* @file CPU power management code for IA-32
*
* DESCRIPTION
* This module provides an implementation of the architecture-specific
* k_cpu_idle() primitive required by the nanokernel idle loop component.
* k_cpu_idle() primitive required by the kernel idle loop component.
* It can be called within an implementation of _sys_power_save_idle(),
* which is provided for the microkernel by the platform.
*
@ -46,7 +45,7 @@ extern uint64_t __idle_tsc; /* timestamp when CPU went idle */
*
* @brief Power save idle routine for IA-32
*
* This function will be called by the nanokernel idle loop or possibly within
* This function will be called by the kernel idle loop or possibly within
* an implementation of _sys_power_save_idle in the microkernel when the
* '_sys_power_save_flag' variable is non-zero. The IA-32 'hlt' instruction
* will be issued causing a low-power consumption sleep mode.
@ -70,16 +69,12 @@ void k_cpu_idle(void)
*
* @brief Atomically re-enable interrupts and enter low power mode
*
* This function is utilized by the nanokernel object "wait" APIs for tasks,
* e.g. nano_task_lifo_get(), nano_task_sem_take(),
* nano_task_stack_pop(), and nano_task_fifo_get().
*
* INTERNAL
* The requirements for k_cpu_atomic_idle() are as follows:
* 1) The enablement of interrupts and entering a low-power mode needs to be
* atomic, i.e. there should be no period of time where interrupts are
* enabled before the processor enters a low-power mode. See the comments
* in nano_task_lifo_get(), for example, of the race condition that
* in k_lifo_get(), for example, of the race condition that
* occurs if this requirement is not met.
*
* 2) After waking up from the low-power mode, the interrupt lockout state

View file

@ -1,4 +1,2 @@
ccflags-y += -I$(srctree)/kernel/nanokernel/include
ccflags-y += -I$(srctree)/kernel/microkernel/include
obj-y = debug_frames.o

View file

@ -16,7 +16,7 @@
/**
* @file
* @brief Nanokernel fatal error handler
* @brief Kernel fatal error handler
*
* This module provides the _NanoFatalErrorHandler() routine.
*/
@ -54,7 +54,7 @@ const NANO_ESF _default_esf = {
/**
*
* @brief Nanokernel fatal error handler
* @brief Kernel fatal error handler
*
* This routine is called when a fatal error condition is detected by either
* hardware or software.

View file

@ -16,14 +16,14 @@
/**
* @file
* @brief Nanokernel structure member offset definition file
* @brief Kernel structure member offset definition file
*
* This module is responsible for the generation of the absolute symbols whose
* value represents the member offsets for various IA-32 nanokernel structures.
* value represents the member offsets for various IA-32 structures.
*
* All of the absolute symbols defined by this module will be present in the
* final microkernel or nanokernel ELF image (due to the linker's reference to
* the _OffsetAbsSyms symbol).
* final kernel ELF image (due to the linker's reference to the _OffsetAbsSyms
* symbol).
*
* INTERNAL
* It is NOT necessary to define the offset for every member of a structure.
@ -32,7 +32,7 @@
* completeness.
*/
#include <gen_offset.h> /* located in kernel/arch/common/include */
#include <gen_offset.h> /* located in kernel/include */
/* list of headers that define whose structure offsets will be generated */

View file

@ -16,11 +16,11 @@
/**
* @file
* @brief Nanokernel swapper code for IA-32
* @brief Kernel swapper code for IA-32
*
* This module implements the _Swap() routine for the IA-32 architecture.
*
* Note that the file include/nanokernel/x86/swapstk.h defines
* Note that the file arch/x86/include/swapstk.h defines
* a representation of the save stack frame generated by _Swap() in order
* to generate offsets (in the form of absolute symbols) for consumption by
* host tools. Please update swapstk.h if changing the structure of the
@ -44,7 +44,7 @@
*
* @brief Initiate a cooperative context switch
*
* The _Swap() routine is invoked by various nanokernel services to effect
* The _Swap() routine is invoked by various kernel services to effect
* a cooperative context switch. Prior to invoking _Swap(), the
* caller disables interrupts (via irq_lock) and the return 'key'
* is passed as a parameter to _Swap(). The 'key' actually represents
@ -69,7 +69,7 @@
*
* Floating point registers are handled using a lazy save/restore
* mechanism since it's expected relatively few threads will be created
* with the K_FP_REGS or K_SSE_REGS option bits. The nanokernel data structure
* with the K_FP_REGS or K_SSE_REGS option bits. The kernel data structure
* maintains a 'current_fp' field to keep track of the thread that "owns"
* the floating point registers. Floating point registers consist of
* ST0->ST7 (x87 FPU and MMX registers) and XMM0 -> XMM7.

View file

@ -16,9 +16,9 @@
/**
* @file
* @brief Nanokernel thread support primitives
* @brief Thread support primitives
*
* This module provides core nanokernel fiber related primitives for the IA-32
* This module provides core thread related primitives for the IA-32
* processor architecture.
*/

View file

@ -1,3 +1,2 @@
ccflags-y += -I$(srctree)/kernel/nanokernel/include
obj-$(CONFIG_GDB_SERVER) = gdb_arch.o gdb_dbg_regs.o

View file

@ -34,7 +34,7 @@ extern "C" {
*
* @brief Performs architecture-specific initialization
*
* This routine performs architecture-specific initialization of the nanokernel.
* This routine performs architecture-specific initialization of the kernel.
* Trivial stuff is done inline; more complex initialization is done via
* function calls.
*
@ -98,8 +98,8 @@ extern void _MsrWrite(unsigned int msr, uint64_t msrData);
extern uint64_t _MsrRead(unsigned int msr);
/*
* _IntLibInit() is called from the non-arch specific nanokernel function,
* _nano_init(). The IA-32 nanokernel does not require any special
* _IntLibInit() is called from the non-arch specific function,
* prepare_multithreading(). The IA-32 kernel does not require any special
* initialization of the interrupt subsystem. However, we still need to
* provide an _IntLibInit() of some sort to prevent build errors.
*/

View file

@ -16,7 +16,7 @@
/**
* @file
* @brief Intel nanokernel declarations to start a task
* @brief Kernel declarations to start a thread for X86
*
* Intel-specific parts of start_task(). Only FP functionality currently.
*/

View file

@ -1,9 +1,3 @@
/** @file
* @brief timeout queue for fibers on nanokernel objects
*
* This file is meant to be included by nanokernel/include/wait_q.h only
*/
/*
* Copyright (c) 2015 Wind River Systems, Inc.
*
@ -20,8 +14,15 @@
* limitations under the License.
*/
#ifndef _kernel_nanokernel_include_timeout_q__h_
#define _kernel_nanokernel_include_timeout_q__h_
#ifndef _kernel_include_timeout_q__h_
#define _kernel_include_timeout_q__h_
/**
* @file
* @brief timeout queue for threads on kernel objects
*
* This file is meant to be included by kernel/include/wait_q.h only
*/
#include <misc/dlist.h>
@ -29,7 +30,7 @@
extern "C" {
#endif
/* initialize the nano timeouts part of k_thread when enabled in the kernel */
/* initialize the timeouts part of k_thread when enabled in the kernel */
static inline void _init_timeout(struct _timeout *t, _timeout_func_t func)
{
@ -248,4 +249,4 @@ static inline int32_t _get_next_timeout_expiry(void)
}
#endif
#endif /* _kernel_nanokernel_include_timeout_q__h_ */
#endif /* _kernel_include_timeout_q__h_ */

View file

@ -1,4 +1,4 @@
/* wait queue for multiple fibers on nanokernel objects */
/* wait queue for multiple threads on kernel objects */
/*
* Copyright (c) 2015 Wind River Systems, Inc.

View file

@ -16,7 +16,7 @@
/**
* @file
* @brief Nanokernel initialization module
* @brief Kernel initialization module
*
* This module contains routines that are used to initialize the nanokernel.
*/

View file

@ -17,7 +17,7 @@
/**
* @file
*
* @brief Nanokernel semaphore object.
* @brief Kernel semaphore object.
*
* The semaphores are of the 'counting' type, i.e. each 'give' operation will
* increment the internal count by 1, if no fiber is pending on it. The 'init'