kernel: fix all nanokernel usage in comments

Also include kernel.h instead of nanokernel.h

Change-Id: I65dc5e31b5409b809397296817e2d5e7adf28892
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
This commit is contained in:
Anas Nashif 2016-12-19 20:25:56 -05:00 committed by Anas Nashif
parent 3d8e86c12c
commit dc3d73bf58
6 changed files with 30 additions and 31 deletions

View file

@ -14,7 +14,7 @@
* limitations under the License.
*/
#include <nanokernel.h>
#include <kernel.h>
#include <kernel_structs.h>
#include <toolchain.h>
#include <sections.h>
@ -49,7 +49,7 @@ void __attribute__((weak)) _sys_soc_resume_from_deep_sleep(void)
*
* @brief Indicate that kernel is idling in tickless mode
*
* Sets the nanokernel data structure idle field to either a positive value or
* Sets the kernel data structure idle field to either a positive value or
* K_FOREVER.
*
* @param ticks the number of ticks to idle

View file

@ -18,11 +18,11 @@
* @file
* @brief Macros to generate structure member offset definitions
*
* This header contains macros to allow a nanokernel implementation to
* generate absolute symbols whose values represents the member offsets for
* various nanokernel structures. These absolute symbols are typically
* utilized by assembly source files rather than hardcoding the values in
* some local header file.
* This header contains macros to allow a kernel implementation to generate
* absolute symbols whose values represents the member offsets for various
* kernel structures. These absolute symbols are typically utilized by
* assembly source files rather than hardcoding the values in some local header
* file.
*
* WARNING: Absolute symbols can potentially be utilized by external tools --
* for example, to locate a specific field within a data structure.

View file

@ -16,10 +16,9 @@
/**
* @file
* @brief Architecture-independent private nanokernel APIs
* @brief Architecture-independent private kernel APIs
*
* This file contains private nanokernel APIs that are not
* architecture-specific.
* This file contains private kernel APIs that are not architecture-specific.
*/
#ifndef _NANO_INTERNAL__H_

View file

@ -16,8 +16,8 @@
* limitations under the License.
*/
#ifndef _kernel_nanokernel_include_wait_q__h_
#define _kernel_nanokernel_include_wait_q__h_
#ifndef _kernel_include_wait_q__h_
#define _kernel_include_wait_q__h_
#include <kernel_structs.h>
#include <misc/dlist.h>
@ -56,4 +56,4 @@ static ALWAYS_INLINE int _abort_thread_timeout(struct k_thread *thread)
}
#endif
#endif /* _kernel_nanokernel_include_wait_q__h_ */
#endif /* _kernel_include_wait_q__h_ */

View file

@ -18,7 +18,7 @@
* @file
* @brief Kernel initialization module
*
* This module contains routines that are used to initialize the nanokernel.
* This module contains routines that are used to initialize the kernel.
*/
#include <zephyr.h>
@ -97,10 +97,10 @@ k_tid_t const _idle_thread = (k_tid_t)_idle_stack;
/*
* storage space for the interrupt stack
*
* Note: This area is used as the system stack during nanokernel initialization,
* since the nanokernel hasn't yet set up its own stack areas. The dual
* purposing of this area is safe since interrupts are disabled until the
* nanokernel context switches to the background (or idle) task.
* Note: This area is used as the system stack during kernel initialization,
* since the kernel hasn't yet set up its own stack areas. The dual purposing
* of this area is safe since interrupts are disabled until the kernel context
* switches to the init thread.
*/
#if CONFIG_ISR_STACK_SIZE & (STACK_ALIGN - 1)
#error "ISR_STACK_SIZE must be a multiple of the stack alignment"
@ -151,7 +151,7 @@ void _data_copy(void)
/**
*
* @brief Mainline for nanokernel's background task
* @brief Mainline for kernel's background task
*
* This routine completes kernel initialization by invoking the remaining
* init functions, then invokes application's main() routine.
@ -213,10 +213,10 @@ void __weak main(void)
/**
*
* @brief Initializes nanokernel data structures
* @brief Initializes kernel data structures
*
* This routine initializes various nanokernel data structures, including
* the background (or idle) task and any architecture-specific initialization.
* This routine initializes various kernel data structures, including
* the init and idle threads and any architecture-specific initialization.
*
* Note that all fields of "_kernel" are set to zero on entry, which may
* be all the initialization many of them require.
@ -230,7 +230,7 @@ static void prepare_multithreading(struct k_thread *dummy_thread)
#else
/*
* Initialize the current execution thread to permit a level of
* debugging output if an exception should happen during nanokernel
* debugging output if an exception should happen during kernel
* initialization. However, don't waste effort initializing the
* fields of the dummy thread beyond those needed to identify it as a
* dummy thread.
@ -247,7 +247,7 @@ static void prepare_multithreading(struct k_thread *dummy_thread)
/*
* The interrupt library needs to be initialized early since a series
* of handlers are installed into the interrupt table to catch
* spurious interrupts. This must be performed before other nanokernel
* spurious interrupts. This must be performed before other kernel
* subsystems install bonafide handlers, or before hardware device
* drivers are initialized.
*/
@ -347,7 +347,7 @@ extern void *__stack_chk_guard;
/**
*
* @brief Initialize nanokernel
* @brief Initialize kernel
*
* This routine is invoked when the system is ready to run C code. The
* processor must be running in 32-bit mode, and the BSS must have been
@ -360,14 +360,14 @@ FUNC_NORETURN void _Cstart(void)
#ifdef CONFIG_ARCH_HAS_CUSTOM_SWAP_TO_MAIN
void *dummy_thread = NULL;
#else
/* floating point is NOT used during nanokernel init */
/* floating point is NOT used during kernel init */
char __stack dummy_stack[_K_THREAD_NO_FLOAT_SIZEOF];
void *dummy_thread = dummy_stack;
#endif
/*
* Initialize nanokernel data structures. This step includes
* Initialize kernel data structures. This step includes
* initializing the interrupt subsystem, which must be performed
* before the hardware initialization phase.
*/

View file

@ -1,4 +1,4 @@
/* system clock support for nanokernel-only systems */
/* system clock support */
/*
* Copyright (c) 1997-2015 Wind River Systems, Inc.
@ -285,11 +285,11 @@ static void handle_time_slicing(int32_t ticks)
#endif
/**
*
* @brief Announce a tick to the nanokernel
* @brief Announce a tick to the kernel
*
* This function is only to be called by the system clock timer driver when a
* tick is to be announced to the nanokernel. It takes care of dequeuing the
* timers that have expired and wake up the fibers pending on them.
* tick is to be announced to the kernel. It takes care of dequeuing the
* timers that have expired and wake up the threads pending on them.
*
* @return N/A
*/