From 82debdc2139ebb27071d230a66612db2f1ac3a11 Mon Sep 17 00:00:00 2001 From: Gregory Nutt Date: Mon, 25 May 2020 15:30:40 -0600 Subject: [PATCH] Make task_init() and task_activate() internal OS functions. -Move task_init() and task_activate() prototypes from include/sched.h to include/nuttx/sched.h. These are internal OS functions and should not be exposed to the user. -Remove references to task_init() and task_activate() from the User Manual. -Rename task_init() to nxtask_init() since since it is an OS internal function -Rename task_activate() to nxtask_activate since it is an OS internal function --- Documentation/NuttxPortingGuide.html | 2 +- Documentation/NuttxUserGuide.html | 136 +---------------------- TODO | 2 +- arch/arm/src/common/arm_usestack.c | 2 +- arch/avr/src/avr/up_usestack.c | 2 +- arch/avr/src/avr32/up_usestack.c | 2 +- arch/hc/src/common/up_usestack.c | 2 +- arch/mips/src/common/mips_usestack.c | 2 +- arch/renesas/src/common/up_usestack.c | 2 +- arch/risc-v/src/common/riscv_usestack.c | 2 +- arch/sim/src/sim/up_usestack.c | 2 +- arch/x86/src/i486/up_usestack.c | 2 +- arch/x86_64/src/intel64/up_usestack.c | 2 +- arch/xtensa/src/common/xtensa_usestack.c | 2 +- arch/z16/src/common/z16_usestack.c | 2 +- arch/z80/src/common/z80_usestack.c | 2 +- binfmt/binfmt_execmodule.c | 10 +- include/cxx/csched | 43 +++---- include/nuttx/arch.h | 41 +++---- include/nuttx/sched.h | 56 ++++++++++ include/sched.h | 5 - sched/pthread/pthread_create.c | 4 +- sched/task/task_activate.c | 46 +++----- sched/task/task_create.c | 2 +- sched/task/task_init.c | 6 +- sched/task/task_restart.c | 2 +- sched/task/task_setup.c | 5 +- sched/task/task_spawn.c | 6 +- sched/task/task_vfork.c | 2 +- 29 files changed, 138 insertions(+), 256 deletions(-) diff --git a/Documentation/NuttxPortingGuide.html b/Documentation/NuttxPortingGuide.html index 1e1cb7f5a96..0bd36b85361 100644 --- a/Documentation/NuttxPortingGuide.html +++ b/Documentation/NuttxPortingGuide.html @@ -1919,7 +1919,7 @@ The specific environmental definitions are unique for each board but should incl

Description. Setup up stack-related information in the TCB using pre-allocated stack memory. - This function is called only from task_init() when a task or kernel thread is started (never for pthreads). + This function is called only from nxtask_init() when a task or kernel thread is started (never for pthreads).

The following TCB fields must be initialized: diff --git a/Documentation/NuttxUserGuide.html b/Documentation/NuttxUserGuide.html index d0ac29f3f3a..600d32cc31f 100644 --- a/Documentation/NuttxUserGuide.html +++ b/Documentation/NuttxUserGuide.html @@ -14,7 +14,7 @@

NuttX Operating System

User's Manual

by

Gregory Nutt

-

Last Updated: October 16, 2019

+

Last Updated: May 25, 2020

@@ -200,10 +200,8 @@ paragraphs.

Non-standard extensions to VxWorks-like interfaces to support POSIX Cancellation Points. @@ -345,127 +343,7 @@ VxWorks provides the following similar interface:

  • A variable number of parameters can be passed to a task (VxWorks supports ten). -

    2.1.2 task_init

    - -

    -Function Prototype: -

    -   #include <sched.h>
-   int task_init(struct tcb_s *tcb, char *name, int priority, uint32_t *stack, uint32_t stack_size,
-                 maint_t entry, char * const argv[]);
-
    - -

    -Description: -

    - This function initializes a Task Control Block (TCB) - in preparation for starting a new thread. It performs a subset - of the functionality of task_create() (see above). -

    -

    - Unlike task_create(), task_init() does not activate the task. - This must be done by calling task_activate(). -

    -

    -Input Parameters: -

    -

    -

    -Returned Value: -

    - -

    -Assumptions/Limitations: -

    -

    -POSIX Compatibility: This is a NON-POSIX interface. -VxWorks provides the following similar interface: -

    -   STATUS taskInit(WIND_TCB *pTcb, char *name, int priority, int options, uint32_t *pStackBase, int stackSize,
-                   FUNCPTR entryPt, int arg1, int arg2, int arg3, int arg4, int arg5,
-                   int arg6, int arg7, int arg8, int arg9, int arg10);
-
    - -

    - The NuttX task_init() differs from VxWorks' taskInit() in the - following ways: -

    - - -

    2.1.3 task_activate

    - -

    -Function Prototype: -

    -    #include <sched.h>
-    int task_activate(struct tcb_s *tcb);
-
    - -

    -Description: This function activates tasks created by task_init(). -Without activation, a task is ineligible for execution by the -scheduler. -

    -Input Parameters: -

    - -

    -Returned Value: -

    - -

    -Assumptions/Limitations: -

    -

    -POSIX Compatibility: This is a NON-POSIX interface. -VxWorks provides the following similar interface: -

    -    STATUS taskActivate(int tid);
-
    - -

    - The NuttX task_activate() differs from VxWorks' taskActivate() in the - following ways: -

    - - -

    2.1.4 task_delete

    +

    2.1.2 task_delete

    Function Prototype: @@ -534,7 +412,7 @@ STATUS taskDelete(int tid);

  • Deletion of self is supported, but only because task_delete() will re-direct processing to exit(). -

    2.1.5 task_restart

    +

    2.1.3 task_restart

    Function Prototype: